Package adams.gui.visualization.object.objectannotations.label

Class ConditionalLabelPlotter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.objectannotations.label.AbstractLabelPlotter

adams.gui.visualization.object.objectannotations.label.ConditionalLabelPlotter

All Implemented Interfaces:

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

public class ConditionalLabelPlotter
extends AbstractLabelPlotter

Plots the label only if the object is located by the specified object finder.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected LabelPlotter	m_LabelPlotter	the label plotter to use.
protected ObjectFinder	m_ObjectFinder	the object finder to apply.

Fields inherited from class adams.gui.visualization.object.objectannotations.label.AbstractLabelPlotter

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

Method Summary

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

Methods inherited from class adams.gui.visualization.object.objectannotations.label.AbstractLabelPlotter

enabledTipText, getEnabled, getQuickInfo, plotLabel, 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_LabelPlotter

protected LabelPlotter m_LabelPlotter

the label plotter to use.

Constructor Detail

ConditionalLabelPlotter

public ConditionalLabelPlotter()

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 AbstractLabelPlotter

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.

setLabelPlotter

public void setLabelPlotter(LabelPlotter value)

Sets the label plotter to use.

Parameters:

value - the plotter

getLabelPlotter

public LabelPlotter getLabelPlotter()

Returns the label plotter in use.

Returns:

the plotter

labelPlotterTipText

public String labelPlotterTipText()

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 AbstractLabelPlotter

Returns:

null if no info available, otherwise short string

doPlotLabel

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

Plots the label.

Specified by:

doPlotLabel in class AbstractLabelPlotter

Parameters:

object - the object to plot

color - the color to use

g - the graphics context