|
Generated by JDiff |
||||||||
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES |
This file contains all the changes in documentation in the packagejava.awt.print
as colored differences. Deletions are shownlike 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.
Returns the PageFormat of the page specified byClass Book, Printable getPrintable(int)pageIndex
. @param pageIndex the zero based index of the page whosePageFormat
is being requested @return thePageFormat
describing the size and orientation of the page. @exceptionthrows IndexOutOfBoundsExceptionTheif thePageable
does not contain the requested page
Returns the Printable instance responsible for rendering the page specified byClass Book, void setPage(int, Printable, PageFormat)pageIndex
. @param pageIndex the zero based index of the page whosePrintable
is being requested @return thePrintable
that renders the page. @exceptionthrows IndexOutOfBoundsException if thePageable
does not contain the requested page.
Sets thePageFormat
and thePainter
for a specified page number. @param pageIndex the zero based index of the page whose painter and format is altered @param painter thePrintable
instance that renders the page @param page the size and orientation of the page @exceptionthrows IndexOutOfBoundsExceptionIfif the specified page is not already in thisBook
@throws NullPointerExceptionIfif thepainter
orpage
argument isnull
Returns the orientation of thisClass PageFormat, Paper getPaper()PageFormat
. @return thisPageFormat
object's orientation. @see #setOrientation
Returns a copy of the Paper object associated with thisClass PageFormat, void setOrientation(int)PageFormat
. Changes made to thePaper
object returned from this method do not affect thePaper
object of thisPageFormat
. To update thePaper
object of thisPageFormat
create a newPaper
object and set it into thisPageFormat
by using the #setPaper(Paper) method. @return a copy of thePaper
object associated with thisPageFormat
. @see #setPaper
Sets the page orientation.Class PageFormat, void setPaper(Paper)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
Sets thePaper
object for thisPageFormat
. @param paper thePaper
object to which to set thePaper
object for thisPageFormat
. @exceptionNullPointerException
a null paper instance was passed as a parameter. @see #getPaper
Returns theClass Pageable, Printable getPrintable(int)PageFormat
of the page specified bypageIndex
. @param pageIndex the zero based index of the page whosePageFormat
is being requested @return thePageFormat
describing the size and orientation. @exceptionthrows IndexOutOfBoundsException if thePageable
does not contain the requested page.
Returns theClass Pageable, int UNKNOWN_NUMBER_OF_PAGESPrintable
instance responsible for rendering the page specified bypageIndex
. @param pageIndex the zero based index of the page whosePrintable
is being requested @return thePrintable
that renders the page. @exceptionthrows IndexOutOfBoundsException if thePageable
does not contain the requested page.
This constant is returned from the getNumberOfPages method if a Pageable
implementation does not know the number of pages in its set.
TheClass PrinterIOException, IOException getIOException()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."
Returns theIOException
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. @seejava.io.IOException
Gets the number of copies to be printed. @return the number of copies to be printed. @see #setCopiesClass PrinterJob, String getJobName()
Gets the name of the document to be printed. @return the name of the document to be printed. @see #setJobNameClass PrinterJob, PrinterJob getPrinterJob()
Creates and returns aClass PrinterJob, PageFormat pageDialog(PageFormat)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 butgetPrintService()
will returnnull
and calling print with thisPrinterJob
might generate an exception. Applications that need to determine if there are suitable printers before creating aPrinterJob
should ensure that the array returned from lookupPrintServices is not empty. @return a newPrinterJob
.
Displays a dialog that allows modification of aClass PrinterJob, boolean printDialog()PageFormat
instance. Thepage
argument is used to initialize controls in the page setup dialog. If the user cancels the dialog then this method returns the originalpage
object unmodified. If the user okays the dialog then this method returns a newPageFormat
object with the indicated changes. In either case the originalpage
object is not modified. @param page the defaultPageFormat
presented to the user for modification @return the originalpage
object if the dialog is cancelled; a newPageFormat
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
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 useClass PrinterJob, void setCopies(int)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.
@returntrue
if the user does not cancel the dialog;false
otherwise. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless
Sets the number of copies to be printed. @param copies the number of copies to be printed @see #getCopiesClass 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