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

Class AbstractLabelPlotter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Anchored, MultiLabelPlotter, NoLabel

public abstract class AbstractLabelPlotter
extends AbstractOptionHandler
implements LabelPlotter

Ancestor for label plotters.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Enabled	whether the plotter is 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
AbstractLabelPlotter()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected abstract void	doPlotLabel(LocatedObject object, Color color, Graphics2D g)	Plots the label.
String	enabledTipText()	Returns the tip text for this property.
protected String	generateQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
boolean	getEnabled()	Returns whether the plotter is enabled.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
void	plotLabel(LocatedObject object, Color color, Graphics2D g)	Plots the label.
void	setEnabled(boolean value)	Sets whether the plotter is enabled.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, 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.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_Enabled

protected boolean m_Enabled

whether the plotter is enabled.

Constructor Detail

AbstractLabelPlotter

public AbstractLabelPlotter()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setEnabled

public void setEnabled(boolean value)

Sets whether the plotter is enabled.

Parameters:

value - true if enabled

getEnabled

public boolean getEnabled()

Returns whether the plotter is enabled.

Returns:

true if enabled

enabledTipText

public String enabledTipText()

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.
Default implementation returns null.

Returns:

null if no info available, otherwise short string

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

doPlotLabel

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

Plots the label.

Parameters:

object - the object to plot

color - the color to use

g - the graphics context

plotLabel

public void plotLabel(LocatedObject object,
                      Color color,
                      Graphics2D g)

Plots the label.

Specified by:

plotLabel in interface LabelPlotter

Parameters:

object - the object to plot

color - the color to use

g - the graphics context