org.math.plot

Class PlotPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.math.plot.PlotPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

Plot2DPanel, Plot3DPanel

public abstract class PlotPanel
extends JPanel

BSD License

Author:

Yann RICHET

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static String	BAR
static String	BOX
static Color[]	COLORLIST
static String	EAST
static String	GRID
static String	HISTOGRAM
static String	INVISIBLE
static String	LINE
static String	NORTH
PlotCanvas	plotCanvas
LegendPanel	plotLegend
PlotToolBar	plotToolBar
static String	SCATTER
static String	SOUTH
static String	STAIRCASE
static String	WEST

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, 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(PlotCanvas _canvas)
PlotPanel(PlotCanvas _canvas, String legendOrientation)

Method Summary

Modifier and Type	Method and Description
void	addBaseLabel(String text, Color c, double... where)
void	addGaussQuantilestoPlot(int numPlot, int numAxe, double s)
void	addGaussQuantilestoPlot(int numPlot, int numAxe, double[] s)
void	addLabel(String text, Color c, double... where)
void	addLegend(String location) Defines where the legend of the plot should be added to the plot panel.
int	addPlot(Plot newPlot)
abstract int	addPlot(String type, String name, Color c, double[]... v)
int	addPlot(String type, String name, double[]... v)
void	addPlotable(Plotable p)
void	addPlotToolBar(String location) Adds a new plot toolbar to the specified location.
void	addQuantilestoPlot(int numPlot, int numAxe, double[] q)
void	addQuantilestoPlot(int numPlot, int numAxe, double[][] q)
void	addQuantiletoPlot(int numPlot, int numAxe, double rate, boolean symetric, double q)
void	addQuantiletoPlot(int numPlot, int numAxe, double rate, boolean symetric, double[] q)
void	addVectortoPlot(int numPlot, double[][] v)
void	changePlotColor(int I, Color c)
void	changePlotData(int I, double[]... XY)
void	changePlotName(int I, String name)
Axis	getAxis(int i) Return the axis specified in parameter.
String[]	getAxisScales() Returns the scaling for all of the axis of the plot.
boolean	getEditable()
Font	getFont()
protected Color	getNewColor()
boolean	getNotable()
Plot	getPlot(int i)
Plotable	getPlotable(int i)
LinkedList<Plotable>	getPlotables()
int	getPlotIndex(Plot p)
LinkedList<Plot>	getPlots()
PlotToolBar	getPlotToolBar()
void	includeInBounds(double... into) Modify bounds of the axes so as to include the point given in parameter.
void	includeInBounds(Plot plot) Modify axes boundaries so as to include all the points of a given plot.
static void	main(String[] args)
double[][]	mapData(Object[][] stringdata)
void	removeAllPlotables()
void	removeAllPlots()
void	removeLegend() Removes the current legend from the plot panel.
void	removePlot(int I)
void	removePlot(Plot p)
void	removePlotable(int i)
void	removePlotable(Plotable p)
void	removePlotToolBar() Removes the plot toolbar from the panel.
void	resetMapData()
void	setActionMode(int am)
void	setAdjustBounds(boolean adjust)
void	setAutoBounds() Set bounds automatically.
void	setAutoBounds(int axe) Set bounds automatically for one axis.
void	setAxisLabel(int axe, String label) Sets the name of the axis specified in parameter.
void	setAxisLabels(String... labels) Sets the name of the axis, in this order: X, Y and Z.
void	setAxisScale(int axe, String scale) Sets the scaling of the specified axis.
void	setAxisScales(String... scales) Sets the scale of the axes, linear or logarithm, in this order: X,Y,Z.
void	setEditable(boolean b)
void	setFixedBounds(double[] min, double[] max) Sets the boundaries for each axis.
void	setFixedBounds(int axe, double min, double max) Sets the boundaries for the specified axis.
void	setFont(Font font)
void	setLegendOrientation(String location) Moves the legend to the specified location.
void	setNotable(boolean b)
void	setNoteCoords(boolean b)
void	setPlot(int I, Plot p)
void	setPlotToolBarOrientation(String location) Moves the plot toolbar to the specified location.
void	toGraphicFile(File file)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, 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, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, 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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

