Package adams.gui.visualization.sequence

Class StraightLineOverlayPaintlet

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.StraightLineOverlayPaintlet

All Implemented Interfaces:

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

public class StraightLineOverlayPaintlet
extends AbstractStrokePaintlet
implements XYSequencePaintlet, AntiAliasingSupporter

Draws a straight line. The inclination can be influenced using the x-factor.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-stroke-thickness <float> (property: strokeThickness)
    The thickness of the stroke.
    default: 1.0
    minimum: 0.01
 

-x-factor <double> (property: XFactor)
    The factor to multiply the X values with to determine the inclination of 
    the line.
    default: 1.0
 

-color <java.awt.Color> (property: color)
    The color for the line.
    default: #000000
 

Version:

$Revision$

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_Color	the color for the overlay.
protected double	m_XFactor	the factor to mulitply the x values with.
protected double	m_YOffset	the offset to shift the line up or down.

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

Method Summary

Modifier and Type	Method	Description
String	antiAliasingEnabledTipText()	Returns the tip text for this property.
String	colorTipText()	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.
Color	getColor()	Get the stroke color for the paintlet.
PaintEvent.PaintMoment	getPaintMoment()	Returns when this paintlet is to be executed.
XYSequencePanel	getSequencePanel()	Returns the XY sequence panel currently in use.
double	getXFactor()	Returns the factor to multiply the X values with to determine the inclination.
double	getYOffset()	Returns the offset on the Y axis.
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	setColor(Color value)	Set the stroke color for the paintlet.
void	setXFactor(double value)	Sets the factor to multiply the X values with to determine the inclination.
void	setYOffset(double value)	Sets the offset on the Y axis.
String	XFactorTipText()	Returns the tip text for this property.
String	YOffsetTipText()	Returns the tip text for this property.

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, initialize, isEnabled, isInitializing, memberChanged, memberChanged, paint, repaint, setEnabled, setPanel, setPanel, setRepaintOnChange, shallowCopy, shallowCopy, updatePanel

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, 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, setPanel, setRepaintOnChange

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Field Detail

m_XFactor

protected double m_XFactor

the factor to mulitply the x values with.

m_YOffset

protected double m_YOffset

the offset to shift the line up or down.

m_Color

protected Color m_Color

the color for the overlay.

m_AntiAliasingEnabled

protected boolean m_AntiAliasingEnabled

whether anti-aliasing is enabled.

Constructor Detail

StraightLineOverlayPaintlet

public StraightLineOverlayPaintlet()

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

setXFactor

public void setXFactor(double value)

Sets the factor to multiply the X values with to determine the inclination.

Parameters:

value - the factor

getXFactor

public double getXFactor()

Returns the factor to multiply the X values with to determine the inclination.

Returns:

the factor

XFactorTipText

public String XFactorTipText()

Returns the tip text for this property.

Returns:

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

setYOffset

public void setYOffset(double value)

Sets the offset on the Y axis.

Parameters:

value - the offset

getYOffset

public double getYOffset()

Returns the offset on the Y axis.

Returns:

the offset

YOffsetTipText

public String YOffsetTipText()

Returns the tip text for this property.

Returns:

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

setColor

public void setColor(Color value)

Set the stroke color for the paintlet.

Parameters:

value - color of the stroke

getColor

public Color getColor()

Get the stroke color for the paintlet.

Returns:

color of the stroke

colorTipText

public String colorTipText()

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.

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

getSequencePanel

public XYSequencePanel getSequencePanel()

Returns the XY sequence panel currently in use.

Specified by:

getSequencePanel in interface XYSequencePaintlet

Returns:

the panel in use

newHitDetector

public AbstractXYSequencePointHitDetector newHitDetector()

Returns a new instance of the hit detector to use.

Specified by:

newHitDetector in interface XYSequencePaintlet

Returns:

always null

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