jplot

Class JPlot

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jplot.JPlot

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class JPlot
extends JPanel

JPLOT: Jan's Plotting Program. Developped for JCHESS (http://chess.ensmp.fr), but extended for general use.

BUGS/TODO:

• rescale the X-scale as well with some value
• save/read settings stuff must be rewritten in XML format.
• put the different graph-styles in separate functions. Otherwise it is impossible to use different graph-styles together (e.g., a histogram AND a line connecting the points).
• decent automatic update method (check datafile's date/time)
• allow for two Y scales (and 2 X scales ?)

See Also:

Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

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

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
JFrame	about
static String	AppName
static boolean	debug
static String[]	fontNames
JFrame	frame
static String	FS
static int	HEIGHT
PanelLabel	labelPanel
PanelLegend	legendPanel
boolean	loaded
JFrame	plotFrame
Vector<PanelPlot>	plotPanels
StyleChooser	styleChooser
static int	WIDTH

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, PROPERTIES, SOMEBITS

Constructor Summary

Constructors

Constructor and Description
JPlot(JFrame parent) Another constructor.
JPlot(JFrame parent, Vector files) Another constructor.
JPlot(JFrame parent, Vector files, File script, boolean lonely) Principal constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the plot-panel, kills eventual plot frames
void	clearData()
void	clearData(int i)
void	dismissGraph() kills the graph frame, stops showing anything.
Vector	getAllPanels()
PanelAxes	getAxesPanel()
Vector	getDataArray()
DataArray	getDataArray(int ind)
DataArray	getDataArraySelected()
GraphGeneral	getGraph()
GraphSettings	getGraphSettings()
GraphSettings	getGS()
ImageIcon	getImageIcon(String name) Returns an image which is found in a valid image URL.
PanelLabel	getLabelPanel()
PanelLegend	getLegendPanel()
StyleChooser	getStyleChooser()
boolean	insertData(int index_data, DataArray data)
boolean	insertDatafile(File file)
boolean	insertDataReader(BufferedReader in, LinePars lp)
void	quit() Quits the app, really quits.
void	quitDialog() Quits the application but asks confirmation if you didn't saved yet.
void	readProject(String ffile) Load the script from a file in memory after heaving cleared the actual data.
void	replaceData(int index_data, DataArray data)
void	replaceLinePars(int index_data, LinePars lp)
PanelScaling	ScalingPanel()
void	setAutoUpdate(boolean b) Toggles timer which updates the graph every second.
void	setGraphLocation(int x, int y) Sets the location at which we put the graph
void	setGraphSettings(GraphSettings gs)
void	setGS(GraphSettings s)
void	show(String fn) Refreshes the actual graph with new data.
boolean	showGraph() Display the graph in a separate frame.
boolean	showGraph(boolean b) Display the graph in a separate frame.
boolean	showGraph(boolean b, boolean toFront) Displays the graph in a separate frame.
int	sizeData()
boolean	switchGraphType(int graphType) Switch from one graph type to another.
void	update(String fn) Refreshes the actual graph with new data.
void	updateGraphIfShowing() Update the graph if the graph is actually showing.
void	updateGraphIfShowing(boolean b) Update the graph if the graph is actually showing.
void	updateLookAndFeel(String laf) Sets the current L&F
boolean	writeScript(File f) Writes the script to a file.

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, paint, 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

debug

public static final boolean debug

See Also:

Constant Field Values

WIDTH

public static int WIDTH

HEIGHT

public static int HEIGHT

AppName

public static final String AppName

See Also:

Constant Field Values

frame

public JFrame frame

about

public JFrame about

plotFrame

public JFrame plotFrame

plotPanels

public Vector<PanelPlot> plotPanels

labelPanel

public PanelLabel labelPanel

legendPanel

public PanelLegend legendPanel

styleChooser

public StyleChooser styleChooser

fontNames

public static String[] fontNames

loaded

public boolean loaded

FS

public static final String FS

Constructor Detail

JPlot

public JPlot(JFrame parent,
             Vector files,
             File script,
             boolean lonely)

Principal constructor. Builds the panel with the plotting commands

Parameters:

files - vector of files containing the data arrays. This array is the result of command-line filenames, and may be empty.

JPlot

public JPlot(JFrame parent)

Another constructor. Builds the panel without initial files.

JPlot

public JPlot(JFrame parent,
             Vector files)

Another constructor. Builds the panel with files

Method Detail

updateGraphIfShowing

public void updateGraphIfShowing(boolean b)

Update the graph if the graph is actually showing. Also repains the plot panel because it shows linestyles.

Parameters:

b - true if the graph must be brought to the front

updateGraphIfShowing

public void updateGraphIfShowing()

Update the graph if the graph is actually showing. Also repains the plot panel because it shows linestyles.

getGraph

public GraphGeneral getGraph()

getGraphSettings

public GraphSettings getGraphSettings()

setGraphSettings

public void setGraphSettings(GraphSettings gs)

getStyleChooser

public StyleChooser getStyleChooser()

getAxesPanel

public PanelAxes getAxesPanel()

ScalingPanel

public PanelScaling ScalingPanel()

getLabelPanel

public PanelLabel getLabelPanel()

getLegendPanel

public PanelLegend getLegendPanel()

getImageIcon

public ImageIcon getImageIcon(String name)

Returns an image which is found in a valid image URL. The basis of the url is where 'jplot' is created.

Parameters:

name - name of the image

Returns:

an image or icon

switchGraphType

public boolean switchGraphType(int graphType)

Switch from one graph type to another. Calling this function switches the GUI in a mode which is specific for a graph. It should (dynamically) change the menu items, options, toolbar etc.. The argument is a graph type, a symbolic constant statically defined in gs.

Parameters:

graphType - type of the graph (i.e. PIPER, 2D...)

Returns:

true if the graph has actually switched

showGraph

public boolean showGraph(boolean b,
                         boolean toFront)

Displays the graph in a separate frame. The first argument can be set to false if the graph shouldn't be shown in a frame. This is useful to make the graph before hand, e.g. to pre-define the graph-parameters or to print the graph.

Parameters:

b - flag, true if the graph must be shown.

toFront - true if the graph must be pushed to the foreground.

Returns:

true if the graph could be drawn.

showGraph

public boolean showGraph(boolean b)

Display the graph in a separate frame.

Parameters:

b - flag, true if the graph must be shown.

Returns:

true if the graph could be drawn, false otherwise.

showGraph

public boolean showGraph()

Display the graph in a separate frame.

Returns:

true if the graph could be drawn, false otherwise.

quitDialog

public void quitDialog()

Quits the application but asks confirmation if you didn't saved yet. Asks for saving the script, if not yet done and allows to cancel this drastic action.

quit

public void quit()

Quits the app, really quits. Exists if this is a stand alone instance. Otherwise we clear the graph and dispose the frame (can be popped up later, but without data and with default settings). S.Chekanov: I had to add many null statements. This is really importnat due to memory leaks in this appls

dismissGraph

public void dismissGraph()

kills the graph frame, stops showing anything.

insertDataReader

public boolean insertDataReader(BufferedReader in,
                                LinePars lp)

insertDatafile

public boolean insertDatafile(File file)

replaceData

public void replaceData(int index_data,
                        DataArray data)

clearData

public void clearData()

clearData

public void clearData(int i)

sizeData

public int sizeData()

replaceLinePars

public void replaceLinePars(int index_data,
                            LinePars lp)

getGS

public GraphSettings getGS()

setGS

public void setGS(GraphSettings s)

insertData

public boolean insertData(int index_data,
                          DataArray data)

getDataArray

public Vector getDataArray()

getDataArray

public DataArray getDataArray(int ind)

getDataArraySelected

public DataArray getDataArraySelected()

writeScript

public boolean writeScript(File f)

Writes the script to a file.

Parameters:

f - file to which to save the script

Returns:

false if something went wrong, true otherwise.

readProject

public void readProject(String ffile)

Load the script from a file in memory after heaving cleared the actual data. TODO: should be threaded.

update

public void update(String fn)

Refreshes the actual graph with new data. Updates the graph only if showing. This function first checks whether the file 'filename' is already present in the system. If not, that's simple, the file is added. If it is already present, then we must replace the file, the difficulty is to preserve, as much as possible, the former selection.

Parameters:

fn - name of the file with data for JPlot.

setAutoUpdate

public void setAutoUpdate(boolean b)

Toggles timer which updates the graph every second. TODO This function needs to be amended to update only if the data actually changed.

setGraphLocation

public void setGraphLocation(int x,
                             int y)

Sets the location at which we put the graph

Parameters:

x - x-position in pixels

y - y-position in pixels

show

public void show(String fn)

Refreshes the actual graph with new data. This function calls first 'update' which updates the graph if showing. If the graph isn't showing, we also popup the graph.

Parameters:

fn - name of the file with data for JPlot.

clear

public void clear()

Clears the plot-panel, kills eventual plot frames

getAllPanels

public Vector getAllPanels()

updateLookAndFeel

public void updateLookAndFeel(String laf)

Sets the current L&F