org.jfree.chart.axis

Class AxisSpace

public class AxisSpace extends Object implements Cloneable, PublicCloneable, Serializable

A record that contains the space required at each edge of a plot.
Constructor Summary
AxisSpace()
Creates a new axis space record.
Method Summary
voidadd(double space, RectangleEdge edge)
Adds space to the top, bottom, left or right edge of the plot area.
Objectclone()
Returns a clone of the object.
voidensureAtLeast(AxisSpace space)
Ensures that this object reserves at least as much space as another.
voidensureAtLeast(double space, RectangleEdge edge)
Ensures there is a minimum amount of space at the edge corresponding to the specified axis location.
booleanequals(Object obj)
Tests this object for equality with another object.
Rectangle2Dexpand(Rectangle2D area, Rectangle2D result)
Expands an area by the amount of space represented by this object.
doublegetBottom()
Returns the space reserved for axes at the bottom of the plot area.
doublegetLeft()
Returns the space reserved for axes at the left of the plot area.
doublegetRight()
Returns the space reserved for axes at the right of the plot area.
doublegetTop()
Returns the space reserved for axes at the top of the plot area.
inthashCode()
Returns a hash code for this object.
Rectangle2Dreserved(Rectangle2D area, RectangleEdge edge)
Calculates the reserved area.
voidsetBottom(double space)
Sets the space reserved for axes at the bottom of the plot area.
voidsetLeft(double space)
Sets the space reserved for axes at the left of the plot area.
voidsetRight(double space)
Sets the space reserved for axes at the right of the plot area.
voidsetTop(double space)
Sets the space reserved for axes at the top of the plot area.
Rectangle2Dshrink(Rectangle2D area, Rectangle2D result)
Shrinks an area by the space attributes.
StringtoString()
Returns a string representing the object (for debugging purposes).

Constructor Detail

AxisSpace

public AxisSpace()
Creates a new axis space record.

Method Detail

add

public void add(double space, RectangleEdge edge)
Adds space to the top, bottom, left or right edge of the plot area.

Parameters: space the space (in Java2D units). edge the edge (null not permitted).

clone

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

Returns: A clone.

Throws: CloneNotSupportedException This class won't throw this exception, but subclasses (if any) might.

ensureAtLeast

public void ensureAtLeast(AxisSpace space)
Ensures that this object reserves at least as much space as another.

Parameters: space the other space.

ensureAtLeast

public void ensureAtLeast(double space, RectangleEdge edge)
Ensures there is a minimum amount of space at the edge corresponding to the specified axis location.

Parameters: space the space. edge the location.

equals

public boolean equals(Object obj)
Tests this object for equality with another object.

Parameters: obj the object to compare against.

Returns: true or false.

expand

public Rectangle2D expand(Rectangle2D area, Rectangle2D result)
Expands an area by the amount of space represented by this object.

Parameters: area the area to expand. result an optional carrier for the result.

Returns: The result.

getBottom

public double getBottom()
Returns the space reserved for axes at the bottom of the plot area.

Returns: The space (in Java2D units).

getLeft

public double getLeft()
Returns the space reserved for axes at the left of the plot area.

Returns: The space (in Java2D units).

getRight

public double getRight()
Returns the space reserved for axes at the right of the plot area.

Returns: The space (in Java2D units).

getTop

public double getTop()
Returns the space reserved for axes at the top of the plot area.

Returns: The space (in Java2D units).

hashCode

public int hashCode()
Returns a hash code for this object.

Returns: A hash code.

reserved

public Rectangle2D reserved(Rectangle2D area, RectangleEdge edge)
Calculates the reserved area.

Parameters: area the area. edge the edge.

Returns: The reserved area.

setBottom

public void setBottom(double space)
Sets the space reserved for axes at the bottom of the plot area.

Parameters: space the space (in Java2D units).

setLeft

public void setLeft(double space)
Sets the space reserved for axes at the left of the plot area.

Parameters: space the space (in Java2D units).

setRight

public void setRight(double space)
Sets the space reserved for axes at the right of the plot area.

Parameters: space the space (in Java2D units).

setTop

public void setTop(double space)
Sets the space reserved for axes at the top of the plot area.

Parameters: space the space (in Java2D units).

shrink

public Rectangle2D shrink(Rectangle2D area, Rectangle2D result)
Shrinks an area by the space attributes.

Parameters: area the area to shrink. result an optional carrier for the result.

Returns: The result.

toString

public String toString()
Returns a string representing the object (for debugging purposes).

Returns: A string.