org.uob.braveapi.signaller.algorithms.graphs

Class Graph

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.uob.braveapi.signaller.algorithms.graphs.Graph

All Implemented Interfaces:

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

public class Graph
extends javax.swing.JPanel

Graph class for use with the API component. The graph is contains in its own panel. The graph has GraphSeries objects added to it. It offers the user pan and zoom functionality.

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
Graph(java.lang.String title, java.awt.Color backgroundColour, java.awt.Color foregroundColour, double minX, double maxX, double minY, double maxY, double minXLimit, double maxXLimit, double minYLimit, double maxYLimit, boolean mobileX, boolean mobileY, java.lang.String xAxisLabel, java.lang.String yAxisLabel) Full constructor for the graph.
Graph(java.lang.String title, double minX, double maxX, double minY, double maxY, double minXLimit, double maxXLimit, double minYLimit, double maxYLimit, boolean mobileX, boolean mobileY, java.lang.String xAxisLabel, java.lang.String yAxisLabel) Constructor for graphg - using default background and foregrounds values.

Method Summary

Modifier and Type	Method and Description
void	addSeries(GraphSeries graphSeries) Adds a series to the graph.
double	getMaxX() Gets the maximum X value currently being shown on the graph.
double	getMinX() Gets the minimum X value currently being shown on the graph.
java.util.ArrayList<GraphSeries>	getSeries() Gets the list of series for this graph.
java.lang.String	getTitle() Gets the title being used for this graph.
java.lang.String	getxAxisLabel() Gets the X-axis label being used on this graph.
java.lang.String	getyAxisLabel() Gets the Y-axis label being used on this graph.
void	initialise(java.lang.String title, java.awt.Color backgroundColour, java.awt.Color foregroundColour, double minX, double maxX, double minY, double maxY, double minXLimit, double maxXLimit, double minYLimit, double maxYLimit, boolean mobileX, boolean mobileY, java.lang.String xAxisLabel, java.lang.String yAxisLabel) Initialise the graphs.
void	makePointVisibleOnScreen(Point2D p) Make the specified point visible on the graph.
void	paintComponent(java.awt.Graphics g) Main paint method.
void	resetToBestSize() Reset the size so the points fit in the graph to the edge.
void	setForegroundColour(java.awt.Color foregroundColour) Sets the foreground colour (axis and label colour).
void	setMaxX(double maxX) Set the current maximum X-axis value to be displayed.
void	setMaxXLimit(double maxXLimit) Set the limit of the maximum value to be shown on the X-axis.
void	setMaxY(double maxY) Set the current maximum Y-axis value to be displayed.
void	setMaxYLimit(double maxYLimit) Set the limit of the maximum value to be shown on the Y-axis.
void	setMinX(double minX) Set the current minimum X-axis value to be displayed.
void	setMinXLimit(double minXLimit) Set the limit of the minimum value to be shown on the X-axis.
void	setMinY(double minY) Set the current minimum Y-axis value to be displayed.
void	setMinYLimit(double minYLimit) Set the limit of the minimum value to be shown on the Y-axis.
void	setMobileX(boolean mobileX) Set the flag allowing the user to pan and zoom the X-axis.
void	setMobileY(boolean mobileY) Set the flag allowing the user to pan and zoom the Y-axis.
void	setTitle(java.lang.String title) Set the graph title.
void	setXAxisLabel(java.lang.String xAxisLabel) Set the X-axis label.
void	setYAxisLabel(java.lang.String yAxisLabel) Set the Y-axis label.
Point2D	translate(Point2D xy, boolean allowOffLimit) Translate a XY position into screen coordinates.
Point2D	untranslate(Point2D xy, boolean allowOffLimit) Untranslate a screen coordinate back to its X/Y value.

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

Constructor Detail

Graph

public Graph(java.lang.String title,
             double minX,
             double maxX,
             double minY,
             double maxY,
             double minXLimit,
             double maxXLimit,
             double minYLimit,
             double maxYLimit,
             boolean mobileX,
             boolean mobileY,
             java.lang.String xAxisLabel,
             java.lang.String yAxisLabel)

Constructor for graphg - using default background and foregrounds values.

Parameters:

title - The title of the graph.

minX - The initial minimum X value.

maxX - The initial maximum X value.

minY - The initial minimum Y value.

maxY - The initial maximum Y value.

minXLimit - The minimum limit of the X-axis range.

maxXLimit - The maximum limit of the X-axis range.

minYLimit - The minimum limit of the Y-axis range.

maxYLimit - The maximum limit of the Y-axis range.

mobileX - Whether the user should be able to pan and zoom on the X-axis.

mobileY - Whether the user should be able to pan and zoom on the Y-axis.

xAxisLabel - The label for the X-axis.

yAxisLabel - The label for the Y-axis.

Graph

public Graph(java.lang.String title,
             java.awt.Color backgroundColour,
             java.awt.Color foregroundColour,
             double minX,
             double maxX,
             double minY,
             double maxY,
             double minXLimit,
             double maxXLimit,
             double minYLimit,
             double maxYLimit,
             boolean mobileX,
             boolean mobileY,
             java.lang.String xAxisLabel,
             java.lang.String yAxisLabel)

Full constructor for the graph.

Parameters:

title - The title of the graph.

backgroundColour - Colour for the background area.

foregroundColour - Colour for the foreground (axis and labels).

minX - The initial minimum X value.

