/*
* Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code 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
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package java.awt.print;
import java.util.Vector;
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. See Also:
/**
* The {@code Book} class provides a representation of a document in
* which pages may have different page formats and page painters. This
* class uses the {@link Pageable} interface to interact with a
* {@link PrinterJob}.
* @see Pageable
* @see PrinterJob
*/
public class Book implements Pageable {
/* Class Constants */
/* Class Variables */
/* Instance Variables */
The set of pages that make up the Book.
/**
* The set of pages that make up the Book.
*/
private Vector<BookPage> mPages;
/* Instance Methods */
Creates a new, empty Book. /**
* Creates a new, empty {@code Book}.
*/
public Book() {
mPages = new Vector<>();
}
Returns the number of pages in this Book. Returns: the number of pages this Book contains.
/**
* Returns the number of pages in this {@code Book}.
* @return the number of pages this {@code Book} contains.
*/
public int getNumberOfPages(){
return mPages.size();
}
Returns the PageFormat of the page specified by pageIndex. Params: - pageIndex – the zero based index of the page whose
PageFormat is being requested
Throws: - IndexOutOfBoundsException – if the
Pageable does not contain the requested page
Returns: the PageFormat describing the size and orientation of the page.
/**
* Returns the {@link PageFormat} of the page specified by
* {@code pageIndex}.
* @param pageIndex the zero based index of the page whose
* {@code PageFormat} is being requested
* @return the {@code PageFormat} describing the size and
* orientation of the page.
* @throws IndexOutOfBoundsException if the {@code Pageable}
* does not contain the requested page
*/
public PageFormat getPageFormat(int pageIndex)
throws IndexOutOfBoundsException
{
return getPage(pageIndex).getPageFormat();
}
Returns the Printable instance responsible for rendering the page specified by pageIndex. Params: - pageIndex – the zero based index of the page whose
Printable is being requested
Throws: - IndexOutOfBoundsException – if the
Pageable does not contain the requested page
Returns: the Printable that renders the page.
/**
* Returns the {@link Printable} instance responsible for rendering
* the page specified by {@code pageIndex}.
* @param pageIndex the zero based index of the page whose
* {@code Printable} is being requested
* @return the {@code Printable} that renders the page.
* @throws IndexOutOfBoundsException if the {@code Pageable}
* does not contain the requested page
*/
public Printable getPrintable(int pageIndex)
throws IndexOutOfBoundsException
{
return getPage(pageIndex).getPrintable();
}
Sets the PageFormat and the Painter for a specified page number. Params: - 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
/**
* Sets the {@code PageFormat} and the {@code Painter} for a
* specified page number.
* @param pageIndex the zero based index of the page whose
* painter and format is altered
* @param painter the {@code Printable} instance that
* renders the page
* @param page the size and orientation of the page
* @throws IndexOutOfBoundsException if the specified
* page is not already in this {@code Book}
* @throws NullPointerException if the {@code painter} or
* {@code page} argument is {@code null}
*/
public void setPage(int pageIndex, Printable painter, PageFormat page)
throws IndexOutOfBoundsException
{
if (painter == null) {
throw new NullPointerException("painter is null");
}
if (page == null) {
throw new NullPointerException("page is null");
}
mPages.setElementAt(new BookPage(painter, page), pageIndex);
}
Appends a single page to the end of this Book. Params: - 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
/**
* Appends a single page to the end of this {@code Book}.
* @param painter the {@code Printable} instance that
* renders the page
* @param page the size and orientation of the page
* @throws NullPointerException
* If the {@code painter} or {@code page}
* argument is {@code null}
*/
public void append(Printable painter, PageFormat page) {
mPages.addElement(new BookPage(painter, page));
}
Appends numPages pages to the end of this Book. Each of the pages is associated with page. Params: - 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
/**
* Appends {@code numPages} pages to the end of this
* {@code Book}. Each of the pages is associated with
* {@code page}.
* @param painter the {@code Printable} instance that renders
* the page
* @param page the size and orientation of the page
* @param numPages the number of pages to be added to the
* this {@code Book}.
* @throws NullPointerException
* If the {@code painter} or {@code page}
* argument is {@code null}
*/
public void append(Printable painter, PageFormat page, int numPages) {
BookPage bookPage = new BookPage(painter, page);
int pageIndex = mPages.size();
int newSize = pageIndex + numPages;
mPages.setSize(newSize);
for(int i = pageIndex; i < newSize; i++){
mPages.setElementAt(bookPage, i);
}
}
Return the BookPage for the page specified by 'pageIndex'.
/**
* Return the BookPage for the page specified by 'pageIndex'.
*/
private BookPage getPage(int pageIndex)
throws ArrayIndexOutOfBoundsException
{
return mPages.elementAt(pageIndex);
}
The BookPage inner class describes an individual
page in a Book through a PageFormat-Printable pair.
/**
* The BookPage inner class describes an individual
* page in a Book through a PageFormat-Printable pair.
*/
private class BookPage {
The size and orientation of the page.
/**
* The size and orientation of the page.
*/
private PageFormat mFormat;
The instance that will draw the page.
/**
* The instance that will draw the page.
*/
private Printable mPainter;
A new instance where 'format' describes the page's
size and orientation and 'painter' is the instance
that will draw the page's graphics.
Throws: - NullPointerException – If the
painter or format argument is null
/**
* A new instance where 'format' describes the page's
* size and orientation and 'painter' is the instance
* that will draw the page's graphics.
* @throws NullPointerException
* If the {@code painter} or {@code format}
* argument is {@code null}
*/
BookPage(Printable painter, PageFormat format) {
if (painter == null || format == null) {
throw new NullPointerException();
}
mFormat = format;
mPainter = painter;
}
Return the instance that paints the
page.
/**
* Return the instance that paints the
* page.
*/
Printable getPrintable() {
return mPainter;
}
Return the format of the page.
/**
* Return the format of the page.
*/
PageFormat getPageFormat() {
return mFormat;
}
}
}