Package org.apache.maven.doxia.module.fo

Class NumberedListItem

java.lang.Object

org.apache.maven.doxia.module.fo.NumberedListItem

public class NumberedListItem
extends java.lang.Object

Used to count the position in a numbered list.

Since:

1.1

Version:

$Id: NumberedListItem.java 946933 2010-05-21 08:39:07Z ltheussl $

Author:

ltheussl

Constructor Summary

Constructors

Constructor	Description
NumberedListItem(int itemFormat)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	count()	Returns the current count, ie the position in the list.
int	format()	Returns the numbering format.
java.lang.String	getListItemSymbol()	Returns the symbol for the current list item.
void	next()	Increase the current count by 1.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NumberedListItem

public NumberedListItem(int itemFormat)

Constructor. Initializes count and format.

Parameters:

itemFormat - The numbering format of this List. Should be one of the formats defined in Sink.

Method Detail

count

public int count()

Returns the current count, ie the position in the list.

Returns:

The current count.

format

public int format()

Returns the numbering format.

Returns:

The numbering format.

next

public void next()

Increase the current count by 1.

getListItemSymbol

public java.lang.String getListItemSymbol()

Returns the symbol for the current list item.

Returns:

The symbol for the current list item.