plotToolBar

public PlotToolBar plotToolBar

plotCanvas

public PlotCanvas plotCanvas

plotLegend

public LegendPanel plotLegend

EAST

public static final String EAST

See Also:

Constant Field Values

SOUTH

public static final String SOUTH

See Also:

Constant Field Values

NORTH

public static final String NORTH

See Also:

Constant Field Values

WEST

public static final String WEST

See Also:

Constant Field Values

INVISIBLE

public static final String INVISIBLE

See Also:

Constant Field Values

SCATTER

public static final String SCATTER

See Also:

Constant Field Values

LINE

public static final String LINE

See Also:

Constant Field Values

BAR

public static final String BAR

See Also:

Constant Field Values

HISTOGRAM

public static final String HISTOGRAM

See Also:

Constant Field Values

BOX

public static final String BOX

See Also:

Constant Field Values

STAIRCASE

public static final String STAIRCASE

See Also:

Constant Field Values

GRID

public static final String GRID

See Also:

Constant Field Values

COLORLIST

public static final Color[] COLORLIST

Constructor Detail

PlotPanel

public PlotPanel(PlotCanvas _canvas,
                 String legendOrientation)

PlotPanel

public PlotPanel(PlotCanvas _canvas)

Method Detail

addLegend

public void addLegend(String location)

Defines where the legend of the plot should be added to the plot panel.

Parameters:

location - Location where should be put the legend (String). location can have the following values (case insensitive): EAST, SOUTH, WEST, NORTH, INVISIBLE (legend will be hidden in this case). Any other value will be ignored and an error message will be sent to the error output.

removeLegend

public void removeLegend()

Removes the current legend from the plot panel.

setLegendOrientation

public void setLegendOrientation(String location)

Moves the legend to the specified location.

Parameters:

location - Location where should be put the legend (String). location can have the following values (case insensitive): EAST, SOUTH, WEST, NORTH, INVISIBLE (legend will be hidden in this case). Any other value will be ignored and an error message will be sent to the error output.

addPlotToolBar

public void addPlotToolBar(String location)

Adds a new plot toolbar to the specified location. The previous toolbar is deleted.

Parameters:

location - Location where should be put the toolbar (String). location can have the following values (case insensitive): EAST, SOUTH, WEST, NORTH. Any other value will be ignored and an error message will be sent to the error output.

removePlotToolBar

public void removePlotToolBar()

Removes the plot toolbar from the panel.

setPlotToolBarOrientation

public void setPlotToolBarOrientation(String location)

Moves the plot toolbar to the specified location.

Parameters:

location - Location where should be put the toolbar (String). location can have the following values (case insensitive): EAST, SOUTH, WEST, NORTH. Any other value will be ignored and an error message will be sent to the error output.

getPlotToolBar

public PlotToolBar getPlotToolBar()

setAdjustBounds

public void setAdjustBounds(boolean adjust)

setActionMode

public void setActionMode(int am)

setNoteCoords

public void setNoteCoords(boolean b)

setEditable

public void setEditable(boolean b)

getEditable

public boolean getEditable()

setNotable

public void setNotable(boolean b)

getNotable

public boolean getNotable()

getPlots

public LinkedList<Plot> getPlots()

getPlot

public Plot getPlot(int i)

getPlotIndex

public int getPlotIndex(Plot p)

getPlotables

public LinkedList<Plotable> getPlotables()

getPlotable

public Plotable getPlotable(int i)

getAxis

public Axis getAxis(int i)

Return the axis specified in parameter.

Parameters:

i - Axis number. 0 for X, 1 for Y, 2 for Z.

Returns:

The axis which number is given in parameter.

getAxisScales

public String[] getAxisScales()

Returns the scaling for all of the axis of the plot.

Returns:

An array of String

setAxisLabels

public void setAxisLabels(String... labels)

Sets the name of the axis, in this order: X, Y and Z.

Parameters:

labels - One to three strings containing the name of each axis.

setAxisLabel

public void setAxisLabel(int axe,
                         String label)

Sets the name of the axis specified in parameter.

Parameters:

axe - Axis number. 0 for X, 1 for Y, 2 for Z.

