Package adams.gui.visualization.sequence

Class AbstractXYSequencePaintlet

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractPaintlet

adams.gui.visualization.core.AbstractStrokePaintlet

adams.gui.visualization.sequence.AbstractXYSequencePaintlet

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, Paintlet, HitDetectorSupporter<AbstractXYSequencePointHitDetector>, PaintletWithOptionalPointPreprocessor, XYSequencePaintlet, XYSequencePaintletWithCustomerContainerManager, Serializable

Direct Known Subclasses:

AbstractControlChartPaintlet, AbstractXYSequenceMetaDataColorPaintlet, ByNamePaintlet, LinePaintlet, MathExpressionOverlayPaintlet, MeanOverlayPaintlet, MedianOverlayPaintlet, NullPaintlet, OutlierPaintlet, PaintletWithFixedXRange, PaintletWithFixedYRange, PercentileOverlayPaintlet, StdDevOverlayPaintlet

public abstract class AbstractXYSequencePaintlet
extends AbstractStrokePaintlet
implements XYSequencePaintletWithCustomerContainerManager, PaintletWithOptionalPointPreprocessor, HitDetectorSupporter<AbstractXYSequencePointHitDetector>

Abstract superclass for paintlets for X-Y sequences.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected XYSequenceContainerManager	m_CustomerContainerManager	a custom container manager to obtain the sequences from.
protected AbstractXYSequencePointHitDetector	m_HitDetector	the hit detector to use.
protected PointPreprocessor	m_PointPreprocessor	the preprocessor.

Fields inherited from class adams.gui.visualization.core.AbstractStrokePaintlet

m_StrokeThickness

Fields inherited from class adams.gui.visualization.core.AbstractPaintlet

m_Enabled, m_Initializing, m_Panel, m_RepaintOnChange

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractXYSequencePaintlet()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
XYSequenceContainerManager	getActualContainerManager()	Returns the container manager in use.
Color	getColor(int index)	Returns the color for the data with the given index.
XYSequenceContainerManager	getCustomerContainerManager()	Returns the current custom container manager to obtain the sequences from.
AbstractXYSequencePointHitDetector	getHitDetector()	Returns the hit detector to use for this paintlet.
PaintEvent.PaintMoment	getPaintMoment()	Returns when this paintlet is to be executed.
PointPreprocessor	getPointPreprocessor()	Returns the point preprocessor in use.
XYSequencePanel	getSequencePanel()	Returns the XY sequence panel currently in use.
protected void	initialize()	Initializes the members.
void	memberChanged()	Executes a repaints only if the changes to members are not ignored.
abstract AbstractXYSequencePointHitDetector	newHitDetector()	Returns a new instance of the hit detector to use.
PointPreprocessor	newPointPreprocessor()	Returns the point preprocessor in use.
String	pointPreprocessorTipText()	Returns the tip text for this property.
void	setCustomContainerManager(XYSequenceContainerManager value)	Sets the custom container manager to obtain the sequences from.
void	setLoggingLevel(LoggingLevel value)	Sets the logging level.
void	setPanel(PaintablePanel value)	Sets the panel to use, null to disable painting.
void	setPointPreprocessor(PointPreprocessor value)	Sets the point preprocessor to use.
boolean	supportsPointPreprocessor()	Returns whether point preprocessing is actually supported.
protected void	updateHitDetector()	Updates the settings of the hit detector.

Methods inherited from class adams.gui.visualization.core.AbstractStrokePaintlet

applyStroke, doPerformPaint, getStrokeThickness, getStrokeWidth, performPaint, setStrokeThickness, strokeThicknessTipText

Methods inherited from class adams.gui.visualization.core.AbstractPaintlet

canPaint, finishInit, forCommandLine, forName, getPaintlets, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, isInitializing, memberChanged, paint, repaint, setEnabled, setPanel, setRepaintOnChange, shallowCopy, shallowCopy, updatePanel

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.gui.visualization.core.Paintlet

canPaint, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, paint, performPaint, setEnabled, setPanel, setRepaintOnChange

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Field Detail

m_HitDetector

protected AbstractXYSequencePointHitDetector m_HitDetector

the hit detector to use.

m_CustomerContainerManager

