java.awt.print
Interface Printable


public interface Printable

This interface provides a mechanism for the actual printing of pages to the printer. The object implementing this interface performs the page rendering.


Field Summary
static int NO_SUCH_PAGE
          This value is returned by the print() method to indicate that the requested page number does not exist.
static int PAGE_EXISTS
          This value is returned by the print() method to indicate that the requested page exists and has been printed.
 
Method Summary
 int print(Graphics graphics, PageFormat format, int page_number)
          This method prints the specified page to the specified graphics context in the specified format.
 

Field Detail

PAGE_EXISTS

static final int PAGE_EXISTS
This value is returned by the print() method to indicate that the requested page exists and has been printed.

See Also:
Constant Field Values

NO_SUCH_PAGE

static final int NO_SUCH_PAGE
This value is returned by the print() method to indicate that the requested page number does not exist.

See Also:
Constant Field Values
Method Detail

print

int print(Graphics graphics,
          PageFormat format,
          int page_number)
          throws PrinterException
This method prints the specified page to the specified graphics context in the specified format. The pages are numbered starting from zero.

Parameters:
graphics - The graphics context to render the pages on.
format - The format in which to print the page.
page_number - The page number to print, where numbers start at zero.
Returns:
PAGE_EXISTS if the requested page exists and was successfully printed, NO_SUCH_PAGE otherwise.
Throws:
PrinterException - If an error occurs during printing.