org.geotools.axis
Interface TickIterator

All Known Implementing Classes:
Axis2D.TickIterator

public interface TickIterator

Provides the mechanism for Graduation objects to return the values and labels of their ticks one tick at a time. This interface returns tick values from some minimal value up to some maximal value, using some increment value. Note that the increment value may not be constant. For example, a graduation for the time axis may use a slightly variable increment between differents months, since all months doesn't have the same number of days.

Since:
2.0
Author:
Martin Desruisseaux (PMO, IRD)
Module:

Method Summary
 String currentLabel()
          Returns the label for current tick.
 double currentPosition()
          Returns the position where to draw the current tick.
 double currentValue()
          Returns the value for current tick.
 Locale getLocale()
          Returns the locale used for formatting tick labels.
 boolean hasNext()
          Tests if the iterator has more ticks.
 boolean isMajorTick()
          Tests if the current tick is a major one.
 void next()
          Moves the iterator to the next minor or major tick.
 void nextMajor()
          Moves the iterator to the next major tick.
 void rewind()
          Reset the iterator on its first tick.
 

Method Detail

hasNext

boolean hasNext()
Tests if the iterator has more ticks.


isMajorTick

boolean isMajorTick()
Tests if the current tick is a major one.

Returns:
true if current tick is a major tick, or false if it is a minor tick.

currentPosition

double currentPosition()
Returns the position where to draw the current tick. The position is scaled from the graduation's minimum to maximum. This is usually the same number than currentValue(). The mean exception is for logarithmic graduation, in which the tick position is not proportional to the tick value.


currentValue

double currentValue()
Returns the value for current tick. The current tick may be major or minor.


currentLabel

String currentLabel()
Returns the label for current tick. This method is usually invoked only for major ticks, but may be invoked for minor ticks as well. This method returns null if it can't produces a label for current tick.


next

void next()
Moves the iterator to the next minor or major tick.


nextMajor

void nextMajor()
Moves the iterator to the next major tick. This move ignore any minor ticks between current position and the next major tick.


rewind

void rewind()
Reset the iterator on its first tick. All other properties are left unchanged.


getLocale

Locale getLocale()
Returns the locale used for formatting tick labels.



Copyright © 1996-2009 Geotools. All Rights Reserved.