Package adams.gui.visualization.watermark

Class MultiWatermark

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.watermark.AbstractWatermark

adams.gui.visualization.watermark.MultiWatermark

All Implemented Interfaces:

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

public class MultiWatermark
extends AbstractWatermark

Applies the specified watermarks sequentially.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Watermark[]	m_Watermarks	the watermarks to apply.

Fields inherited from class adams.gui.visualization.watermark.AbstractWatermark

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canApplyWatermark(Graphics g, Dimension dimension)	Returns whether the watermark can be applied.
void	defineOptions()	Adds options to the internal list of options.
protected void	doApplyWatermark(Graphics g, Dimension dimension)	Applies the watermark in the specified graphics context.
Watermark[]	getWatermarks()	Returns the watermarks to apply.
String	globalInfo()	Returns a string describing the object.
void	setWatermarks(Watermark[] value)	Sets the watermarks to apply.
String	watermarksTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.watermark.AbstractWatermark

applyWatermark, enabledTipText, getEnabled, 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.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Watermarks

protected Watermark[] m_Watermarks

the watermarks to apply.

Constructor Detail

MultiWatermark

public MultiWatermark()

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 AbstractWatermark

setWatermarks

public void setWatermarks(Watermark[] value)

Sets the watermarks to apply.

Parameters:

value - the watermarks

getWatermarks

public Watermark[] getWatermarks()

Returns the watermarks to apply.

Returns:

the watermarks

watermarksTipText

public String watermarksTipText()

Returns the tip text for this property.

Returns:

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

canApplyWatermark

protected boolean canApplyWatermark(Graphics g,
                                    Dimension dimension)

Returns whether the watermark can be applied.

Overrides:

canApplyWatermark in class AbstractWatermark

Parameters:

g - the graphics context

dimension - the dimension of the drawing area

Returns:

true if it can be applied

doApplyWatermark

protected void doApplyWatermark(Graphics g,
                                Dimension dimension)

Applies the watermark in the specified graphics context.

Specified by:

doApplyWatermark in class AbstractWatermark

Parameters:

g - the graphics context

dimension - the dimension of the drawing area