Package adams.gui.visualization.object.objectannotations.shape

Class ConditionalShapePlotter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.objectannotations.shape.AbstractShapePlotter

adams.gui.visualization.object.objectannotations.shape.ConditionalShapePlotter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ShapePlotter, Serializable

public class ConditionalShapePlotter
extends AbstractShapePlotter

Applies the base shape plotter only if the object is located by the object finder.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ObjectFinder	m_ObjectFinder	the object finder to apply.
protected ShapePlotter	m_ShapePlotter	the shape plotter to use.

Fields inherited from class adams.gui.visualization.object.objectannotations.shape.AbstractShapePlotter

m_Enabled

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doPlotShape(LocatedObject object, Color color, Graphics2D g)	Plots the outline.
protected String	generateQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
ObjectFinder	getObjectFinder()	Returns the object finder in use.
ShapePlotter	getShapePlotter()	Returns the shape plotter in use.
String	globalInfo()	Returns a string describing the object.
String	objectFinderTipText()	Returns the tip text for this property.
void	setObjectFinder(ObjectFinder value)	Sets the object finder to use.
void	setShapePlotter(ShapePlotter value)	Sets the shape plotter to use.
String	shapePlotterTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.object.objectannotations.shape.AbstractShapePlotter

enabledTipText, getEnabled, getQuickInfo, plotShape, setEnabled

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

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

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_ObjectFinder

protected ObjectFinder m_ObjectFinder

the object finder to apply.

m_ShapePlotter

protected ShapePlotter m_ShapePlotter

the shape plotter to use.

Constructor Detail

ConditionalShapePlotter

public ConditionalShapePlotter()

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 AbstractShapePlotter

setObjectFinder

public void setObjectFinder(ObjectFinder value)

Sets the object finder to use.

Parameters:

value - the finder

getObjectFinder

public ObjectFinder getObjectFinder()

Returns the object finder in use.

Returns:

the finder

objectFinderTipText

public String objectFinderTipText()

Returns the tip text for this property.

Returns:

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

setShapePlotter

public void setShapePlotter(ShapePlotter value)

Sets the shape plotter to use.

Parameters:

value - the plotter

getShapePlotter

public ShapePlotter getShapePlotter()

Returns the shape plotter in use.

Returns:

the plotter

shapePlotterTipText

public String shapePlotterTipText()

Returns the tip text for this property.

Returns:

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

generateQuickInfo

protected String generateQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Overrides:

generateQuickInfo in class AbstractShapePlotter

Returns:

null if no info available, otherwise short string

doPlotShape

protected void doPlotShape(LocatedObject object,
                           Color color,
                           Graphics2D g)

Plots the outline.

Specified by:

doPlotShape in class AbstractShapePlotter

Parameters:

object - the object to plot

color - the color to use

g - the graphics context