maxX - The initial maximum X value.

minY - The initial minimum Y value.

maxY - The initial maximum Y value.

minXLimit - The minimum limit of the X-axis range.

maxXLimit - The maximum limit of the X-axis range.

minYLimit - The minimum limit of the Y-axis range.

maxYLimit - The maximum limit of the Y-axis range.

mobileX - Whether the user should be able to pan and zoom on the X-axis.

mobileY - Whether the user should be able to pan and zoom on the Y-axis.

xAxisLabel - The label for the X-axis.

yAxisLabel - The label for the Y-axis.

Method Detail

initialise

public void initialise(java.lang.String title,
                       java.awt.Color backgroundColour,
                       java.awt.Color foregroundColour,
                       double minX,
                       double maxX,
                       double minY,
                       double maxY,
                       double minXLimit,
                       double maxXLimit,
                       double minYLimit,
                       double maxYLimit,
                       boolean mobileX,
                       boolean mobileY,
                       java.lang.String xAxisLabel,
                       java.lang.String yAxisLabel)

Initialise the graphs.

Parameters:

title - The title of the graph.

backgroundColour - Colour for the background area.

foregroundColour - Colour for the foreground (axis and labels).

minX - The initial minimum X value.

maxX - The initial maximum X value.

minY - The initial minimum Y value.

maxY - The initial maximum Y value.

minXLimit - The minimum limit of the X-axis range.

maxXLimit - The maximum limit of the X-axis range.

minYLimit - The minimum limit of the Y-axis range.

maxYLimit - The maximum limit of the Y-axis range.

mobileX - Whether the user should be able to pan and zoom on the X-axis.

mobileY - Whether the user should be able to pan and zoom on the Y-axis.

xAxisLabel - The label for the X-axis.

yAxisLabel - The label for the Y-axis.

addSeries

public void addSeries(GraphSeries graphSeries)

Adds a series to the graph.

Parameters:

graphSeries -

makePointVisibleOnScreen

public void makePointVisibleOnScreen(Point2D p)

Make the specified point visible on the graph.

Parameters:

p -

paintComponent

public void paintComponent(java.awt.Graphics g)

Main paint method. Draw the axis, labels and graph series.

Overrides:

paintComponent in class javax.swing.JComponent

translate

public Point2D translate(Point2D xy,
                         boolean allowOffLimit)

Translate a XY position into screen coordinates.

Parameters:

xy -

allowOffLimit -

Returns:

untranslate

public Point2D untranslate(Point2D xy,
                           boolean allowOffLimit)

Untranslate a screen coordinate back to its X/Y value.

Parameters:

xy -

allowOffLimit -

Returns:

setXAxisLabel

public void setXAxisLabel(java.lang.String xAxisLabel)

Set the X-axis label.

Parameters:

xAxisLabel -

setYAxisLabel

public void setYAxisLabel(java.lang.String yAxisLabel)

Set the Y-axis label.

Parameters:

yAxisLabel -

setTitle

public void setTitle(java.lang.String title)

Set the graph title.

Parameters:

title -

setMinX

public void setMinX(double minX)

Set the current minimum X-axis value to be displayed.

Parameters:

minX -

setMaxX

public void setMaxX(double maxX)

Set the current maximum X-axis value to be displayed.

Parameters:

maxX -

setMinY

public void setMinY(double minY)

Set the current minimum Y-axis value to be displayed.

Parameters:

maxX -

setMaxY

public void setMaxY(double maxY)

Set the current maximum Y-axis value to be displayed.

Parameters:

maxX -

setMinXLimit

public void setMinXLimit(double minXLimit)

Set the limit of the minimum value to be shown on the X-axis.

Parameters:

minXLimit -

setMaxXLimit

public void setMaxXLimit(double maxXLimit)

Set the limit of the maximum value to be shown on the X-axis.

Parameters:

minXLimit -

setMinYLimit

public void setMinYLimit(double minYLimit)

Set the limit of the minimum value to be shown on the Y-axis.

Parameters:

minXLimit -

setMaxYLimit

public void setMaxYLimit(double maxYLimit)

Set the limit of the maximum value to be shown on the Y-axis.

Parameters:

minXLimit -

setMobileX

public void setMobileX(boolean mobileX)

Set the flag allowing the user to pan and zoom the X-axis.

Parameters:

mobileX -

setMobileY

public void setMobileY(boolean mobileY)

Set the flag allowing the user to pan and zoom the Y-axis.

Parameters:

mobileY -

getSeries

public java.util.ArrayList<GraphSeries> getSeries()

Gets the list of series for this graph.

Returns:

getxAxisLabel

public java.lang.String getxAxisLabel()

Gets the X-axis label being used on this graph.

Returns:

getyAxisLabel

public java.lang.String getyAxisLabel()

Gets the Y-axis label being used on this graph.

Returns:

getTitle

public java.lang.String getTitle()

Gets the title being used for this graph.

Returns:

setForegroundColour

public void setForegroundColour(java.awt.Color foregroundColour)

Sets the foreground colour (axis and label colour).

Parameters:

foregroundColour -

getMinX

public double getMinX()

Gets the minimum X value currently being shown on the graph.

Returns:

getMaxX

public double getMaxX()

Gets the maximum X value currently being shown on the graph.

Returns:

resetToBestSize

public void resetToBestSize()

Reset the size so the points fit in the graph to the edge.