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.PageFormat,
Printable| Modifier and Type | Field and Description |
|---|---|
static 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 and Description |
|---|---|
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. |
@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. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.