001    /* ===========================================================
002     * JFreeChart : a free chart library for the Java(tm) platform
003     * ===========================================================
004     *
005     * (C) Copyright 2000-2005, 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     * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
025     * in the United States and other countries.]
026     *
027     * ------------------
028     * RendererState.java
029     * ------------------
030     * (C) Copyright 2003-2005, by Object Refinery Limited.
031     *
032     * Original Author:  David Gilbert (for Object Refinery Limited);
033     * Contributor(s):   -;
034     *
035     * $Id: RendererState.java,v 1.2.2.2 2005/10/25 20:53:40 mungady Exp $
036     *
037     * Changes:
038     * --------
039     * 07-Oct-2003 : Version 1 (DG);
040     * 09-Jun-2005 : Added a convenience method to access the entity 
041     *               collection (DG);
042     *
043     */
044    
045    package org.jfree.chart.renderer;
046    
047    import org.jfree.chart.ChartRenderingInfo;
048    import org.jfree.chart.entity.EntityCollection;
049    import org.jfree.chart.plot.PlotRenderingInfo;
050    
051    /**
052     * Represents the current state of a renderer.
053     */
054    public class RendererState {
055        
056        /** The plot rendering info. */
057        private PlotRenderingInfo info;
058        
059        /**
060         * Creates a new state object.
061         * 
062         * @param info  the plot rendering info.
063         */
064        public RendererState(PlotRenderingInfo info) {
065            this.info = info;
066        }
067        
068        /**
069         * Returns the plot rendering info.
070         * 
071         * @return The info.
072         */
073        public PlotRenderingInfo getInfo() {
074            return this.info;
075        }
076        
077        /**
078         * A convenience method that returns a reference to the entity
079         * collection (may be <code>null</code>) being used to record
080         * chart entities.
081         * 
082         * @return The entity collection (possibly <code>null</code>).
083         */
084        public EntityCollection getEntityCollection() {
085            EntityCollection result = null;
086            if (this.info != null) {
087                ChartRenderingInfo owner = this.info.getOwner();
088                if (owner != null) {
089                    result = owner.getEntityCollection(); 
090                }
091            }
092            return result;
093        }
094        
095    }