jplot

Class GraphGeneral

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jplot.GraphGeneral

All Implemented Interfaces:

ImageObserver, MenuContainer, Printable, Serializable, Accessible

Direct Known Subclasses:

GraphXY

public abstract class GraphGeneral
extends JPanel
implements Printable

The Graph class builds a panel which displays a graph according to the data stored in the DataArray. Extends JPanel since the graph is returned in a panel (it can be used in other applications or embedded in a frame. Implements Printable, so we can print the graph, and ComponentListener, needed to listen to a resize event. This class should be sub-classed in order to build a specific graph type (i.e. a 2D graph, piper diagram or 3D, later)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GraphGeneral.DragListener Drag listener, does the actual painting during dragging.
class	GraphGeneral.GraphMouseListener GraphMouseListener, allows to drag'n drop with the mouse.

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
JMenuItem	m_default
JMenuItem	m_edit
JMenuItem	m_refresh
float	scalingFrame
float	scalingFrameX
float	scalingFrameY

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.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
GraphGeneral(GraphSettings gs) Main constructor.
GraphGeneral(JPlot jp, GraphSettings gs) Main constructor.

Method Summary

Modifier and Type	Method and Description
void	arrowCoords(int x1, int y1, int x2, int y2, int x3, int y3)
void	calcCoords(int index, int x, int y, double dist, double dirn)
void	calcValues(int x1, int y1, int x2, int y2)
void	calcValuesQuad(int x1, int y1, int x2, int y2)
void	clear() Clear the graph.
void	drawArrow(Graphics g, int x1, int y1, int x2, int y2) Another way with closed ends
void	drawArrow2(org.freehep.graphics2d.VectorGraphics g, int x1, int y1, int x2, int y2) Draw arrow this allows you to draw an arrow with headlength (headsize), headwidth (headsize - difference), hedheight (factor (relative to headlength)),
void	drawDashedLine(org.freehep.graphics2d.VectorGraphics g, int x1, int y1, int x2, int y2, double dashlength, double spacelength) draw dotted or dashed lines
void	drawPolylineArrow(Graphics g, int[] xPoints, int[] yPoints, int headLength, int headwidth) Draw arrow
static String	formatNumber(double num, int n) formats a double precision number such that it is correctly rounded for output.
Dimension	getMinimumSize() Get the minimum size of this component.
static int	getNumDigits(double num) Return the number of digits required to display the given number.
Dimension	getPreferredSize() Get the preferred size of this component.
static double	log10(double x) Returns the log10 of a double value.
void	paintComponent(Graphics g) Overloaded paintComponent, is called at each repaint.
int	print(Graphics g, PageFormat pageFormat, int pageIndex) Prints the graph.
void	resetLabelPositions(double w0, double h0, double w1, double h1)
void	show(Vector data) Draws the graph on the graphics canvas of this panel.
abstract double	toUserX(int x) Returns the X-value scaled to the data-availability.
abstract double	toUserY(int x) Returns the Y-value scaled to the data-availability.
abstract double	toX(double x) Returns the X-value scaled to the pixel-availability.
abstract double	toY(double y) Returns the Y-value scaled to the pixel-availability.

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, getNextFocusableComponent, getPopupLocation, 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

m_edit

public JMenuItem m_edit

m_default

public JMenuItem m_default

m_refresh

public JMenuItem m_refresh

scalingFrame

public float scalingFrame

scalingFrameY

public float scalingFrameY

scalingFrameX

public float scalingFrameX

Constructor Detail

GraphGeneral

public GraphGeneral(JPlot jp,
                    GraphSettings gs)

Main constructor. Sets the settings to their default values. If the graph is used without the jplot GUI (hence without a JPlot instance), set the first parameter to null or use the other constructor instead.

Parameters:

jp - JPlot instance (parent).

gs - container with all the graph settings.

GraphGeneral

public GraphGeneral(GraphSettings gs)

Main constructor. Sets the settings to their default values.

Parameters:

gs - container with all the graph settings.

Method Detail

getMinimumSize

public Dimension getMinimumSize()

Get the minimum size of this component. This is the panel size defined by width and height.

Overrides:

getMinimumSize in class JComponent

Returns:

the minimum size.

clear

public void clear()

Clear the graph.

getPreferredSize

public Dimension getPreferredSize()

Get the preferred size of this component. This is the panel size defined by width and height

Overrides:

getPreferredSize in class JComponent

Returns:

the preferred size.

log10

public static double log10(double x)

Returns the log10 of a double value.

Parameters:

x - value

Returns:

log10(x)

getNumDigits

public static int getNumDigits(double num)

Return the number of digits required to display the given number. If more than 15 digits are required, 15 is returned).

