java.awt.print

Class Book

public class Book extends Object implements Pageable

This class allows documents to be created with different paper types, page formatters, and painters.

Constructor Summary
	Book() Initializes a new instance of `Book` that is empty.

Method Summary
void	append(Printable printable, PageFormat page_format) This method appends a page to the end of the book.
void	append(Printable printable, PageFormat page_format, int num_pages) This method appends the specified number of pages to the end of the book.
int	getNumberOfPages() Returns the number of pages in this book.
PageFormat	getPageFormat(int page_number) This method returns the `PageFormat` object for the specified page.
Printable	getPrintable(int page_number) This method returns the `Printable` object for the specified page.
void	setPage(int page_num, Printable printable, PageFormat page_format) This method changes the `Printable` and `PageFormat` for the specified page.

Constructor Detail

Book

public Book()

Initializes a new instance of Book that is empty.

Method Detail

append

public void append(Printable printable, PageFormat page_format)

This method appends a page to the end of the book.

Parameters: printable The Printable for this page. page_format The PageFormat for this page.

Throws: NullPointerException If either argument is null.

append

public void append(Printable printable, PageFormat page_format, int num_pages)

This method appends the specified number of pages to the end of the book. Each one will be associated with the specified Printable and PageFormat.

Parameters: printable The Printable for this page. page_format The PageFormat for this page. num_pages The number of pages to append.

Throws: NullPointerException If any argument is null.

getNumberOfPages

public int getNumberOfPages()

Returns the number of pages in this book.

Returns: The number of pages in this book.

getPageFormat

public PageFormat getPageFormat(int page_number)

This method returns the PageFormat object for the specified page.

Parameters: page_number The number of the page to get information for, where page numbers start at 0.

Returns: The PageFormat object for the specified page.

Throws: IndexOutOfBoundsException If the page number is not valid.

getPrintable

public Printable getPrintable(int page_number)

This method returns the Printable object for the specified page.

Parameters: page_number The number of the page to get information for, where page numbers start at 0.

Returns: The Printable object for the specified page.

Throws: IndexOutOfBoundsException If the page number is not valid.

setPage

public void setPage(int page_num, Printable printable, PageFormat page_format)

This method changes the Printable and PageFormat for the specified page. The page must already exist or an exception will be thrown.

Parameters: page_num The page number to alter. printable The new Printable for the page. page_format The new PageFormat for the page.

Throws: IndexOutOfBoundsException If the specified page does not exist.