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
|
/* Pageable.java -- Pages to be printed
Copyright (C) 1999 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., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.
As a special exception, if you link this library with other files to
produce an executable, this library does not by itself cause the
resulting executable to be covered by the GNU General Public License.
This exception does not however invalidate any other reasons why the
executable file might be covered by the GNU General Public License. */
package java.awt.print;
/**
* This interface represents pages that are to be printed.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
public interface Pageable
{
/*
* Static Variables
*/
/**
* This constant is returned when <code>getNumberOfPages()</code>
* cannot determine the number of pages available for printing.
*/
public static final int UNKNOWN_NUMBER_OF_PAGES = -1;
/*************************************************************************/
/*
* Instance Methods
*/
/**
* This method returns the number of pages this object contains, or
* <code>UNKNOWN_NUMBER_OF_PAGES</code> if it cannot determine the number
* of pages to be printed.
*
* @return The number of pages to be printed, or
* <code>UNKNOWN_NUMBER_OF_PAGES</code> if this is unknown.
*/
public abstract int
getNumberOfPages();
/*************************************************************************/
/**
* This method returns the <code>PageFormat</code> instance for the
* specified page. Page numbers start at zero. An exception is thrown if
* the requested page does not exist.
*
* @param pageIndex The index of the page to return the
* <code>PageFormat</code> for.
*
* @return The <code>PageFormat</code> for the requested page.
*
* @exception IndexOutOfBoundsException If the requested page number does
* not exist.
*/
public abstract PageFormat
getPageFormat(int pageIndex) throws IndexOutOfBoundsException;
/*************************************************************************/
/**
* This method returns the <code>Printable</code> instance for the
* specified page. Page numbers start at zero. An exception is thrown if
* the requested page does not exist.
*
* @param pageIndex The index of the page to return the
* <code>Printable</code> for.
*
* @return The <code>Printable</code> for the requested page.
*
* @exception IndexOutOfBoundsException If the requested page number does
* not exist.
*/
public abstract Printable
getPrintable(int pageIndex) throws IndexOutOfBoundsException;
} // interface Pageable
|
