Generated by
JDiff

java.awt.print Documentation Differences

This file contains all the changes in documentation in the package java.awt.print as colored differences. Deletions are shown like this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

Class Book, PageFormat getPageFormat(int)

Returns the PageFormat of the page specified by pageIndex. @param pageIndex the zero based index of the page whose PageFormat is being requested @return the PageFormat describing the size and orientation of the page. @exceptionthrows IndexOutOfBoundsException Theif the Pageable does not contain the requested page
Class Book, Printable getPrintable(int)

Returns the Printable instance responsible for rendering the page specified by pageIndex. @param pageIndex the zero based index of the page whose Printable is being requested @return the Printable that renders the page. @exceptionthrows IndexOutOfBoundsException if the Pageable does not contain the requested page.
Class Book, void setPage(int, Printable, PageFormat)

Sets the PageFormat and the Painter for a specified page number. @param pageIndex the zero based index of the page whose painter and format is altered @param painter the Printable instance that renders the page @param page the size and orientation of the page @exceptionthrows IndexOutOfBoundsException Ifif the specified page is not already in this Book @throws NullPointerException Ifif the painter or page argument is null

Class PageFormat, int getOrientation()

Returns the orientation of this PageFormat. @return this PageFormat object's orientation. @see #setOrientation
Class PageFormat, Paper getPaper()

Returns a copy of the Paper object associated with this PageFormat. Changes made to the Paper object returned from this method do not affect the Paper object of this PageFormat. To update the Paper object of this PageFormat create a new Paper object and set it into this PageFormat by using the #setPaper(Paper) method. @return a copy of the Paper object associated with this PageFormat. @see #setPaper
Class PageFormat, void setOrientation(int)

Sets the page orientation. orientation must be one of the constants: PORTRAIT LANDSCAPE or REVERSE_LANDSCAPE. @param orientation the new orientation for the page @exceptionthrows IllegalArgumentException if an unknown orientation was requested @see #getOrientation
Class PageFormat, void setPaper(Paper)

Sets the Paper object for this PageFormat. @param paper the Paper object to which to set the Paper object for this PageFormat. @exception NullPointerException a null paper instance was passed as a parameter. @see #getPaper

Class Pageable, PageFormat getPageFormat(int)

Returns the PageFormat of the page specified by pageIndex. @param pageIndex the zero based index of the page whose PageFormat is being requested @return the PageFormat describing the size and orientation. @exceptionthrows IndexOutOfBoundsException if the Pageable does not contain the requested page.
Class Pageable, Printable getPrintable(int)

Returns the Printable instance responsible for rendering the page specified by pageIndex. @param pageIndex the zero based index of the page whose Printable is being requested @return the Printable that renders the page. @exceptionthrows IndexOutOfBoundsException if the Pageable does not contain the requested page.
Class Pageable, int UNKNOWN_NUMBER_OF_PAGES

This constant is returned from the getNumberOfPages method if a Pageable implementation does not know the number of pages in its set.

Class PrinterIOException

The PrinterIOException class is a subclass of PrinterException and is used to indicate that an IO error of some sort has occurred while printing.

As of release 1.4 this exception has been retrofitted to conform to the general purpose exception-chaining mechanism. The "IOException that terminated the print job" that is provided at construction time and accessed via the #getIOException() method is now known as the cause and may be accessed via the Throwable#getCause() method as well as the aforementioned "legacy method."

Class PrinterIOException, IOException getIOException()

Returns the IOException that terminated the print job.

This method predates the general-purpose exception chaining facility. The Throwable#getCause() method is now the preferred means of obtaining this information. @return the IOException that terminated the print job. @see java.io.IOException


Class PrinterJob, int getCopies()

Gets the number of copies to be printed. @return the number of copies to be printed. @see #setCopies
Class PrinterJob, String getJobName()

Gets the name of the document to be printed. @return the name of the document to be printed. @see #setJobName
Class PrinterJob, PrinterJob getPrinterJob()

Creates and returns a PrinterJob which is initially associated with the default printer. If no printers are available on the system a PrinterJob will still be returned from this method but getPrintService() will return null and calling print with this PrinterJob might generate an exception. Applications that need to determine if there are suitable printers before creating a PrinterJob should ensure that the array returned from lookupPrintServices is not empty. @return a new PrinterJob.
Class PrinterJob, PageFormat pageDialog(PageFormat)

Displays a dialog that allows modification of a PageFormat instance. The page argument is used to initialize controls in the page setup dialog. If the user cancels the dialog then this method returns the original page object unmodified. If the user okays the dialog then this method returns a new PageFormat object with the indicated changes. In either case the original page object is not modified. @param page the default PageFormat presented to the user for modification @return the original page object if the dialog is cancelled; a new PageFormat object containing the format indicated by the user if the dialog is acknowledged. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @since 1.2
Class PrinterJob, boolean printDialog()

Presents a dialog to the user for changing the properties of the print job. This method will display a native dialog if a native print service is selected and user choice of printers will be restricted to these native print services. To present the cross platform print dialog for all services including native ones instead use printDialog(PrintRequestAttributeSet).

PrinterJob implementations which can use PrintService's will update the PrintService for this PrinterJob to reflect the new service selected by the user. @return true if the user does not cancel the dialog; false otherwise. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless

Class PrinterJob, void setCopies(int)

Sets the number of copies to be printed. @param copies the number of copies to be printed @see #getCopies
Class PrinterJob, void setJobName(String)

Sets the name of the document to be printed. The document name can not be null. @param jobName the name of the document to be printed @see #getJobName