001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2014, 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 * [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 * ChartMouseEventFX.java
029 * ----------------------
030 * (C) Copyright 2014, by Object Refinery Limited and Contributors.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * Changes:
036 * --------
037 * 25-Jun-2014 : Version 1 (DG);
038 *
039 */
040
041package org.jfree.chart.fx.interaction;
042
043import java.io.Serializable;
044import java.util.EventObject;
045import javafx.scene.input.MouseEvent;
046import org.jfree.chart.JFreeChart;
047import org.jfree.chart.entity.ChartEntity;
048import org.jfree.chart.fx.ChartViewer;
049
050/**
051 * A mouse event for a chart that is displayed in a (JavaFX) 
052 * {@link ChartViewer}.
053 *
054 * @see ChartMouseListenerFX
055 * 
056 * <p>THE API FOR THIS CLASS IS SUBJECT TO CHANGE IN FUTURE RELEASES.  This is
057 * so that we can incorporate feedback on the (new) JavaFX support in 
058 * JFreeChart.</p>
059 * 
060 * @since 1.0.18
061 */
062public class ChartMouseEventFX extends EventObject implements Serializable {
063
064    /** For serialization. */
065    private static final long serialVersionUID = -682393837314562149L;
066
067    /** The chart that the mouse event relates to. */
068    private JFreeChart chart;
069
070    /** The Java mouse event that triggered this event. */
071    private MouseEvent trigger;
072
073    /** The chart entity (if any). */
074    private ChartEntity entity;
075
076    /**
077     * Constructs a new event.
078     *
079     * @param chart  the source chart ({@code null} not permitted).
080     * @param trigger  the mouse event that triggered this event
081     *                 ({@code null} not permitted).
082     * @param entity  the chart entity (if any) under the mouse point
083     *                ({@code null} permitted).
084     */
085    public ChartMouseEventFX(JFreeChart chart, MouseEvent trigger,
086                           ChartEntity entity) {
087        super(chart);
088        this.chart = chart;
089        this.trigger = trigger;
090        this.entity = entity;
091    }
092
093    /**
094     * Returns the chart that the mouse event relates to.
095     *
096     * @return The chart (never {@code null}).
097     */
098    public JFreeChart getChart() {
099        return this.chart;
100    }
101
102    /**
103     * Returns the mouse event that triggered this event.
104     *
105     * @return The event (never {@code null}).
106     */
107    public MouseEvent getTrigger() {
108        return this.trigger;
109    }
110
111    /**
112     * Returns the chart entity (if any) under the mouse point.
113     *
114     * @return The chart entity (possibly {@code null}).
115     */
116    public ChartEntity getEntity() {
117        return this.entity;
118    }
119
120}