Source for org.jfree.chart.ChartRenderingInfo

   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:  * ChartRenderingInfo.java
  29:  * -----------------------
  30:  * (C) Copyright 2002-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 22-Jan-2002 : Version 1 (DG);
  38:  * 05-Feb-2002 : Added a new constructor, completed Javadoc comments (DG);
  39:  * 05-Mar-2002 : Added a clear() method (DG);
  40:  * 23-May-2002 : Renamed DrawInfo --> ChartRenderingInfo (DG);
  41:  * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG);
  42:  * 17-Sep-2003 : Added PlotRenderingInfo (DG);
  43:  * 01-Nov-2005 : Updated equals() method (DG);
  44:  * 30-Nov-2005 : Removed get/setPlotArea() (DG);
  45:  * ------------- JFREECHART 1.0.x ---------------------------------------------
  46:  * 01-Dec-2006 : Fixed equals() and clone() (DG);
  47:  *
  48:  */
  49: 
  50: package org.jfree.chart;
  51: 
  52: import java.awt.geom.Rectangle2D;
  53: import java.io.IOException;
  54: import java.io.ObjectInputStream;
  55: import java.io.ObjectOutputStream;
  56: import java.io.Serializable;
  57: 
  58: import org.jfree.chart.entity.EntityCollection;
  59: import org.jfree.chart.entity.StandardEntityCollection;
  60: import org.jfree.chart.plot.PlotRenderingInfo;
  61: import org.jfree.io.SerialUtilities;
  62: import org.jfree.util.ObjectUtilities;
  63: import org.jfree.util.PublicCloneable;
  64: 
  65: /**
  66:  * A structure for storing rendering information from one call to the
  67:  * JFreeChart.draw() method.
  68:  * <P>
  69:  * An instance of the {@link JFreeChart} class can draw itself within an 
  70:  * arbitrary rectangle on any <code>Graphics2D</code>.  It is assumed that 
  71:  * client code will sometimes render the same chart in more than one view, so 
  72:  * the {@link JFreeChart} instance does not retain any information about its 
  73:  * rendered dimensions.  This information can be useful sometimes, so you have 
  74:  * the option to collect the information at each call to 
  75:  * <code>JFreeChart.draw()</code>, by passing an instance of this
  76:  * <code>ChartRenderingInfo</code> class.
  77:  */
  78: public class ChartRenderingInfo implements Cloneable, Serializable {
  79: 
  80:     /** For serialization. */
  81:     private static final long serialVersionUID = 2751952018173406822L;
  82:     
  83:     /** The area in which the chart is drawn. */
  84:     private transient Rectangle2D chartArea;
  85: 
  86:     /** Rendering info for the chart's plot (and subplots, if any). */
  87:     private PlotRenderingInfo plotInfo;
  88: 
  89:     /** 
  90:      * Storage for the chart entities.  Since retaining entity information for 
  91:      * charts with a large number of data points consumes a lot of memory, it 
  92:      * is intended that you can set this to <code>null</code> to prevent the 
  93:      * information being collected.
  94:      */
  95:     private EntityCollection entities;
  96: 
  97:     /**
  98:      * Constructs a new ChartRenderingInfo structure that can be used to 
  99:      * collect information about the dimensions of a rendered chart.
 100:      */
 101:     public ChartRenderingInfo() {
 102:         this(new StandardEntityCollection());
 103:     }
 104: 
 105:     /**
 106:      * Constructs a new instance. If an entity collection is supplied, it will 
 107:      * be populated with information about the entities in a chart.  If it is 
 108:      * <code>null</code>, no entity information (including tool tips) will
 109:      * be collected.
 110:      *
 111:      * @param entities  an entity collection (<code>null</code> permitted).
 112:      */
 113:     public ChartRenderingInfo(EntityCollection entities) {
 114:         this.chartArea = new Rectangle2D.Double();
 115:         this.plotInfo = new PlotRenderingInfo(this);
 116:         this.entities = entities;
 117:     }
 118: 
 119:     /**
 120:      * Returns the area in which the chart was drawn.
 121:      *
 122:      * @return The area in which the chart was drawn.
 123:      * 
 124:      * @see #setChartArea(Rectangle2D)
 125:      */
 126:     public Rectangle2D getChartArea() {
 127:         return this.chartArea;
 128:     }
 129: 
 130:     /**
 131:      * Sets the area in which the chart was drawn.
 132:      *
 133:      * @param area  the chart area.
 134:      * 
 135:      * @see #getChartArea()
 136:      */
 137:     public void setChartArea(Rectangle2D area) {
 138:         this.chartArea.setRect(area);
 139:     }
 140: 
 141:     /**
 142:      * Returns the collection of entities maintained by this instance.
 143:      *
 144:      * @return The entity collection (possibly <code>null</code>).
 145:      * 
 146:      * @see #setEntityCollection(EntityCollection)
 147:      */
 148:     public EntityCollection getEntityCollection() {
 149:         return this.entities;
 150:     }
 151: 
 152:     /**
 153:      * Sets the entity collection.
 154:      *
 155:      * @param entities  the entity collection (<code>null</code> permitted).
 156:      * 
 157:      * @see #getEntityCollection()
 158:      */
 159:     public void setEntityCollection(EntityCollection entities) {
 160:         this.entities = entities;
 161:     }
 162: 
 163:     /**
 164:      * Clears the information recorded by this object.
 165:      */
 166:     public void clear() {
 167:         this.chartArea.setRect(0.0, 0.0, 0.0, 0.0);
 168:         this.plotInfo = new PlotRenderingInfo(this);
 169:         if (this.entities != null) {
 170:             this.entities.clear();
 171:         }
 172:     }
 173:   
 174:     /**
 175:      * Returns the rendering info for the chart's plot.
 176:      * 
 177:      * @return The rendering info for the plot.
 178:      */  
 179:     public PlotRenderingInfo getPlotInfo() {
 180:         return this.plotInfo;
 181:     }
 182:     
 183:     /**
 184:      * Tests this object for equality with an arbitrary object.
 185:      * 
 186:      * @param obj  the object to test against (<code>null</code> permitted).
 187:      * 
 188:      * @return A boolean.
 189:      */
 190:     public boolean equals(Object obj) {
 191:         if (obj == this) {
 192:             return true;   
 193:         }
 194:         if (!(obj instanceof ChartRenderingInfo)) {
 195:             return false;
 196:         }
 197:         ChartRenderingInfo that = (ChartRenderingInfo) obj;
 198:         if (!ObjectUtilities.equal(this.chartArea, that.chartArea)) {
 199:             return false;   
 200:         }
 201:         if (!ObjectUtilities.equal(this.plotInfo, that.plotInfo)) {
 202:             return false;
 203:         }
 204:         if (!ObjectUtilities.equal(this.entities, that.entities)) {
 205:             return false;
 206:         }
 207:         return true;
 208:     }
 209:     
 210:     /**
 211:      * Returns a clone of this object.
 212:      * 
 213:      * @return A clone.
 214:      * 
 215:      * @throws CloneNotSupportedException if the object cannot be cloned.
 216:      */
 217:     public Object clone() throws CloneNotSupportedException {
 218:         ChartRenderingInfo clone = (ChartRenderingInfo) super.clone();
 219:         if (this.chartArea != null) {
 220:             clone.chartArea = (Rectangle2D) this.chartArea.clone();
 221:         }
 222:         if (this.entities instanceof PublicCloneable) {
 223:             PublicCloneable pc = (PublicCloneable) this.entities;
 224:             clone.entities = (EntityCollection) pc.clone();
 225:         }
 226:         return clone;
 227:     }
 228: 
 229:     /**
 230:      * Provides serialization support.
 231:      *
 232:      * @param stream  the output stream.
 233:      *
 234:      * @throws IOException  if there is an I/O error.
 235:      */
 236:     private void writeObject(ObjectOutputStream stream) throws IOException {
 237:         stream.defaultWriteObject();
 238:         SerialUtilities.writeShape(this.chartArea, stream);
 239:     }
 240: 
 241:     /**
 242:      * Provides serialization support.
 243:      *
 244:      * @param stream  the input stream.
 245:      *
 246:      * @throws IOException  if there is an I/O error.
 247:      * @throws ClassNotFoundException  if there is a classpath problem.
 248:      */
 249:     private void readObject(ObjectInputStream stream) 
 250:         throws IOException, ClassNotFoundException {
 251:         stream.defaultReadObject();
 252:         this.chartArea = (Rectangle2D) SerialUtilities.readShape(stream);
 253:     }
 254:         
 255: }