Package adams.gui.visualization.core

Class AbstractStrokePaintletWithContainerIDMatching

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractPaintlet

adams.gui.visualization.core.AbstractStrokePaintlet

adams.gui.visualization.core.AbstractStrokePaintletWithContainerIDMatching

All Implemented Interfaces:

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

Direct Known Subclasses:

LinearRegressionOverlayPaintlet, LOWESSOverlayPaintlet

public abstract class AbstractStrokePaintletWithContainerIDMatching
extends AbstractStrokePaintlet
implements PaintletWithContainerIDMatching

Ancestor for paintlets that restrict painting to containers which ID matches a regular expression.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseRegExp	m_ContainerIDRegExp	the regular expression the container IDs must match.

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

m_StrokeThickness

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

Method Summary

Modifier and Type	Method	Description
String	containerIDRegExpTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
BaseRegExp	getContainerIDRegExp()	Returns the regular expression the container IDs must match.
protected boolean	isContainerIDMatch(String id)	Returns whether the given container ID is a match.
void	setContainerIDRegExp(BaseRegExp value)	Sets the regular expression the container IDs must match.

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

applyStroke, doPerformPaint, getStrokeThickness, getStrokeWidth, performPaint, setStrokeThickness, strokeThicknessTipText

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

canPaint, finishInit, forCommandLine, forName, getPaintlets, getPaintMoment, 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, globalInfo, 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, getPaintMoment, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, paint, performPaint, setEnabled, setPanel, setPanel, setRepaintOnChange

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Field Detail

m_ContainerIDRegExp

protected BaseRegExp m_ContainerIDRegExp

the regular expression the container IDs must match.

Constructor Detail

AbstractStrokePaintletWithContainerIDMatching

public AbstractStrokePaintletWithContainerIDMatching()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractStrokePaintlet

setContainerIDRegExp

public void setContainerIDRegExp(BaseRegExp value)

Sets the regular expression the container IDs must match.

Specified by:

setContainerIDRegExp in interface PaintletWithContainerIDMatching

Parameters:

value - the expression

getContainerIDRegExp

public BaseRegExp getContainerIDRegExp()

Returns the regular expression the container IDs must match.

Specified by:

getContainerIDRegExp in interface PaintletWithContainerIDMatching

Returns:

the expression

containerIDRegExpTipText

public String containerIDRegExpTipText()

Returns the tip text for this property.

Returns:

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

isContainerIDMatch

protected boolean isContainerIDMatch(String id)

Returns whether the given container ID is a match.

Parameters:

id - the ID to check

Returns:

true if a match, ie can be painted