com.jrefinery.chart
Class ChartRenderingInfo

java.lang.Object
  extended by com.jrefinery.chart.ChartRenderingInfo

public class ChartRenderingInfo
extends java.lang.Object

A structure for storing rendering information from one call to the JFreeChart.draw(...) method.

An instance of the 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 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.


Field Summary
protected  java.awt.geom.Rectangle2D chartArea
          The area in which the chart is drawn.
protected  java.awt.geom.Rectangle2D dataArea
          The area in which the data is plotted.
protected  com.jrefinery.chart.entity.EntityCollection entities
          Storage for the chart entities.
protected  boolean generateToolTips
           
protected  java.awt.geom.Rectangle2D plotArea
          The area in which the plot and axes are drawn.
 
Constructor Summary
ChartRenderingInfo()
          Constructs a new ChartRenderingInfo structure.
ChartRenderingInfo(com.jrefinery.chart.entity.EntityCollection entities)
          Constructs a new ChartRenderingInfo structure.
 
Method Summary
 void clear()
          Clears the information recorded by this object.
 java.awt.geom.Rectangle2D getChartArea()
          Returns the area in which the chart was drawn.
 java.awt.geom.Rectangle2D getDataArea()
          Returns the area in which the data was plotted.
 com.jrefinery.chart.entity.EntityCollection getEntityCollection()
          Returns a collection of entities.
 java.awt.geom.Rectangle2D getPlotArea()
          Returns the area in which the plot (and axes, if any) were drawn.
 boolean isGenerateToolTips()
           
 void setChartArea(java.awt.geom.Rectangle2D area)
          Sets the area in which the chart was drawn.
 void setDataArea(java.awt.geom.Rectangle2D area)
          Sets the area in which the data has been plotted.
 void setEntityCollection(com.jrefinery.chart.entity.EntityCollection entities)
          Sets the entity collection.
 void setGenerateToolTips(boolean flag)
           
 void setPlotArea(java.awt.geom.Rectangle2D area)
          Sets the area in which the plot and axes were drawn.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

chartArea

protected java.awt.geom.Rectangle2D chartArea
The area in which the chart is drawn.


plotArea

protected java.awt.geom.Rectangle2D plotArea
The area in which the plot and axes are drawn.


dataArea

protected java.awt.geom.Rectangle2D dataArea
The area in which the data is plotted.


entities

protected com.jrefinery.chart.entity.EntityCollection entities
Storage for the chart entities.


generateToolTips

protected boolean generateToolTips
Constructor Detail

ChartRenderingInfo

public ChartRenderingInfo()
Constructs a new ChartRenderingInfo structure. By default, no tooltip info will be collected.


ChartRenderingInfo

public ChartRenderingInfo(com.jrefinery.chart.entity.EntityCollection entities)
Constructs a new ChartRenderingInfo structure.

Method Detail

getChartArea

public java.awt.geom.Rectangle2D getChartArea()
Returns the area in which the chart was drawn.

Returns:
The area in which the chart was drawn.

setChartArea

public void setChartArea(java.awt.geom.Rectangle2D area)
Sets the area in which the chart was drawn.

Parameters:
area - The chart area.

getPlotArea

public java.awt.geom.Rectangle2D getPlotArea()
Returns the area in which the plot (and axes, if any) were drawn.

Returns:
The area in which the plot (and axes, if any) were drawn.

setPlotArea

public void setPlotArea(java.awt.geom.Rectangle2D area)
Sets the area in which the plot and axes were drawn.

Parameters:
area - The plot area.

getDataArea

public java.awt.geom.Rectangle2D getDataArea()
Returns the area in which the data was plotted.

Returns:
The area in which the data was plotted.

setDataArea

public void setDataArea(java.awt.geom.Rectangle2D area)
Sets the area in which the data has been plotted.


getEntityCollection

public com.jrefinery.chart.entity.EntityCollection getEntityCollection()
Returns a collection of entities.

Returns:
The entity collection.

setEntityCollection

public void setEntityCollection(com.jrefinery.chart.entity.EntityCollection entities)
Sets the entity collection.

Parameters:
entities - The entity collection.

isGenerateToolTips

public boolean isGenerateToolTips()

setGenerateToolTips

public void setGenerateToolTips(boolean flag)

clear

public void clear()
Clears the information recorded by this object.



Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.