dataPlots

Class TDControl

java.lang.Object

dataPlots.TDControl

All Implemented Interfaces:

PamSettings, UserDisplayComponent

public class TDControl
extends java.lang.Object
implements UserDisplayComponent, PamSettings

Constructor Summary

Constructors

Constructor and Description
TDControl()
TDControl(TDParameters tdParameters)
TDControl(TDParameters tdParameters, boolean registerSettings)
TDControl(TDParameters tdParameters, boolean registerSettings, boolean showControlPanel) Create a new time display.

Method Summary

Methods

Modifier and Type	Method and Description
void	addGraph()
void	closeComponent() Called when the component is removed from the display.
PamScroller	createScroller()
java.awt.Component	getComponent()
PamObserver	getDataObserver()
java.util.ArrayList<TDGraph>	getGraphs()
int	getGraphTimePixels() Get the number of pixels in a time graph.
javax.swing.JCheckBox	getPauseButton() Get the pause button.
int	getRunMode()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
TDAxes	getTdAxes()
TDParameters	getTdParameters()
RangeSpinner	getTimeRangeSpinner()
PamScroller	getTimeScroller()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
boolean	isShowControlPanel() Check whether the time display has a control panel.
boolean	isViewer()
void	layoutGraphs()
void	notifyModelChanged(int changeType) Pick up model changed notifications from a parent user display.
void	openComponent() Called when the component is first displayed.
void	removeGraph(int iGraph) Remove graph with given index.
void	repaintAll()
void	repaintAll(long millis)
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setShowControlPanel(boolean showControlPanel) Set whether the graphs has a control panel, allowing panels etc to be added.
void	setShowGraphLabels(boolean show) Set whether graphs within the display show their label.
void	subscribeScrollDataBlocks() Subscribe datablocks to the time scroller.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TDControl

public TDControl(TDParameters tdParameters)

TDControl

public TDControl(TDParameters tdParameters,
         boolean registerSettings)

TDControl

public TDControl(TDParameters tdParameters,
         boolean registerSettings,
         boolean showControlPanel)

Create a new time display.

Parameters:

tdParameters - - time display paramaters.

registerSettings - - register settings or not.

showControlPanel- - show a control panel on the graph allowing users to add/remnove panels.

TDControl

public TDControl()

Method Detail

subscribeScrollDataBlocks

public void subscribeScrollDataBlocks()

Subscribe datablocks to the time scroller.
seems like a daft call sequence, but the time scroller will only hold one copy of each block, so if a block is removed, it may be that it shouldn't be removed - so easer just to remake the entire list every time

layoutGraphs

public void layoutGraphs()

createScroller

public PamScroller createScroller()

getComponent

public java.awt.Component getComponent()

Specified by:

getComponent in interface UserDisplayComponent

Returns:

The Swing component to add to the frame

openComponent

public void openComponent()

Description copied from interface: UserDisplayComponent

Called when the component is first displayed.

Specified by:

openComponent in interface UserDisplayComponent

closeComponent

public void closeComponent()

Description copied from interface: UserDisplayComponent

Called when the component is removed from the display.

Specified by:

closeComponent in interface UserDisplayComponent

notifyModelChanged

public void notifyModelChanged(int changeType)

Description copied from interface: UserDisplayComponent

Pick up model changed notifications from a parent user display.

Specified by:

notifyModelChanged in interface UserDisplayComponent

getTdParameters

public TDParameters getTdParameters()

Returns:

the tdParameters

getTdAxes

public TDAxes getTdAxes()

Returns:

the tdAxes

getRunMode

public int getRunMode()

Returns:

the runMode

getTimeScroller

public PamScroller getTimeScroller()

Returns:

the pamScroller

getGraphs

public java.util.ArrayList<TDGraph> getGraphs()

Returns:

the graphs

repaintAll

public void repaintAll()

repaintAll

public void repaintAll(long millis)

getTimeRangeSpinner

public RangeSpinner getTimeRangeSpinner()

Returns:

the timeRangeSpinner

addGraph

public void addGraph()

removeGraph

public void removeGraph(int iGraph)

Remove graph with given index.

Parameters:

iGraph - graph index.

getUnitName

public java.lang.String getUnitName()

Specified by:

getUnitName in interface PamSettings

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public java.lang.String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Glick detector

getSettingsReference

public java.io.Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

isViewer

public boolean isViewer()

Returns:

the isViewer

getDataObserver

public PamObserver getDataObserver()

getGraphTimePixels

public int getGraphTimePixels()

Get the number of pixels in a time graph. All should be the same, so just grab the first one.

Returns:

number of time pixels in the plots.

isShowControlPanel

public boolean isShowControlPanel()

Check whether the time display has a control panel.

Returns:

true if there is a control panel. False if not control panel is present.

setShowControlPanel

public void setShowControlPanel(boolean showControlPanel)

Set whether the graphs has a control panel, allowing panels etc to be added.

Parameters:

showControlPanel - - true to show a control panel.

setShowGraphLabels

public void setShowGraphLabels(boolean show)

Set whether graphs within the display show their label. Generally this is only to save a little space.

Parameters:

show - - true if graphs show a label describing graph on top right.

getPauseButton

public javax.swing.JCheckBox getPauseButton()

Get the pause button.

Returns:

the pause button for the graph.