Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.plot

Class PlotRenderingInfo

Implemented Interfaces:
Cloneable, Serializable
public class PlotRenderingInfo
extends java.lang.Object
implements Cloneable, Serializable
Stores information about the dimensions of a plot and its subplots.

Constructor Summary

PlotRenderingInfo(ChartRenderingInfo owner)
Creates a new instance.

Method Summary

void
addSubplotInfo(PlotRenderingInfo info)
Adds the info for a subplot.
Object
clone()
Returns a clone of this object.
boolean
equals(Object obj)
Tests this instance for equality against an arbitrary object.
Rectangle2D
getDataArea()
Returns the plot's data area (in Java2D space).
ChartRenderingInfo
getOwner()
Returns the owner (as specified in the constructor).
Rectangle2D
getPlotArea()
Returns the plot area (in Java2D space).
int
getSubplotCount()
Returns the number of subplots (possibly zero).
int
getSubplotIndex(Point2D source)
Returns the index of the subplot that contains the specified (x, y) point (the "source" point).
PlotRenderingInfo
getSubplotInfo(int index)
Returns the info for a subplot.
void
setDataArea(Rectangle2D area)
Sets the data area.
void
setPlotArea(Rectangle2D area)
Sets the plot area.

Constructor Details

PlotRenderingInfo

public PlotRenderingInfo(ChartRenderingInfo owner)
Creates a new instance.
Parameters:
owner - the owner (null permitted).

Method Details

addSubplotInfo

public void addSubplotInfo(PlotRenderingInfo info)
Adds the info for a subplot.
Parameters:
info - the subplot info.
See Also:
getSubplotInfo(int)

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this object.
Returns:
A clone.

equals

public boolean equals(Object obj)
Tests this instance for equality against an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getDataArea

public Rectangle2D getDataArea()
Returns the plot's data area (in Java2D space).
Returns:
The data area (possibly null).
See Also:
setDataArea(Rectangle2D)

getOwner

public ChartRenderingInfo getOwner()
Returns the owner (as specified in the constructor).
Returns:
The owner (possibly null).

getPlotArea

public Rectangle2D getPlotArea()
Returns the plot area (in Java2D space).
Returns:
The plot area (possibly null).
See Also:
setPlotArea(Rectangle2D)

getSubplotCount

public int getSubplotCount()
Returns the number of subplots (possibly zero).
Returns:
The subplot count.

getSubplotIndex

public int getSubplotIndex(Point2D source)
Returns the index of the subplot that contains the specified (x, y) point (the "source" point). The source point will usually come from a mouse click on a ChartPanel, and this method is then used to determine the subplot that contains the source point.
Parameters:
source - the source point (in Java2D space).
Returns:
The subplot index (or -1 if no subplot contains the point).

getSubplotInfo

public PlotRenderingInfo getSubplotInfo(int index)
Returns the info for a subplot.
Parameters:
index - the subplot index.
Returns:
The info.
See Also:
addSubplotInfo(PlotRenderingInfo)

setDataArea

public void setDataArea(Rectangle2D area)
Sets the data area.
Parameters:
area - the data area (in Java2D space, null permitted but discouraged).
See Also:
getDataArea()

setPlotArea

public void setPlotArea(Rectangle2D area)
Sets the plot area.
Parameters:
area - the plot area (in Java2D space, null permitted but discouraged)
See Also:
getPlotArea()

Overview Package Class Use Source Tree Index Deprecated About