Package adams.gui.visualization.container

Class AbstractDataContainerZoomOverviewPaintlet<P extends DataContainerPanel>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractPaintlet

adams.gui.visualization.container.AbstractDataContainerZoomOverviewPaintlet<P>

Type Parameters:

P - the type of DataContainerPanel to use

All Implemented Interfaces:

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

Direct Known Subclasses:

InstanceZoomOverviewPaintlet, SpreadSheetRowZoomOverviewPaintlet, TimeseriesZoomOverviewPaintlet

public abstract class AbstractDataContainerZoomOverviewPaintlet<P extends DataContainerPanel>
extends AbstractPaintlet

Highlights the current zoom in the data container panel.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	m_HighlightColor	the background color.

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

Method Summary

Modifier and Type	Method	Description
String	backgroundColorTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected abstract P	getContainerPanel()	Returns the panel to obtain plot and containers from.
Color	getHighlightColor()	Returns the color for the zoom highlight.
PaintEvent.PaintMoment	getPaintMoment()	Returns when this paintlet is to be executed.
String	globalInfo()	Returns a string describing the object.
void	performPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.
void	setHighlightColor(Color value)	Sets the color for the zoom highlight.

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_HighlightColor

protected Color m_HighlightColor

the background color.

Constructor Detail

AbstractDataContainerZoomOverviewPaintlet

public AbstractDataContainerZoomOverviewPaintlet()

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

setHighlightColor

public void setHighlightColor(Color value)

Sets the color for the zoom highlight.

Parameters:

value - the color

getHighlightColor

public Color getHighlightColor()

Returns the color for the zoom highlight.

Returns:

the color

backgroundColorTipText

public String backgroundColorTipText()

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

getContainerPanel

protected abstract P getContainerPanel()

Returns the panel to obtain plot and containers from.

Returns:

the panel

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