public class

Book

extends Object
implements Pageable
java.lang.Object
   ↳ java.awt.print.Book

Class Overview

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.

Summary

[Expand]
Inherited Constants
From interface java.awt.print.Pageable
Public Constructors
Book()
Creates a new, empty Book.
Public Methods
void append(Printable painter, PageFormat page, int numPages)
Appends numPages pages to the end of this Book.
void append(Printable painter, PageFormat page)
Appends a single page to the end of this Book.
int getNumberOfPages()
Returns the number of pages in this Book.
PageFormat getPageFormat(int pageIndex)
Returns the PageFormat of the page specified by pageIndex.
Printable getPrintable(int pageIndex)
Returns the Printable instance responsible for rendering the page specified by pageIndex.
void setPage(int pageIndex, Printable painter, PageFormat page)
Sets the PageFormat and the Painter for a specified page number.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.awt.print.Pageable

Public Constructors

public Book ()

Creates a new, empty Book.

Public Methods

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 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
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 the Printable instance that renders the page
page the size and orientation of the page
Throws
If the painter or page argument is null

public int getNumberOfPages ()

Returns the number of pages in this Book.

Returns
  • the number of pages this Book contains.

public PageFormat getPageFormat (int pageIndex)

Returns the PageFormat of the page specified by pageIndex.

Parameters
pageIndex the zero based index of the page whose PageFormat is being requested
Returns
  • the PageFormat describing the size and orientation of the page.
Throws
IndexOutOfBoundsException if the Pageable does not contain the requested page

public Printable getPrintable (int pageIndex)

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

Parameters
pageIndex the zero based index of the page whose Printable is being requested
Returns
  • the Printable that renders the page.
Throws
IndexOutOfBoundsException if the Pageable does not contain the requested page

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

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 if the specified page is not already in this Book
NullPointerException if the painter or page argument is null