ui.outputpanels

Class PlotPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ui.outputpanels.PlotPanel

All Implemented Interfaces:

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

public class PlotPanel
extends javax.swing.JPanel

This class provides a labeled box within which to place a data plot. Zooming in and out is supported, as is panning. When calling the methods, in most cases the changes will not be visible until paint() has been called. To request that this be done, call repaint().

Author:

Clinic 08-09, modified by Clinic 10-11, Max Comstock 2013

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PlotPanel.DragListener This class decides how to draw the zoom boxes and where to pan the graph.
class	PlotPanel.ZoomListener inner classes

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

Modifier and Type	Field and Description
static int	GUIDE_BOX_SIDE Constant
static java.awt.Image	toDisplay The image of the plot

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
PlotPanel(GraphPanel owner, PlotState s) Constructor that creates a plotpanel from a plotstate

Method Summary

Methods

Modifier and Type	Method and Description
void	addPointClickedListener(PointClickedListener pcl) Add pointClickedListeners to be notified when a user clicks on the screen.
void	autoScaleAxis(int axis) Auto-scales the specified axis.
void	clear() Removes all solution specific information from the plot and resets to initial ranges.
void	equilibriumReceived() Readjust the scale and repain when a new Equilibrium is received.
void	export(java.io.FileOutputStream out) Exports the graph to PostScript.
void	fillPlot() Repaints and autoscales if autoscale is on.
boolean	getAutoScale() Returns whether the autoscale is on.
SinglePlotState.DirFieldSettings	getDfSettings() Returns the direction field's settings.
boolean	getDirFieldOn() Returns whether the graph's dirfield is on or off.
boolean	getEquMode() Returns whether graph is in equilibrium finder mode.
boolean	getICMode() Returns whether graph is in initial conditions mode.
boolean	getPanMode() Returns whether graph is in pan mode.
boolean	getPlotOrbitMode() Returns whether graph is in plot orbit mode.
PlotState	getPlotState() Returns the plotstate.
java.lang.String	getTitle() Returns the plot's title.
java.lang.String	getXLabel() Returns the plot's x-axis label.
double[]	getXRange() Returns the range of the x-axis.
ODEVar	getXVar() Returns the variable plotted on the x-axis.
java.lang.String	getYLabel() Returns the plot's y-axis label.
double[]	getYRange() Returns the range of the y-axis.
ODEVarVector	getYVars()
boolean	getZoomMode() Returns whether graph is in zoom mode.
boolean	isDirFieldPossible() returns whether or not the variables on this plot have a dir-field.
void	notifyPointClickedListeners(java.awt.geom.Point2D.Double point) Notifies all the PointClickedListeners of a user clicking a point on the screen
void	paint(java.awt.Graphics graphics) Paint the component contents.
void	printPlot() Prints the plot (on a printer)
void	scalePlotToFit() Forcibly autoscales the graph.
void	setAutoscale(boolean scale) Sets auto-scaling on or off.
void	setAutoscaleNeeded() Tells the state that, if autoscale is on, the graph needs to be autoscaled.
void	setDirColor(java.awt.Color color) Changes the color of dirfield arrows.
void	setDirFieldOn(boolean dirFieldOn) Turns dirFields on or off.
void	setDirFieldSettings(SinglePlotState.DirFieldSettings settings) Sets all dir field settings at once.
void	setDirScale(double d) I believe this changes the length of dirfield arrows but am not sure
void	setDirXCount(int value) Changes the number of arrows on the x-direction of the direction field.
void	setDirYCount(int value) Changes the number of arrows on the y-direction of the direction field.
void	setEquMode() Sets "find equilibrium" mode on.
void	setGrid(boolean on) Toggles gridlines on or off.
void	setICMode() Sets pick initial conditions mode on.
void	setLogscaleX(boolean log) sets x-axis log-scale on or off.
void	setLogscaleY(boolean log) sets y-axis log-scale on or off.
void	setPanMode() Set the panning mode on.
void	setPlotOrbitMode() Set the plot orbit mode on.
void	setPopupMode(boolean b) This function essentially forces the graph to do nothing the next time repaint is called, after which repaint behaves normally.
void	setRange(double xMin, double xMax, double yMin, double yMax) Sets the ranges of the axes.
void	setSlopeType(SinglePlotState.DirLineType type) Changes how the dirfield is displayed.
void	setTitle(java.lang.String s) Changes the graph's title and repaints it.
void	setXLabel(java.lang.String s) Changes the graph's x-axis label and repaints it.
void	setYLabel(java.lang.String s) Changes the graph's y-axis label and repaints it.
void	setZoomMode() Set the zooming mode on or off.
void	setZoomSquare() Zooms the plot out so that shapes are preserved.
void	solutionReceived() Tells state it needs a new autoscale, and redraws the graph.
void	updateAutoScale(boolean aS) Sets the autoscale and, if the autoscale is changed to on, forcibly autoscales the graph.

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

Field Detail

toDisplay

public static java.awt.Image toDisplay

The image of the plot

GUIDE_BOX_SIDE

public static final int GUIDE_BOX_SIDE

Constant

See Also:

Constant Field Values

Constructor Detail

PlotPanel

public PlotPanel(GraphPanel owner,
         PlotState s)

Constructor that creates a plotpanel from a plotstate

Parameters:

owner - the GraphPanel that owns this plotpanel

s - the state of the plot

Method Detail

paint

public void paint(java.awt.Graphics graphics)

Paint the component contents.

Overrides:

paint in class javax.swing.JComponent

Parameters:

graphics - The graphics context.

clear

public void clear()

Removes all solution specific information from the plot and resets to initial ranges.

fillPlot

public void fillPlot()

Repaints and autoscales if autoscale is on.

printPlot

public void printPlot()

Prints the plot (on a printer)

addPointClickedListener

public void addPointClickedListener(PointClickedListener pcl)

Add pointClickedListeners to be notified when a user clicks on the screen.

Parameters:

pcl - The PointClickedListener to notify.

notifyPointClickedListeners

public void notifyPointClickedListeners(java.awt.geom.Point2D.Double point)

Notifies all the PointClickedListeners of a user clicking a point on the screen

Parameters:

point - A 2 element array of doubles containing the coordinates of the point clicked.

setTitle

public void setTitle(java.lang.String s)

Changes the graph's title and repaints it.

Parameters:

s -

setXLabel

public void setXLabel(java.lang.String s)

Changes the graph's x-axis label and repaints it.

Parameters:

s -

setYLabel

public void setYLabel(java.lang.String s)

Changes the graph's y-axis label and repaints it.

Parameters:

s -

setEquMode

public void setEquMode()

Sets "find equilibrium" mode on. When in this mode the program attempts to find an equilibrium point from the conditions the user selects. Only valid for phased graphs.

setPanMode

public void setPanMode()

Set the panning mode on. When we are in panning mode dragging the mouse along the plot moves the plot axis and redraws the plot. The default mode is to draw a zoom box.

setPlotOrbitMode

public void setPlotOrbitMode()

Set the plot orbit mode on. When we are in plot orbit mode, the behavior is the same as initial condition mode except that the orbit for the chosen initial conditions is plotted after the user clicks (solves both forwards and backwards). Currently only valid for phase graphs.

setICMode

public void setICMode()

Sets pick initial conditions mode on. When in this mode, when the user clicks the program sets initial conditions to that point on the graph.

setZoomMode

public void setZoomMode()

Set the zooming mode on or off. When we are in panning mode dragging the mouse along the plot moves the plot axis and redraws the plot. The default mode is to draw a zoom box. @param panning

getPlotOrbitMode

public boolean getPlotOrbitMode()

Returns whether graph is in plot orbit mode.

Returns:

_plotOrbits.

getEquMode

public boolean getEquMode()

Returns whether graph is in equilibrium finder mode.

Returns:

_equMode.

getICMode

public boolean getICMode()

Returns whether graph is in initial conditions mode.

Returns:

_icMode

getZoomMode

public boolean getZoomMode()

Returns whether graph is in zoom mode.

Returns:

_zoomMode

getPanMode

public boolean getPanMode()

Returns whether graph is in pan mode.

Returns:

_panMode

setPopupMode

public void setPopupMode(boolean b)

This function essentially forces the graph to do nothing the next time repaint is called, after which repaint behaves normally. This function should be called before displaying popups to prevent weird artifacts from displaying.

getTitle

public java.lang.String getTitle()

Returns the plot's title.

Returns:

the plot's title

getXLabel

public java.lang.String getXLabel()

Returns the plot's x-axis label.

Returns:

the plot's x-axis label

getYLabel

