org.jfree.chart

Class ChartRenderingInfo

public class ChartRenderingInfo extends Object implements Cloneable, Serializable

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.

Constructor Summary
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.
Method Summary
voidclear()
Clears the information recorded by this object.
Objectclone()
Returns a clone of this object.
booleanequals(Object obj)
Tests this object for equality with an arbitrary object.
Rectangle2DgetChartArea()
Returns the area in which the chart was drawn.
EntityCollectiongetEntityCollection()
Returns the collection of entities maintained by this instance.
PlotRenderingInfogetPlotInfo()
Returns the rendering info for the chart's plot.
voidsetChartArea(Rectangle2D area)
Sets the area in which the chart was drawn.
voidsetEntityCollection(EntityCollection entities)
Sets the entity collection.

Constructor Detail

ChartRenderingInfo

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

ChartRenderingInfo

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).

Method Detail

clear

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

clone

public Object clone()
Returns a clone of this object.

Returns: A clone.

Throws: CloneNotSupportedException if the object cannot be cloned.

equals

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.

getChartArea

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

Returns: The area in which the chart was drawn.

See Also: setChartArea

getEntityCollection

public EntityCollection getEntityCollection()
Returns the collection of entities maintained by this instance.

Returns: The entity collection (possibly null).

See Also: setEntityCollection

getPlotInfo

public PlotRenderingInfo getPlotInfo()
Returns the rendering info for the chart's plot.

Returns: The rendering info for the plot.

setChartArea

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

Parameters: area the chart area.

See Also: getChartArea

setEntityCollection

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

Parameters: entities the entity collection (null permitted).

See Also: getEntityCollection

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.