public class

ChartRenderingInfo

extends Object
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.ChartRenderingInfo

Class Overview

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.

Summary

Public Constructors
ChartRenderingInfo()
Constructs a new ChartRenderingInfo structure that can be used to collect information about the dimensions of a rendered chart.
ChartRenderingInfo(EntityCollection entities)
Constructs a new instance.
Public Methods
void clear()
Clears the information recorded by this object.
Object clone()
Returns a clone of this object.
boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
Rectangle2D getChartArea()
Returns the area in which the chart was drawn.
EntityCollection getEntityCollection()
Returns the collection of entities maintained by this instance.
PlotRenderingInfo getPlotInfo()
Returns the rendering info for the chart's plot.
void setChartArea(Rectangle2D area)
Sets the area in which the chart was drawn.
void setEntityCollection(EntityCollection entities)
Sets the entity collection.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ChartRenderingInfo ()

Constructs a new ChartRenderingInfo structure that can be used to collect information about the dimensions of a rendered chart.

public ChartRenderingInfo (EntityCollection entities)

Constructs a new instance. 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.

Parameters
entities an entity collection (null permitted).

Public Methods

public void clear ()

Clears the information recorded by this object.

public Object clone ()

Returns a clone of this object.

Returns
  • A clone.
Throws
CloneNotSupportedException if the object cannot be cloned.

public boolean equals (Object obj)

Tests this object for equality with an arbitrary object.

Parameters
obj the object to test against (null permitted).
Returns
  • A boolean.

public Rectangle2D getChartArea ()

Returns the area in which the chart was drawn.

Returns
  • The area in which the chart was drawn.
See Also

public EntityCollection getEntityCollection ()

Returns the collection of entities maintained by this instance.

Returns
  • The entity collection (possibly null).
See Also

public PlotRenderingInfo getPlotInfo ()

Returns the rendering info for the chart's plot.

Returns
  • The rendering info for the plot.

public void setChartArea (Rectangle2D area)

Sets the area in which the chart was drawn.

Parameters
area the chart area.
See Also

public void setEntityCollection (EntityCollection entities)

Sets the entity collection.

Parameters
entities the entity collection (null permitted).
See Also