Package adams.gui.visualization.core

Interface PaintletWithMarkers

All Known Implementing Classes:

IncrementalSumPaintlet, InstanceLinePaintlet, LinePaintlet, ReportColorInstancePaintlet, ReportColorTimeseriesPaintlet, SpreadSheetRowLinePaintlet, TimeseriesPaintlet

public interface PaintletWithMarkers

Interface for paintlets that support markers.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String	alwaysShowMarkersTipText()	Returns the tip text for this property.
boolean	getAlwaysShowMarkers()	Returns whether marker shapes are always drawn.
int	getMarkerExtent()	Returns the current marker extent (which is the width and height of the shape).
boolean	isMarkersDisabled()	Returns whether marker shapes are disabled.
String	markerExtentTipText()	Returns the tip text for this property.
String	markersDisabledTipText()	Returns the tip text for this property.
void	setAlwaysShowMarkers(boolean value)	Sets whether to always draw markers.
void	setMarkerExtent(int value)	Sets the extent (width and height of the shape around the plotted point).
void	setMarkersDisabled(boolean value)	Sets whether to draw markers or not.

Method Detail

isMarkersDisabled

boolean isMarkersDisabled()

Returns whether marker shapes are disabled.

Returns:

true if marker shapes are disabled

setMarkersDisabled

void setMarkersDisabled(boolean value)

Sets whether to draw markers or not.

Parameters:

value - if true then marker shapes won't be drawn

markersDisabledTipText

String markersDisabledTipText()

Returns the tip text for this property.

Returns:

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

getAlwaysShowMarkers

boolean getAlwaysShowMarkers()

Returns whether marker shapes are always drawn.

Returns:

true if marker shapes are always drawn, not just when zoomed in

setAlwaysShowMarkers

void setAlwaysShowMarkers(boolean value)

Sets whether to always draw markers.

Parameters:

value - if true then marker are always drawn, not just when zoomed in

alwaysShowMarkersTipText

String alwaysShowMarkersTipText()

Returns the tip text for this property.

Returns:

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

setMarkerExtent

void setMarkerExtent(int value)

Sets the extent (width and height of the shape around the plotted point). 0 turns the plotting off. Should be an odd number for centering the shape.

Parameters:

value - the new extent

getMarkerExtent

int getMarkerExtent()

Returns the current marker extent (which is the width and height of the shape).

Returns:

the current extent

markerExtentTipText

String markerExtentTipText()

Returns the tip text for this property.

Returns:

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