Package adams.flow.transformer.draw

Class Watermark

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.draw.AbstractDrawOperation

adams.flow.transformer.draw.Watermark

All Implemented Interfaces:

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

public class Watermark
extends AbstractDrawOperation

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.flow.transformer.draw.AbstractDrawOperation

m_Owner

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doDraw(BufferedImageContainer image)	Performs the actual draw operation.
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.flow.transformer.draw.AbstractDrawOperation

check, draw, getOwner, getQuickInfo, setOwner

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_Watermark

protected Watermark m_Watermark

the watermark to apply.

Constructor Detail

Watermark

public Watermark()

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 AbstractOptionHandler

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.

doDraw

protected String doDraw(BufferedImageContainer image)

Performs the actual draw operation.

Specified by:

doDraw in class AbstractDrawOperation

Parameters:

image - the image to draw on

Returns:

null if OK, otherwise error message