de.gsi.chart.plugins

Class AbstractValueIndicator

java.lang.Object

de.gsi.chart.plugins.ChartPlugin

de.gsi.chart.plugins.AbstractValueIndicator

Direct Known Subclasses:

AbstractRangeValueIndicator, AbstractSingleValueIndicator

public abstract class AbstractValueIndicator
extends ChartPlugin

Base class for plugins indicating a specific value or range of values on a Chart with an optional text label description.

Author:

mhrabia

Property Summary

Type	Property and Description
BooleanProperty	editableIndicator whether this plugin is editable
ObjectProperty<HPos>	labelHorizontalAnchor Specifies anchor of the text label with respect to the horizontal label position i.e.
ObjectProperty<VPos>	labelVerticalAnchor Specifies anchor of the text label with respect to the vertical label position i.e.
StringProperty	text Text to be displayed by the label.

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

addButtonsToToolBarProperty, chartProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractValueIndicator.Delta

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractValueIndicator.Delta	dragDelta
protected BooleanProperty	editableIndicator
protected Label	label

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addChildNodeIfNotPresent(Node node)
BooleanProperty	editableIndicatorProperty() whether this plugin is editable
HPos	getLabelHorizontalAnchor() Returns the value of the labelHorizontalAnchorProperty().
VPos	getLabelVerticalAnchor() Returns the value of the labelVerticalAnchorProperty().
protected Axis	getNumericAxis() Returns the ValueAxis that this indicator is associated with.
String	getText() Returns the value of the textProperty().
boolean	isEditable()
ObjectProperty<HPos>	labelHorizontalAnchorProperty() Specifies anchor of the text label with respect to the horizontal label position i.e.
ObjectProperty<VPos>	labelVerticalAnchorProperty() Specifies anchor of the text label with respect to the vertical label position i.e.
protected void	layoutLabel(Bounds bounds, double hPos, double vPos) Layouts the label within specified bounds and given horizontal and vertical position, taking into account horizontal and vertical anchor.
void	setEditable(boolean newState) Sets the state whether this plugin is editable
void	setLabelHorizontalAnchor(HPos anchor) Sets the value of the labelHorizontalAnchorProperty().
void	setLabelVerticalAnchor(VPos anchor) Sets the value of the labelVerticalAnchorProperty().
void	setStyleClasses(Node node, String prefix, String root)
void	setText(String text) Sets the value of the textProperty().
StringProperty	textProperty() Text to be displayed by the label.
abstract void	updateStyleClass() There might be several instances of a given indicator class.

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

editableIndicator

public final BooleanProperty editableIndicatorProperty

whether this plugin is editable

labelHorizontalAnchor

public final ObjectProperty<HPos> labelHorizontalAnchorProperty

Specifies anchor of the text label with respect to the horizontal label position i.e. it describes whether the position is related to the LEFT, CENTER or RIGHT side of the label. The position itself should be specified by the extending classes.

Default value: HPos.CENTER

See Also:

getLabelHorizontalAnchor(), setLabelHorizontalAnchor(HPos)

labelVerticalAnchor

public final ObjectProperty<VPos> labelVerticalAnchorProperty

Specifies anchor of the text label with respect to the vertical label position i.e. it describes whether the position is related to the TOP, CENTER, BASELINE or BOTTOM of of the label. The position itself should be specified by the extending classes.

Default value: VPos.CENTER

See Also:

getLabelVerticalAnchor(), setLabelVerticalAnchor(VPos)

text

public final StringProperty textProperty

Text to be displayed by the label. If set to null, the label is not shown.

See Also:

getText(), setText(String)

Field Detail

label

protected final Label label

dragDelta

protected final AbstractValueIndicator.Delta dragDelta

editableIndicator

protected final BooleanProperty editableIndicator

Constructor Detail

AbstractValueIndicator

protected AbstractValueIndicator(Axis axis,
                                 String text)

Creates a new instance of the indicator.

Parameters:

axis - the axis this indicator is associated with

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

Method Detail

addChildNodeIfNotPresent

protected void addChildNodeIfNotPresent(Node node)

editableIndicatorProperty

public final BooleanProperty editableIndicatorProperty()

whether this plugin is editable

getLabelHorizontalAnchor

public final HPos getLabelHorizontalAnchor()

Returns the value of the labelHorizontalAnchorProperty().

Returns:

value of the labelHorizontalAnchor property

getLabelVerticalAnchor

public final VPos getLabelVerticalAnchor()

Returns the value of the labelVerticalAnchorProperty().

Returns:

value of the labelVerticalAnchor property

getNumericAxis

protected Axis getNumericAxis()

Returns the ValueAxis that this indicator is associated with.

Returns:

associated ValueAxis

getText

public final String getText()

Returns the value of the textProperty().

Returns:

text displayed within or next to the indicator

isEditable

public final boolean isEditable()

Returns:

whether this plugin is editable

labelHorizontalAnchorProperty

public final ObjectProperty<HPos> labelHorizontalAnchorProperty()

Specifies anchor of the text label with respect to the horizontal label position i.e. it describes whether the position is related to the LEFT, CENTER or RIGHT side of the label. The position itself should be specified by the extending classes.

Default value: HPos.CENTER

See Also:

getLabelHorizontalAnchor(), setLabelHorizontalAnchor(HPos)

labelVerticalAnchorProperty

public final ObjectProperty<VPos> labelVerticalAnchorProperty()

Specifies anchor of the text label with respect to the vertical label position i.e. it describes whether the position is related to the TOP, CENTER, BASELINE or BOTTOM of of the label. The position itself should be specified by the extending classes.

Default value: VPos.CENTER

See Also:

getLabelVerticalAnchor(), setLabelVerticalAnchor(VPos)

layoutLabel

protected final void layoutLabel(Bounds bounds,
                                 double hPos,
                                 double vPos)

Layouts the label within specified bounds and given horizontal and vertical position, taking into account horizontal and vertical anchor.

Parameters:

bounds - the bounding rectangle with respect to which the label should be positioned

hPos - relative [0, 1] horizontal position of the label within the bounds

vPos - relative [0, 1] vertical position of the label within the bounds

setEditable

public final void setEditable(boolean newState)

Sets the state whether this plugin is editable

Parameters:

newState - true: edits are allowed

setLabelHorizontalAnchor

public final void setLabelHorizontalAnchor(HPos anchor)

Sets the value of the labelHorizontalAnchorProperty().

Parameters:

anchor - new anchor

setLabelVerticalAnchor

public final void setLabelVerticalAnchor(VPos anchor)

Sets the value of the labelVerticalAnchorProperty().

Parameters:

anchor - new anchor

setStyleClasses

public void setStyleClasses(Node node,
                            String prefix,
                            String root)

setText

public final void setText(String text)

Sets the value of the textProperty().

Parameters:

text - the new text. If null, the label will be hidden.

textProperty

public final StringProperty textProperty()

Text to be displayed by the label. If set to null, the label is not shown.

See Also:

getText(), setText(String)

updateStyleClass

public abstract void updateStyleClass()

There might be several instances of a given indicator class. If one wants to specify different CSS for each instance - we need a unique class name for each, so whenever the list of plugins changes, this method should update name of it's CSS class.