Source for org.jfree.chart.renderer.RendererState

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, 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:  * RendererState.java
  29:  * ------------------
  30:  * (C) Copyright 2003-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes:
  36:  * --------
  37:  * 07-Oct-2003 : Version 1 (DG);
  38:  * 09-Jun-2005 : Added a convenience method to access the entity 
  39:  *               collection (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.chart.renderer;
  44: 
  45: import org.jfree.chart.ChartRenderingInfo;
  46: import org.jfree.chart.entity.EntityCollection;
  47: import org.jfree.chart.plot.PlotRenderingInfo;
  48: 
  49: /**
  50:  * Represents the current state of a renderer.
  51:  */
  52: public class RendererState {
  53:     
  54:     /** The plot rendering info. */
  55:     private PlotRenderingInfo info;
  56:     
  57:     /**
  58:      * Creates a new state object.
  59:      * 
  60:      * @param info  the plot rendering info.
  61:      */
  62:     public RendererState(PlotRenderingInfo info) {
  63:         this.info = info;
  64:     }
  65:     
  66:     /**
  67:      * Returns the plot rendering info.
  68:      * 
  69:      * @return The info.
  70:      */
  71:     public PlotRenderingInfo getInfo() {
  72:         return this.info;
  73:     }
  74:     
  75:     /**
  76:      * A convenience method that returns a reference to the entity
  77:      * collection (may be <code>null</code>) being used to record
  78:      * chart entities.
  79:      * 
  80:      * @return The entity collection (possibly <code>null</code>).
  81:      */
  82:     public EntityCollection getEntityCollection() {
  83:         EntityCollection result = null;
  84:         if (this.info != null) {
  85:             ChartRenderingInfo owner = this.info.getOwner();
  86:             if (owner != null) {
  87:                 result = owner.getEntityCollection(); 
  88:             }
  89:         }
  90:         return result;
  91:     }
  92:     
  93: }