www.pudn.com > jfreechart-0.9.12.zip > ChartRenderingInfo.java

/* ====================================== 
 * JFreeChart : a free Java chart library 
 * ====================================== 
 * 
 * Project Info:  http://www.jfree.org/jfreechart/index.html 
 * Project Lead:  David Gilbert (david.gilbert@object-refinery.com); 
 * 
 * (C) Copyright 2000-2003, by Object Refinery Limited and Contributors. 
 * 
 * This library is free software; you can redistribute it and/or modify it under the terms 
 * of the GNU Lesser General Public License as published by the Free Software Foundation; 
 * either version 2.1 of the License, or (at your option) any later version. 
 * 
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 * See the GNU Lesser General Public License for more details. 
 * 
 * You should have received a copy of the GNU Lesser General Public License along with this 
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, 
 * Boston, MA 02111-1307, USA. 
 * 
 * ----------------------- 
 * ChartRenderingInfo.java 
 * ----------------------- 
 * (C) Copyright 2002, 2003, by Object Refinery Limited. 
 * 
 * Original Author:  David Gilbert (for Object Refinery Limited); 
 * Contributor(s):   -; 
 * 
 * $Id: ChartRenderingInfo.java,v 1.4 2003/09/09 10:14:33 mungady Exp $ 
 * 
 * Changes 
 * ------- 
 * 22-Jan-2002 : Version 1 (DG); 
 * 05-Feb-2002 : Added a new constructor, completed Javadoc comments (DG); 
 * 05-Mar-2002 : Added a clear() method (DG); 
 * 23-May-2002 : Renamed DrawInfo --> ChartRenderingInfo (DG); 
 * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG); 
 * 
 */ 
 
package org.jfree.chart; 
 
import java.awt.geom.Rectangle2D; 
 
import org.jfree.chart.entity.EntityCollection; 
import org.jfree.chart.entity.StandardEntityCollection; 
 
/** 
 * A structure for storing rendering information from one call to the 
 * JFreeChart.draw(...) method. 
 * 
 
 * An instance of the {@link JFreeChart} class can draw itself within an arbitrary 
 * rectangle on any Graphics2D.  It is assumed that client code will sometimes 
 * render the same chart in more than one view, so the {@link JFreeChart} instance does 
 * not retain any information about its rendered dimensions.  This information 
 * can be useful sometimes, so you have the option to collect the information 
 * at each call to JFreeChart.draw(...), by passing an instance of this 
 * ChartRenderingInfo class. 
 * 
 * @author David Gilbert 
 */ 
public class ChartRenderingInfo { 
 
    /** The area in which the chart is drawn. */ 
    private Rectangle2D chartArea; 
 
    /** The area in which the plot and axes are drawn. */ 
    private Rectangle2D plotArea; 
 
    /** The area in which the data is plotted. */ 
    private Rectangle2D dataArea; 
 
    /**  
     * Storage for the chart entities.  Since retaining entity information for charts with a 
     * large number of data points consumes a lot of memory, it is intended that you can set 
     * this to null to prevent the information being collected. 
     */ 
    private EntityCollection entities; 
 
    /** 
     * Constructs a new ChartRenderingInfo structure that can be used to collect information 
     * about the dimensions of a rendered chart. 
     */ 
    public ChartRenderingInfo() { 
        this(new StandardEntityCollection()); 
    } 
 
    /** 
     * Constructs a new ChartRenderingInfo structure. 
     * 
 
     * If an entity collection is supplied, it will be populated with information about the 
     * entities in a chart.  If it is null, no entity information (including tool tips) will 
     * be collected. 
     * 
     * @param entities  an entity collection (null permitted). 
     */ 
    public ChartRenderingInfo(EntityCollection entities) { 
 
        this.chartArea = new Rectangle2D.Double(); 
        this.plotArea = new Rectangle2D.Double(); 
        this.dataArea = new Rectangle2D.Double(); 
 
        this.entities = entities; 
 
    } 
 
    /** 
     * Returns the area in which the chart was drawn. 
     * 
     * @return the area in which the chart was drawn. 
     */ 
    public Rectangle2D getChartArea() { 
        return this.chartArea; 
    } 
 
    /** 
     * Sets the area in which the chart was drawn. 
     * 
     * @param area  the chart area. 
     */ 
    public void setChartArea(Rectangle2D area) { 
        chartArea.setRect(area); 
    } 
 
    /** 
     * Returns the area in which the plot (and axes, if any) were drawn. 
     * 
     * @return the plot area. 
     */ 
    public Rectangle2D getPlotArea() { 
        return this.plotArea; 
    } 
 
    /** 
     * Sets the area in which the plot and axes were drawn. 
     * 
     * @param area  the plot area. 
     */ 
    public void setPlotArea(Rectangle2D area) { 
        plotArea.setRect(area); 
    } 
 
    /** 
     * Returns the area in which the data was plotted. 
     * 
     * @return the data area. 
     */ 
    public Rectangle2D getDataArea() { 
        return this.dataArea; 
    } 
 
    /** 
     * Sets the area in which the data has been plotted. 
     * 
     * @param area  the data area. 
     */ 
    public void setDataArea(Rectangle2D area) { 
        dataArea.setRect(area); 
    } 
 
    /** 
     * Returns the collection of entities maintained by this instance. 
     * 
     * @return The entity collection (possibly null. 
     */ 
    public EntityCollection getEntityCollection() { 
        return this.entities; 
    } 
 
    /** 
     * Sets the entity collection. 
     * 
     * @param entities  the entity collection (null permitted). 
     */ 
    public void setEntityCollection(EntityCollection entities) { 
        this.entities = entities; 
    } 
 
    /** 
     * Clears the information recorded by this object. 
     */ 
    public void clear() { 
 
        this.chartArea.setRect(0.0, 0.0, 0.0, 0.0); 
        this.plotArea.setRect(0.0, 0.0, 0.0, 0.0); 
        this.dataArea.setRect(0.0, 0.0, 0.0, 0.0); 
        if (this.entities != null) { 
            this.entities.clear(); 
        } 
 
    } 
 
}