API Overview API Index Package Overview Direct link to this page
JDK 1.6
  java.awt.print. Book View Javadoc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203

/*
 * @(#)Book.java	1.18 05/11/17
 *
 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */

package java.awt.print;

import java.util.Vector;

/**
 * The <code>Book</code> 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.
     */
    private Vector mPages;

 /* Instance Methods */

    /**
     *	Creates a new, empty <code>Book</code>.
     */
    public Book() {
    	mPages = new Vector();
    }

    /**
     * Returns the number of pages in this <code>Book</code>.
     * @return the number of pages this <code>Book</code> contains.
     */
    public int getNumberOfPages(){
	return mPages.size();
    }

    /**
     * Returns the {@link PageFormat} of the page specified by
     * <code>pageIndex</code>.
     * @param pageIndex the zero based index of the page whose
     *            <code>PageFormat</code> is being requested
     * @return the <code>PageFormat</code> describing the size and
     *          orientation of the page.
     * @throws IndexOutOfBoundsException if the <code>Pageable</code> 
     * 		does not contain the requested page 
     */
    public PageFormat getPageFormat(int pageIndex)
	throws IndexOutOfBoundsException
    {
	return getPage(pageIndex).getPageFormat();
    }

    /**
     * Returns the {@link Printable} instance responsible for rendering   
     * the page specified by <code>pageIndex</code>.
     * @param pageIndex the zero based index of the page whose
     *                  <code>Printable</code> is being requested
     * @return the <code>Printable</code> that renders the page.
     * @throws IndexOutOfBoundsException if the <code>Pageable</code>
     *            does not contain the requested page 
     */
    public Printable getPrintable(int pageIndex)
	throws IndexOutOfBoundsException
    {
	return getPage(pageIndex).getPrintable();
    }

    /**
     * Sets the <code>PageFormat</code> and the <code>Painter</code> 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</code> 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</code> 
     * @throws NullPointerException if the <code>painter</code> or
     *		<code>page</code> argument is <code>null</code>
     */
    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 <code>Book</code>.   
     * @param painter   the <code>Printable</code> instance that
     *                  renders the page
     * @param page      the size and orientation of the page 
     * @throws <code>NullPointerException</code>
     *          If the <code>painter</code> or <code>page</code>
     *		argument is <code>null</code>
     */
    public void append(Printable painter, PageFormat page) {
	mPages.addElement(new BookPage(painter, page));
    }

    /**
     * Appends <code>numPages</code> pages to the end of this
     * <code>Book</code>.  Each of the pages is associated with 
     * <code>page</code>.
     * @param painter   the <code>Printable</code> 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</code>. 
     * @throws <code>NullPointerException</code>
     *          If the <code>painter</code> or <code>page</code>
     *		argument is <code>null</code>
     */
    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'.
     */
    private BookPage getPage(int pageIndex)
	throws ArrayIndexOutOfBoundsException
    {
	return (BookPage) mPages.elementAt(pageIndex);
    }

    /**
     * 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.
	 */
	private PageFormat mFormat;

	/**
	 * 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 <code>painter</code> or <code>format</code>
	 *	    argument is <code>null</code>
	 */
	BookPage(Printable painter, PageFormat format) {

	    if (painter == null || format == null) {
		throw new NullPointerException();
	    }

	    mFormat = format;
	    mPainter = painter;
	}

	/**
	 * Return the instance that paints the
	 * page.
	 */
	Printable getPrintable() {
	    return mPainter;
	}

	/**
	 * Return the format of the page.
	 */
	PageFormat getPageFormat() {
	    return mFormat;
	}
    }
}

Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar