Package de.gsi.chart.plugins

Class XRangeIndicator

java.lang.Object

de.gsi.chart.plugins.ChartPlugin

de.gsi.chart.plugins.AbstractValueIndicator

de.gsi.chart.plugins.AbstractRangeValueIndicator

de.gsi.chart.plugins.XRangeIndicator

public class XRangeIndicator
extends AbstractRangeValueIndicator

A rectangle drawn on the plot area, covering specified range of X values, with an optional text label describing the range.

Style Classes (from least to most specific):

• Label: range-indicator-label, x-range-indicator-label, x-range-indicator-label[index]
• Rectangle: range-indicator-rect, x-range-indicator-rect, x-range-indicator-rect[index]

where [index] corresponds to the index (zero based) of this indicator instance added to the XYChartPane. For example class x-range-indicator-label1 can be used to style label of the second instance of this indicator added to the chart pane.

Author:

mhrabia

Nested Class Summary

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

AbstractValueIndicator.Delta

Field Summary

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

rectangle

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

dragDelta, editableIndicator, label

Constructor Summary

Constructors

Constructor	Description
XRangeIndicator(Axis axis, double lowerBound, double upperBound)	Creates a new instance of the indicator.
XRangeIndicator(Axis axis, double lowerBound, double upperBound, java.lang.String text)	Creates a new instance of the indicator.

Method Summary

Modifier and Type	Method	Description
void	layoutChildren()	Optional method that allows the plug-in to react in case the size of the chart that it belongs to has changed.
void	updateStyleClass()

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

getLabelHorizontalPosition, getLabelVerticalPosition, getLowerBound, getUpperBound, labelHorizontalPositionProperty, labelVerticalPositionProperty, layout, lowerBoundProperty, setLabelHorizontalPosition, setLabelVerticalPosition, setLowerBound, setUpperBound, upperBoundProperty

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

XRangeIndicator

public XRangeIndicator(Axis axis,
                       double lowerBound,
                       double upperBound)

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

XRangeIndicator

public XRangeIndicator(Axis axis,
                       double lowerBound,
                       double upperBound,
                       java.lang.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

updateStyleClass

public void updateStyleClass()

layoutChildren

public void layoutChildren()

Description copied from class: ChartPlugin

Optional method that allows the plug-in to react in case the size of the chart that it belongs to has changed.

Overrides:

layoutChildren in class ChartPlugin