-
- All Known Implementing Classes:
Book
public interface PageableThePageableimplementation represents a set of pages to be printed. ThePageableobject returns the total number of pages in the set as well as thePageFormatandPrintablefor a specified page.- See Also:
PageFormat,Printable
-
-
Field Summary
Fields Modifier and Type Field Description static intUNKNOWN_NUMBER_OF_PAGESThis constant is returned from thegetNumberOfPagesmethod if aPageableimplementation does not know the number of pages in its set.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description intgetNumberOfPages()Returns the number of pages in the set.PageFormatgetPageFormat(int pageIndex)Returns thePageFormatof the page specified bypageIndex.PrintablegetPrintable(int pageIndex)Returns thePrintableinstance 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 thegetNumberOfPagesmethod if aPageableimplementation 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 thatPageableimplementations 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 thePageFormatof the page specified bypageIndex.- Parameters:
pageIndex- the zero based index of the page whosePageFormatis being requested- Returns:
- the
PageFormatdescribing the size and orientation. - Throws:
IndexOutOfBoundsException- if thePageabledoes not contain the requested page.
-
getPrintable
Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException
Returns thePrintableinstance responsible for rendering the page specified bypageIndex.- Parameters:
pageIndex- the zero based index of the page whosePrintableis being requested- Returns:
- the
Printablethat renders the page. - Throws:
IndexOutOfBoundsException- if thePageabledoes not contain the requested page.
-
-