java.awt.print

Class Book

Implemented Interfaces:
Pageable

public class Book
extends Object
implements Pageable

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

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

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.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Book

public Book()
Initializes a new instance of Book that is empty.

Method Details

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.
Specified by:
getNumberOfPages in interface Pageable
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.
Specified by:
getPageFormat in interface Pageable
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.
Specified by:
getPrintable in interface Pageable
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.

Book.java -- A mixed group of pages to print. Copyright (C) 1999, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.