org.jfree.chart.fx.interaction

Class AbstractMouseHandlerFX

java.lang.Object

org.jfree.chart.fx.interaction.AbstractMouseHandlerFX

All Implemented Interfaces:

MouseHandlerFX

Direct Known Subclasses:

AnchorHandlerFX, DispatchHandlerFX, PanHandlerFX, ScrollHandlerFX, TooltipHandlerFX, ZoomHandlerFX

public class AbstractMouseHandlerFX
extends Object
implements MouseHandlerFX

A base class that can be used to implement the MouseHandlerFX interface.

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
AbstractMouseHandlerFX(String id, boolean altKey, boolean ctrlKey, boolean metaKey, boolean shiftKey) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
String	getID() Returns the ID for the handler.
void	handleMouseClicked(ChartCanvas canvas, MouseEvent e) Handles a mouse clicked event.
void	handleMouseDragged(ChartCanvas canvas, MouseEvent e) Handles a mouse dragged event.
void	handleMouseMoved(ChartCanvas canvas, MouseEvent e) Handles a mouse moved event.
void	handleMousePressed(ChartCanvas canvas, MouseEvent e) Handles a mouse pressed event.
void	handleMouseReleased(ChartCanvas canvas, MouseEvent e) Handles a mouse released event.
void	handleScroll(ChartCanvas canvas, ScrollEvent e) Handles a scroll event.
boolean	hasMatchingModifiers(MouseEvent e) Returns true if the specified mouse event has modifier keys that match this handler.
boolean	isEnabled() Returns the flag that controls whether or not the handler is enabled.
void	setEnabled(boolean enabled) Sets the flag that controls the enabled/disabled state of the handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMouseHandlerFX

public AbstractMouseHandlerFX(String id,
                              boolean altKey,
                              boolean ctrlKey,
                              boolean metaKey,
                              boolean shiftKey)

Creates a new instance. The modifier keys are used to select a mouse handler to be the current "live" handler (when a handler is used as an auxiliary handler, the modifier keys are not relevant).

Parameters:

id - the handler id (null not permitted).

altKey - require ALT key modifier?

ctrlKey - require ALT key modifier?

metaKey - require ALT key modifier?

shiftKey - require ALT key modifier?

Method Detail

getID

public String getID()

Returns the ID for the handler.

Specified by:

getID in interface MouseHandlerFX

Returns:

The ID (never null).

isEnabled

public boolean isEnabled()

Returns the flag that controls whether or not the handler is enabled.

Specified by:

isEnabled in interface MouseHandlerFX

Returns:

A boolean.

setEnabled

public void setEnabled(boolean enabled)

Sets the flag that controls the enabled/disabled state of the handler.

Parameters:

enabled - the new flag value.

hasMatchingModifiers

public boolean hasMatchingModifiers(MouseEvent e)

Returns true if the specified mouse event has modifier keys that match this handler.

Specified by:

hasMatchingModifiers in interface MouseHandlerFX

Parameters:

e - the mouse event (null not permitted).

Returns:

A boolean.

handleMouseMoved

public void handleMouseMoved(ChartCanvas canvas,
                             MouseEvent e)

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

Specified by:

handleMouseMoved in interface MouseHandlerFX

Parameters:

canvas - the canvas (null not permitted).

e - the event (null not permitted).

handleMouseClicked

public void handleMouseClicked(ChartCanvas canvas,
                               MouseEvent e)

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

Specified by:

handleMouseClicked in interface MouseHandlerFX

Parameters:

canvas - the canvas (null not permitted).

e - the event (null not permitted).

handleMousePressed

public void handleMousePressed(ChartCanvas canvas,
                               MouseEvent e)

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

Specified by:

handleMousePressed in interface MouseHandlerFX

Parameters:

canvas - the canvas (null not permitted).

e - the event (null not permitted).

handleMouseDragged

public void handleMouseDragged(ChartCanvas canvas,
                               MouseEvent e)

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

Specified by:

handleMouseDragged in interface MouseHandlerFX

Parameters:

canvas - the canvas (null not permitted).

e - the event (null not permitted).

handleMouseReleased

public void handleMouseReleased(ChartCanvas canvas,
                                MouseEvent e)

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

Specified by:

handleMouseReleased in interface MouseHandlerFX

Parameters:

canvas - the canvas (null not permitted).

e - the event (null not permitted).

handleScroll

public void handleScroll(ChartCanvas canvas,
                         ScrollEvent e)

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

Specified by:

handleScroll in interface MouseHandlerFX

Parameters:

canvas - the canvas (null not permitted).

e - the event (null not permitted).