ui.outputpanels

Class GraphPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ui.outputpanels.OutputPanel

ui.outputpanels.GraphPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, PointClickedListener

Direct Known Subclasses:

ComponentGraphPanel, MultiGraphPanel, PhaseGraphPanel

public abstract class GraphPanel
extends OutputPanel
implements PointClickedListener

GraphPanel is an abstract class defining one of two types of OutputPanels inside a TabbedOutputPanel for an ODEWorkspace, the other class being a DataPanel. GraphPanels are used for displaying a PlotPanel and providing useful functionality to the user for editing the plot view and allowing the user to interact with the graph. All GraphPanels contain a toolbar and a PlotPanel, as well as a right-click menu for the plot display, and a set of dialogs for modifying the labels, direction fields, and scaling options of the graph. There are three types of GraphPanels, each defined in a separate subclass: ComponentGraphPanels are for displaying a single independent variable against the dependent variable. PhaseGraphPanels are for plotting a pair of independent variables against each other, allowing for direction fields and other phase plot options, such as plotting orbit lines and finding equilibrium points. MultiGraphPanels are intended for plotting all the independent variables against the dependent variable in a single PlotPanel.

Author:

Clinic 08-09, modified by Max Comstock 2013

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
GraphPanel(TabbedOutputPanel owner) Default Constructor, creates a new OutputPanel given a TabbedOutputPanel

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canPrint() As of right now all GraphPanels can print.
void	clear() Clears the displayed data, resets the scale settings to default, and empties the PlotPanel and PlotState.
void	equilibriumReceived() Response when a new Equilibrium is available.
void	errorCondition(java.lang.Exception ex) Required by the PointClickedListener interface.
void	errorCondition(java.lang.String error) Required by the PointClickedListener interface.
void	exportPostscript() Exports the PlotPanel to a postscript file.
PlotPanel	getPlotPanel() Accessor function for the PlotPanel associated with this GraphPanel.
PlotState	getPlotState() Accessor function for the PlotState associated with this GraphPanel.
boolean	isDirFieldPossible() Returns whether the PlotPanel allows a direction field.
boolean	isPlotOrbitPossible() Returns whether the PlotPanel allows a Plot Orbit and Find Eq Points.
void	paint(java.awt.Graphics g) Paints the GraphPanel, and repaints the PlotPanel.
void	pointClicked(java.awt.geom.Point2D.Double pt) Action function required by the PointClickedListener interface.
void	print() Prints the graph, which in turn launches the printing dialog box.
void	setAllAutoScale(boolean autoScaleOn) This function is called any time auto-scaling is toggled.
void	setAllDirField(boolean selected) This function is called any time direction fields are enabled/disabled.
void	setAllGrid(boolean gridOn) This function is called any time the grid lines are toggled.
void	setXLogScale(boolean xLogScaleOn) This function is called any time the scaling for the horizontal axis is changed.
void	setYLogScale(boolean yLogScaleOn) This function is called any time the scaling for the vertical axis is changed.
void	solutionReceived() This function is called any time a new solution is to be painted on the PlotPanel.
void	updateLabelDialog() This function updates the label dialog with the current labels; it is called after labels are loaded when the user opens a .ode file.
void	updateScaleDialog() This function updates the scaling dialog with the current range values; it is called after ranges are loaded when the user opens a .ode file.
void	updateTool() This function is called any time the mouse action tool is changed.

Methods inherited from class ui.outputpanels.OutputPanel

gainedFocus, getTabName

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GraphPanel

public GraphPanel(TabbedOutputPanel owner)

Default Constructor, creates a new OutputPanel given a TabbedOutputPanel

Parameters:

owner - the TabbedOutputPanel to which the GraphPanel belongs

Method Detail

getPlotPanel

public PlotPanel getPlotPanel()

Accessor function for the PlotPanel associated with this GraphPanel.

Returns:

the PlotPanel associated with this GraphPanel

getPlotState

public PlotState getPlotState()

Accessor function for the PlotState associated with this GraphPanel.

Returns:

the PlotState associated with this GraphPanel

isDirFieldPossible

public boolean isDirFieldPossible()

Returns whether the PlotPanel allows a direction field.

isPlotOrbitPossible

public boolean isPlotOrbitPossible()

