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 * Changes: 036 * -------- 037 * 07-Oct-2003 : Version 1 (DG); 038 * 09-Jun-2005 : Added a convenience method to access the entity 039 * collection (DG); 040 * 041 */ 042 043package org.jfree.chart.renderer; 044 045import org.jfree.chart.ChartRenderingInfo; 046import org.jfree.chart.entity.EntityCollection; 047import org.jfree.chart.plot.PlotRenderingInfo; 048 049/** 050 * Represents the current state of a renderer. 051 */ 052public class RendererState { 053 054 /** The plot rendering info. */ 055 private PlotRenderingInfo info; 056 057 /** 058 * A flag that indicates whether or not rendering hints should be added to 059 * identify chart elements. It is initialised from the corresponding flag 060 * in the JFreeChart instance. 061 */ 062 private boolean elementHinting; 063 064 /** 065 * Creates a new state object. 066 * 067 * @param info the plot rendering info. 068 */ 069 public RendererState(PlotRenderingInfo info) { 070 this.info = info; 071 this.elementHinting = false; 072 } 073 074 /** 075 * Returns the flag that controls whether or not the renderer should 076 * add rendering hints to the output that identify chart elements. 077 * 078 * @return A boolean. 079 * 080 * @since 1.0.20 081 */ 082 public boolean getElementHinting() { 083 return this.elementHinting; 084 } 085 086 /** 087 * Sets the elementHinting flag. 088 * 089 * @param hinting the new flag value. 090 * 091 * @since 1.0.20 092 */ 093 public void setElementHinting(boolean hinting) { 094 this.elementHinting = hinting; 095 } 096 097 /** 098 * Returns the plot rendering info. 099 * 100 * @return The info. 101 */ 102 public PlotRenderingInfo getInfo() { 103 return this.info; 104 } 105 106 /** 107 * A convenience method that returns a reference to the entity 108 * collection (may be {@code null}) being used to record 109 * chart entities. 110 * 111 * @return The entity collection (possibly {@code null}). 112 */ 113 public EntityCollection getEntityCollection() { 114 EntityCollection result = null; 115 if (this.info != null) { 116 ChartRenderingInfo owner = this.info.getOwner(); 117 if (owner != null) { 118 result = owner.getEntityCollection(); 119 } 120 } 121 return result; 122 } 123 124}