001: /* ===========================================================
002: * JFreeChart : a free chart library for the Java(tm) platform
003: * ===========================================================
004: *
005: * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
006: *
007: * Project Info: http://www.jfree.org/jfreechart/index.html
008: *
009: * This library is free software; you can redistribute it and/or modify it
010: * under the terms of the GNU Lesser General Public License as published by
011: * the Free Software Foundation; either version 2.1 of the License, or
012: * (at your option) any later version.
013: *
014: * This library is distributed in the hope that it will be useful, but
015: * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016: * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017: * License for more details.
018: *
019: * You should have received a copy of the GNU Lesser General Public
020: * License along with this library; if not, write to the Free Software
021: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
022: * USA.
023: *
024: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025: * in the United States and other countries.]
026: *
027: * --------------------
028: * ChartMouseEvent.java
029: * --------------------
030: * (C) Copyright 2002-2007, by Object Refinery Limited and Contributors.
031: *
032: * Original Author: David Gilbert (for Object Refinery Limited);
033: * Contributor(s): Alex Weber;
034: *
035: * $Id: ChartMouseEvent.java,v 1.3.2.2 2007/05/24 09:30:37 mungady Exp $
036: *
037: * Changes
038: * -------
039: * 27-May-2002 : Version 1, incorporating code and ideas by Alex Weber (DG);
040: * 13-Jun-2002 : Added Javadoc comments (DG);
041: * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG);
042: * 05-Nov-2002 : Added a reference to the source chart (DG);
043: * 13-Jul-2004 : Now extends EventObject and implements Serializable (DG);
044: * ------------- JFREECHART 1.0.x ---------------------------------------------
045: * 24-May-2007 : Updated API docs (DG);
046: *
047: */
048:
049: package org.jfree.chart;
050:
051: import java.awt.event.MouseEvent;
052: import java.io.Serializable;
053: import java.util.EventObject;
054:
055: import org.jfree.chart.entity.ChartEntity;
056:
057: /**
058: * A mouse event for a chart that is displayed in a {@link ChartPanel}.
059: *
060: * @see ChartMouseListener
061: */
062: public class ChartMouseEvent extends EventObject implements
063: Serializable {
064:
065: /** For serialization. */
066: private static final long serialVersionUID = -682393837314562149L;
067:
068: /** The chart that the mouse event relates to. */
069: private JFreeChart chart;
070:
071: /** The Java mouse event that triggered this event. */
072: private MouseEvent trigger;
073:
074: /** The chart entity (if any). */
075: private ChartEntity entity;
076:
077: /**
078: * Constructs a new event.
079: *
080: * @param chart the source chart (<code>null</code> not permitted).
081: * @param trigger the mouse event that triggered this event
082: * (<code>null</code> not permitted).
083: * @param entity the chart entity (if any) under the mouse point
084: * (<code>null</code> permitted).
085: */
086: public ChartMouseEvent(JFreeChart chart, MouseEvent trigger,
087: ChartEntity entity) {
088: super (chart);
089: this .chart = chart;
090: this .trigger = trigger;
091: this .entity = entity;
092: }
093:
094: /**
095: * Returns the chart that the mouse event relates to.
096: *
097: * @return The chart (never <code>null</code>).
098: */
099: public JFreeChart getChart() {
100: return this .chart;
101: }
102:
103: /**
104: * Returns the mouse event that triggered this event.
105: *
106: * @return The event (never <code>null</code>).
107: */
108: public MouseEvent getTrigger() {
109: return this .trigger;
110: }
111:
112: /**
113: * Returns the chart entity (if any) under the mouse point.
114: *
115: * @return The chart entity (possibly <code>null</code>).
116: */
117: public ChartEntity getEntity() {
118: return this.entity;
119: }
120:
121: }
|