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
|
/* Printable.java -- Renders a page to the print device
Copyright (C) 1999 Free Software Foundation, Inc.
This file is part of the non-peer AWT libraries of GNU Classpath.
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Library General Public License as published
by the Free Software Foundation, either version 2 of the License, or
(at your option) any later verion.
This library 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 Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; if not, write to the Free Software Foundation
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307 USA. */
package java.awt.print;
import java.awt.Graphics;
/**
* This interface provides a mechanism for the actual printing of pages to the
* printer. The object implementing this interface performs the page
* rendering.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
public interface Printable
{
/*
* Static Variables
*/
/**
* This value is returned by the <code>print()</code> method to indicate
* that the requested page number does not exist.
*/
public static final int NO_SUCH_PAGE = 0;
/**
* This value is returned by the <code>print()</code> method to indicate
* that the requested page exists and has been printed.
*/
public static final int PAGE_EXISTS = 1;
/*************************************************************************/
/**
* This method prints the specified page to the specified graphics
* context in the specified format. The pages are numbered starting
* from zero.
*
* @param graphics The graphics context to render the pages on.
* @param format The format in which to print the page.
* @param page_number The page number to print, where numbers start at zero.
*
* @return <code>PAGE_EXISTS</code> if the requested page exists and was
* successfully printed, <code>NO_SUCH_PAGE</code> otherwise.
*
* @exception PrinterException If an error occurs during printing.
*/
public abstract int
print(Graphics graphics, PageFormat format, int page_number)
throws PrinterException;
} // interface Printable
|
