cern.extjfx.chart

Class XYChartPlugin<X,Y>

java.lang.Object

cern.extjfx.chart.XYChartPlugin<X,Y>

Type Parameters:

X - type of X values

Y - type of Y values

Direct Known Subclasses:

AbstractDataFormattingPlugin, AbstractValueIndicator, ChartOverlay, Panner, Zoomer

public abstract class XYChartPlugin<X,Y>
extends Object

Represents an add-on to a XYChart 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 registerMouseEventHandler(EventType, EventHandler) method.

When plugin is added to the XYChartPane, it is bound to it via chartPaneProperty(), therefore plugin implementations may observe it and be notified when they are added or removed from the XYChartPane.

Property Summary

Type	Property and Description
ObjectProperty<XYChartPane<X,Y>>	chartPane The associated XYChartPane.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ObjectProperty<XYChartPane<X,Y>>	chartPaneProperty() The associated XYChartPane.
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.
XYChartPane<X,Y>	getChartPane() Returns the value of the chartPaneProperty().
protected List<XYChart<X,Y>>	getCharts() Convenience method returning a list containing the chart pane base chart and all overlay charts.
protected Point2D	getLocationInPlotArea(MouseEvent event) Converts mouse location within the scene to the location relative to the plot area.
void	layoutChildren() Optional method that allows the plug-in to react in case the size of the XYChartPane that it belongs to has changed.
protected void	registerMouseEventHandler(EventType<MouseEvent> eventType, EventHandler<MouseEvent> 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	setChartPane(XYChartPane<X,Y> chartPane) Called by the XYChartPane when the plugin is added to it.
protected XYChart.Data<X,Y>	toDataPoint(Axis<Y> yAxis, Point2D displayPoint) Converts given display point within the plot area coordinates to the corresponding data point within data coordinates.
protected Point2D	toDisplayPoint(Axis<Y> yAxis, XYChart.Data<X,Y> dataPoint) 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

chartPane

public final ObjectProperty<XYChartPane<X,Y>> chartPaneProperty

The associated XYChartPane. Initialized when the plugin is added to the ChartPane, set to null when removed.

See Also:

getChartPane(), setChartPane(XYChartPane)

Constructor Detail

XYChartPlugin

protected XYChartPlugin()

Creates a new instance of the ChartPlugin.

Method Detail

chartPaneProperty

public final ObjectProperty<XYChartPane<X,Y>> chartPaneProperty()

The associated XYChartPane. Initialized when the plugin is added to the ChartPane, set to null when removed.

See Also:

getChartPane(), setChartPane(XYChartPane)

getChartPane

public final XYChartPane<X,Y> getChartPane()

Returns the value of the chartPaneProperty().

Returns:

the associated ChartPane or null

setChartPane

public final void setChartPane(XYChartPane<X,Y> chartPane)

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

Parameters:

chartPane - the chart pane

registerMouseEventHandler

protected final void registerMouseEventHandler(EventType<MouseEvent> eventType,
                                               EventHandler<MouseEvent> 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

getCharts

protected final List<XYChart<X,Y>> getCharts()

Convenience method returning a list containing the chart pane base chart and all overlay charts.

Returns:

list containing base and all overlay charts

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

layoutChildren

public void layoutChildren()

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

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

toDisplayPoint

protected final Point2D toDisplayPoint(Axis<Y> yAxis,
                                       XYChart.Data<X,Y> dataPoint)

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

Parameters:

yAxis - the Y axis for which conversion should be done

dataPoint - data point to be converted

Returns:

corresponding display point within the plot area

toDataPoint

protected final XYChart.Data<X,Y> toDataPoint(Axis<Y> yAxis,
                                              Point2D displayPoint)

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

Parameters:

yAxis - the Y axis for which conversion should be done

displayPoint - the display point to be converted

Returns:

the data point