Modifier and Type	Class and Description
private static class	Book.BookPage The BookPage inner class describes an individual page in a Book through a PageFormat-Printable pair.

Modifier and Type	Field and Description
private Vector<Book.BookPage>	mPages The set of pages that make up the Book.

Access	Constructor and Description
public	Book() Creates a new, empty `Book`.

Method Summary

Modifier and Type	Method and Description
public void	append(Printable the `Printable` instance that renders the page painter, PageFormat the size and orientation of the page page) Appends a single page to the end of this `Book`.
public void	append(Printable the `Printable` instance that renders the page painter, PageFormat the size and orientation of the page page, int the number of pages to be added to the this `Book`. numPages) Appends `numPages` pages to the end of this `Book`.
public int	Returns: the number of pages this `Book` contains. getNumberOfPages() Implements java.awt.print.Pageable.getNumberOfPages. Returns the number of pages in this `Book`.
private Book.BookPage	getPage(int pageIndex) Return the BookPage for the page specified by 'pageIndex'.
public PageFormat	Returns: the `PageFormat` describing the size and orientation of the page. getPageFormat(int the zero based index of the page whose `PageFormat` is being requested pageIndex) Implements java.awt.print.Pageable.getPageFormat. Returns the `PageFormat` of the page specified by `pageIndex`.
public Printable	Returns: the `Printable` that renders the page. getPrintable(int the zero based index of the page whose `Printable` is being requested pageIndex) Implements java.awt.print.Pageable.getPrintable. Returns the `Printable` instance responsible for rendering the page specified by `pageIndex`.
public void	setPage(int the zero based index of the page whose painter and format is altered pageIndex, Printable the `Printable` instance that renders the page painter, PageFormat the size and orientation of the page page) Sets the `PageFormat` and the `Painter` for a specified page number.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

mPages	back to summary
private Vector<Book.BookPage> mPages The set of pages that make up the Book.

Constructor Detail

Book	back to summary
public Book() Creates a new, empty `Book`.

Method Detail

append back to summary

append	back to summary
public void append(Printable painter, PageFormat page) Appends a single page to the end of this `Book`. Parameters painter:Printable the `Printable` instance that renders the page page:PageFormat the size and orientation of the page Exceptions NullPointerException: If the `painter` or `page` argument is `null`

public void append(Printable painter, PageFormat page)

Appends a single page to the end of this Book.

Parameters

painter:Printable: the Printable instance that renders the page
page:PageFormat: the size and orientation of the page

Exceptions

NullPointerException:: If the painter or page argument is null

append back to summary

append	back to summary
public void append(Printable painter, PageFormat page, int numPages) Appends `numPages` pages to the end of this `Book`. Each of the pages is associated with `page`. Parameters painter:Printable the `Printable` instance that renders the page page:PageFormat the size and orientation of the page numPages:int the number of pages to be added to the this `Book`. Exceptions NullPointerException: If the `painter` or `page` argument is `null`

public void append(Printable painter, PageFormat page, int numPages)

Appends numPages pages to the end of this Book. Each of the pages is associated with page.

Parameters

painter:Printable: the Printable instance that renders the page
page:PageFormat: the size and orientation of the page
numPages:int: the number of pages to be added to the this Book.

Exceptions

NullPointerException:: If the painter or page argument is null

getNumberOfPages back to summary

getNumberOfPages	back to summary
public int getNumberOfPages() Implements java.awt.print.Pageable.getNumberOfPages. Returns the number of pages in this `Book`. Returns:int the number of pages this `Book` contains.

public int getNumberOfPages()

Implements java.awt.print.Pageable.getNumberOfPages.

Returns the number of pages in this Book.

Returns:int: the number of pages this Book contains.

getPage	back to summary
private Book.BookPage getPage(int pageIndex) throws ArrayIndexOutOfBoundsException Return the BookPage for the page specified by 'pageIndex'.

getPageFormat back to summary

