- java.lang.Object
-
- java.awt.print.Book
-
- All Implemented Interfaces:
Pageable
public class Book extends Object implements Pageable
TheBookclass provides a representation of a document in which pages may have different page formats and page painters. This class uses thePageableinterface to interact with aPrinterJob.- See Also:
Pageable,PrinterJob
-
-
Field Summary
-
Fields declared in interface java.awt.print.Pageable
UNKNOWN_NUMBER_OF_PAGES
-
-
Constructor Summary
Constructors Constructor Description Book()Creates a new, emptyBook.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidappend(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.intgetNumberOfPages()Returns the number of pages in thisBook.PageFormatgetPageFormat(int pageIndex)Returns thePageFormatof the page specified bypageIndex.PrintablegetPrintable(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.
-
-
-
Method Detail
-
getNumberOfPages
public int getNumberOfPages()
Returns the number of pages in thisBook.- Specified by:
getNumberOfPagesin interfacePageable- Returns:
- the number of pages this
Bookcontains.
-
getPageFormat
public PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException
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
public Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException
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 IndexOutOfBoundsExceptionSets 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
public void append(Printable painter, PageFormat page)
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
public void append(Printable painter, PageFormat page, int numPages)
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
-
-