| org.geotools.axis.TickIterator
All known Subclasses: org.geotools.axis.NumberIterator, org.geotools.axis.DateIterator,
| TickIterator | | public interface TickIterator (Code) | | 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
version:
$Id: TickIterator.java 20883 2006-08-07 13:48:09Z jgarnett $
author:
Martin Desruisseaux |
| Method Summary | |
| abstract public String | currentLabel()
Returns the label for current tick. | | abstract public double | currentPosition()
Returns the position where to draw the current tick. | | abstract public double | currentValue()
Returns the value for current tick. | | abstract public Locale | getLocale()
Returns the locale used for formatting tick labels. | | abstract public boolean | hasNext()
Tests if the iterator has more ticks. | | abstract public boolean | isMajorTick()
Tests if the current tick is a major one. | | abstract public void | next()
Moves the iterator to the next minor or major tick. | | abstract public void | nextMajor()
Moves the iterator to the next major tick. | | abstract public void | rewind()
Reset the iterator on its first tick. |
| currentLabel | | abstract public String currentLabel()(Code) | | 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.
|
| currentPosition | | abstract public double currentPosition()(Code) | | 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
TickIterator.currentValue . The mean exception is for logarithmic graduation,
in which the tick position is not proportional to the tick value.
|
| currentValue | | abstract public double currentValue()(Code) | | Returns the value for current tick. The current tick may be major or minor.
|
| getLocale | | abstract public Locale getLocale()(Code) | | Returns the locale used for formatting tick labels.
|
| hasNext | | abstract public boolean hasNext()(Code) | | Tests if the iterator has more ticks.
|
| isMajorTick | | abstract public boolean isMajorTick()(Code) | | Tests if the current tick is a major one.
true if current tick is a major tick,or false if it is a minor tick. |
| next | | abstract public void next()(Code) | | Moves the iterator to the next minor or major tick.
|
| nextMajor | | abstract public void nextMajor()(Code) | | Moves the iterator to the next major tick. This move
ignore any minor ticks between current position and
the next major tick.
|
| rewind | | abstract public void rewind()(Code) | | Reset the iterator on its first tick.
All other properties are left unchanged.
|
|
|