de.gsi.chart.plugins

Class AbstractSingleValueIndicator

java.lang.Object

de.gsi.chart.plugins.ChartPlugin

de.gsi.chart.plugins.AbstractValueIndicator

de.gsi.chart.plugins.AbstractSingleValueIndicator

Direct Known Subclasses:

XValueIndicator, YValueIndicator

public abstract class AbstractSingleValueIndicator
extends AbstractValueIndicator

Plugin indicating a specific X or Y value as a line drawn on the plot area, with an optional text label describing the value.

Author:

mhrabia

Property Summary

Type	Property and Description
DoubleProperty	labelPosition Relative position, between 0.0 (left, bottom) and 1.0 (right, top) of the description label in the plot area.
DoubleProperty	pickingDistance Distance of the mouse cursor from the line (in pixel) that should trigger the moving of the line.
DoubleProperty	value Value indicated by this plugin.

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

editableIndicatorProperty, labelHorizontalAnchorProperty, labelVerticalAnchorProperty, textProperty

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

addButtonsToToolBarProperty, chartProperty

Nested Class Summary

Nested classes/interfaces inherited from class de.gsi.chart.plugins.AbstractValueIndicator

AbstractValueIndicator.Delta

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_PICKING_DISTANCE The default distance between the data point coordinates and mouse cursor that triggers shifting the line.
protected Line	line Line indicating the value.
protected static double	MIDDLE_POSITION
protected Line	pickLine
protected static String	STYLE_CLASS_LABEL
protected static String	STYLE_CLASS_LINE
protected static String	STYLE_CLASS_MARKER
protected Polygon	triangle small triangle marker as handler to shift the line marker
protected static double	triangleHalfWidth

Fields inherited from class de.gsi.chart.plugins.AbstractValueIndicator

dragDelta, editableIndicator, label

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSingleValueIndicator(Axis axis, double value, String text) Creates a new instance of AbstractSingleValueIndicator.

Method Summary

Modifier and Type	Method and Description
double	getLabelPosition() Returns the value of the labelPositionProperty().
double	getPickingDistance() Returns the value of the pickingDistanceProperty().
double	getValue() Returns the indicated value.
DoubleProperty	labelPositionProperty() Relative position, between 0.0 (left, bottom) and 1.0 (right, top) of the description label in the plot area.
protected void	layoutLine(double startX, double startY, double endX, double endY) Sets the line coordinates.
protected void	layoutMarker(double startX, double startY, double endX, double endY) Sets the marker coordinates.
DoubleProperty	pickingDistanceProperty() Distance of the mouse cursor from the line (in pixel) that should trigger the moving of the line.
void	setLabelPosition(double value) Sets the new value of the labelPositionProperty().
void	setPickingDistance(double distance) Sets the value of pickingDistanceProperty().
void	setValue(double newValue) Sets the value that should be indicated.
DoubleProperty	valueProperty() Value indicated by this plugin.

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

addChildNodeIfNotPresent, editableIndicatorProperty, getLabelHorizontalAnchor, getLabelVerticalAnchor, getNumericAxis, getText, isEditable, labelHorizontalAnchorProperty, labelVerticalAnchorProperty, layoutLabel, setEditable, setLabelHorizontalAnchor, setLabelVerticalAnchor, setStyleClasses, setText, textProperty, updateStyleClass

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

labelPosition

public final DoubleProperty labelPositionProperty

Relative position, between 0.0 (left, bottom) and 1.0 (right, top) of the description label in the plot area.

Default value: 0.5

See Also:

getLabelPosition(), setLabelPosition(double)

pickingDistance

public final DoubleProperty pickingDistanceProperty

Distance of the mouse cursor from the line (in pixel) that should trigger the moving of the line. By default initialized to 30.

See Also:

getPickingDistance(), setPickingDistance(double)

value

public final DoubleProperty valueProperty

Value indicated by this plugin.

See Also:

getValue(), setValue(double)

Field Detail

DEFAULT_PICKING_DISTANCE

protected static final int DEFAULT_PICKING_DISTANCE

The default distance between the data point coordinates and mouse cursor that triggers shifting the line.

See Also:

Constant Field Values

MIDDLE_POSITION

protected static final double MIDDLE_POSITION

See Also:

Constant Field Values

STYLE_CLASS_LABEL

protected static final String STYLE_CLASS_LABEL

See Also:

Constant Field Values

STYLE_CLASS_LINE

protected static final String STYLE_CLASS_LINE

See Also:

Constant Field Values

STYLE_CLASS_MARKER

protected static final String STYLE_CLASS_MARKER

See Also:

Constant Field Values

triangleHalfWidth

protected static double triangleHalfWidth

line

protected final Line line

Line indicating the value.

pickLine

protected final Line pickLine

triangle

protected final Polygon triangle

small triangle marker as handler to shift the line marker

Constructor Detail

AbstractSingleValueIndicator

protected AbstractSingleValueIndicator(Axis axis,
                                       double value,
                                       String text)

Creates a new instance of AbstractSingleValueIndicator.

Parameters:

axis - reference axis

value - a X value to be indicated

text - the text to be shown by the label. Value of AbstractValueIndicator.textProperty().

Method Detail

getLabelPosition

public final double getLabelPosition()

Returns the value of the labelPositionProperty().

Returns:

the relative position of the text label

getPickingDistance

public final double getPickingDistance()

Returns the value of the pickingDistanceProperty().

Returns:

the current picking distance

getValue

public final double getValue()

Returns the indicated value.

Returns:

indicated value

labelPositionProperty

public final DoubleProperty labelPositionProperty()

Relative position, between 0.0 (left, bottom) and 1.0 (right, top) of the description label in the plot area.

Default value: 0.5

See Also:

getLabelPosition(), setLabelPosition(double)

layoutLine

protected void layoutLine(double startX,
                          double startY,
                          double endX,
                          double endY)

Sets the line coordinates.

Parameters:

startX - start x coordinate

startY - start y coordinate

endX - stop x coordinate

endY - stop y coordinate

layoutMarker

protected void layoutMarker(double startX,
                            double startY,
                            double endX,
                            double endY)

Sets the marker coordinates.

Parameters:

startX - start x coordinate

startY - start y coordinate

endX - stop x coordinate

endY - stop y coordinate

pickingDistanceProperty

public final DoubleProperty pickingDistanceProperty()

Distance of the mouse cursor from the line (in pixel) that should trigger the moving of the line. By default initialized to 30.

See Also:

getPickingDistance(), setPickingDistance(double)

setLabelPosition

public final void setLabelPosition(double value)

Sets the new value of the labelPositionProperty().

Parameters:

value - the label position, between 0.0 and 1.0 (both inclusive)

setPickingDistance

public final void setPickingDistance(double distance)

Sets the value of pickingDistanceProperty().

Parameters:

distance - the new picking distance

setValue

public final void setValue(double newValue)

Sets the value that should be indicated.

Parameters:

newValue - value to be indicated

valueProperty

public final DoubleProperty valueProperty()

Value indicated by this plugin.

See Also:

getValue(), setValue(double)