Class Book
java.lang.Object
java.awt.print.Book
- All Implemented Interfaces:
Pageable
The
Book class provides a representation of a document in
which pages may have different page formats and page painters. This
class uses the Pageable interface to interact with a
PrinterJob.- See Also:
-
Field Summary
Fields declared in interface java.awt.print.Pageable
UNKNOWN_NUMBER_OF_PAGES -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidappend(Printable painter, PageFormat page) Appends a single page to the end of thisBook.voidappend(Printable painter, PageFormat page, int numPages) AppendsnumPagespages to the end of thisBook.intReturns the number of pages in thisBook.getPageFormat(int pageIndex) Returns thePageFormatof the page specified bypageIndex.getPrintable(int pageIndex) Returns thePrintableinstance responsible for rendering the page specified bypageIndex.voidsetPage(int pageIndex, Printable painter, PageFormat page) Sets thePageFormatand thePainterfor a specified page number.
-
Constructor Details
-
Book
public Book()Creates a new, emptyBook.
-
-
Method Details
-
getNumberOfPages
public int getNumberOfPages()Returns the number of pages in thisBook.- Specified by:
getNumberOfPagesin interfacePageable- Returns:
- the number of pages this
Bookcontains.
-
getPageFormat
Returns thePageFormatof the page specified bypageIndex.- Specified by:
getPageFormatin interfacePageable- Parameters:
pageIndex- the zero based index of the page whosePageFormatis being requested- Returns:
- the
PageFormatdescribing the size and orientation of the page. - Throws:
IndexOutOfBoundsException- if thePageabledoes not contain the requested page
-
getPrintable
Returns thePrintableinstance responsible for rendering the page specified bypageIndex.- Specified by:
getPrintablein interfacePageable- 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
-
setPage
public void setPage(int pageIndex, Printable painter, PageFormat page) throws IndexOutOfBoundsException Sets thePageFormatand thePainterfor a specified page number.- Parameters:
pageIndex- the zero based index of the page whose painter and format is alteredpainter- thePrintableinstance that renders the pagepage- the size and orientation of the page- Throws:
IndexOutOfBoundsException- if the specified page is not already in thisBookNullPointerException- if thepainterorpageargument isnull
-
append
Appends a single page to the end of thisBook.- Parameters:
painter- thePrintableinstance that renders the pagepage- the size and orientation of the page- Throws:
NullPointerException- If thepainterorpageargument isnull
-
append
AppendsnumPagespages to the end of thisBook. Each of the pages is associated withpage.- Parameters:
painter- thePrintableinstance that renders the pagepage- the size and orientation of the pagenumPages- the number of pages to be added to the thisBook.- Throws:
NullPointerException- If thepainterorpageargument isnull
-