File Doc Category Size Date Package
Pageable.java API Doc Java SE 5 API 2275 Fri Aug 26 14:56:56 BST 2005 java.awt.print

Pageable

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.

see: java.awt.print.PageFormat
see: java.awt.print.Printable

Fields Summary
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.
Constructors Summary
Methods 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.
return
the number of pages in this Pageable.
public java.awt.print.PageFormat getPageFormat(int pageIndex)
Returns the PageFormat of the page specified by pageIndex.
param
pageIndex the zero based index of the page whose PageFormat is being requested
return
the PageFormat describing the size and orientation.
throws
IndexOutOfBoundsException if the Pageable does not contain the requested page.
public java.awt.print.Printable getPrintable(int pageIndex)
Returns the Printable instance responsible for rendering the page specified by pageIndex.
param
pageIndex the zero based index of the page whose Printable is being requested
return
the Printable that renders the page.
throws
IndexOutOfBoundsException if the Pageable does not contain the requested page.