Source for org.jfree.chart.ChartMouseEvent

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * --------------------
  28:  * ChartMouseEvent.java
  29:  * --------------------
  30:  * (C) Copyright 2002-2007, by Object Refinery Limited and Contributors.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   Alex Weber;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 27-May-2002 : Version 1, incorporating code and ideas by Alex Weber (DG);
  38:  * 13-Jun-2002 : Added Javadoc comments (DG);
  39:  * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG);
  40:  * 05-Nov-2002 : Added a reference to the source chart (DG);
  41:  * 13-Jul-2004 : Now extends EventObject and implements Serializable (DG);
  42:  * ------------- JFREECHART 1.0.x ---------------------------------------------
  43:  * 24-May-2007 : Updated API docs (DG);
  44:  *
  45:  */
  46: 
  47: package org.jfree.chart;
  48: 
  49: import java.awt.event.MouseEvent;
  50: import java.io.Serializable;
  51: import java.util.EventObject;
  52: 
  53: import org.jfree.chart.entity.ChartEntity;
  54: 
  55: /**
  56:  * A mouse event for a chart that is displayed in a {@link ChartPanel}.
  57:  * 
  58:  * @see ChartMouseListener
  59:  */
  60: public class ChartMouseEvent extends EventObject implements Serializable {
  61: 
  62:     /** For serialization. */
  63:     private static final long serialVersionUID = -682393837314562149L;
  64:     
  65:     /** The chart that the mouse event relates to. */
  66:     private JFreeChart chart;
  67: 
  68:     /** The Java mouse event that triggered this event. */
  69:     private MouseEvent trigger;
  70: 
  71:     /** The chart entity (if any). */
  72:     private ChartEntity entity;
  73: 
  74:     /**
  75:      * Constructs a new event.
  76:      *
  77:      * @param chart  the source chart (<code>null</code> not permitted).
  78:      * @param trigger  the mouse event that triggered this event 
  79:      *                 (<code>null</code> not permitted).
  80:      * @param entity  the chart entity (if any) under the mouse point 
  81:      *                (<code>null</code> permitted).
  82:      */
  83:     public ChartMouseEvent(JFreeChart chart, MouseEvent trigger, 
  84:                            ChartEntity entity) {
  85:         super(chart);
  86:         this.chart = chart;
  87:         this.trigger = trigger;
  88:         this.entity = entity;
  89:     }
  90: 
  91:     /**
  92:      * Returns the chart that the mouse event relates to.
  93:      *
  94:      * @return The chart (never <code>null</code>).
  95:      */
  96:     public JFreeChart getChart() {
  97:         return this.chart;
  98:     }
  99: 
 100:     /**
 101:      * Returns the mouse event that triggered this event.
 102:      *
 103:      * @return The event (never <code>null</code>).
 104:      */
 105:     public MouseEvent getTrigger() {
 106:         return this.trigger;
 107:     }
 108: 
 109:     /**
 110:      * Returns the chart entity (if any) under the mouse point.
 111:      *
 112:      * @return The chart entity (possibly <code>null</code>).
 113:      */
 114:     public ChartEntity getEntity() {
 115:         return this.entity;
 116:     }
 117: 
 118: }