Package adams.gui.visualization.core

Class BackgroundImagePaintlet

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractPaintlet

adams.gui.visualization.core.BackgroundImagePaintlet

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, Paintlet, Serializable

public class BackgroundImagePaintlet
extends AbstractPaintlet

Paintlet for painting a background image.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Image	m_Image	the image.
protected PlaceholderFile	m_ImageFile	the image file to paint.
protected boolean	m_UseFixedSize	whether to use fixed size or resize.

Fields inherited from class adams.gui.visualization.core.AbstractPaintlet

m_Enabled, m_Initializing, m_Panel, m_RepaintOnChange

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
PlaceholderFile	getImageFile()	Returns the image file to load.
PaintEvent.PaintMoment	getPaintMoment()	Returns when this paintlet is to be executed.
boolean	getUseFixedSize()	Returns the image file to load.
String	globalInfo()	Returns a string describing the object.
String	imageFileTipText()	Returns the tip text for this property.
void	performPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.
void	setImageFile(PlaceholderFile value)	Sets the image file to load.
void	setUseFixedSize(boolean value)	Sets the whether to use a fixed size image or resize according to canvas.
String	useFixedSizeTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.core.AbstractPaintlet

canPaint, finishInit, forCommandLine, forName, getPaintlets, getPanel, getPlot, getRepaintOnChange, hasPanel, initialize, isEnabled, isInitializing, memberChanged, memberChanged, paint, repaint, setEnabled, setPanel, setPanel, setRepaintOnChange, shallowCopy, shallowCopy, updatePanel

Methods inherited from class adams.core.option.AbstractOptionHandler

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

protected PlaceholderFile m_ImageFile

the image file to paint.

m_Image

protected transient Image m_Image

the image.

m_UseFixedSize

protected boolean m_UseFixedSize

whether to use fixed size or resize.

Constructor Detail

BackgroundImagePaintlet

public BackgroundImagePaintlet()

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

setImageFile

public void setImageFile(PlaceholderFile value)

Sets the image file to load.

Parameters:

value - the file

getImageFile

public PlaceholderFile getImageFile()

Returns the image file to load.

Returns:

the file

imageFileTipText

public String imageFileTipText()

Returns the tip text for this property.

Returns:

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

setUseFixedSize

public void setUseFixedSize(boolean value)

Sets the whether to use a fixed size image or resize according to canvas.

Parameters:

value - true if to use fixed size

getUseFixedSize

public boolean getUseFixedSize()

Returns the image file to load.

Returns:

the file

useFixedSizeTipText

public String useFixedSizeTipText()

Returns the tip text for this property.

Returns:

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

getPaintMoment

public PaintEvent.PaintMoment getPaintMoment()

Returns when this paintlet is to be executed.

Specified by:

getPaintMoment in interface Paintlet

Specified by:

getPaintMoment in class AbstractPaintlet

Returns:

when this paintlet is to be executed

performPaint

public void performPaint(Graphics g,
                         PaintEvent.PaintMoment moment)

The paint routine of the paintlet.

Specified by:

performPaint in interface Paintlet

Specified by:

performPaint in class AbstractPaintlet

Parameters:

g - the graphics context to use for painting

moment - what PaintEvent.PaintMoment is currently being painted