java.awt.print
Interface Pageable
- All Known Implementing Classes:
- Book
- public abstract 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
PageFormat
and Printable
for a specified page.
- See Also:
PageFormat
,
Printable
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 . |
UNKNOWN_NUMBER_OF_PAGES
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
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
- 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
- the Pageable
does not contain the requested
page.
Submit a bug or feature Version 1.2 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.