org.gillius.jfxutils.chart

Class JFXChartUtil

java.lang.Object

org.gillius.jfxutils.chart.JFXChartUtil

public class JFXChartUtil
extends Object

JFXChartUtil contains chart-related JavaFX utility methods used in the Gillius jfxutils project.

Author:

Jason Winnebeck

Constructor Summary

Constructors

Constructor and Description
JFXChartUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static javafx.scene.layout.Region	setupZooming(javafx.scene.chart.XYChart<?,?> chart) Sets up zooming via the setupZooming(XYChart, EventHandler) method by using the ChartZoomManager's default filter.
static javafx.scene.layout.Region	setupZooming(javafx.scene.chart.XYChart<?,?> chart, javafx.event.EventHandler<? super javafx.scene.input.MouseEvent> mouseFilter) Convenience method for simple and default setup of zooming on an XYChart via a ChartZoomManager.

Methods inherited from class java.lang.Object

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

Constructor Detail

JFXChartUtil

public JFXChartUtil()

Method Detail

setupZooming

public static javafx.scene.layout.Region setupZooming(javafx.scene.chart.XYChart<?,?> chart)

Sets up zooming via the setupZooming(XYChart, EventHandler) method by using the ChartZoomManager's default filter.

setupZooming

public static javafx.scene.layout.Region setupZooming(javafx.scene.chart.XYChart<?,?> chart,
                                      javafx.event.EventHandler<? super javafx.scene.input.MouseEvent> mouseFilter)

Convenience method for simple and default setup of zooming on an XYChart via a ChartZoomManager. Wraps the chart in the components required to implement zooming. The current implementation wraps the chart in a StackPane, which has the chart and a blue translucent rectangle as children. Returns the top level of the created components.

If the chart already has a parent, that parent must be a Pane, and the chart is replaced with the wrapping region, and the return value could be ignored. If the chart does not have a parent, the same wrapping node is returned, which will need to be added to some parent.

The chart's axes must both be a type of ValueAxis.

The wrapping logic does not seem to be perfect, in fact there is a special case to handle BorderPanes. If it's not found to be reliable, then create the wrapping components yourself (such as in the FXML), or setup zooming before adding it to a parent.

Parameters:

mouseFilter - EventHandler that consumes events that should not trigger a zoom action

Returns:

The top-level Region