001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert 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 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * --------------------
028 * ChartMouseEvent.java
029 * --------------------
030 * (C) Copyright 2002-present, by David Gilbert and Contributors.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   Alex Weber;
034 *
035 */
036
037package org.jfree.chart;
038
039import java.awt.event.MouseEvent;
040import java.io.Serializable;
041import java.util.EventObject;
042
043import org.jfree.chart.entity.ChartEntity;
044
045/**
046 * A mouse event for a chart that is displayed in a {@link ChartPanel}.
047 *
048 * @see ChartMouseListener
049 */
050public class ChartMouseEvent extends EventObject implements Serializable {
051
052    /** For serialization. */
053    private static final long serialVersionUID = -682393837314562149L;
054
055    /** The chart that the mouse event relates to. */
056    private final JFreeChart chart;
057
058    /** The Java mouse event that triggered this event. */
059    private final MouseEvent trigger;
060
061    /** The chart entity (if any). */
062    private final ChartEntity entity;
063
064    /**
065     * Constructs a new event.
066     *
067     * @param chart  the source chart ({@code null} not permitted).
068     * @param trigger  the mouse event that triggered this event
069     *                 ({@code null} not permitted).
070     * @param entity  the chart entity (if any) under the mouse point
071     *                ({@code null} permitted).
072     */
073    public ChartMouseEvent(JFreeChart chart, MouseEvent trigger,
074                           ChartEntity entity) {
075        super(chart);
076        this.chart = chart;
077        this.trigger = trigger;
078        this.entity = entity;
079    }
080
081    /**
082     * Returns the chart that the mouse event relates to.
083     *
084     * @return The chart (never {@code null}).
085     */
086    public JFreeChart getChart() {
087        return this.chart;
088    }
089
090    /**
091     * Returns the mouse event that triggered this event.
092     *
093     * @return The event (never {@code null}).
094     */
095    public MouseEvent getTrigger() {
096        return this.trigger;
097    }
098
099    /**
100     * Returns the chart entity (if any) under the mouse point.
101     *
102     * @return The chart entity (possibly {@code null}).
103     */
104    public ChartEntity getEntity() {
105        return this.entity;
106    }
107
108}