Package adams.gui.visualization.object.overlay

Class MultiOverlay

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.overlay.AbstractOverlay

adams.gui.visualization.object.overlay.MultiOverlay

All Implemented Interfaces:

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

public class MultiOverlay
extends AbstractOverlay

Combines multiple overlays.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Overlay[]	m_Overlays	the overlays to combine.

Fields inherited from class adams.gui.visualization.object.overlay.AbstractOverlay

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

Method Summary

Modifier and Type	Method	Description
MultiOverlay	addOverlay(Overlay value)	Adds the overlays.
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 void	doPaint(ObjectAnnotationPanel panel, Graphics g)	Paints the overlay.
Overlay[]	getOverlays()	Returns the overlays to manage.
String	globalInfo()	Returns a string describing the object.
String	overlaysTipText()
void	setOverlays(Overlay[] value)	Sets the overlays to manage.

Methods inherited from class adams.gui.visualization.object.overlay.AbstractOverlay

enabledTipText, getEnabled, paint, setEnabled

Methods inherited from class adams.core.option.AbstractOptionHandler

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

protected Overlay[] m_Overlays

the overlays to combine.

Constructor Detail

MultiOverlay

public MultiOverlay()

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 AbstractOverlay

addOverlay

public MultiOverlay addOverlay(Overlay value)

Adds the overlays.

Parameters:

value - the overlay

Returns:

itself

setOverlays

public void setOverlays(Overlay[] value)

Sets the overlays to manage.

Parameters:

value - the overlays

getOverlays

public Overlay[] getOverlays()

Returns the overlays to manage.

Returns:

the overlays

overlaysTipText

public String overlaysTipText()

annotationsChanged

public void annotationsChanged()

Hook method for when annotations change.

Specified by:

annotationsChanged in interface Overlay

Overrides:

annotationsChanged in class AbstractOverlay

doPaint

protected void doPaint(ObjectAnnotationPanel panel,
                       Graphics g)

Paints the overlay.

Specified by:

doPaint in class AbstractOverlay

Parameters:

panel - the owning panel

g - the graphics context

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler

Specified by:

cleanUp in interface Overlay

Overrides:

cleanUp in class AbstractOverlay