formatNumber

public static String formatNumber(double num,
                                  int n)

formats a double precision number such that it is correctly rounded for output. Kind of pre-processor for all number for output.

Parameters:

num - number to be formatted

n - number of digits (accuracy) after the decimal point.

Returns:

the formatted number in a string.

toX

public abstract double toX(double x)

Returns the X-value scaled to the pixel-availability. This function takes the X-value and returns the corresponding coordinates for the panel.

Parameters:

x - real x-value (as introduced by the data)

Returns:

x-value scaled to the actual panel coordinates

toY

public abstract double toY(double y)

Returns the Y-value scaled to the pixel-availability. This function takes the Y-value and returns the corresponding coordinates for the panel.

Parameters:

y - real y-value (as introduced by the data)

Returns:

y-value scaled to the actual panel coordinates

toUserX

public abstract double toUserX(int x)

Returns the X-value scaled to the data-availability. This function takes the X-value and returns the corresponding coordinates for the panel.

Parameters:

x - integer x-value (as introduced by the pixels)

Returns:

x-value scaled to the actual data coordinates

toUserY

public abstract double toUserY(int x)

Returns the Y-value scaled to the data-availability. This function takes the Y-value and returns the corresponding coordinates for the panel.

Parameters:

x - integer x-value (as introduced by the pixels)

Returns:

x-value scaled to the actual data coordinate

show

public void show(Vector data)

Draws the graph on the graphics canvas of this panel. Performs a test on the minimum and maximum values. If they are different by more than 10 % with respect to their previous values, release all fixed positions of legend, labels etc and restore the default positions. Otherwise, they may fall far beyond the screen, leading to a coredump.

Parameters:

data - vector of Data Array vectors with the data points

resetLabelPositions

public void resetLabelPositions(double w0,
                                double h0,
                                double w1,
                                double h1)

paintComponent

public void paintComponent(Graphics g)

Overloaded paintComponent, is called at each repaint. If the panel size changed then the user probably resized the window with the mouse and we have to reset the margins of the graph.

Overrides:

paintComponent in class JComponent

Parameters:

g - graphics context

print

public int print(Graphics g,
                 PageFormat pageFormat,
                 int pageIndex)
          throws PrinterException

Prints the graph.

Specified by:

print in interface Printable

Parameters:

g - graphics instance, to which we print the graph.

pageFormat - format of the page

pageIndex - index of the page

Throws:

PrinterException

drawPolylineArrow

public void drawPolylineArrow(Graphics g,
                              int[] xPoints,
                              int[] yPoints,
                              int headLength,
                              int headwidth)

Draw arrow

Parameters:

g -

xPoints - x1,x2 positions

yPoints - y1,y2 positions

headLength - head length

headwidth - head width

drawArrow

public void drawArrow(Graphics g,
                      int x1,
                      int y1,
                      int x2,
                      int y2)

Another way with closed ends

calcValues

public void calcValues(int x1,
                       int y1,
                       int x2,
                       int y2)

calcValuesQuad

public void calcValuesQuad(int x1,
                           int y1,
                           int x2,
                           int y2)

calcCoords

public void calcCoords(int index,
                       int x,
                       int y,
                       double dist,
                       double dirn)

arrowCoords

public void arrowCoords(int x1,
                        int y1,
                        int x2,
                        int y2,
                        int x3,
                        int y3)

drawArrow2

public void drawArrow2(org.freehep.graphics2d.VectorGraphics g,
                       int x1,
                       int y1,
                       int x2,
                       int y2)

Draw arrow this allows you to draw an arrow with headlength (headsize), headwidth (headsize - difference), hedheight (factor (relative to headlength)),

Parameters:

g -

x1 -

y1 -

x2 -

y2 -

drawDashedLine

public void drawDashedLine(org.freehep.graphics2d.VectorGraphics g,
                           int x1,
                           int y1,
                           int x2,
                           int y2,
                           double dashlength,
                           double spacelength)

draw dotted or dashed lines