Book
public interface Pageable
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.Modifier and Type | Field | Description |
---|---|---|
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. |
Modifier and Type | Method | Description |
---|---|---|
int |
getNumberOfPages() |
Returns the number of pages in the set. |
PageFormat |
getPageFormat |
Returns the PageFormat of the page specified by pageIndex . |
Printable |
getPrintable |
Returns the Printable instance responsible for rendering the page specified by pageIndex . |
@Native static final int UNKNOWN_NUMBER_OF_PAGES
getNumberOfPages
method if a Pageable
implementation does not know the number of pages in its set.int getNumberOfPages()
Pageable
implementations return the true number of pages rather than the UNKNOWN_NUMBER_OF_PAGES constant.Pageable
.PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException
PageFormat
of the page specified by pageIndex
.pageIndex
- the zero based index of the page whose PageFormat
is being requestedPageFormat
describing the size and orientation.IndexOutOfBoundsException
- if the Pageable
does not contain the requested page.Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException
Printable
instance responsible for rendering the page specified by pageIndex
.pageIndex
- the zero based index of the page whose Printable
is being requestedPrintable
that renders the page.IndexOutOfBoundsException
- if the Pageable
does not contain the requested page.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/print/Pageable.html