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