Printable interface is implemented
by the print methods of the current
page painter, which is called by the printing
system to render a page. When building a
Pageable, pairs of PageFormat
instances and instances that implement
this interface are used to describe each page. The
instance implementing Printable is called to
print the page's graphics.
A Printable(..) may be set on a PrinterJob.
When the client subsequently initiates printing by calling
PrinterJob.print(..) control
is handed to the printing system until all pages have been printed.
It does this by calling Printable.print(..) until
all pages in the document have been printed.
In using the Printable interface the printing
commits to image the contents of a page whenever
requested by the printing system.
The parameters to Printable.print(..) include a
PageFormat which describes the printable area of
the page, needed for calculating the contents that will fit the
page, and the page index, which specifies the zero-based print
stream index of the requested page.
For correct printing behaviour, the following points should be observed:
Printable.print(..)
with page indexes which increase monotonically, although as noted above,
the Printable should expect multiple calls for a page index
and that page indexes may be skipped, when page ranges are specified
by the client, or by a user through a print dialog.
Printable must
inspect and honour the supplied PageFormat parameter as well as the
page index. The format of the page to be drawn is specified by the
supplied PageFormat. The size, orientation and imageable area of the page
is therefore already determined and rendering must be within this
imageable area.
This is key to correct printing behaviour, and it has the
implication that the client has the responsibility of tracking
what content belongs on the specified page.
Printable is obtained from a client-supplied
Pageable then the client may provide different PageFormats
for each page index. Calculations of page breaks must account for this.
java.awt.print.Pageable , java.awt.print.PageFormat , java.awt.print.PrinterJob
| Modifier and Type | Field and Description |
|---|---|
| public static final int | NO_SUCH_PAGE
Returned from |
| public static final int | PAGE_EXISTS
Returned from |
| Modifier and Type | Method and Description |
|---|---|
| public int | Returns: PAGE_EXISTS if the page is rendered successfully or NO_SUCH_PAGE ifpageIndex specifies a
non-existent page.the context into which the page is drawn graphics, PageFormat the size and orientation of the page being drawn pageFormat, int the zero based index of the page to be drawn pageIndex)Prints the page at the specified index into the specified
|
| NO_SUCH_PAGE | back to summary |
|---|---|
| public static final int NO_SUCH_PAGE Returned from | |
| PAGE_EXISTS | back to summary |
|---|---|
| public static final int PAGE_EXISTS Returned from | |
| back to summary | |
|---|---|
| public int print(Graphics graphics, PageFormat pageFormat, int pageIndex) throws PrinterException Prints the page at the specified index into the specified
| |