-
- All Known Implementing Classes:
Book
public interface Pageable
ThePageable
implementation represents a set of pages to be printed. ThePageable
object returns the total number of pages in the set as well as thePageFormat
andPrintable
for a specified page.- See Also:
PageFormat
,Printable
-
-
Field Summary
Fields Modifier and Type Field Description static int
UNKNOWN_NUMBER_OF_PAGES
This constant is returned from thegetNumberOfPages
method if aPageable
implementation does not know the number of pages in its set.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getNumberOfPages()
Returns the number of pages in the set.PageFormat
getPageFormat(int pageIndex)
Returns thePageFormat
of the page specified bypageIndex
.Printable
getPrintable(int pageIndex)
Returns thePrintable
instance responsible for rendering the page specified bypageIndex
.
-
-
-
Field Detail
-
UNKNOWN_NUMBER_OF_PAGES
@Native static final int UNKNOWN_NUMBER_OF_PAGES
This constant is returned from thegetNumberOfPages
method if aPageable
implementation does not know the number of pages in its set.- See Also:
- Constant Field Values
-
-
Method Detail
-
getNumberOfPages
int getNumberOfPages()
Returns the number of pages in the set. To enable advanced printing features, it is recommended thatPageable
implementations return the true number of pages rather than the UNKNOWN_NUMBER_OF_PAGES constant.- Returns:
- the number of pages in this
Pageable
.
-
getPageFormat
PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException
Returns thePageFormat
of the page specified bypageIndex
.- Parameters:
pageIndex
- the zero based index of the page whosePageFormat
is being requested- Returns:
- the
PageFormat
describing the size and orientation. - Throws:
IndexOutOfBoundsException
- if thePageable
does not contain the requested page.
-
getPrintable
Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException
Returns thePrintable
instance responsible for rendering the page specified bypageIndex
.- Parameters:
pageIndex
- the zero based index of the page whosePrintable
is being requested- Returns:
- the
Printable
that renders the page. - Throws:
IndexOutOfBoundsException
- if thePageable
does not contain the requested page.
-
-