www.pudn.com > jfreechart-0.9.12.zip > ChartMouseEvent.java

/* ====================================== 
 * JFreeChart : a free Java chart library 
 * ====================================== 
 * 
 * Project Info:  http://www.jfree.org/jfreechart/index.html 
 * Project Lead:  David Gilbert (david.gilbert@object-refinery.com); 
 * 
 * (C) Copyright 2000-2003, by Object Refinery Limited and Contributors. 
 * 
 * This library is free software; you can redistribute it and/or modify it under the terms 
 * of the GNU Lesser General Public License as published by the Free Software Foundation; 
 * either version 2.1 of the License, or (at your option) any later version. 
 * 
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 * See the GNU Lesser General Public License for more details. 
 * 
 * You should have received a copy of the GNU Lesser General Public License along with this 
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, 
 * Boston, MA 02111-1307, USA. 
 * 
 * -------------------- 
 * ChartMouseEvent.java 
 * -------------------- 
 * (C) Copyright 2002, 2003, by Object Refinery Limited and Contributors. 
 * 
 * Original Author:  David Gilbert (for Object Refinery Limited); 
 * Contributor(s):   Alex Weber; 
 * 
 * $Id: ChartMouseEvent.java,v 1.3 2003/06/12 16:53:57 mungady Exp $ 
 * 
 * Changes 
 * ------- 
 * 27-May-2002 : Version 1, incorporating code and ideas by Alex Weber (DG); 
 * 13-Jun-2002 : Added Javadoc comments (DG); 
 * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG); 
 * 05-Nov-2002 : Added a reference to the source chart (DG); 
 * 
 */ 
 
package org.jfree.chart; 
 
import java.awt.event.MouseEvent; 
 
import org.jfree.chart.entity.ChartEntity; 
 
/** 
 * A mouse event for a chart that is displayed in a ChartPanel. 
 * 
 * @author David Gilbert 
 */ 
public class ChartMouseEvent { 
 
    /** The chart that the mouse event relates to. */ 
    private JFreeChart chart; 
 
    /** The Java mouse event that triggered this event. */ 
    private MouseEvent trigger; 
 
    /** The chart entity (if any). */ 
    private ChartEntity entity; 
 
    /** 
     * Constructs a new event. 
     * 
     * @param chart  the source chart. 
     * @param trigger  the mouse event that triggered this event. 
     * @param entity  the chart entity (if any) under the mouse point. 
     */ 
    public ChartMouseEvent(JFreeChart chart, MouseEvent trigger, ChartEntity entity) { 
        this.chart = chart; 
        this.trigger = trigger; 
        this.entity = entity; 
    } 
 
    /** 
     * Returns the chart that the mouse event relates to. 
     * 
     * @return the chart. 
     */ 
    public JFreeChart getChart() { 
        return this.chart; 
    } 
 
    /** 
     * Returns the mouse event that triggered this event. 
     * 
     * @return the event. 
     */ 
    public MouseEvent getTrigger() { 
        return this.trigger; 
    } 
 
    /** 
     * Returns the chart entity (if any) under the mouse point. 
     * 
     * @return the chart entity. 
     */ 
    public ChartEntity getEntity() { 
        return this.entity; 
    } 
 
}