Package adams.gui.visualization.core

Interface Paintlet

All Superinterfaces:

ShallowCopySupporter<Paintlet>

All Known Subinterfaces:

DataPoolPaintlet, DiameterBasedPaintlet, FlowAwarePaintlet, MarkerPaintlet, MetaDataColorPaintlet, MetaXYSequencePaintlet, PaintletWithContainerIDMatching, PaintletWithCustomDataSupport, PaintletWithFixedXRange, PaintletWithFixedYRange, SizeBasedPaintlet, XYSequencePaintlet, XYSequencePaintletWithCustomerContainerManager

All Known Implementing Classes:

AbstractColorPaintlet, AbstractControlChartPaintlet, AbstractDataContainerPaintlet, AbstractDataContainerZoomOverviewPaintlet, AbstractDataPoolPaintlet, AbstractErrorPaintlet, AbstractInstancePaintlet, AbstractMarkerPaintlet, AbstractOverlayPaintlet, AbstractPaintlet, AbstractProbabilityPaintlet, AbstractScatterPlotPaintlet, AbstractSpreadSheetRowPaintlet, AbstractStrokePaintlet, AbstractStrokePaintletWithContainerIDMatching, AbstractTimeseriesPaintlet, AbstractXYSequenceMetaDataColorPaintlet, AbstractXYSequencePaintlet, AbstractZOverlayPaintlet, AbstractZScorePaintlet, BackgroundImagePaintlet, BarPaintlet, ByNameErrorPaintlet, ByNameMarkerPaintlet, ByNamePaintlet, ChartPaintlet, CirclePaintlet, CoordinatesPaintlet, CoordinatesPaintlet, CrossHairTracker, CrossPaintlet, DiagonalOverlayPaintlet, DiagonalPaintlet, DotPaintlet, ErrorBandPaintlet, ErrorCirclePaintlet, ErrorCrossPaintlet, Exponential, FixedTimestampPaintlet, FixedTimestampRangePaintlet, Gamma, HistogramPaintlet, HorizontalIndicator, HorizontalIndicatorPaintlet, IncrementalSumPaintlet, InstanceLinePaintlet, InstanceZoomOverviewPaintlet, KendallTheilOverlayPaintlet, LimitPaintlet, LinearRegressionOverlayPaintlet, LinePaintlet, Logistic, Loglogistic, Lognormal, LOWESSOverlayPaintlet, LowessPaintlet, MathExpressionOverlayPaintlet, MeanOverlayPaintlet, MeanPaintlet, MedianOverlayPaintlet, MetaDataValuePaintlet, MultiMouseMovementTracker, MultiPaintlet, MultiPaintlet, NoErrorPaintlet, NoMarkers, Normal, NullPaintlet, OutlierPaintlet, PaintletWithFixedXRange, PaintletWithFixedXRange, PaintletWithFixedXYRange, PaintletWithFixedXYRange, PaintletWithFixedYRange, PaintletWithFixedYRange, PercentileOverlayPaintlet, PeriodicityPaintlet, ReportColorInstancePaintlet, ReportColorTimeseriesPaintlet, ReportDateFieldPaintlet, ReportDateFieldRangePaintlet, ScatterPaintletCircle, ScatterPaintletCross, ScatterPaintletErrors, ScatterPaintletMetaDataValue, SelectedTimestampPaintlet, SimpleErrorPaintlet, SimpleInstanceLinePaintlet, SimpleSpreadSheetRowLinePaintlet, SpreadSheetRowLinePaintlet, SpreadSheetRowZoomOverviewPaintlet, SquarePaintlet, StdDevOverlayPaintlet, StdDevPaintlet, StickPaintlet, StraightLineOverlayPaintlet, TextOverlayPaintlet, TextOverlayPaintlet, TimeseriesPaintlet, TimeseriesZoomOverviewPaintlet, TrianglePaintlet, VerticalMarkers, VsFitPaintlet, VsOrderPaintlet, XYPaintlet, ZScoreCircle, ZScoreCross

public interface Paintlet
extends ShallowCopySupporter<Paintlet>

An interface for paintlets.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
boolean	canPaint(PaintEvent.PaintMoment moment)	Checks whether the paintlet is supposed to paint for this PaintEvent.PaintMoment.
PaintEvent.PaintMoment	getPaintMoment()	Returns when this paintlet is to be executed.
PaintablePanel	getPanel()	Returns the spectrum panel currently in use.
PlotPanel	getPlot()	Returns the plot panel of the panel, null if no panel present.
boolean	getRepaintOnChange()	Returns whether the paintlet reacts with repaints to changes of its members.
boolean	hasPanel()	Returns whether a panel has been set.
boolean	isEnabled()	Returns whether the paintlet is currently enabled.
void	paint(Graphics g)	The paint routine of the paintlet.
void	performPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.
void	setEnabled(boolean value)	Sets whether the paintlet is enabled or not.
void	setPanel(PaintablePanel value)	Sets the spectrum panel to use, null to disable painting.
void	setPanel(PaintablePanel value, boolean register)	Sets the spectrum panel to use, null to disable painting.
void	setRepaintOnChange(boolean value)	Sets whether the paintlet reacts with repaints to changes of its members.

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Method Detail

setPanel

void setPanel(PaintablePanel value)

Sets the spectrum panel to use, null to disable painting.

Parameters:

value - the panel to paint on

setPanel

void setPanel(PaintablePanel value,
              boolean register)

Sets the spectrum panel to use, null to disable painting.

Parameters:

value - the panel to paint on

register - whether to register the panel

getPanel

PaintablePanel getPanel()

Returns the spectrum panel currently in use.

Returns:

the panel in use

hasPanel

boolean hasPanel()

Returns whether a panel has been set.

Returns:

true if a panel is currently set

getPlot

PlotPanel getPlot()

Returns the plot panel of the panel, null if no panel present.

Returns:

the plot panel

setEnabled

void setEnabled(boolean value)

Sets whether the paintlet is enabled or not. Setting it to true automatically initiates a repaint. Is not affected by m_RepaintOnChange.

Parameters:

value - if true then the paintlet is enabled

See Also:

#m_RepaintOnChange

isEnabled

boolean isEnabled()

Returns whether the paintlet is currently enabled.

Returns:

true if the paintlet is enabled.

setRepaintOnChange

void setRepaintOnChange(boolean value)

Sets whether the paintlet reacts with repaints to changes of its members.

Parameters:

value - if true then the paintlet repaints whenever members get changed

getRepaintOnChange

boolean getRepaintOnChange()

Returns whether the paintlet reacts with repaints to changes of its members.

Returns:

true if paintlet repaints whenever members get changed

getPaintMoment

PaintEvent.PaintMoment getPaintMoment()

Returns when this paintlet is to be executed.

Returns:

when this paintlet is to be executed

canPaint

boolean canPaint(PaintEvent.PaintMoment moment)

Checks whether the paintlet is supposed to paint for this PaintEvent.PaintMoment.

Returns:

true if painting should occur

performPaint

void performPaint(Graphics g,
                  PaintEvent.PaintMoment moment)

The paint routine of the paintlet.

Parameters:

g - the graphics context to use for painting

moment - what PaintEvent.PaintMoment is currently being painted

paint

void paint(Graphics g)

The paint routine of the paintlet.

Parameters:

g - the graphics context to use for painting

See Also:

isEnabled()