Class NumberedListItem

java.lang.Object
org.apache.maven.doxia.module.fo.NumberedListItem

public class NumberedListItem extends Object
Used to count the position in a numbered list.
Since:
1.1
  • Field Details

    • DECIMALS

      private static final String[] DECIMALS
      Arabic decimals from 1 - 26.
    • LOWER_ALPHAS

      private static final String[] LOWER_ALPHAS
      Lower-case alphanumerics from a - z.
    • UPPER_ALPHAS

      private static final String[] UPPER_ALPHAS
      Upper-case alphanumerics from A - Z.
    • LOWER_ROMANS

      private static final String[] LOWER_ROMANS
      Lower-case roman numbers from i - xxvi.
    • UPPER_ROMANS

      private static final String[] UPPER_ROMANS
      Upper-case roman numbers from I - XXVI.
    • count

      private int count
      The position in the list.
    • format

      private final int format
      The numbering format.
  • Constructor Details

    • 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 Details

    • 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 String getListItemSymbol()
      Returns the symbol for the current list item.
      Returns:
      The symbol for the current list item.
    • isValidItemFormat

      private boolean isValidItemFormat(int itemFormat)
      Determines if the given format is one of the formats defined in Sink.
      Parameters:
      itemFormat - the format to check.
      Returns:
      True if the format is a valid item format according to the Sink API.