de.gsi.chart.plugins

Class YRangeIndicator

java.lang.Object

de.gsi.chart.plugins.ChartPlugin

de.gsi.chart.plugins.AbstractValueIndicator

de.gsi.chart.plugins.AbstractRangeValueIndicator

de.gsi.chart.plugins.YRangeIndicator

public class YRangeIndicator
extends AbstractRangeValueIndicator

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

Style Classes (from least to most specific):

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

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

Author:

mhrabia

Property Summary

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

labelHorizontalPositionProperty, labelVerticalPositionProperty, lowerBoundProperty, upperBoundProperty

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 inherited from class de.gsi.chart.plugins.AbstractRangeValueIndicator

rectangle, STYLE_CLASS_LABEL, STYLE_CLASS_RECT

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

dragDelta, editableIndicator, label

Constructor Summary

Constructors

Constructor and Description
YRangeIndicator(Axis axis, double lowerBound, double upperBound) Creates a new instance that indicates given Y range of the specified Y axis.
YRangeIndicator(Axis axis, double lowerBound, double upperBound, String text) Creates a new instance that indicates given Y range.

Method Summary

Modifier and Type	Method and 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() There might be several instances of a given indicator class.

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, setStyleClasses, 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

YRangeIndicator

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

Creates a new instance that indicates given Y range of the specified Y axis.

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

YRangeIndicator

public YRangeIndicator(Axis axis,
                       double lowerBound,
                       double upperBound,
                       String text)

Creates a new instance that indicates given Y range.

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 indicator's label's text

Method Detail

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

updateStyleClass

public void updateStyleClass()

Description copied from class: AbstractValueIndicator

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.

Specified by:

updateStyleClass in class AbstractValueIndicator