Package adams.gui.visualization.object.overlay

Class AbstractOverlay

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.overlay.AbstractOverlay

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractObjectOverlayFromReport, AbstractPointOverlayFromReport, ClassificationLabelTextOverlay, MultiOverlay, NullOverlay, ObjectAnnotations

public abstract class AbstractOverlay
extends AbstractOptionHandler
implements Overlay

Ancestor for overlays.

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 overlay 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
AbstractOverlay()

Method Summary

Modifier and Type	Method	Description
void	annotationsChanged()	Hook method for when annotations change.
void	cleanUp()	Cleans up data structures, frees up memory.
void	defineOptions()	Adds options to the internal list of options.
protected abstract void	doPaint(ObjectAnnotationPanel panel, Graphics g)	Paints the overlay.
String	enabledTipText()	Returns the tip text for this property.
boolean	getEnabled()	Returns whether the overlay is enabled.
void	paint(ObjectAnnotationPanel panel, Graphics g)	Paints the overlay.
void	setEnabled(boolean value)	Sets whether the overlay 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 overlay is enabled.

Constructor Detail

AbstractOverlay

public AbstractOverlay()

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 overlay is enabled.

Specified by:

setEnabled in interface Overlay

Parameters:

value - true if enabled

getEnabled

public boolean getEnabled()

Returns whether the overlay is enabled.

Specified by:

getEnabled in interface Overlay

Returns:

true if enabled

enabledTipText

public String enabledTipText()

Returns the tip text for this property.

Specified by:

enabledTipText in interface Overlay

Returns:

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

doPaint

protected abstract void doPaint(ObjectAnnotationPanel panel,
                                Graphics g)

Paints the overlay.

Parameters:

panel - the owning panel

g - the graphics context

paint

public void paint(ObjectAnnotationPanel panel,
                  Graphics g)

Paints the overlay.

Specified by:

paint in interface Overlay

Parameters:

panel - the owning panel

g - the graphics context

annotationsChanged

public void annotationsChanged()

Hook method for when annotations change.

Specified by:

annotationsChanged in interface Overlay

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler

Specified by:

cleanUp in interface Overlay