java.awt.print
Interface Pageable

All Known Implementing Classes:
Book

public interface Pageable

This interface represents pages that are to be printed.


Field Summary
static int UNKNOWN_NUMBER_OF_PAGES
          This constant is returned when getNumberOfPages() cannot determine the number of pages available for printing.
 
Method Summary
 int getNumberOfPages()
          This method returns the number of pages this object contains, or UNKNOWN_NUMBER_OF_PAGES if it cannot determine the number of pages to be printed.
 PageFormat getPageFormat(int pageIndex)
          This method returns the PageFormat instance for the specified page.
 Printable getPrintable(int pageIndex)
          This method returns the Printable instance for the specified page.
 

Field Detail

UNKNOWN_NUMBER_OF_PAGES

static final int UNKNOWN_NUMBER_OF_PAGES
This constant is returned when getNumberOfPages() cannot determine the number of pages available for printing.

See Also:
Constant Field Values
Method Detail

getNumberOfPages

int getNumberOfPages()
This method returns the number of pages this object contains, or UNKNOWN_NUMBER_OF_PAGES if it cannot determine the number of pages to be printed.

Returns:
The number of pages to be printed, or UNKNOWN_NUMBER_OF_PAGES if this is unknown.

getPageFormat

PageFormat getPageFormat(int pageIndex)
                         throws IndexOutOfBoundsException
This method returns the PageFormat instance for the specified page. Page numbers start at zero. An exception is thrown if the requested page does not exist.

Parameters:
pageIndex - The index of the page to return the PageFormat for.
Returns:
The PageFormat for the requested page.
Throws:
IndexOutOfBoundsException - If the requested page number does not exist.

getPrintable

Printable getPrintable(int pageIndex)
                       throws IndexOutOfBoundsException
This method returns the Printable instance for the specified page. Page numbers start at zero. An exception is thrown if the requested page does not exist.

Parameters:
pageIndex - The index of the page to return the Printable for.
Returns:
The Printable for the requested page.
Throws:
IndexOutOfBoundsException - If the requested page number does not exist.