Header
And More


org.jfree.chart.axis
Class AxisSpace

java.lang.Object
  extended by org.jfree.chart.axis.AxisSpace
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, org.jfree.util.PublicCloneable

public class AxisSpace
extends java.lang.Object
implements java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable

A record that contains the space required at each edge of a plot.

See Also:
Serialized Form

Constructor Summary
AxisSpace()
          Creates a new axis space record.
 
Method Summary
 void add(double space, org.jfree.ui.RectangleEdge edge)
          Adds space to the top, bottom, left or right edge of the plot area.
 java.lang.Object clone()
          Returns a clone of the object.
 void ensureAtLeast(AxisSpace space)
          Ensures that this object reserves at least as much space as another.
 void ensureAtLeast(double space, org.jfree.ui.RectangleEdge edge)
          Ensures there is a minimum amount of space at the edge corresponding to the specified axis location.
 boolean equals(java.lang.Object obj)
          Tests this object for equality with another object.
 java.awt.geom.Rectangle2D expand(java.awt.geom.Rectangle2D area, java.awt.geom.Rectangle2D result)
          Expands an area by the amount of space represented by this object.
 double getBottom()
          Returns the space reserved for axes at the bottom of the plot area.
 double getLeft()
          Returns the space reserved for axes at the left of the plot area.
 double getRight()
          Returns the space reserved for axes at the right of the plot area.
 double getTop()
          Returns the space reserved for axes at the top of the plot area.
 int hashCode()
          Returns a hash code for this object.
 java.awt.geom.Rectangle2D reserved(java.awt.geom.Rectangle2D area, org.jfree.ui.RectangleEdge edge)
          Calculates the reserved area.
 void setBottom(double space)
          Sets the space reserved for axes at the bottom of the plot area.
 void setLeft(double space)
          Sets the space reserved for axes at the left of the plot area.
 void setRight(double space)
          Sets the space reserved for axes at the right of the plot area.
 void setTop(double space)
          Sets the space reserved for axes at the top of the plot area.
 java.awt.geom.Rectangle2D shrink(java.awt.geom.Rectangle2D area, java.awt.geom.Rectangle2D result)
          Shrinks an area by the space attributes.
 java.lang.String toString()
          Returns a string representing the object (for debugging purposes).
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AxisSpace

public AxisSpace()
Creates a new axis space record.

Method Detail

getTop

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

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

getBottom

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

Returns:
The space (in Java2D units).

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

getLeft

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

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

getRight

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

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

add

public void add(double space,
                org.jfree.ui.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).

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,
                          org.jfree.ui.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.

shrink

public java.awt.geom.Rectangle2D shrink(java.awt.geom.Rectangle2D area,
                                        java.awt.geom.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.

expand

public java.awt.geom.Rectangle2D expand(java.awt.geom.Rectangle2D area,
                                        java.awt.geom.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.

reserved

public java.awt.geom.Rectangle2D reserved(java.awt.geom.Rectangle2D area,
                                          org.jfree.ui.RectangleEdge edge)
Calculates the reserved area.

Parameters:
area - the area.
edge - the edge.
Returns:
The reserved area.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns a clone of the object.

Specified by:
clone in interface org.jfree.util.PublicCloneable
Overrides:
clone in class java.lang.Object
Returns:
A clone.
Throws:
java.lang.CloneNotSupportedException - This class won't throw this exception, but subclasses (if any) might.

equals

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

Overrides:
equals in class java.lang.Object
Parameters:
obj - the object to compare against.
Returns:
true or false.

hashCode

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

Overrides:
hashCode in class java.lang.Object
Returns:
A hash code.

toString

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

Overrides:
toString in class java.lang.Object
Returns:
A string.

Footer
And More


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