de.gsi.chart.plugins

Class AbstractRangeValueIndicator

java.lang.Object

de.gsi.chart.plugins.ChartPlugin

de.gsi.chart.plugins.AbstractValueIndicator

de.gsi.chart.plugins.AbstractRangeValueIndicator

Direct Known Subclasses:

XRangeIndicator, YRangeIndicator

public abstract class AbstractRangeValueIndicator
extends AbstractValueIndicator

Plugin indicating a value range as a rectangle drawn on the plot area, with an optional text label describing the range.

Author:

mhrabia

Property Summary

Type	Property and Description
DoubleProperty	labelHorizontalPosition Relative horizontal position of the text label on the plot area, with value between 0.0 (left) and 1.0 (right).
DoubleProperty	labelVerticalPosition Relative vertical position of the text label on the plot area, with value between 0.0 (bottom) and 1.0 (top).
DoubleProperty	lowerBound Lower bound (min value) of the range to be indicated.
DoubleProperty	upperBound Upper bound (max value) of the range to be indicated.

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 Rectangle	rectangle Rectangle indicating the range.
protected static String	STYLE_CLASS_LABEL
protected static String	STYLE_CLASS_RECT

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

dragDelta, editableIndicator, label

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRangeValueIndicator(Axis axis, double lowerBound, double upperBound, String text) Creates a new instance of the indicator.

Method Summary

Modifier and Type	Method and Description
double	getLabelHorizontalPosition() Returns the value of the labelHorizontalPositionProperty().
double	getLabelVerticalPosition() Returns the value of the labelVerticalPositionProperty().
double	getLowerBound() Returns the value of the lowerBoundProperty().
double	getUpperBound() Returns the value of the upperBoundProperty().
DoubleProperty	labelHorizontalPositionProperty() Relative horizontal position of the text label on the plot area, with value between 0.0 (left) and 1.0 (right).
DoubleProperty	labelVerticalPositionProperty() Relative vertical position of the text label on the plot area, with value between 0.0 (bottom) and 1.0 (top).
protected void	layout(Bounds bounds) Layouts the rectangle and label within given bounds.
DoubleProperty	lowerBoundProperty() Lower bound (min value) of the range to be indicated.
void	setLabelHorizontalPosition(double value) Sets the new value of the labelHorizontalPositionProperty().
void	setLabelVerticalPosition(double value) Sets the new value of the labelVerticalPositionProperty().
void	setLowerBound(double value) Sets the value of the lowerBoundProperty()
void	setUpperBound(double value) Sets the value of upperBoundProperty()
DoubleProperty	upperBoundProperty() Upper bound (max value) of the range to be indicated.

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

labelHorizontalPosition

public final DoubleProperty labelHorizontalPositionProperty

Relative horizontal position of the text label on the plot area, with value between 0.0 (left) and 1.0 (right). Value 0.5 will position the label in the middle of the plot area.

See Also:

getLabelHorizontalPosition(), setLabelHorizontalPosition(double)

labelVerticalPosition

public final DoubleProperty labelVerticalPositionProperty

Relative vertical position of the text label on the plot area, with value between 0.0 (bottom) and 1.0 (top). Value 0.5 will position the label in the middle of the plot area.

See Also:

getLabelVerticalPosition(), setLabelVerticalPosition(double)

lowerBound

public final DoubleProperty lowerBoundProperty

Lower bound (min value) of the range to be indicated.

See Also:

getLowerBound(), setLowerBound(double)

upperBound

public final DoubleProperty upperBoundProperty

Upper bound (max value) of the range to be indicated.

See Also:

getUpperBound(), setUpperBound(double)

Field Detail

STYLE_CLASS_LABEL

protected static final String STYLE_CLASS_LABEL

See Also:

Constant Field Values

STYLE_CLASS_RECT

protected static final String STYLE_CLASS_RECT

See Also:

Constant Field Values

rectangle

protected final Rectangle rectangle

Rectangle indicating the range.

Constructor Detail

AbstractRangeValueIndicator

protected AbstractRangeValueIndicator(Axis axis,
                                      double lowerBound,
                                      double upperBound,
                                      String text)

Creates a new instance of the indicator.

Parameters:

axis - the axis this indicator is associated with

lowerBound - lower bound (min value) of the range

upperBound - upper bound (max value) of the range

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

Method Detail

getLabelHorizontalPosition

public final double getLabelHorizontalPosition()

Returns the value of the labelHorizontalPositionProperty().

Returns:

relative horizontal position of the text label

getLabelVerticalPosition

public final double getLabelVerticalPosition()

Returns the value of the labelVerticalPositionProperty().

Returns:

relative vertical position of the text label

getLowerBound

public final double getLowerBound()

Returns the value of the lowerBoundProperty().

Returns:

lower bound of the range to be indicated

getUpperBound

public final double getUpperBound()

Returns the value of the upperBoundProperty().

Returns:

upper bound (max value) of the range to be indicated

labelHorizontalPositionProperty

public final DoubleProperty labelHorizontalPositionProperty()

Relative horizontal position of the text label on the plot area, with value between 0.0 (left) and 1.0 (right). Value 0.5 will position the label in the middle of the plot area.

See Also:

getLabelHorizontalPosition(), setLabelHorizontalPosition(double)

labelVerticalPositionProperty

public final DoubleProperty labelVerticalPositionProperty()

Relative vertical position of the text label on the plot area, with value between 0.0 (bottom) and 1.0 (top). Value 0.5 will position the label in the middle of the plot area.

See Also:

getLabelVerticalPosition(), setLabelVerticalPosition(double)

layout

protected void layout(Bounds bounds)

Layouts the rectangle and label within given bounds.

Parameters:

bounds - our own bounds in relation to the plot area bounds

lowerBoundProperty

public final DoubleProperty lowerBoundProperty()

Lower bound (min value) of the range to be indicated.

See Also:

getLowerBound(), setLowerBound(double)

setLabelHorizontalPosition

public final void setLabelHorizontalPosition(double value)

Sets the new value of the labelHorizontalPositionProperty().

Parameters:

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

setLabelVerticalPosition

public final void setLabelVerticalPosition(double value)

Sets the new value of the labelVerticalPositionProperty().

Parameters:

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

setLowerBound

public final void setLowerBound(double value)

Sets the value of the lowerBoundProperty()

Parameters:

value - the value for the lower bound of the indicator

setUpperBound

public final void setUpperBound(double value)

Sets the value of upperBoundProperty()

Parameters:

value - upper bound (max value) of the range to be indicated

upperBoundProperty

public final DoubleProperty upperBoundProperty()

Upper bound (max value) of the range to be indicated.

See Also:

getUpperBound(), setUpperBound(double)