protected XYSequenceContainerManager m_CustomerContainerManager

a custom container manager to obtain the sequences from.

m_PointPreprocessor

protected PointPreprocessor m_PointPreprocessor

the preprocessor.

Constructor Detail

AbstractXYSequencePaintlet

public AbstractXYSequencePaintlet()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractStrokePaintlet

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractPaintlet

memberChanged

public void memberChanged()

Executes a repaints only if the changes to members are not ignored.

Also updates the current hit detector, if necessary.

Overrides:

memberChanged in class AbstractPaintlet

See Also:

AbstractPaintlet.getRepaintOnChange(), AbstractPaintlet.isInitializing(), AbstractPaintlet.repaint()

updateHitDetector

protected void updateHitDetector()

Updates the settings of the hit detector.

Default implementation does nothing.

newHitDetector

public abstract AbstractXYSequencePointHitDetector newHitDetector()

Returns a new instance of the hit detector to use.

Specified by:

newHitDetector in interface XYSequencePaintlet

Returns:

the hit detector

newPointPreprocessor

public PointPreprocessor newPointPreprocessor()

Returns the point preprocessor in use.

Returns:

the preprocessor

supportsPointPreprocessor

public boolean supportsPointPreprocessor()

Returns whether point preprocessing is actually supported.

Specified by:

supportsPointPreprocessor in interface PaintletWithOptionalPointPreprocessor

Returns:

true if supported

setPointPreprocessor

public void setPointPreprocessor(PointPreprocessor value)

Sets the point preprocessor to use.

Specified by:

setPointPreprocessor in interface PaintletWithOptionalPointPreprocessor

Parameters:

value - the preprocessor

getPointPreprocessor

public PointPreprocessor getPointPreprocessor()

Returns the point preprocessor in use.

Specified by:

getPointPreprocessor in interface PaintletWithOptionalPointPreprocessor

Returns:

the preprocessor

pointPreprocessorTipText

public String pointPreprocessorTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setLoggingLevel

public void setLoggingLevel(LoggingLevel value)

Sets the logging level.

Specified by:

setLoggingLevel in interface LoggingLevelHandler

Overrides:

setLoggingLevel in class AbstractOptionHandler

Parameters:

value - the level

setPanel

public void setPanel(PaintablePanel value)

Sets the panel to use, null to disable painting.

Specified by:

setPanel in interface Paintlet

Overrides:

setPanel in class AbstractPaintlet

Parameters:

value - the panel to paint on

getSequencePanel

public XYSequencePanel getSequencePanel()

Returns the XY sequence panel currently in use.

Specified by:

getSequencePanel in interface XYSequencePaintlet

Returns:

the panel in use

setCustomContainerManager

public void setCustomContainerManager(XYSequenceContainerManager value)

Sets the custom container manager to obtain the sequences from.

Specified by:

setCustomContainerManager in interface XYSequencePaintletWithCustomerContainerManager

Parameters:

value - the manager

getCustomerContainerManager

public XYSequenceContainerManager getCustomerContainerManager()

Returns the current custom container manager to obtain the sequences from.

Specified by:

getCustomerContainerManager in interface XYSequencePaintletWithCustomerContainerManager

Returns:

the manager, null if none set

getActualContainerManager

public XYSequenceContainerManager getActualContainerManager()

Returns the container manager in use. Custom manager overrides the sequence panel's one.

Specified by:

getActualContainerManager in interface XYSequencePaintletWithCustomerContainerManager

Returns:

the container manager

See Also:

getCustomerContainerManager()

getPaintMoment

public PaintEvent.PaintMoment getPaintMoment()

Returns when this paintlet is to be executed.

Specified by:

getPaintMoment in interface Paintlet

Specified by:

getPaintMoment in class AbstractPaintlet

Returns:

when this paintlet is to be executed

getColor

public Color getColor(int index)

Returns the color for the data with the given index.

Parameters:

index - the index of the sequence

Returns:

the color for the sequence

getHitDetector

public AbstractXYSequencePointHitDetector getHitDetector()

Returns the hit detector to use for this paintlet.

Specified by:

getHitDetector in interface HitDetectorSupporter<AbstractXYSequencePointHitDetector>

Returns:

the detector