|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.awt.print.Book
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 a
PrinterJob
.
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(Printable painter,
PageFormat page)
Appends a single page to the end of this Book . |
void |
append(Printable painter,
PageFormat page,
int numPages)
Appends numPages pages 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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Book()
Book
.
Method Detail |
---|
public int getNumberOfPages()
Book
.
getNumberOfPages
in interface Pageable
Book
contains.public PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException
PageFormat
of the page specified by
pageIndex
.
getPageFormat
in interface Pageable
pageIndex
- the zero based index of the page whose
PageFormat
is being requested
PageFormat
describing the size and
orientation of the page.
IndexOutOfBoundsException
- if the Pageable
does not contain the requested pagepublic Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException
Printable
instance responsible for rendering
the page specified by pageIndex
.
getPrintable
in interface Pageable
pageIndex
- the zero based index of the page whose
Printable
is being requested
Printable
that renders the page.
IndexOutOfBoundsException
- if the Pageable
does not contain the requested pagepublic void setPage(int pageIndex, Printable painter, PageFormat page) throws IndexOutOfBoundsException
PageFormat
and the Painter
for a
specified page number.
pageIndex
- the zero based index of the page whose
painter and format is alteredpainter
- the Printable
instance that
renders the pagepage
- the size and orientation of the page
IndexOutOfBoundsException
- if the specified
page is not already in this Book
NullPointerException
- if the painter
or
page
argument is null
public void append(Printable painter, PageFormat page)
Book
.
painter
- the Printable
instance that
renders the pagepage
- the size and orientation of the page
NullPointerException
- If the painter
or page
argument is null
public void append(Printable painter, PageFormat page, int numPages)
numPages
pages to the end of this
Book
. Each of the pages is associated with
page
.
painter
- the Printable
instance that renders
the pagepage
- the size and orientation of the pagenumPages
- the number of pages to be added to the
this Book
.
NullPointerException
- If the painter
or page
argument is null
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.