Package clickDetector.tdPlots

Class ClickPlotInfo

java.lang.Object

dataPlots.data.TDDataInfo

clickDetector.tdPlots.ClickPlotInfo

public class ClickPlotInfo
extends TDDataInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected BTDisplayParameters	btDisplayParams

Fields inherited from class dataPlots.data.TDDataInfo

UNITS_ANGLE, UNITS_TEMPERATURE

Constructor Summary

Constructors

Constructor	Description
ClickPlotInfo(TDDataProvider tdDataProvider, ClickControl clickControl, TDGraph tdGraph, PamDataBlock pamDataBlock)

Method Summary

Modifier and Type	Method	Description
void	clearDraw()	Clear any residual drawing objects that get held between calls, e.g.
boolean	editOptions(Window frame)	Edit options - generally involves throwing up a dialog of some sort.
ClickControl	getClickControl()	Get the CickControl class fro this ClickPlotInfo
Double	getDataValue(PamDataUnit pamDataUnit)	Gets a value for a specific data unit which should be in the same units as the scale information.
int	getDisplayChannels()
TDScaleInfo	getFixedScaleInformation(int orientation)
HidingDialogComponent	getHidingDialogComponent()	Return a hiding dialog component which will get incorporated into a larger tabbed sliding dialog.
TDScaleInfo	getScaleInformation(int orientation, boolean autoScale)
Serializable	getStoredSettings()	Get an object that will be packed up with the serialised settings when information about a plot get's stored.
TDSymbolChooser	getSymbolChooser()
boolean	hasOptions()	Has options that will result in a dialog.
void	selectColourType(int colourId)
void	selectDataLine(DataLineInfo dataLine)	Called when the user selects a specific data line
void	setDisplayChannels(int displayChannels)
boolean	setStoredSettings(Serializable storedSettings)	Set settings which have been read back from storage (the psf file).
void	updateSettings()	Called when settings have changed.

Methods inherited from class dataPlots.data.TDDataInfo

addDataUnits, drawData, drawDataUnit, drawHighLightData, getCurrentDataLine, getCurrentDataLineIndex, getDataBlock, getDataDimensions, getDataLineInfos, getDataName, getDataProvider, getPamDataBlock, getShortName, getTdDataProvider, getTdGraph, getToolTipText, hasAxisName, isShowing, isViewer, notifyModelChanged, removeData, setCurrentAxisName, setFixedScaleInformation, setShowing, timeRangeSpinnerChange, timeScrollRangeChanged, timeScrollValueChanged

Methods inherited from class java.lang.Object

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

Field Details

btDisplayParams

protected BTDisplayParameters btDisplayParams

Constructor Details

ClickPlotInfo

public ClickPlotInfo(TDDataProvider tdDataProvider,
 ClickControl clickControl,
 TDGraph tdGraph,
 PamDataBlock pamDataBlock)

Method Details

getDataValue

public Double getDataValue(PamDataUnit pamDataUnit)

Description copied from class: TDDataInfo

Gets a value for a specific data unit which should be in the same units as the scale information. This will then be converted into a plot position by the TDGraph.

Specified by:

getDataValue in class TDDataInfo

Parameters:

pamDataUnit -

Returns:

data value or null if this data poit should not be plotted.

getClickControl

public ClickControl getClickControl()

Get the CickControl class fro this ClickPlotInfo

Returns:

ClickControl instance fro this ClickPlotInfo.

getSymbolChooser

public TDSymbolChooser getSymbolChooser()

Specified by:

getSymbolChooser in class TDDataInfo

Returns:

a class containing functions to chose a symbol to plot.

getScaleInformation

public TDScaleInfo getScaleInformation(int orientation,
 boolean autoScale)

Overrides:

getScaleInformation in class TDDataInfo

Parameters:

orientation -

Returns:

Information about the scales of the data.

getFixedScaleInformation

public TDScaleInfo getFixedScaleInformation(int orientation)

Overrides:

getFixedScaleInformation in class TDDataInfo

Returns:

the fixedScaleInformation

clearDraw

public void clearDraw()

Description copied from class: TDDataInfo

Clear any residual drawing objects that get held between calls, e.g. the point of the previous unit plotted which may have been held so that lines can be drawn between points.

Overrides:

clearDraw in class TDDataInfo

hasOptions

public boolean hasOptions()

Description copied from class: TDDataInfo

Has options that will result in a dialog.

Overrides:

hasOptions in class TDDataInfo

Returns:

true if there are options.

editOptions

public boolean editOptions(Window frame)

Description copied from class: TDDataInfo

Edit options - generally involves throwing up a dialog of some sort.

Overrides:

editOptions in class TDDataInfo

Returns:

true if options dialog OK button was pressed.

getStoredSettings

public Serializable getStoredSettings()

Description copied from class: TDDataInfo

Get an object that will be packed up with the serialised settings when information about a plot get's stored.
The Object MUST implement serializable and ideally also cloneable or it will go belly up !
This only gets called when settings are to be saved so there is no need to keep parameters this returns up to date except right at settings save time (when this is called)

Overrides:

getStoredSettings in class TDDataInfo

Returns:

serializable object to save.

setStoredSettings

public boolean setStoredSettings(Serializable storedSettings)

Description copied from class: TDDataInfo

Set settings which have been read back from storage (the psf file). Assume these are of the right type and cast into whatever is needed !

Overrides:

setStoredSettings in class TDDataInfo

Parameters:

storedSettings -

Returns:

true if all OK.

getDisplayChannels

public int getDisplayChannels()

setDisplayChannels

public void setDisplayChannels(int displayChannels)

getHidingDialogComponent

public HidingDialogComponent getHidingDialogComponent()

Description copied from class: TDDataInfo

Return a hiding dialog component which will get incorporated into a larger tabbed sliding dialog.

Overrides:

getHidingDialogComponent in class TDDataInfo

Returns:

sliding dialog component.

updateSettings

public void updateSettings()

Called when settings have changed.

selectColourType

public void selectColourType(int colourId)

selectDataLine

public void selectDataLine(DataLineInfo dataLine)

Description copied from class: TDDataInfo

Called when the user selects a specific data line

Overrides:

selectDataLine in class TDDataInfo

Parameters:

dataLine -