de.gsi.chart.plugins

Class ChartPlugin

java.lang.Object

de.gsi.chart.plugins.ChartPlugin

Direct Known Subclasses:

AbstractDataFormattingPlugin, AbstractValueIndicator, ChartOverlay, ColormapSelector, EditAxis, Panner, ParameterMeasurements, TableViewer, UpdateAxisLabels, Zoomer

public abstract class ChartPlugin
extends Object

Represents an add-on to a Chart that can either annotate/decorate the chart or perform some interactions with it.

Concrete plugin implementations may add custom nodes to the chart via getChartChildren() which returns an observable and modifiable list of nodes that will be added to the XYChartPane on top of charts.

Plugins may also listen and react to events (e.g. mouse events) generated on the XYChartPane via registerInputEventHandler(EventType, EventHandler) method.

Author:

Grzegorz Kruk, braeun - modified to be able to use XYChart class, rstein - modified to new Chart, XYChart API

Property Summary

Type	Property and Description
BooleanProperty	addButtonsToToolBar When true the corresponding control buttons are added to the chart tool bar
ObjectProperty<Chart>	chart The associated Chart.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChartPlugin() Creates a new instance of the ChartPlugin.

Method Summary

Modifier and Type	Method and Description
BooleanProperty	addButtonsToToolBarProperty() When true the corresponding control buttons are added to the chart tool bar
ObjectProperty<Chart>	chartProperty() The associated Chart.
Chart	getChart() Returns the value of the chartProperty().
ObservableList<Node>	getChartChildren() Returns a list containing nodes that should be added to the list of child nodes of the associated XYChart's plot area children.
protected Point2D	getLocationInPlotArea(MouseEvent event) Converts mouse location within the scene to the location relative to the plot area.
boolean	isAddButtonsToToolBar() Returns the value of the addButtonsToToolBarProperty().
void	layoutChildren() Optional method that allows the plug-in to react in case the size of the chart that it belongs to has changed.
protected void	registerInputEventHandler(EventType<? extends InputEvent> eventType, EventHandler<? extends InputEvent> handler) Registers event handlers that should be added to the XYChartPane node when the plugin is added to the pane and are removed once the plugin is removed from the pane.
void	setAddButtonsToToolBar(boolean state) Sets the value of the addButtonsToToolBarProperty().
void	setChart(Chart chart) Called by the Chart when the plugin is added to it.
protected Tuple<Number,Number>	toDataPoint(Axis yAxis, Point2D displayPoint) Converts given display point within the plot area coordinates to the corresponding data point within data coordinates.
protected Point2D	toDisplayPoint(Axis yAxis, double x, double y) Converts given point in data coordinates to a point in display coordinates.

Methods inherited from class java.lang.Object

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

Property Detail

addButtonsToToolBar

public final BooleanProperty addButtonsToToolBarProperty

When true the corresponding control buttons are added to the chart tool bar

See Also:

isAddButtonsToToolBar(), setAddButtonsToToolBar(boolean)

chart

public final ObjectProperty<Chart> chartProperty

The associated Chart. Initialised when the plug-in is added to the Chart, set to null when removed.

Returns:

the chart property

Constructor Detail

ChartPlugin

protected ChartPlugin()

Creates a new instance of the ChartPlugin.

Method Detail

addButtonsToToolBarProperty

public final BooleanProperty addButtonsToToolBarProperty()

When true the corresponding control buttons are added to the chart tool bar

See Also:

isAddButtonsToToolBar(), setAddButtonsToToolBar(boolean)

chartProperty

public final ObjectProperty<Chart> chartProperty()

The associated Chart. Initialised when the plug-in is added to the Chart, set to null when removed.

Returns:

the chart property

getChart

public final Chart getChart()

Returns the value of the chartProperty().

Returns:

the associated Chart or null

getChartChildren

public final ObservableList<Node> getChartChildren()

Returns a list containing nodes that should be added to the list of child nodes of the associated XYChart's plot area children.

The method should be used by concrete implementations to add nodes that should be added to the chart area.

Returns:

non-null list of nodes to be added to the chart's plot area

getLocationInPlotArea

protected final Point2D getLocationInPlotArea(MouseEvent event)

Converts mouse location within the scene to the location relative to the plot area.

Parameters:

event - mouse event

Returns:

location within the plot area

isAddButtonsToToolBar

public final boolean isAddButtonsToToolBar()

Returns the value of the addButtonsToToolBarProperty().

Returns:

true the corresponding control buttons are added to the chart tool bar

layoutChildren

public void layoutChildren()

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

registerInputEventHandler

protected final void registerInputEventHandler(EventType<? extends InputEvent> eventType,
                                               EventHandler<? extends InputEvent> handler)

Registers event handlers that should be added to the XYChartPane node when the plugin is added to the pane and are removed once the plugin is removed from the pane.

Parameters:

eventType - the event type on which the handler should be called

handler - the event handler to be added to the chart

setAddButtonsToToolBar

public final void setAddButtonsToToolBar(boolean state)

Sets the value of the addButtonsToToolBarProperty().

Parameters:

state - if true the corresponding control buttons are added to the chart tool bar

setChart

public final void setChart(Chart chart)

Called by the Chart when the plugin is added to it.

Parameters:

chart - the chart pane

toDataPoint

protected final Tuple<Number,Number> toDataPoint(Axis yAxis,
                                                 Point2D displayPoint)

Converts given display point within the plot area coordinates to the corresponding data point within data coordinates.

Parameters:

yAxis - the number-based y axis

displayPoint - the display point to be converted

Returns:

the data point

toDisplayPoint

protected final Point2D toDisplayPoint(Axis yAxis,
                                       double x,
                                       double y)

Converts given point in data coordinates to a point in display coordinates.

Parameters:

yAxis - the corresponding y-axis (number axis)

x - the X coordinate (can be generic non-number, ie. CategoryAxis)

y - the Y coordinate on the yAxis (Number based)

Returns:

corresponding display point within the plot area