Source for org.jfree.chart.event.ChartChangeEvent

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2005, 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:  * ChartChangeEvent.java
  29:  * ---------------------
  30:  * (C) Copyright 2000-2005, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: ChartChangeEvent.java,v 1.3.2.1 2005/10/25 20:42:25 mungady Exp $
  36:  *
  37:  * Changes (from 24-Aug-2001)
  38:  * --------------------------
  39:  * 24-Aug-2001 : Added standard source header. Fixed DOS encoding problem (DG);
  40:  * 07-Nov-2001 : Updated header (DG);
  41:  *               Change event type names (DG);
  42:  * 09-Oct-2002 : Fixed errors reported by Checkstyle (DG);
  43:  * 18-Feb-2005 : Changed the type from int to ChartChangeEventType (DG);
  44:  *
  45:  */
  46: 
  47: package org.jfree.chart.event;
  48: 
  49: import java.util.EventObject;
  50: 
  51: import org.jfree.chart.JFreeChart;
  52: 
  53: /**
  54:  * A change event that encapsulates information about a change to a chart.
  55:  */
  56: public class ChartChangeEvent extends EventObject {
  57: 
  58:     /** The type of event. */
  59:     private ChartChangeEventType type;
  60: 
  61:     /** The chart that generated the event. */
  62:     private JFreeChart chart;
  63: 
  64:     /**
  65:      * Creates a new chart change event.
  66:      *
  67:      * @param source  the source of the event (could be the chart, a title, 
  68:      *                an axis etc.)
  69:      */
  70:     public ChartChangeEvent(Object source) {
  71:         this(source, null, ChartChangeEventType.GENERAL);
  72:     }
  73: 
  74:     /**
  75:      * Creates a new chart change event.
  76:      *
  77:      * @param source  the source of the event (could be the chart, a title, an 
  78:      *                axis etc.)
  79:      * @param chart  the chart that generated the event.
  80:      */
  81:     public ChartChangeEvent(Object source, JFreeChart chart) {
  82:         this(source, chart, ChartChangeEventType.GENERAL);
  83:     }
  84: 
  85:     /**
  86:      * Creates a new chart change event.
  87:      *
  88:      * @param source  the source of the event (could be the chart, a title, an
  89:                       axis etc.)
  90:      * @param chart  the chart that generated the event.
  91:      * @param type  the type of event.
  92:      */
  93:     public ChartChangeEvent(Object source, JFreeChart chart, 
  94:                             ChartChangeEventType type) {
  95:         super(source);
  96:         this.chart = chart;
  97:         this.type = type;
  98:     }
  99: 
 100:     /**
 101:      * Returns the chart that generated the change event.
 102:      *
 103:      * @return The chart that generated the change event.
 104:      */
 105:     public JFreeChart getChart() {
 106:         return this.chart;
 107:     }
 108: 
 109:     /**
 110:      * Sets the chart that generated the change event.
 111:      *
 112:      * @param chart  the chart that generated the event.
 113:      */
 114:     public void setChart(JFreeChart chart) {
 115:         this.chart = chart;
 116:     }
 117: 
 118:     /**
 119:      * Returns the event type.
 120:      *
 121:      * @return The event type.
 122:      */
 123:     public ChartChangeEventType getType() {
 124:         return this.type;
 125:     }
 126: 
 127:     /**
 128:      * Sets the event type.
 129:      *
 130:      * @param type  the event type.
 131:      */
 132:     public void setType(ChartChangeEventType type) {
 133:         this.type = type;
 134:     }
 135: 
 136: }