Pageable (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.awt.print
interface Pageable

All Known Implementing Classes:: Book

public interface Pageable

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 {@link PageFormat} and {@link Printable} for a specified page.

Field Summary
`static int`	`UNKNOWN_NUMBER_OF_PAGES` This constant is returned from the java.awt.print.Pageable.getNumberOfPages method if a `Pageable` implementation does not know the number of pages in its set.

Method Summary
`int`	`getNumberOfPages()` Returns the number of pages in the set.
`PageFormat`	`getPageFormat(int pageIndex)` Returns the `PageFormat` of the page specified by `pageIndex`.
`Printable`	`getPrintable(int pageIndex)` Returns the `Printable` instance responsible for rendering the page specified by `pageIndex`.

Field Detail

UNKNOWN_NUMBER_OF_PAGES

public static final int UNKNOWN_NUMBER_OF_PAGES

This constant is returned from the {@link #getNumberOfPages() getNumberOfPages} method if a Pageable implementation does not know the number of pages in its set.

Method Detail

getNumberOfPages

public int getNumberOfPages()

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.

getPageFormat

public PageFormat getPageFormat(int pageIndex)
                         throws IndexOutOfBoundsException

Returns the PageFormat of the page specified by pageIndex.

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

getPrintable

public Printable getPrintable(int pageIndex)
                       throws IndexOutOfBoundsException

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

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