1 |
/* Printable.java -- Renders a page to the print device |
/* Printable.java -- Renders a page to the print device |
2 |
Copyright (C) 1999 Free Software Foundation, Inc. |
Copyright (C) 1999, 2004 Free Software Foundation, Inc. |
3 |
|
|
4 |
This file is part of GNU Classpath. |
This file is part of GNU Classpath. |
5 |
|
|
35 |
obligated to do so. If you do not wish to do so, delete this |
obligated to do so. If you do not wish to do so, delete this |
36 |
exception statement from your version. */ |
exception statement from your version. */ |
37 |
|
|
|
|
|
38 |
package java.awt.print; |
package java.awt.print; |
39 |
|
|
40 |
import java.awt.Graphics; |
import java.awt.Graphics; |
41 |
|
|
42 |
|
|
43 |
/** |
/** |
44 |
* This interface provides a mechanism for the actual printing of pages to the |
* This interface provides a mechanism for the actual printing of pages to the |
45 |
* printer. The object implementing this interface performs the page |
* printer. The object implementing this interface performs the page |
46 |
* rendering. |
* rendering. |
47 |
* |
* |
48 |
* @author Aaron M. Renn (arenn@urbanophile.com) |
* @author Aaron M. Renn (arenn@urbanophile.com) |
49 |
*/ |
*/ |
50 |
public interface Printable |
public interface Printable |
51 |
{ |
{ |
52 |
|
/** |
53 |
/* |
* This value is returned by the <code>print()</code> method to indicate |
54 |
* Static Variables |
* that the requested page exists and has been printed. |
55 |
*/ |
*/ |
56 |
|
int PAGE_EXISTS = 0; |
57 |
/** |
|
58 |
* This value is returned by the <code>print()</code> method to indicate |
/** |
59 |
* that the requested page number does not exist. |
* This value is returned by the <code>print()</code> method to indicate |
60 |
*/ |
* that the requested page number does not exist. |
61 |
int NO_SUCH_PAGE = 0; |
*/ |
62 |
|
int NO_SUCH_PAGE = 1; |
63 |
/** |
|
64 |
* This value is returned by the <code>print()</code> method to indicate |
/** |
65 |
* that the requested page exists and has been printed. |
* This method prints the specified page to the specified graphics |
66 |
*/ |
* context in the specified format. The pages are numbered starting |
67 |
int PAGE_EXISTS = 1; |
* from zero. |
68 |
|
* |
69 |
/*************************************************************************/ |
* @param graphics The graphics context to render the pages on. |
70 |
|
* @param format The format in which to print the page. |
71 |
/** |
* @param page_number The page number to print, where numbers start at zero. |
72 |
* This method prints the specified page to the specified graphics |
* |
73 |
* context in the specified format. The pages are numbered starting |
* @return <code>PAGE_EXISTS</code> if the requested page exists and was |
74 |
* from zero. |
* successfully printed, <code>NO_SUCH_PAGE</code> otherwise. |
75 |
* |
* |
76 |
* @param graphics The graphics context to render the pages on. |
* @exception PrinterException If an error occurs during printing. |
77 |
* @param format The format in which to print the page. |
*/ |
78 |
* @param page_number The page number to print, where numbers start at zero. |
int print(Graphics graphics, PageFormat format, int page_number) |
79 |
* |
throws PrinterException; |
80 |
* @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. |
|
|
*/ |
|
|
int |
|
|
print(Graphics graphics, PageFormat format, int page_number) |
|
|
throws PrinterException; |
|
|
|
|
|
} // interface Printable |
|
|
|
|