org.jfree.chart.fx.interaction

Class ChartMouseEventFX

java.lang.Object

java.util.EventObject

org.jfree.chart.fx.interaction.ChartMouseEventFX

All Implemented Interfaces:

Serializable

public class ChartMouseEventFX
extends EventObject
implements Serializable

A mouse event for a chart that is displayed in a (JavaFX) ChartViewer.

Since:

1.0.18

See Also:

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.

, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChartMouseEventFX(JFreeChart chart, MouseEvent trigger, ChartEntity entity) Constructs a new event.

Method Summary

Modifier and Type	Method and Description
JFreeChart	getChart() Returns the chart that the mouse event relates to.
ChartEntity	getEntity() Returns the chart entity (if any) under the mouse point.
MouseEvent	getTrigger() Returns the mouse event that triggered this event.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartMouseEventFX

public ChartMouseEventFX(JFreeChart chart,
                         MouseEvent trigger,
                         ChartEntity entity)

Constructs a new event.

Parameters:

chart - the source chart (null not permitted).

trigger - the mouse event that triggered this event (null not permitted).

entity - the chart entity (if any) under the mouse point (null permitted).

Method Detail

getChart

public JFreeChart getChart()

Returns the chart that the mouse event relates to.

Returns:

The chart (never null).

getTrigger

public MouseEvent getTrigger()

Returns the mouse event that triggered this event.

Returns:

The event (never null).

getEntity

public ChartEntity getEntity()

Returns the chart entity (if any) under the mouse point.

Returns:

The chart entity (possibly null).