public java.lang.String getYLabel()

Returns the plot's y-axis label.

Returns:

the plot's y-axis label

setGrid

public void setGrid(boolean on)

Toggles gridlines on or off.

Parameters:

on - true iff turn the gridlines on, false otherwise

getXRange

public double[] getXRange()

Returns the range of the x-axis.

Returns:

the range of the x-axis

getYRange

public double[] getYRange()

Returns the range of the y-axis.

Returns:

the range of the y-axis

setLogscaleX

public void setLogscaleX(boolean log)

sets x-axis log-scale on or off.

Parameters:

log - true iff set to on, false otherwise

setLogscaleY

public void setLogscaleY(boolean log)

sets y-axis log-scale on or off.

Parameters:

log - true iff set to on, false otherwise

solutionReceived

public void solutionReceived()

Tells state it needs a new autoscale, and redraws the graph. Executes when a solution received event is triggered.

equilibriumReceived

public void equilibriumReceived()

Readjust the scale and repain when a new Equilibrium is received.

getPlotState

public PlotState getPlotState()

Returns the plotstate.

Returns:

the plotstate

getAutoScale

public boolean getAutoScale()

Returns whether the autoscale is on.

Returns:

whether the autoscale is on

setAutoscale

public void setAutoscale(boolean scale)

Sets auto-scaling on or off.

Parameters:

scale - true iff set to on, false otherwise

setAutoscaleNeeded

public void setAutoscaleNeeded()

Tells the state that, if autoscale is on, the graph needs to be autoscaled.

autoScaleAxis

public void autoScaleAxis(int axis)

Auto-scales the specified axis.

Parameters:

axis - int representing the axis (0 for x, 1 for y)

getXVar

public ODEVar getXVar()

Returns the variable plotted on the x-axis.

Returns:

the variable plotted on the x-axis

getYVars

public ODEVarVector getYVars()

Returns:

all variables plotted on the y-axis

export

public void export(java.io.FileOutputStream out)

Exports the graph to PostScript.

Parameters:

out - the output stream

scalePlotToFit

public void scalePlotToFit()

Forcibly autoscales the graph.

updateAutoScale

public void updateAutoScale(boolean aS)

Sets the autoscale and, if the autoscale is changed to on, forcibly autoscales the graph.

Parameters:

aS - true iff set to true, false otherwise

setZoomSquare

public void setZoomSquare()

Zooms the plot out so that shapes are preserved.

setRange

public void setRange(double xMin,
            double xMax,
            double yMin,
            double yMax)

Sets the ranges of the axes.

Parameters:

xMin - the minimum value on x-axis

xMax - the maximum value on x-axis

yMin - the minimum value on y-axis

yMax - the maximum value on y-axis

isDirFieldPossible

public boolean isDirFieldPossible()

returns whether or not the variables on this plot have a dir-field.

setDirFieldOn

public void setDirFieldOn(boolean dirFieldOn)

Turns dirFields on or off.

Parameters:

dirFieldOn - true iff turn on, false otherwise

getDirFieldOn

public boolean getDirFieldOn()

Returns whether the graph's dirfield is on or off.

Returns:

true iff the graph's dirfield is on, false otherwise

setDirColor

public void setDirColor(java.awt.Color color)

Changes the color of dirfield arrows.

Parameters:

color - the new color of the direction field arrows

setDirScale

public void setDirScale(double d)

I believe this changes the length of dirfield arrows but am not sure

Parameters:

d - the new length of the dirfield arrows

setSlopeType

public void setSlopeType(SinglePlotState.DirLineType type)

Changes how the dirfield is displayed. Can be shown as an arrow, a line, or a line with a dot.

Parameters:

type - the new line type of the dirfield arrows

setDirXCount

public void setDirXCount(int value)

Changes the number of arrows on the x-direction of the direction field.

Parameters:

value - the number of arrows on the x-direction

setDirYCount

public void setDirYCount(int value)

Changes the number of arrows on the y-direction of the direction field.

Parameters:

value - the number of arrows on the y-direction

setDirFieldSettings

public void setDirFieldSettings(SinglePlotState.DirFieldSettings settings)

Sets all dir field settings at once. Sets by value, not reference.

Parameters:

settings - the new settings of the direction field

getDfSettings

public SinglePlotState.DirFieldSettings getDfSettings()

Returns the direction field's settings.

Returns:

DirField's settings