label - Name to be given.

setAxisScales

public void setAxisScales(String... scales)

Sets the scale of the axes, linear or logarithm, in this order: X,Y,Z.

Parameters:

scales - Strings containing the scaling, LOG or LIN (case insensitive) for the axes.

setAxisScale

public void setAxisScale(int axe,
                         String scale)

Sets the scaling of the specified axis.

Parameters:

axe - Axis number. 0 for X, 1 for Y, 2 for Z.

scale - String specifying the scaling. LIN or LOG, case insensitive.

setFixedBounds

public void setFixedBounds(double[] min,
                           double[] max)

Sets the boundaries for each axis.

Parameters:

min - Array of at most 3 doubles specifying the min bound of each axis, in this order: X,Y,Z.

max - Array of at most 3 doubles specifying the max bound of each axis, in this order: X,Y,Z.

setFixedBounds

public void setFixedBounds(int axe,
                           double min,
                           double max)

Sets the boundaries for the specified axis.

Parameters:

axe - Axis number to modify. 0 for X, 1 for Y, 2 for Z.

min - Min bound of the axis.

max - Max bound of the axis.

includeInBounds

public void includeInBounds(double... into)

Modify bounds of the axes so as to include the point given in parameter.

Parameters:

into - Coords of the point to include in bounds.

includeInBounds

public void includeInBounds(Plot plot)

Modify axes boundaries so as to include all the points of a given plot.

Parameters:

plot - Plot to include.

setAutoBounds

public void setAutoBounds()

Set bounds automatically.

setAutoBounds

public void setAutoBounds(int axe)

Set bounds automatically for one axis.

Parameters:

axe - Number of the axis to modify. 0 for X, 1 for Y, 2 for Z.

mapData

public double[][] mapData(Object[][] stringdata)

resetMapData

public void resetMapData()

addLabel

public void addLabel(String text,
                     Color c,
                     double... where)

addBaseLabel

public void addBaseLabel(String text,
                         Color c,
                         double... where)

addPlotable

public void addPlotable(Plotable p)

removePlotable

public void removePlotable(Plotable p)

removePlotable

public void removePlotable(int i)

removeAllPlotables

public void removeAllPlotables()

addPlot

public int addPlot(Plot newPlot)

getNewColor

protected Color getNewColor()

addPlot

public int addPlot(String type,
                   String name,
                   double[]... v)

addPlot

public abstract int addPlot(String type,
                            String name,
                            Color c,
                            double[]... v)

setPlot

public void setPlot(int I,
                    Plot p)

changePlotData

public void changePlotData(int I,
                           double[]... XY)

changePlotName

public void changePlotName(int I,
                           String name)

changePlotColor

public void changePlotColor(int I,
                            Color c)

removePlot

public void removePlot(int I)

removePlot

public void removePlot(Plot p)

removeAllPlots

public void removeAllPlots()

addVectortoPlot

public void addVectortoPlot(int numPlot,
                            double[][] v)

addQuantiletoPlot

public void addQuantiletoPlot(int numPlot,
                              int numAxe,
                              double rate,
                              boolean symetric,
                              double[] q)

addQuantiletoPlot

public void addQuantiletoPlot(int numPlot,
                              int numAxe,
                              double rate,
                              boolean symetric,
                              double q)

addQuantilestoPlot

public void addQuantilestoPlot(int numPlot,
                               int numAxe,
                               double[][] q)

addQuantilestoPlot

public void addQuantilestoPlot(int numPlot,
                               int numAxe,
                               double[] q)

addGaussQuantilestoPlot

public void addGaussQuantilestoPlot(int numPlot,
                                    int numAxe,
                                    double[] s)

addGaussQuantilestoPlot

public void addGaussQuantilestoPlot(int numPlot,
                                    int numAxe,
                                    double s)

toGraphicFile

public void toGraphicFile(File file)
                   throws IOException

Throws:

IOException

main

public static void main(String[] args)

getFont

public Font getFont()

Specified by:

getFont in interface MenuContainer

Overrides:

getFont in class Component

Returns:

the font

setFont

public void setFont(Font font)

Overrides:

setFont in class JComponent

Parameters:

font - the font to set