Pageable JDK 1.6)

Description

public interface Pageable

The Pageable implementation represents a set of pages to be printed.

The Pageable implementation represents a set of
pages to be printed. The Pageable object returns
the total number of pages in the set as well as the
PageFormat and Printable for a specified page.

See also: PageFormat Printable

Methods

Hide/Show inherited methods

public int getNumberOfPages ()

Returns the number of pages in the set.

Returns the number of pages in the set.
To enable advanced printing features,
it is recommended that Pageable
implementations return the true number of pages
rather than the
UNKNOWN_NUMBER_OF_PAGES constant.
Returns: the number of pages in this Pageable.

public PageFormat getPageFormat (int pageIndex) throws IndexOutOfBoundsException

Returns the PageFormat of the page specified by pageIndex.

Returns the PageFormat of the page specified by
pageIndex.
Returns: the PageFormat describing the size and orientation.
Parameters:
- pageIndex - the zero based index of the page whose PageFormat is being requested
Throws:
- IndexOutOfBoundsException - if the Pageable does not contain the requested page.

public Printable getPrintable (int pageIndex) throws IndexOutOfBoundsException

Returns the Printable instance responsible for rendering the page specified by pageIndex.

Returns the Printable instance responsible for
rendering the page specified by pageIndex.
Returns: the Printable that renders the page.
Parameters:
- pageIndex - the zero based index of the page whose Printable is being requested
Throws:
- IndexOutOfBoundsException - if the Pageable does not contain the requested page.