Package adams.gui.visualization.core

Class MultiPaintlet

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractPaintlet

adams.gui.visualization.core.MultiPaintlet

All Implemented Interfaces:

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

public class MultiPaintlet
extends AbstractPaintlet
implements FlowAwarePaintlet

Paintlet that combines multiple paintlets.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Actor	m_Actor	the actor that this paintlet belongs to.
protected Paintlet[]	m_SubPaintlets	the paintlets to use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
Actor	getActor()	Returns the owning actor.
protected Paintlet[]	getDefaultSubPaintlets()	Returns the default paintlets.
PaintEvent.PaintMoment	getPaintMoment()	Returns when this paintlet is to be executed.
Paintlet[]	getSubPaintlets()	Returns the paintlets to use.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
void	performPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.
void	setActor(Actor actor)	Sets the owning actor.
void	setPanel(PaintablePanel value)	Sets the panel to use, null to disable painting.
void	setSubPaintlets(Paintlet[] value)	Sets the paintlets to use.
String	subPaintletsTipText()	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, isEnabled, isInitializing, memberChanged, memberChanged, paint, repaint, setEnabled, 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

Methods inherited from interface adams.gui.visualization.core.Paintlet

canPaint, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, paint, setEnabled, setPanel, setRepaintOnChange

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Field Detail

m_SubPaintlets

protected Paintlet[] m_SubPaintlets

the paintlets to use.

m_Actor

protected Actor m_Actor

the actor that this paintlet belongs to.

Constructor Detail

MultiPaintlet

public MultiPaintlet()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractPaintlet

setActor

public void setActor(Actor actor)

Sets the owning actor.

Specified by:

setActor in interface FlowAwarePaintlet

Parameters:

actor - the actor this paintlet belongs to

getActor

public Actor getActor()

Returns the owning actor.

Specified by:

getActor in interface FlowAwarePaintlet

Returns:

the actor this paintlet belongs to, null if none set

getDefaultSubPaintlets

protected Paintlet[] getDefaultSubPaintlets()

Returns the default paintlets.

Returns:

the paintlets

setSubPaintlets

public void setSubPaintlets(Paintlet[] value)

Sets the paintlets to use.

Parameters:

value - the paintlets

getSubPaintlets

public Paintlet[] getSubPaintlets()

Returns the paintlets to use.

Returns:

the paintlets

subPaintletsTipText

public String subPaintletsTipText()

Returns the tip text for this property.

Returns:

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

setPanel

public void setPanel(PaintablePanel value)

Sets the panel to use, null to disable painting.

Specified by:

setPanel in interface Paintlet

Overrides:

setPanel in class AbstractPaintlet

Parameters:

value - the panel to paint on

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