org.apache.fop.fo.pagination

Class PageNumberGenerator


public class PageNumberGenerator
extends java.lang.Object

This class uses the 'format', 'groupingSeparator', 'groupingSize', and 'letterValue' properties on fo:page-sequence to return a String corresponding to the supplied integer page number.

Constructor Summary

PageNumberGenerator(String format, char groupingSeparator, int groupingSize, int letterValue)
Main constructor.

Method Summary

String
makeFormattedPageNumber(int number)
Formats a page number.

Constructor Details

PageNumberGenerator

public PageNumberGenerator(String format,
                           char groupingSeparator,
                           int groupingSize,
                           int letterValue)
Main constructor. For further information on the parameters see the XSLT specs (Number to String Conversion Attributes).
Parameters:
format - format for the page number
groupingSeparator - grouping separator
groupingSize - grouping size
letterValue - letter value

Method Details

makeFormattedPageNumber

public String makeFormattedPageNumber(int number)
Formats a page number.
Parameters:
number - page number to format
Returns:
the formatted page number as a String

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.