Package adams.gui.visualization.object.annotator

Class AbstractPointAnnotator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.annotator.AbstractAnnotator

adams.gui.visualization.object.annotator.AbstractReportBasedAnnotator

adams.gui.visualization.object.annotator.AbstractPointAnnotator

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ObjectPrefixHandler, Serializable

Direct Known Subclasses:

SimplePointAnnotator

public abstract class AbstractPointAnnotator
extends AbstractReportBasedAnnotator

Ancestor for point annotators.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<SelectionPoint>	m_Locations	the current rectangles.
protected int	m_NumDigits	the number of digits to use for left-padding the index.

Fields inherited from class adams.gui.visualization.object.annotator.AbstractReportBasedAnnotator

m_Prefix

Fields inherited from class adams.gui.visualization.object.annotator.AbstractAnnotator

m_Owner, m_Selecting

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

Method Summary

Modifier and Type	Method	Description
void	annotationsChanged()	Hook method for when annotations change.
void	defineOptions()	Adds options to the internal list of options.
protected int	getDefaultNumDigits()	Returns the default number of digits to use.
protected String	getDefaultPrefix()	Returns the default prefix to use for the objects.
protected List<SelectionPoint>	getLocations(Report report)	Retruns all currently stored locations.
int	getNumDigits()	Returns the number of digits to use for the left-padded index.
String	numDigitsTipText()	Returns the tip text for this property.
protected void	reset()	Resets the scheme.
void	setNumDigits(int value)	Sets the number of digits to use for the left-padded index.

Methods inherited from class adams.gui.visualization.object.annotator.AbstractReportBasedAnnotator

findLastIndex, getPrefix, prefixTipText, removeIndex, setPrefix, valuesForIndex

Methods inherited from class adams.gui.visualization.object.annotator.AbstractAnnotator

applyStroke, cleanUp, doInstall, doPaintSelection, doUninstall, getCurrentLabel, getOwner, getStrokeWidth, hasCurrentLabel, initialize, install, labelChanged, paintSelection, setOwner, uninstall

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, 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

Field Detail

m_NumDigits

protected int m_NumDigits

the number of digits to use for left-padding the index.

m_Locations

protected List<SelectionPoint> m_Locations

the current rectangles.

Constructor Detail

AbstractPointAnnotator

public AbstractPointAnnotator()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractReportBasedAnnotator

getDefaultPrefix

protected String getDefaultPrefix()

Returns the default prefix to use for the objects.

Specified by:

getDefaultPrefix in class AbstractReportBasedAnnotator

Returns:

the default

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractOptionHandler

getDefaultNumDigits

protected int getDefaultNumDigits()

Returns the default number of digits to use.

Returns:

the default

setNumDigits

public void setNumDigits(int value)

Sets the number of digits to use for the left-padded index.

Parameters:

value - the number of digits

getNumDigits

public int getNumDigits()

Returns the number of digits to use for the left-padded index.

Returns:

the number of digits

numDigitsTipText

public String numDigitsTipText()

Returns the tip text for this property.

Returns:

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

annotationsChanged

public void annotationsChanged()

Hook method for when annotations change.

Overrides:

annotationsChanged in class AbstractAnnotator

getLocations

protected List<SelectionPoint> getLocations(Report report)

Retruns all currently stored locations.

Parameters:

report - the report to get the locations from

Returns:

the locations