public class

AxisSpace

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

Class Overview

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

Summary

Public Constructors
AxisSpace()
Creates a new axis space record.
Public Methods
void add(double space, RectangleEdge edge)
Adds space to the top, bottom, left or right edge of the plot area.
Object clone()
Returns a clone of the object.
void ensureAtLeast(double space, RectangleEdge edge)
Ensures there is a minimum amount of space at the edge corresponding to the specified axis location.
void ensureAtLeast(AxisSpace space)
Ensures that this object reserves at least as much space as another.
boolean equals(Object obj)
Tests this object for equality with another object.
Rectangle2D expand(Rectangle2D area, 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.
Rectangle2D reserved(Rectangle2D area, 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.
Rectangle2D shrink(Rectangle2D area, Rectangle2D result)
Shrinks an area by the space attributes.
String toString()
Returns a string representing the object (for debugging purposes).
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public AxisSpace ()

Creates a new axis space record.

Public Methods

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

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.

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.

public void ensureAtLeast (AxisSpace space)

Ensures that this object reserves at least as much space as another.

Parameters
space the other space.

public boolean equals (Object obj)

Tests this object for equality with another object.

Parameters
obj the object to compare against.
Returns
  • true or false.

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.

public double getBottom ()

Returns the space reserved for axes at the bottom of the plot area.

Returns
  • The space (in Java2D units).

public double getLeft ()

Returns the space reserved for axes at the left of the plot area.

Returns
  • The space (in Java2D units).

public double getRight ()

Returns the space reserved for axes at the right of the plot area.

Returns
  • The space (in Java2D units).

public double getTop ()

Returns the space reserved for axes at the top of the plot area.

Returns
  • The space (in Java2D units).

public int hashCode ()

Returns a hash code for this object.

Returns
  • A hash code.

public Rectangle2D reserved (Rectangle2D area, RectangleEdge edge)

Calculates the reserved area.

Parameters
area the area.
edge the edge.
Returns
  • The reserved area.

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

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

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

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

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.

public String toString ()

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

Returns
  • A string.