Package adams.gui.visualization.image

Class WatermarkOverlay

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.image.AbstractImageOverlay

adams.gui.visualization.image.WatermarkOverlay

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractImageOverlay>, SizeOfHandler, ImageOverlay, Serializable

public class WatermarkOverlay
extends AbstractImageOverlay

Overlays a watermark.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Watermark	m_Watermark	the watermark to apply.

Fields inherited from class adams.gui.visualization.image.AbstractImageOverlay

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doImageChanged(ImagePanel.PaintPanel panel)	Notifies the overlay that the image has changed.
protected void	doPaintOverlay(ImagePanel.PaintPanel panel, Graphics g)	Performs the actual painting of the overlay.
Watermark	getWatermark()	Returns the watermark to apply.
String	globalInfo()	Returns a string describing the object.
void	setWatermark(Watermark value)	Sets the watermark to apply.
String	watermarkTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.image.AbstractImageOverlay

cleanUp, enabledTipText, imageChanged, isEnabled, overlayAdded, overlayRemoved, paintOverlay, setEnabled, shallowCopy, shallowCopy

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_Watermark

protected Watermark m_Watermark

the watermark to apply.

Constructor Detail

WatermarkOverlay

public WatermarkOverlay()

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 AbstractImageOverlay

setWatermark

public void setWatermark(Watermark value)

Sets the watermark to apply.

Parameters:

value - the watermark

getWatermark

public Watermark getWatermark()

Returns the watermark to apply.

Returns:

the watermark

watermarkTipText

public String watermarkTipText()

Returns the tip text for this property.

Returns:

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

doImageChanged

protected void doImageChanged(ImagePanel.PaintPanel panel)

Notifies the overlay that the image has changed.

Specified by:

doImageChanged in class AbstractImageOverlay

Parameters:

panel - the panel this overlay belongs to

doPaintOverlay

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

Performs the actual painting of the overlay.

Specified by:

doPaintOverlay in class AbstractImageOverlay

Parameters:

panel - the panel this overlay is for

g - the graphics context