org.jfree.chart.fx.interaction

Class ScrollHandlerFX

java.lang.Object

org.jfree.chart.fx.interaction.AbstractMouseHandlerFX

org.jfree.chart.fx.interaction.ScrollHandlerFX

All Implemented Interfaces:

MouseHandlerFX

public class ScrollHandlerFX
extends AbstractMouseHandlerFX
implements MouseHandlerFX

Handles scroll events (mouse wheel etc) on a ChartCanvas.

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
ScrollHandlerFX(String id) Creates a new instance with the specified ID.

Method Summary

Modifier and Type	Method and Description
double	getZoomFactor() Returns the zoom factor.
void	handleScroll(ChartCanvas canvas, ScrollEvent e) Handles a scroll event.
void	setZoomFactor(double zoomFactor) Sets the zoom factor (a percentage amount by which the mouse wheel movement will change the chart size).

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

getID, handleMouseClicked, handleMouseDragged, handleMouseMoved, handleMousePressed, handleMouseReleased, hasMatchingModifiers, isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jfree.chart.fx.interaction.MouseHandlerFX

getID, handleMouseClicked, handleMouseDragged, handleMouseMoved, handleMousePressed, handleMouseReleased, hasMatchingModifiers, isEnabled

Constructor Detail

ScrollHandlerFX

public ScrollHandlerFX(String id)

Creates a new instance with the specified ID.

Parameters:

id - the handler ID (null not permitted).

Method Detail

getZoomFactor

public double getZoomFactor()

Returns the zoom factor. The default value is 0.10 (ten percent).

Returns:

The zoom factor.

setZoomFactor

public void setZoomFactor(double zoomFactor)

Sets the zoom factor (a percentage amount by which the mouse wheel movement will change the chart size).

Parameters:

zoomFactor - the zoom factor.

handleScroll

public void handleScroll(ChartCanvas canvas,
                         ScrollEvent e)

Description copied from class: AbstractMouseHandlerFX

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

Specified by:

handleScroll in interface MouseHandlerFX

Overrides:

handleScroll in class AbstractMouseHandlerFX

Parameters:

canvas - the canvas (null not permitted).

e - the event (null not permitted).