Package adams.gui.visualization.object.annotator

Class ClassificationLabelAnnotator

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

All Implemented Interfaces:

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

public class ClassificationLabelAnnotator
extends AbstractAnnotator

Simply sets the chosen label in the report.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Field	m_Field	the field to store the classification label in.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doInstall()	Installs the annotator with the owner.
protected void	doPaintSelection(Graphics g)	Paints the selection.
protected void	doUninstall()	Uninstalls the annotator with the owner.
String	fieldTipText()	Returns the tip text for this property.
Field	getField()	Returns the field to use.
String	globalInfo()	Returns a string describing the object.
void	labelChanged()	Gets called when the label changes.
void	setField(Field value)	Sets the field to use.

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

annotationsChanged, applyStroke, cleanUp, getCurrentLabel, getOwner, getStrokeWidth, hasCurrentLabel, initialize, install, paintSelection, setOwner, uninstall

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, 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

Field Detail

m_Field

protected Field m_Field

the field to store the classification label in.

Constructor Detail

ClassificationLabelAnnotator

public ClassificationLabelAnnotator()

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

setField

public void setField(Field value)

Sets the field to use.

Parameters:

value - the field

getField

public Field getField()

Returns the field to use.

Returns:

the field

fieldTipText

public String fieldTipText()

Returns the tip text for this property.

Returns:

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

doInstall

protected void doInstall()

Installs the annotator with the owner.

Specified by:

doInstall in class AbstractAnnotator

doUninstall

protected void doUninstall()

Uninstalls the annotator with the owner.

Specified by:

doUninstall in class AbstractAnnotator

doPaintSelection

protected void doPaintSelection(Graphics g)

Paints the selection.

Specified by:

doPaintSelection in class AbstractAnnotator

Parameters:

g - the graphics context

labelChanged

public void labelChanged()

Gets called when the label changes.

Overrides:

labelChanged in class AbstractAnnotator