de.gsi.chart.plugins

Class DataPointTooltip

java.lang.Object

de.gsi.chart.plugins.ChartPlugin

de.gsi.chart.plugins.AbstractDataFormattingPlugin

de.gsi.chart.plugins.DataPointTooltip

public class DataPointTooltip
extends AbstractDataFormattingPlugin

A tool tip label appearing next to the mouse cursor when placed over a data point's symbol. If symbols are not created/shown for given plot, the tool tip is shown for the closest data point that is within the pickingDistanceProperty() from the mouse cursor.

CSS style class name: "chart-datapoint-tooltip-label"

Author:

Grzegorz Kruk TODO: extend so that label = new Label(); is a generic object and can also be overwritten with another implementation (<-> advanced interactor) additional add/remove listener are needed to edit/update the custom object based on DataPoint (for the time being private class)

Property Summary

Type	Property and Description
DoubleProperty	pickingDistance Distance of the mouse cursor from the data point (expressed in display units) that should trigger showing the tool tip.

Properties inherited from class de.gsi.chart.plugins.AbstractDataFormattingPlugin

xValueFormatterProperty, yValueFormatterProperty

Properties inherited from class de.gsi.chart.plugins.ChartPlugin

addButtonsToToolBarProperty, chartProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DataPointTooltip.DataPoint

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PICKING_DISTANCE The default distance between the data point coordinates and mouse cursor that triggers showing the tool tip label.
static String	STYLE_CLASS_LABEL Name of the CSS class of the tool tip label.

Constructor Summary

Constructors

Constructor and Description
DataPointTooltip() Creates a new instance of DataPointTooltip class with {picking distance initialized to 5.
DataPointTooltip(double pickingDistance) Creates a new instance of DataPointTooltip class.

Method Summary

Modifier and Type	Method and Description
protected String	formatLabel(DataPointTooltip.DataPoint dataPoint)
protected String	getDataLabelSafe(DataSet dataSet, int index)
protected String	getDefaultDataLabel(DataSet dataSet, int index) Returns label of a data point specified by the index.
double	getPickingDistance() Returns the value of the pickingDistanceProperty().
DoubleProperty	pickingDistanceProperty() Distance of the mouse cursor from the data point (expressed in display units) that should trigger showing the tool tip.
void	setPickingDistance(double distance) Sets the value of pickingDistanceProperty().

Methods inherited from class de.gsi.chart.plugins.AbstractDataFormattingPlugin

formatData, getXValueFormatter, getYValueFormatter, setXValueFormatter, setYValueFormatter, xValueFormatterProperty, yValueFormatterProperty

Methods inherited from class de.gsi.chart.plugins.ChartPlugin

addButtonsToToolBarProperty, chartProperty, getChart, getChartChildren, getLocationInPlotArea, isAddButtonsToToolBar, layoutChildren, registerInputEventHandler, setAddButtonsToToolBar, setChart, toDataPoint, toDisplayPoint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

pickingDistance

public final DoubleProperty pickingDistanceProperty

Distance of the mouse cursor from the data point (expressed in display units) that should trigger showing the tool tip. By default initialized to 5.

See Also:

getPickingDistance(), setPickingDistance(double)

Field Detail

STYLE_CLASS_LABEL

public static final String STYLE_CLASS_LABEL

Name of the CSS class of the tool tip label.

See Also:

Constant Field Values

DEFAULT_PICKING_DISTANCE

public static final int DEFAULT_PICKING_DISTANCE

The default distance between the data point coordinates and mouse cursor that triggers showing the tool tip label.

See Also:

Constant Field Values

Constructor Detail

DataPointTooltip

public DataPointTooltip()

Creates a new instance of DataPointTooltip class with {picking distance initialized to 5.

DataPointTooltip

public DataPointTooltip(double pickingDistance)

Creates a new instance of DataPointTooltip class.

Parameters:

pickingDistance - the initial value for the pickingDistance property

Method Detail

formatLabel

protected String formatLabel(DataPointTooltip.DataPoint dataPoint)

getDataLabelSafe

protected String getDataLabelSafe(DataSet dataSet,
                                  int index)

getDefaultDataLabel

protected String getDefaultDataLabel(DataSet dataSet,
                                     int index)

Returns label of a data point specified by the index. The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.

Parameters:

index - data point index

Returns:

label of a data point specified by the index or null if none label has been specified for this data point.

getPickingDistance

public final double getPickingDistance()

Returns the value of the pickingDistanceProperty().

Returns:

the current picking distance

pickingDistanceProperty

public final DoubleProperty pickingDistanceProperty()

Distance of the mouse cursor from the data point (expressed in display units) that should trigger showing the tool tip. By default initialized to 5.

See Also:

getPickingDistance(), setPickingDistance(double)

setPickingDistance

public final void setPickingDistance(double distance)

Sets the value of pickingDistanceProperty().

Parameters:

distance - the new picking distance