org.opentrafficsim.draw.graphs

Class AbstractPlot

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.opentrafficsim.draw.graphs.AbstractPlot

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, Dataset, Identifiable

Direct Known Subclasses:

AbstractBoundedPlot

public abstract class AbstractPlot
extends JFrame
implements Identifiable, Dataset

Super class of all plots. This schedules regular updates, creates menus and deals with listeners. There are a number of delegate methods for sub classes to implement.

Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 4 okt. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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 Time	DEFAULT_INITIAL_UPPER_TIME_BOUND Initial upper bound for the time scale.
static EventType	GRAPH_ADD_EVENT The (regular, not timed) event type for pub/sub indicating the addition of a graph.
static EventType	GRAPH_REMOVE_EVENT The (regular, not timed) event type for pub/sub indicating the removal of a graph.

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
AbstractPlot(String caption, Duration updateInterval, OTSSimulatorInterface simulator, Duration delay) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(DatasetChangeListener listener)
protected void	addPopUpMenuItems(JPopupMenu popupMenu) Overridable method to add pop up items.
byte[]	encodeAsPng(int width, int height, double fontSize) Returns the chart as a byte array representing a png image.
String	getCaption() Return the caption of this graph.
protected JFreeChart	getChart() Returns the chart.
protected ChartMouseListener	getChartMouseListener() Overridable; may return a chart listener for additional functions.
abstract GraphType	getGraphType() Return the graph type for transceiver.
DatasetGroup	getGroup()
String	getId()
protected abstract String	getStatusLabel(double domainValue, double rangeValue) Returns the status label when the mouse is over the given location.
protected Time	getUpdateTime() Returns time until which data should be plotted.
protected abstract void	increaseTime(Time time) Increase the simulated time span.
void	notifyPlotChange() Notify all change listeners.
void	removeChangeListener(DatasetChangeListener listener)
protected void	setAutoBoundDomain(XYPlot plot) Overridable; activates auto bounds on domain axis from user input.
protected void	setAutoBoundRange(XYPlot plot) Overridable; activates auto bounds on range axis from user input.
protected void	setChart(JFreeChart chart) Sets the chart and adds menus and listeners.
void	setGroup(DatasetGroup group)
protected void	setStatusLabel(String label) Manually set status label from sub class.
protected void	setUpdateInterval(Duration interval) Sets a new update interval.
protected void	update() Redraws the plot and schedules the next update.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

GRAPH_ADD_EVENT

public static final EventType GRAPH_ADD_EVENT

The (regular, not timed) event type for pub/sub indicating the addition of a graph. Not used internally.
Payload: String graph caption (not an array, just a String)

GRAPH_REMOVE_EVENT

public static final EventType GRAPH_REMOVE_EVENT

The (regular, not timed) event type for pub/sub indicating the removal of a graph. Not used internally.
Payload: String Graph caption (not an array, just a String)

DEFAULT_INITIAL_UPPER_TIME_BOUND

public static final Time DEFAULT_INITIAL_UPPER_TIME_BOUND

Initial upper bound for the time scale.

Constructor Detail

AbstractPlot

public AbstractPlot(String caption,
                    Duration updateInterval,
                    OTSSimulatorInterface simulator,
                    Duration delay)

Constructor.

Parameters:

caption - String; caption

updateInterval - Duration; regular update interval (simulation time)

simulator - OTSSimulatorInterface; simulator

delay - Duration; delay so critical future events have occurred, e.g. GTU's next move's to extend trajectories

Method Detail

setChart

protected void setChart(JFreeChart chart)

Sets the chart and adds menus and listeners.

Parameters:

chart - JFreeChart; chart

encodeAsPng

public byte[] encodeAsPng(int width,
                          int height,
                          double fontSize)
                   throws IOException

Returns the chart as a byte array representing a png image.

Parameters:

width - int; width

height - int; height

fontSize - double; font size (16 is the original on screen size)

Returns:

byte[]; the chart as a byte array representing a png image

Throws:

IOException - on IO exception

getGroup

public final DatasetGroup getGroup()

Specified by:

getGroup in interface Dataset

setGroup

public final void setGroup(DatasetGroup group)

Specified by:

setGroup in interface Dataset

addPopUpMenuItems

protected void addPopUpMenuItems(JPopupMenu popupMenu)

Overridable method to add pop up items.

Parameters:

popupMenu - JPopupMenu; pop up menu

setAutoBoundDomain

protected void setAutoBoundDomain(XYPlot plot)

Overridable; activates auto bounds on domain axis from user input. This class does not force the use of XYPlots, but the auto bounds command comes from the ChartPanel that this class creates. In case the used plot is a XYPlot, this method is then invoked. Sub classes with auto domain bounds that work with an XYPlot should implement this. The method is not abstract as the use of XYPlot is not obligated.

Parameters:

plot - XYPlot; plot

setAutoBoundRange

protected void setAutoBoundRange(XYPlot plot)

Overridable; activates auto bounds on range axis from user input. This class does not force the use of XYPlots, but the auto bounds command comes from the ChartPanel that this class creates. In case the used plot is a XYPlot, this method is then invoked. Sub classes with auto range bounds that work with an XYPlot should implement this. The method is not abstract as the use of XYPlot is not obligated.

Parameters:

plot - XYPlot; plot

getChartMouseListener

protected ChartMouseListener getChartMouseListener()

Overridable; may return a chart listener for additional functions.

Returns:

ChartMouseListener, null by default

getGraphType

public abstract GraphType getGraphType()

Return the graph type for transceiver.

Returns:

GraphType; the graph type.

getStatusLabel

protected abstract String getStatusLabel(double domainValue,
                                         double rangeValue)

Returns the status label when the mouse is over the given location.

Parameters:

domainValue - double; domain value (x-axis)

rangeValue - double; range value (y-axis)

Returns:

String; status label when the mouse is over the given location

increaseTime

protected abstract void increaseTime(Time time)

Increase the simulated time span.

Parameters:

time - Time; time to increase to

update

protected void update()

Redraws the plot and schedules the next update.

notifyPlotChange

public final void notifyPlotChange()

Notify all change listeners.

setUpdateInterval

protected final void setUpdateInterval(Duration interval)

Sets a new update interval.

Parameters:

interval - Duration; update interval

getUpdateTime

protected final Time getUpdateTime()

Returns time until which data should be plotted.

Returns:

Time; time until which data should be plotted

getChart

protected final JFreeChart getChart()

Returns the chart.

Returns:

JFreeChart; chart

getId

public final String getId()

Specified by:

getId in interface Identifiable

addChangeListener

public final void addChangeListener(DatasetChangeListener listener)

Specified by:

addChangeListener in interface Dataset

removeChangeListener

public final void removeChangeListener(DatasetChangeListener listener)

Specified by:

removeChangeListener in interface Dataset

setStatusLabel

protected final void setStatusLabel(String label)

Manually set status label from sub class. Will be overwritten by a moving mouse pointer over the axes.

Parameters:

label - String; label to set

getCaption

public final String getCaption()

Return the caption of this graph.

Returns:

String; the caption of this graph