adams.flow.transformer.pixelselector
Class AbstractPixelSelectorOverlay

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.transformer.pixelselector.AbstractPixelSelectorOverlay

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<AbstractPixelSelectorOverlay>, SizeOfHandler, ImageOverlay, Serializable

Direct Known Subclasses:

AbstractColorProviderPixelSelectorOverlay, AbstractSingleColorPixelSelectorOverlay

public abstract class AbstractPixelSelectorOverlay
extends AbstractOptionHandler
implements ImageOverlay, ShallowCopySupporter<AbstractPixelSelectorOverlay>

Ancestor for overlays in the pixel selector GUI, making use of the data stored in the report.

Version:

$Revision: 4831 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected AbstractImage

m_Image the underlying image.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

AbstractPixelSelectorOverlay()

Method Summary

protected abstract void	doPaintOverlay(ImagePanel.PaintPanel panel, Graphics g) Paints the actual overlay over the image.
protected abstract String	getGlobalInfo() Returns a string describing the object.
AbstractImage	getImage() Returns the underlying image.
abstract Class[]	getSuggestedActions() Returns some actions that generate data for this overlay.
String	globalInfo() Returns a string describing the object.
void	paintOverlay(ImagePanel.PaintPanel panel, Graphics g) Paints the overlay over the image.
void	setImage(AbstractImage value) Sets the underlying image.
AbstractPixelSelectorOverlay	shallowCopy() Returns a shallow copy of itself.
AbstractPixelSelectorOverlay	shallowCopy(boolean expand) Returns a shallow copy of itself.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, defineOptions, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Image

protected AbstractImage m_Image

the underlying image.

Constructor Detail

AbstractPixelSelectorOverlay

public AbstractPixelSelectorOverlay()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getGlobalInfo

protected abstract String getGlobalInfo()

Returns a string describing the object.

Returns:

a description suitable for displaying in the gui

getSuggestedActions

public abstract Class[] getSuggestedActions()

Returns some actions that generate data for this overlay.

Returns:

the actions

setImage

public void setImage(AbstractImage value)

Sets the underlying image.

Parameters:

value - the image

getImage

public AbstractImage getImage()

Returns the underlying image.

Returns:

the image

doPaintOverlay

protected abstract void doPaintOverlay(ImagePanel.PaintPanel panel,
                                       Graphics g)

Paints the actual overlay over the image.

Parameters:

panel - the panel this overlay is for

g - the graphics context

paintOverlay

public void paintOverlay(ImagePanel.PaintPanel panel,
                         Graphics g)

Paints the overlay over the image.

Specified by:

paintOverlay in interface ImageOverlay

Parameters:

panel - the panel this overlay is for

g - the graphics context

shallowCopy

public AbstractPixelSelectorOverlay shallowCopy()

Returns a shallow copy of itself.

Specified by:

shallowCopy in interface ShallowCopySupporter<AbstractPixelSelectorOverlay>

Returns:

the shallow copy

shallowCopy

public AbstractPixelSelectorOverlay shallowCopy(boolean expand)

Returns a shallow copy of itself.

Specified by:

shallowCopy in interface ShallowCopySupporter<AbstractPixelSelectorOverlay>

Parameters:

expand - whether to expand variables to their current values

Returns:

the shallow copy