java.awt.print: public interface: Pageable

java.awt.print
public interface: Pageable [javadoc | source]

All Known Implementing Classes:
PrintableWrapper, Book

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.

Also see:

java.awt.print.PageFormat

java.awt.print.Printable

Field Summary
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 from java.awt.print.Pageable Summary:
getNumberOfPages, getPageFormat, getPrintable

Method from java.awt.print.Pageable Detail:
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.
public PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException Returns the `PageFormat` of the page specified by `pageIndex`.
public Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException Returns the `Printable` instance responsible for rendering the page specified by `pageIndex`.

Method from java.awt.print.Pageable Detail:

 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.

 public PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsExceptionReturns the PageFormat of the page specified by
pageIndex.

 public Printable getPrintable(int pageIndex) throws IndexOutOfBoundsExceptionReturns the Printable instance responsible for
rendering the page specified by pageIndex.