APIdia Launch Partner
Top Description Fields Methods
java.awt.print

public Interface Pageable

Known Direct Implementers
sun.print.OpenBook, java.awt.print.Book
Imports
java.lang.annotation.Native
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
java.awt.print.PageFormat, java.awt.print.Printable

Field Summary

Modifier and TypeField and Description
public static final int
UNKNOWN_NUMBER_OF_PAGES

This constant is returned from the getNumberOfPages method if a Pageable implementation does not know the number of pages in its set.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the number of pages in this Pageable.
getNumberOfPages()

Returns the number of pages in the set.

public PageFormat

Returns:

the PageFormat describing the size and orientation.
getPageFormat(int
the zero based index of the page whose PageFormat is being requested
pageIndex)

Returns the PageFormat of the page specified by pageIndex.

public Printable

Returns:

the Printable that renders the page.
getPrintable(int
the zero based index of the page whose Printable is being requested
pageIndex)

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

Field Detail

UNKNOWN_NUMBER_OF_PAGESback to summary
public static final int UNKNOWN_NUMBER_OF_PAGES

This constant is returned from the getNumberOfPages method if a Pageable implementation does not know the number of pages in its set.

Annotations
@Native

Method Detail

getNumberOfPagesback to summary
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:int

the number of pages in this Pageable.

getPageFormatback to summary
public PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException

Returns the PageFormat of the page specified by pageIndex.

Parameters
pageIndex:int

the zero based index of the page whose PageFormat is being requested

Returns:PageFormat

the PageFormat describing the size and orientation.

Exceptions
IndexOutOfBoundsException:
if the Pageable does not contain the requested page.
getPrintableback to summary
public Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException

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

Parameters
pageIndex:int

the zero based index of the page whose Printable is being requested

Returns:Printable

the Printable that renders the page.

Exceptions
IndexOutOfBoundsException:
if the Pageable does not contain the requested page.