Book (Java 2 Platform SE 5.0) (original) (raw)

java.awt.print

Class Book

java.lang.Object extended by java.awt.print.Book

All Implemented Interfaces:

public class Book

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 aPrinterJob.

See Also:

Pageable, PrinterJob

Field Summary

Fields inherited from interface java.awt.print.Pageable
UNKNOWN_NUMBER_OF_PAGES

Constructor Summary
Book() Creates a new, empty Book.

Method Summary
void	[append](../../../java/awt/print/Book.html#append%28java.awt.print.Printable, java.awt.print.PageFormat%29)(Printable painter,PageFormat page) Appends a single page to the end of this Book.
void	[append](../../../java/awt/print/Book.html#append%28java.awt.print.Printable, java.awt.print.PageFormat, int%29)(Printable painter,PageFormat page, int numPages) Appends numPages pages to the end of thisBook.
int	getNumberOfPages() Returns the number of pages in this Book.
PageFormat	getPageFormat(int pageIndex) Returns the PageFormat of the page specified bypageIndex.
Printable	getPrintable(int pageIndex) Returns the Printable instance responsible for rendering the page specified by pageIndex.
void	[setPage](../../../java/awt/print/Book.html#setPage%28int, java.awt.print.Printable, java.awt.print.PageFormat%29)(int pageIndex,Printable painter,PageFormat page) Sets the PageFormat and the Painter for a specified page number.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

Book

public Book()

Creates a new, empty Book.

Method Detail

getNumberOfPages

public int getNumberOfPages()

Returns the number of pages in this Book.

Specified by:

[getNumberOfPages](../../../java/awt/print/Pageable.html#getNumberOfPages%28%29) in interface [Pageable](../../../java/awt/print/Pageable.html "interface in java.awt.print")

Returns:

the number of pages this Book contains.

getPageFormat

public PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException

Returns the PageFormat of the page specified bypageIndex.

Specified by:

[getPageFormat](../../../java/awt/print/Pageable.html#getPageFormat%28int%29) in interface [Pageable](../../../java/awt/print/Pageable.html "interface in java.awt.print")

Parameters:

pageIndex - the zero based index of the page whosePageFormat is being requested

Returns:

the PageFormat describing the size and orientation of the page.

Throws:

[IndexOutOfBoundsException](../../../java/lang/IndexOutOfBoundsException.html "class in java.lang") - if the Pageable does not contain the requested page

getPrintable

public Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException

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

Specified by:

[getPrintable](../../../java/awt/print/Pageable.html#getPrintable%28int%29) in interface [Pageable](../../../java/awt/print/Pageable.html "interface in java.awt.print")

Parameters:

pageIndex - the zero based index of the page whosePrintable is being requested

Returns:

the Printable that renders the page.

Throws:

[IndexOutOfBoundsException](../../../java/lang/IndexOutOfBoundsException.html "class in java.lang") - if the Pageable does not contain the requested page

setPage

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

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

Parameters:

pageIndex - the zero based index of the page whose painter and format is altered

painter - the Printable instance that renders the page

page - the size and orientation of the page

Throws:

[IndexOutOfBoundsException](../../../java/lang/IndexOutOfBoundsException.html "class in java.lang") - if the specified page is not already in this Book

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if the painter orpage argument is null

append

public void append(Printable painter, PageFormat page)

Appends a single page to the end of this Book.

Parameters:

painter - the Printable instance that renders the page

page - the size and orientation of the page

Throws:

`NullPointerException` - If the painter or page argument is null

append

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

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

Parameters:

painter - the Printable instance that renders the page

page - the size and orientation of the page

numPages - the number of pages to be added to the this Book.

Throws:

`NullPointerException` - If the painter or page argument is null

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.