getPageFormat	back to summary
public PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException Implements java.awt.print.Pageable.getPageFormat. Returns the `PageFormat` of the page specified by `pageIndex`. Parameters pageIndex:int the zero based index of the page whose `PageFormat` is being requested Returns:PageFormat the `PageFormat` describing the size and orientation of the page. Exceptions IndexOutOfBoundsException: if the `Pageable` does not contain the requested page

public PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException

Implements java.awt.print.Pageable.getPageFormat.

Returns the PageFormat of the page specified by pageIndex.

Parameters

pageIndex:int: the zero based index of the page whose PageFormat is being requested

Returns:PageFormat

the PageFormat describing the size and orientation of the page.

Exceptions

IndexOutOfBoundsException:: if the Pageable does not contain the requested page

getPrintable back to summary

getPrintable	back to summary
public Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException Implements java.awt.print.Pageable.getPrintable. Returns the `Printable` instance responsible for rendering the page specified by `pageIndex`. Parameters pageIndex:int the zero based index of the page whose `Printable` is being requested Returns:Printable the `Printable` that renders the page. Exceptions IndexOutOfBoundsException: if the `Pageable` does not contain the requested page

public Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException

Implements java.awt.print.Pageable.getPrintable.

Returns the Printable instance responsible for rendering the page specified by pageIndex.

Parameters

pageIndex:int: the zero based index of the page whose Printable is being requested

Returns:Printable

the Printable that renders the page.

Exceptions

IndexOutOfBoundsException:: if the Pageable does not contain the requested page

setPage back to summary

setPage	back to summary
public void setPage(int pageIndex, Printable painter, PageFormat page) throws IndexOutOfBoundsException Sets the `PageFormat` and the `Painter` for a specified page number. Parameters pageIndex:int the zero based index of the page whose painter and format is altered painter:Printable the `Printable` instance that renders the page page:PageFormat the size and orientation of the page Exceptions IndexOutOfBoundsException: if the specified page is not already in this `Book` NullPointerException: if the `painter` or `page` argument is `null`

public void setPage(int pageIndex, Printable painter, PageFormat page) throws IndexOutOfBoundsException

Sets the PageFormat and the Painter for a specified page number.

Parameters

pageIndex:int: the zero based index of the page whose painter and format is altered
painter:Printable: the Printable instance that renders the page
page:PageFormat: the size and orientation of the page

Exceptions

IndexOutOfBoundsException:: if the specified page is not already in this Book
NullPointerException:: if the painter or page argument is null

java.awt.print back to summary

private Class Book.BookPage

Class Inheritance

extends Object

java.lang.Object
java.awt.print.Book.BookPage

The BookPage inner class describes an individual page in a Book through a PageFormat-Printable pair.

Field Summary

Modifier and Type	Field and Description
private PageFormat	mFormat The size and orientation of the page.
private Printable	mPainter The instance that will draw the page.

Constructor Summary

Access	Constructor and Description
pack-priv	BookPage(Printable painter, PageFormat format) A new instance where 'format' describes the page's size and orientation and 'painter' is the instance that will draw the page's graphics.

Method Summary

Modifier and Type	Method and Description
pack-priv PageFormat	getPageFormat() Return the format of the page.
pack-priv Printable	getPrintable() Return the instance that paints the page.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

mFormat	back to summary
private PageFormat mFormat The size and orientation of the page.

mPainter	back to summary
private Printable mPainter The instance that will draw the page.

Constructor Detail

BookPage back to summary

BookPage	back to summary
pack-priv BookPage(Printable painter, PageFormat format) A new instance where 'format' describes the page's size and orientation and 'painter' is the instance that will draw the page's graphics. Exceptions NullPointerException: If the `painter` or `format` argument is `null`

pack-priv BookPage(Printable painter, PageFormat format)

A new instance where 'format' describes the page's size and orientation and 'painter' is the instance that will draw the page's graphics.

Exceptions

NullPointerException:: If the painter or format argument is null

Method Detail

getPageFormat	back to summary
pack-priv PageFormat getPageFormat() Return the format of the page.

getPrintable	back to summary
pack-priv Printable getPrintable() Return the instance that paints the page.

public Class Book

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Book.BookPage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail