org.jfree.chart.axis
Class TickUnits

java.lang.Object
  |
  +--org.jfree.chart.axis.TickUnits
All Implemented Interfaces:
java.io.Serializable

public class TickUnits
extends java.lang.Object
implements java.io.Serializable

A collection of tick units.

Used by the DateAxis and NumberAxis classes.

Author:
David Gilbert
See Also:
Serialized Form

Constructor Summary
TickUnits()
          Constructs a new collection of tick units.
 
Method Summary
 void add(TickUnit unit)
          Adds a tick unit to the collection.
static TickUnits createIntegerTickUnits()
          Deprecated. this method has been moved to the NumberAxis class.
static TickUnits createIntegerTickUnits(java.util.Locale locale)
          Deprecated. this method has been moved to the NumberAxis class.
static TickUnits createStandardTickUnits()
          Deprecated. this method has been moved to the NumberAxis class.
static TickUnits createStandardTickUnits(java.util.Locale locale)
          Deprecated. this method has been moved to the NumberAxis class.
 TickUnit getCeilingTickUnit(double size)
          Returns the tick unit in the collection that is greater than or equal to the specified size.
 TickUnit getCeilingTickUnit(TickUnit unit)
          Returns the tick unit in the collection that is greater than or equal to (in size) the specified unit.
 TickUnit getLargerTickUnit(TickUnit unit)
          Returns a tick unit that is larger than the supplied unit.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TickUnits

public TickUnits()
Constructs a new collection of tick units.

Method Detail

add

public void add(TickUnit unit)
Adds a tick unit to the collection.

The tick units are maintained in ascending order.

Parameters:
unit - the tick unit to add.

getLargerTickUnit

public TickUnit getLargerTickUnit(TickUnit unit)
Returns a tick unit that is larger than the supplied unit.

Parameters:
unit - the unit.
Returns:
a tick unit that is larger than the supplied unit.

getCeilingTickUnit

public TickUnit getCeilingTickUnit(TickUnit unit)
Returns the tick unit in the collection that is greater than or equal to (in size) the specified unit.

Parameters:
unit - the unit.
Returns:
a unit from the collection.

getCeilingTickUnit

public TickUnit getCeilingTickUnit(double size)
Returns the tick unit in the collection that is greater than or equal to the specified size.

Parameters:
size - the size.
Returns:
a unit from the collection.

createStandardTickUnits

public static TickUnits createStandardTickUnits()
Deprecated. this method has been moved to the NumberAxis class.

Creates the standard tick units.

If you don't like these defaults, create your own instance of TickUnits and then pass it to the setStandardTickUnits(...) method in the NumberAxis class.

Returns:
the standard tick units.

createIntegerTickUnits

public static TickUnits createIntegerTickUnits()
Deprecated. this method has been moved to the NumberAxis class.

Returns a collection of tick units for integer values.

Returns:
a collection of tick units for integer values.

createStandardTickUnits

public static TickUnits createStandardTickUnits(java.util.Locale locale)
Deprecated. this method has been moved to the NumberAxis class.

Creates the standard tick units, and uses a given Locale to create the DecimalFormats

If you don't like these defaults, create your own instance of TickUnits and then pass it to the setStandardTickUnits(...) method in the NumberAxis class.

Parameters:
locale - the locale to use to represent Numbers.
Returns:
the standard tick units.

createIntegerTickUnits

public static TickUnits createIntegerTickUnits(java.util.Locale locale)
Deprecated. this method has been moved to the NumberAxis class.

Returns a collection of tick units for integer values. Uses a given Locale to create the DecimalFormats.

Parameters:
locale - the locale to use to represent Numbers.
Returns:
a collection of tick units for integer values.