Source for org.jfree.chart.event.MarkerChangeEvent

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * ----------------------
  28:  * MarkerChangeEvent.java
  29:  * ----------------------
  30:  * (C) Copyright 2006, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: MarkerChangeEvent.java,v 1.1.2.3 2006/10/25 14:49:30 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 05-Sep-2006 : Version 1 (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.chart.event;
  44: 
  45: import org.jfree.chart.plot.Marker;
  46: 
  47: /**
  48:  * An event that can be forwarded to any {@link MarkerChangeListener} to 
  49:  * signal a change to a {@link Marker}.
  50:  * 
  51:  * @since 1.0.3
  52:  */
  53: public class MarkerChangeEvent extends ChartChangeEvent {
  54: 
  55:     /** The plot that generated the event. */
  56:     private Marker marker;
  57: 
  58:     /**
  59:      * Creates a new <code>MarkerChangeEvent</code> instance.
  60:      *
  61:      * @param marker  the marker that triggered the event (<code>null</code> 
  62:      *     not permitted).
  63:      * 
  64:      * @since 1.0.3
  65:      */
  66:     public MarkerChangeEvent(Marker marker) {
  67:         super(marker);
  68:         this.marker = marker;
  69:     }
  70: 
  71:     /**
  72:      * Returns the marker that triggered the event.
  73:      *
  74:      * @return The marker that triggered the event (never <code>null</code>).
  75:      * 
  76:      * @since 1.0.3
  77:      */
  78:     public Marker getMarker() {
  79:         return this.marker;
  80:     }
  81: 
  82: }