org.jfree.chart.fx.interaction

Class ZoomHandlerFX

java.lang.Object

org.jfree.chart.fx.interaction.AbstractMouseHandlerFX

org.jfree.chart.fx.interaction.ZoomHandlerFX

All Implemented Interfaces:

MouseHandlerFX

public class ZoomHandlerFX
extends AbstractMouseHandlerFX

Handles drag zooming of charts on a ChartCanvas. This handler should be configured with the required modifier keys and installed as a live handler (not an auxiliary handler). This handler only works for a ChartCanvas that is embedded in a ChartViewer, since it relies on the ChartViewer for drawing the zoom rectangle.

THE API FOR THIS CLASS IS SUBJECT TO CHANGE IN FUTURE RELEASES. This is so that we can incorporate feedback on the (new) JavaFX support in JFreeChart.

Since:

1.0.18

Constructor Summary

Constructors

Constructor and Description
ZoomHandlerFX(java.lang.String id, ChartViewer parent) Creates a new instance with no modifier keys required.
ZoomHandlerFX(java.lang.String id, ChartViewer parent, boolean altKey, boolean ctrlKey, boolean metaKey, boolean shiftKey) Creates a new instance that will be activated using the specified combination of modifier keys.

Method Summary

Modifier and Type	Method and Description
void	handleMouseDragged(ChartCanvas canvas, javafx.scene.input.MouseEvent e) Handles a mouse dragged event by updating the zoom rectangle displayed in the ChartViewer.
void	handleMousePressed(ChartCanvas canvas, javafx.scene.input.MouseEvent e) Handles a mouse pressed event by recording the initial mouse pointer location.
void	handleMouseReleased(ChartCanvas canvas, javafx.scene.input.MouseEvent e) Handles a mouse released event.

Methods inherited from class org.jfree.chart.fx.interaction.AbstractMouseHandlerFX

getID, handleMouseClicked, handleMouseMoved, handleScroll, hasMatchingModifiers, isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

ZoomHandlerFX

public ZoomHandlerFX(java.lang.String id,
                     ChartViewer parent)

Creates a new instance with no modifier keys required.

Parameters:

id - the handler ID (null not permitted).

parent - the chart viewer.

ZoomHandlerFX

public ZoomHandlerFX(java.lang.String id,
                     ChartViewer parent,
                     boolean altKey,
                     boolean ctrlKey,
                     boolean metaKey,
                     boolean shiftKey)

Creates a new instance that will be activated using the specified combination of modifier keys.

Parameters:

id - the handler ID (null not permitted).

parent - the chart viewer.

altKey - require ALT key?

ctrlKey - require CTRL key?

metaKey - require META key?

shiftKey - require SHIFT key?

Method Detail

handleMousePressed

public void handleMousePressed(ChartCanvas canvas,
                               javafx.scene.input.MouseEvent e)

Handles a mouse pressed event by recording the initial mouse pointer location.

Specified by:

handleMousePressed in interface MouseHandlerFX

Overrides:

handleMousePressed in class AbstractMouseHandlerFX

Parameters:

canvas - the JavaFX canvas (null not permitted).

e - the mouse event (null not permitted).

handleMouseDragged

public void handleMouseDragged(ChartCanvas canvas,
                               javafx.scene.input.MouseEvent e)

Handles a mouse dragged event by updating the zoom rectangle displayed in the ChartViewer.

Specified by:

handleMouseDragged in interface MouseHandlerFX

Overrides:

handleMouseDragged in class AbstractMouseHandlerFX

Parameters:

canvas - the JavaFX canvas (null not permitted).

e - the mouse event (null not permitted).

handleMouseReleased

public void handleMouseReleased(ChartCanvas canvas,
                                javafx.scene.input.MouseEvent e)

Description copied from class: AbstractMouseHandlerFX

Handles a mouse released event. This implementation does nothing, override the method if required.

Specified by:

handleMouseReleased in interface MouseHandlerFX

Overrides:

handleMouseReleased in class AbstractMouseHandlerFX

Parameters:

canvas - the canvas (null not permitted).

e - the event (null not permitted).