001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2020, 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 * RendererState.java
029 * ------------------
030 * (C) Copyright 2003-2016, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 */
035
036package org.jfree.chart.renderer;
037
038import org.jfree.chart.ChartRenderingInfo;
039import org.jfree.chart.entity.EntityCollection;
040import org.jfree.chart.plot.PlotRenderingInfo;
041
042/**
043 * Represents the current state of a renderer.
044 */
045public class RendererState {
046
047    /** The plot rendering info. */
048    private PlotRenderingInfo info;
049    
050    /** 
051     * A flag that indicates whether or not rendering hints should be added to
052     * identify chart elements.  It is initialised from the corresponding flag
053     * in the JFreeChart instance.
054     */
055    private boolean elementHinting;
056
057    /**
058     * Creates a new state object.
059     *
060     * @param info  the plot rendering info.
061     */
062    public RendererState(PlotRenderingInfo info) {
063        this.info = info;
064        this.elementHinting = false;
065    }
066    
067    /**
068     * Returns the flag that controls whether or not the renderer should 
069     * add rendering hints to the output that identify chart elements.
070     * 
071     * @return A boolean.
072     * 
073     * @since 1.0.20
074     */
075    public boolean getElementHinting() {
076        return this.elementHinting;
077    }
078    
079    /**
080     * Sets the elementHinting flag.
081     * 
082     * @param hinting  the new flag value.
083     * 
084     * @since 1.0.20
085     */
086    public void setElementHinting(boolean hinting) {
087        this.elementHinting = hinting;
088    }
089
090    /**
091     * Returns the plot rendering info.
092     *
093     * @return The info.
094     */
095    public PlotRenderingInfo getInfo() {
096        return this.info;
097    }
098
099    /**
100     * A convenience method that returns a reference to the entity
101     * collection (may be {@code null}) being used to record
102     * chart entities.
103     *
104     * @return The entity collection (possibly {@code null}).
105     */
106    public EntityCollection getEntityCollection() {
107        EntityCollection result = null;
108        if (this.info != null) {
109            ChartRenderingInfo owner = this.info.getOwner();
110            if (owner != null) {
111                result = owner.getEntityCollection();
112            }
113        }
114        return result;
115    }
116
117}