Package adams.gui.visualization.sequence

Class PaintletWithFixedYRange

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

adams.gui.visualization.sequence.PaintletWithFixedYRange

All Implemented Interfaces:

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

Direct Known Subclasses:

PaintletWithFixedXYRange

public class PaintletWithFixedYRange
extends AbstractXYSequencePaintlet
implements PaintletWithFixedYRange, FlowAwarePaintlet, MetaXYSequencePaintlet

A wrapper for XY-sequence paintlets, in order to use fixed a Y range.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Actor	m_Actor	the actor the paintlet belongs to.
protected double	m_MaxY	the maximum of Y.
protected double	m_MinY	the minimum of Y.
protected XYSequencePaintlet	m_Paintlet	the actual paintlet to use.

Fields inherited from class adams.gui.visualization.sequence.AbstractXYSequencePaintlet

m_CustomerContainerManager, m_HitDetector, m_PointPreprocessor

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
PaintletWithFixedYRange()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doPerformPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.
Actor	getActor()	Returns the owning actor.
protected XYSequencePaintlet	getDefaultPaintlet()	Returns the default paintlet to use.
AbstractXYSequencePointHitDetector	getHitDetector()	Returns the hit detector to use for this paintlet.
double	getMaximumY()	Returns the maximum of the Y range.
double	getMaxY()	Returns the maximum of the Y range.
double	getMinimumY()	Returns the minimum of the Y range.
double	getMinY()	Returns the minimum of the Y range.
XYSequencePaintlet	getPaintlet()	Returns the painlet in use.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
String	maxYTipText()	Returns the tip text for this property.
String	minYTipText()	Returns the tip text for this property.
AbstractXYSequencePointHitDetector	newHitDetector()	Returns a new instance of the hit detector to use.
String	paintletTipText()	Returns the tip text for this property.
void	setActor(Actor actor)	Sets the owning actor.
void	setMaxY(double value)	Sets the maximum of the Y range.
void	setMinY(double value)	Sets the minimum of the Y range.
void	setPaintlet(XYSequencePaintlet value)	Sets the actual paintlet to use.
void	setPanel(PaintablePanel value)	Sets the spectrum panel to use, null to disable painting.

Methods inherited from class adams.gui.visualization.sequence.AbstractXYSequencePaintlet

getActualContainerManager, getColor, getCustomerContainerManager, getPaintMoment, getPointPreprocessor, getSequencePanel, memberChanged, newPointPreprocessor, pointPreprocessorTipText, setCustomContainerManager, setLoggingLevel, setPointPreprocessor, supportsPointPreprocessor, updateHitDetector

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

applyStroke, 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, 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, getPaintMoment, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, paint, performPaint, setEnabled, setPanel, setRepaintOnChange

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Methods inherited from interface adams.gui.visualization.sequence.XYSequencePaintlet

getSequencePanel

Field Detail

m_MinY

protected double m_MinY

the minimum of Y.

m_MaxY

protected double m_MaxY

the maximum of Y.

m_Paintlet

protected XYSequencePaintlet m_Paintlet

the actual paintlet to use.

m_Actor

protected Actor m_Actor

the actor the paintlet belongs to.

Constructor Detail

PaintletWithFixedYRange

public PaintletWithFixedYRange()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractXYSequencePaintlet

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractXYSequencePaintlet

getDefaultPaintlet

protected XYSequencePaintlet getDefaultPaintlet()

Returns the default paintlet to use.

Returns:

the default paintlet

setPanel

public void setPanel(PaintablePanel value)

Sets the spectrum panel to use, null to disable painting.

Specified by:

setPanel in interface Paintlet

Overrides:

setPanel in class AbstractXYSequencePaintlet

Parameters:

value - the panel to paint on

setMinY

public void setMinY(double value)

Sets the minimum of the Y range.

Parameters:

value - the minimum

getMinY

public double getMinY()

Returns the minimum of the Y range.

Returns:

the minimum

getMinimumY

public double getMinimumY()

Returns the minimum of the Y range.

Specified by:

getMinimumY in interface PaintletWithFixedYRange

Returns:

the minimum

minYTipText

public String minYTipText()

Returns the tip text for this property.

Returns:

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

setMaxY

public void setMaxY(double value)

Sets the maximum of the Y range.

Parameters:

value - the maximum

getMaxY

public double getMaxY()

Returns the maximum of the Y range.

Returns:

the maximum

getMaximumY

public double getMaximumY()

Returns the maximum of the Y range.

Specified by:

getMaximumY in interface PaintletWithFixedYRange

Returns:

the maximum

maxYTipText

public String maxYTipText()

Returns the tip text for this property.

Returns:

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

setPaintlet

public void setPaintlet(XYSequencePaintlet value)

Sets the actual paintlet to use.

Specified by:

setPaintlet in interface MetaXYSequencePaintlet

Parameters:

value - the paintlet

getPaintlet

public XYSequencePaintlet getPaintlet()

Returns the painlet in use.

Specified by:

getPaintlet in interface MetaXYSequencePaintlet

Returns:

the paintlet

paintletTipText

public String paintletTipText()

Returns the tip text for this property.

Specified by:

paintletTipText in interface MetaXYSequencePaintlet

Returns:

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

doPerformPaint

protected void doPerformPaint(Graphics g,
                              PaintEvent.PaintMoment moment)

The paint routine of the paintlet.

Specified by:

doPerformPaint in class AbstractStrokePaintlet

Parameters:

g - the graphics context to use for painting

moment - what PaintEvent.PaintMoment is currently being painted

newHitDetector

public AbstractXYSequencePointHitDetector newHitDetector()

Returns a new instance of the hit detector to use.

Specified by:

newHitDetector in interface XYSequencePaintlet

Specified by:

newHitDetector in class AbstractXYSequencePaintlet

Returns:

the hit detector

getHitDetector

public AbstractXYSequencePointHitDetector getHitDetector()

Returns the hit detector to use for this paintlet.

Specified by:

getHitDetector in interface HitDetectorSupporter<AbstractXYSequencePointHitDetector>

Overrides:

getHitDetector in class AbstractXYSequencePaintlet

Returns:

the detector

setActor

public void setActor(Actor actor)

Sets the owning actor.

Specified by:

setActor in interface FlowAwarePaintlet

Parameters:

actor - the actor this paintlet belongs to

getActor

public Actor getActor()

Returns the owning actor.

Specified by:

getActor in interface FlowAwarePaintlet

Returns:

the actor this paintlet belongs to, null if none set