org.jfree.chart

Class ChartMouseEvent

Implemented Interfaces:
Serializable

public class ChartMouseEvent
extends EventObject
implements Serializable

A mouse event for a chart that is displayed in a ChartPanel.

Constructor Summary

ChartMouseEvent(JFreeChart chart, MouseEvent trigger, ChartEntity entity)
Constructs a new event.

Method Summary

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.

Constructor Details

ChartMouseEvent

public ChartMouseEvent(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 Details

getChart

public JFreeChart getChart()
Returns the chart that the mouse event relates to.
Returns:
The chart (never null).

getEntity

public ChartEntity getEntity()
Returns the chart entity (if any) under the mouse point.
Returns:
The chart entity (possibly null).

getTrigger

public MouseEvent getTrigger()
Returns the mouse event that triggered this event.
Returns:
The event (never null).