Package adams.flow.sink.controlchartplot

Class LimitPaintlet

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.flow.sink.controlchartplot.AbstractControlChartPaintlet

adams.flow.sink.controlchartplot.LimitPaintlet

All Implemented Interfaces:

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

public class LimitPaintlet
extends AbstractControlChartPaintlet
implements AntiAliasingSupporter, HitDetectorSupporter<AbstractXYSequencePointHitDetector>

A paintlet for painting a line plot of a sequence.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_AntiAliasingEnabled	whether anti-aliasing is enabled.
protected Color	m_ColorCenter	the color for the center.
protected Color	m_ColorLower	the color for the lower limit.
protected Color	m_ColorUpper	the color for the upper limit.

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

m_CustomerContainerManager, m_HitDetector

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

Method Summary

Modifier and Type	Method	Description
String	antiAliasingEnabledTipText()	Returns the tip text for this property.
String	colorCenterTipText()	Returns the tip text for this property.
String	colorLowerTipText()	Returns the tip text for this property.
String	colorUpperTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected void	doPerformPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.
protected void	drawData(Graphics g, PaintEvent.PaintMoment moment, XYSequence data)	Draws the limits.
Color	getColorCenter()	Returns the color for the center.
Color	getColorLower()	Returns the color for the lower limit.
Color	getColorUpper()	Returns the color for the upper limit.
PaintEvent.PaintMoment	getPaintMoment()	Returns when this paintlet is to be executed.
String	globalInfo()	Returns a string describing the object.
boolean	isAntiAliasingEnabled()	Returns whether anti-aliasing is used.
AbstractXYSequencePointHitDetector	newHitDetector()	Returns a new instance of the hit detector to use.
void	setAntiAliasingEnabled(boolean value)	Sets whether to use anti-aliasing.
void	setColorCenter(Color value)	Sets the color for the center.
void	setColorLower(Color value)	Sets the color for the lower limit.
void	setColorUpper(Color value)	Sets the color for the upper limit.

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

getActualContainerManager, getColor, getCustomerContainerManager, getHitDetector, getSequencePanel, initialize, memberChanged, setCustomContainerManager, setLoggingLevel, setPanel, 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.gui.visualization.core.plot.HitDetectorSupporter

getHitDetector

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_ColorLower

protected Color m_ColorLower

the color for the lower limit.

m_ColorCenter

protected Color m_ColorCenter

the color for the center.

m_ColorUpper

protected Color m_ColorUpper

the color for the upper limit.

m_AntiAliasingEnabled

protected boolean m_AntiAliasingEnabled

whether anti-aliasing is enabled.

Constructor Detail

LimitPaintlet

public LimitPaintlet()

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 AbstractStrokePaintlet

setColorLower

public void setColorLower(Color value)

Sets the color for the lower limit.

Parameters:

value - the color

getColorLower

public Color getColorLower()

Returns the color for the lower limit.

Returns:

the color

colorLowerTipText

public String colorLowerTipText()

Returns the tip text for this property.

Returns:

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

setColorCenter

public void setColorCenter(Color value)

Sets the color for the center.

Parameters:

value - the color

getColorCenter

public Color getColorCenter()

Returns the color for the center.

Returns:

the color

colorCenterTipText

public String colorCenterTipText()

Returns the tip text for this property.

Returns:

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

setColorUpper

public void setColorUpper(Color value)

Sets the color for the upper limit.

Parameters:

value - the color

getColorUpper

public Color getColorUpper()

Returns the color for the upper limit.

Returns:

the color

colorUpperTipText

public String colorUpperTipText()

Returns the tip text for this property.

Returns:

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

setAntiAliasingEnabled

public void setAntiAliasingEnabled(boolean value)

Sets whether to use anti-aliasing.

Specified by:

setAntiAliasingEnabled in interface AntiAliasingSupporter

Parameters:

value - if true then anti-aliasing is used

isAntiAliasingEnabled

public boolean isAntiAliasingEnabled()

Returns whether anti-aliasing is used.

Specified by:

isAntiAliasingEnabled in interface AntiAliasingSupporter

Returns:

true if anti-aliasing is used

antiAliasingEnabledTipText

public String antiAliasingEnabledTipText()

Returns the tip text for this property.

Returns:

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

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:

null

getPaintMoment

public PaintEvent.PaintMoment getPaintMoment()

Returns when this paintlet is to be executed.

Specified by:

getPaintMoment in interface Paintlet

Overrides:

getPaintMoment in class AbstractXYSequencePaintlet

Returns:

when this paintlet is to be executed

drawData

protected void drawData(Graphics g,
                        PaintEvent.PaintMoment moment,
                        XYSequence data)

Draws the limits.

Parameters:

g - the graphics context

moment - the paint moment

data - the data to draw

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