Package adams.gui.visualization.core

Class MultiMouseMovementTracker

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractPaintlet

adams.gui.visualization.core.MultiMouseMovementTracker

All Implemented Interfaces:

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

public class MultiMouseMovementTracker
extends AbstractPaintlet
implements MouseMovementTracker

Applies multiple trackers sequentially.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

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

-tracker <adams.gui.visualization.core.MouseMovementTracker> [-tracker ...] (property: trackers)
    The mouse movement trackers to apply.
    default: 
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected MouseMovementTracker[]	m_Trackers	the trackers to use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
PaintEvent.PaintMoment	getPaintMoment()	Returns when this paintlet is to be executed.
MouseMovementTracker[]	getTrackers()	Returns the trackers to use.
String	globalInfo()	Returns a string describing the object.
void	mouseMovementTracked(MouseEvent e)	Gets triggered when the mouse moved.
void	performPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.
void	setTrackers(MouseMovementTracker[] value)	Sets the trackers to use.
MouseMovementTracker	shallowCopyTracker()	Returns a shallow copy of the tracker.
MouseMovementTracker	shallowCopyTracker(boolean expand)	Returns a shallow copy of the tracker.
String	trackersTipText()	Returns the tip text for this property.

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

getPanel, setPanel

Field Detail

m_Trackers

protected MouseMovementTracker[] m_Trackers

the trackers to use.

Constructor Detail

MultiMouseMovementTracker

public MultiMouseMovementTracker()

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 AbstractOptionHandler

setTrackers

public void setTrackers(MouseMovementTracker[] value)

Sets the trackers to use.

Parameters:

value - the trackers

getTrackers

public MouseMovementTracker[] getTrackers()

Returns the trackers to use.

Returns:

the trackers

trackersTipText

public String trackersTipText()

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

performPaint

public void performPaint(Graphics g,
                         PaintEvent.PaintMoment moment)

The paint routine of the paintlet.

Specified by:

performPaint in interface Paintlet

Specified by:

performPaint in class AbstractPaintlet

Parameters:

g - the graphics context to use for painting

moment - what PaintEvent.PaintMoment is currently being painted

mouseMovementTracked

public void mouseMovementTracked(MouseEvent e)

Gets triggered when the mouse moved.

Specified by:

mouseMovementTracked in interface MouseMovementTracker

Parameters:

e - the mouse event that triggered the event

shallowCopyTracker

public MouseMovementTracker shallowCopyTracker()

Returns a shallow copy of the tracker. Doesn't expand variables in case of OptionHandler objects.

Specified by:

shallowCopyTracker in interface MouseMovementTracker

Returns:

a shallow copy of the tracker

shallowCopyTracker

public MouseMovementTracker shallowCopyTracker(boolean expand)

Returns a shallow copy of the tracker.

Specified by:

shallowCopyTracker in interface MouseMovementTracker

Parameters:

expand - whether to expand variables to their actual value

Returns:

a shallow copy of the tracker