Returns whether the PlotPanel allows a Plot Orbit and Find Eq Points.

setAllAutoScale

public void setAllAutoScale(boolean autoScaleOn)

This function is called any time auto-scaling is toggled. It updates the status of auto-scaling in the toolbar and the PlotPanel's right-click menu, and activates/de-activates the PlotPanel's auto-scaling feature.

Parameters:

autoScaleOn - the on/off state of the auto-scaling feature

setAllDirField

public void setAllDirField(boolean selected)

This function is called any time direction fields are enabled/disabled. It updates the status of direction fields in the toolbar and the PlotPanel's right-click menu, and activates/de-activates the PlotPanel's direction field.

Parameters:

selected - true if direction fields are enabled, false otherwise

setXLogScale

public void setXLogScale(boolean xLogScaleOn)

This function is called any time the scaling for the horizontal axis is changed. It updates the scaling of the horizontal axis in the toolbar and the PlotPanel's right-click menu, and enables/disables logarithmic scaling for the PlotPanel's horizontal axis.

Parameters:

xLogScaleOn - true if the horizontal axis is log-scaled

setYLogScale

public void setYLogScale(boolean yLogScaleOn)

This function is called any time the scaling for the vertical axis is changed. It updates the scaling of the vertical axis in the toolbar and the PlotPanel's right-click menu, and enables/disables logarithmic scaling for the PlotPanel's vertical axis.

Parameters:

yLogScaleOn - true if the vertical axis is log-scaled

setAllGrid

public void setAllGrid(boolean gridOn)

This function is called any time the grid lines are toggled. It updates the grid lines checkmark in the toolbar and the PlotPanel's right-click menu, and enables/disables the visibility of grid lines in the PlotPanel.

Parameters:

gridOn - true if grid lines are set to on

updateTool

public void updateTool()

This function is called any time the mouse action tool is changed. It updates the tool selector in the toolbar and the radio buttons in the PlotPanel's right-click menu.

updateLabelDialog

public void updateLabelDialog()

This function updates the label dialog with the current labels; it is called after labels are loaded when the user opens a .ode file.

updateScaleDialog

public void updateScaleDialog()

This function updates the scaling dialog with the current range values; it is called after ranges are loaded when the user opens a .ode file.

canPrint

public boolean canPrint()

As of right now all GraphPanels can print.

Specified by:

canPrint in class OutputPanel

print

public void print()

Prints the graph, which in turn launches the printing dialog box.

Specified by:

print in class OutputPanel

clear

public void clear()

Clears the displayed data, resets the scale settings to default, and empties the PlotPanel and PlotState.

Specified by:

clear in class OutputPanel

paint

public void paint(java.awt.Graphics g)

Paints the GraphPanel, and repaints the PlotPanel.

Overrides:

paint in class javax.swing.JComponent

Parameters:

g - Graphics object corresponding to panel display.

exportPostscript

public void exportPostscript()

Exports the PlotPanel to a postscript file.

Specified by:

exportPostscript in class OutputPanel

solutionReceived

public void solutionReceived()

This function is called any time a new solution is to be painted on the PlotPanel. It triggers a method in the PlotPanel class that resets the auto-scaling and redraws the graph given the updated set of curves.

Specified by:

solutionReceived in class OutputPanel

equilibriumReceived

public void equilibriumReceived()

Description copied from class: OutputPanel

Response when a new Equilibrium is available.

Specified by:

equilibriumReceived in class OutputPanel

pointClicked

public void pointClicked(java.awt.geom.Point2D.Double pt)

Action function required by the PointClickedListener interface. If the PlotPanel is in 'Pick Initial Conditions' mode, it stores the point clicked as the new initial conditions and updates the status display with the new coordinates.

Specified by:

pointClicked in interface PointClickedListener

Parameters:

pt - the point being clocked

errorCondition

public void errorCondition(java.lang.Exception ex)

Required by the PointClickedListener interface. Never used by any type of GraphPanel.

Specified by:

errorCondition in interface PointClickedListener

Parameters:

ex - the exception to be handled

errorCondition

public void errorCondition(java.lang.String error)

Required by the PointClickedListener interface. Never used by any type of GraphPanel.

Specified by:

errorCondition in interface PointClickedListener

Parameters:

error - string describing error condition