org.axsl.galley

Interface PageCollection

All Superinterfaces:

AreaNode, java.lang.Iterable<AreaNode>, javax.swing.tree.TreeNode

public interface PageCollection
extends AreaNode

A PageCollection is a collection of formatted pages. It is the immediate child of Galley, and the parent of one or more Pages.

Method Summary

Modifier and Type	Method and Description
int	getPageCount() Returns the count of pages in this page collection.
PositiveIntegerFormatter	getPageNumberFormatter() Returns the page number formatter that was used to format the page numbers for this page collection.
java.lang.CharSequence	getPageNumberPrefix() Returns the page number prefix, if any, for this page collection.
java.lang.CharSequence	getPageNumberSuffix() Returns the page number suffix, if any, for this page collection.

Methods inherited from interface org.axsl.galley.AreaNode

getAreaName, getChildAt, getGalley, render

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildCount, getIndex, getParent, isLeaf

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getPageCount

int getPageCount()

Returns the count of pages in this page collection.

Returns:

The number of pages in this page collection.

getPageNumberFormatter

PositiveIntegerFormatter getPageNumberFormatter()

Returns the page number formatter that was used to format the page numbers for this page collection. This is useful for clients that need to know the general formatting scheme that is used so that they can duplicate it in other places. For example, a client creating PDF output might want to know whether Roman numerals were used to format the page numbers.

Returns:

The page number formatter used.

getPageNumberPrefix

java.lang.CharSequence getPageNumberPrefix()

Returns the page number prefix, if any, for this page collection. For example if the first page number in this collection is "Appendix-8", this method returns "Appendix-".

Returns:

The page number prefix for this collection, or an empty String if there is no prefix.

getPageNumberSuffix

java.lang.CharSequence getPageNumberSuffix()

Returns the page number suffix, if any, for this page collection. For example if the first page number in this collection is "8-Appendix", this method returns "-Appendix".

Returns:

The page number suffix for this collection, or an empty String if there is no suffix.