001 /* =========================================================== 002 * JFreeChart : a free chart library for the Java(tm) platform 003 * =========================================================== 004 * 005 * (C) Copyright 2000-2005, 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-2005, 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.1 2005/10/25 16:50:20 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 * 045 */ 046 047 package org.jfree.chart; 048 049 import java.awt.event.MouseEvent; 050 import java.io.Serializable; 051 import java.util.EventObject; 052 053 import org.jfree.chart.entity.ChartEntity; 054 055 /** 056 * A mouse event for a chart that is displayed in a {@link ChartPanel}. 057 */ 058 public class ChartMouseEvent extends EventObject implements Serializable { 059 060 /** For serialization. */ 061 private static final long serialVersionUID = -682393837314562149L; 062 063 /** The chart that the mouse event relates to. */ 064 private JFreeChart chart; 065 066 /** The Java mouse event that triggered this event. */ 067 private MouseEvent trigger; 068 069 /** The chart entity (if any). */ 070 private ChartEntity entity; 071 072 /** 073 * Constructs a new event. 074 * 075 * @param chart the source chart (<code>null</code> not permitted). 076 * @param trigger the mouse event that triggered this event 077 * (<code>null</code> not permitted). 078 * @param entity the chart entity (if any) under the mouse point 079 * (<code>null</code> permitted). 080 */ 081 public ChartMouseEvent(JFreeChart chart, MouseEvent trigger, 082 ChartEntity entity) { 083 super(chart); 084 this.chart = chart; 085 this.trigger = trigger; 086 this.entity = entity; 087 } 088 089 /** 090 * Returns the chart that the mouse event relates to. 091 * 092 * @return The chart (never <code>null</code>). 093 */ 094 public JFreeChart getChart() { 095 return this.chart; 096 } 097 098 /** 099 * Returns the mouse event that triggered this event. 100 * 101 * @return The event (never <code>null</code>). 102 */ 103 public MouseEvent getTrigger() { 104 return this.trigger; 105 } 106 107 /** 108 * Returns the chart entity (if any) under the mouse point. 109 * 110 * @return The chart entity (possibly <code>null</code>). 111 */ 112 public ChartEntity getEntity() { 113 return this.entity; 114 } 115 116 }