Class JobSettings

public final StringProperty jobNameProperty

StringProperty representing the name of a job.

public final StringProperty outputFileProperty

A StringProperty representing the name of a filesystem file, to which the platform printer driver should spool the rendered print data.

Applications can use this to programmatically request print-to-file behavior where the native print system is capable of spooling the output to a filesystem file, rather than the printer device.

This is often useful where the printer driver generates a format such as Postscript or PDF, and the application intends to distribute the result instead of printing it, or for some other reason the application does not want physical media (paper) emitted by the printer.

The default value is an empty string, which is interpreted as unset, equivalent to null, which means output is sent to the printer. So in order to reset to print to the printer, clear the value of this property by setting it to null or an empty string.

Additionally if the application displays a printer dialog which allows the user to specify a file destination, including altering an application specified file destination, the value of this property will reflect that user-specified choice, including clearing it to reset to print to the printer, if the user does so.

If the print system does not support print-to-file, then this setting will be ignored.

If the specified name specifies a non-existent path, or does not specify a user writable file, when printing the results are platform-dependent. Possible behaviours might include replacement with a default output file location, printing to the printer instead, or a platform printing error. If a SecurityManager is installed and it denies access to the specified file a SecurityException may be thrown.

public final IntegerProperty copiesProperty

IntegerProperty representing the number of copies of the job to print.

public final ObjectProperty pageRangesProperty

An ObjectProperty whose value represents the job pages to print as an array of PageRange. A null values mean print all pages. Otherwise it must be a non-overlapping array of PageRange instances ordered in increasing page number. Page numbers start from 1 (one). An empty array is considered equivalent to a null array.

An illegal or unsupported (by the printer) set of page ranges will be ignored.

Ranges which exceed beyond the number of pages imaged by the job during printing do not cause any error.

public final ObjectProperty<PrintSides> printSidesProperty

Property representing an instance of PrintSides.

public final ObjectProperty<Collation> collationProperty

Property representing an instance of Collation.

public final ObjectProperty<PrintColor> printColorProperty

Property representing an instance of PrintColor.

public final ObjectProperty<PrintQuality> printQualityProperty

Property representing an instance of PrintQuality.

public final ObjectProperty<PrintResolution> printResolutionProperty

Property representing an instance of PrintResolution.

public final ObjectProperty<PaperSource> paperSourceProperty

Property representing an instance of PaperSource.

public final ObjectProperty<PageLayout> pageLayoutProperty

Property representing an instance of PageLayout.

public final StringProperty jobNameProperty()

StringProperty representing the name of a job.

public String getJobName()

Get the name of a job.

public void setJobName(String name)

Set the name of a job.

public final StringProperty outputFileProperty()

A StringProperty representing the name of a filesystem file, to which the platform printer driver should spool the rendered print data.

Applications can use this to programmatically request print-to-file behavior where the native print system is capable of spooling the output to a filesystem file, rather than the printer device.

This is often useful where the printer driver generates a format such as Postscript or PDF, and the application intends to distribute the result instead of printing it, or for some other reason the application does not want physical media (paper) emitted by the printer.

The default value is an empty string, which is interpreted as unset, equivalent to null, which means output is sent to the printer. So in order to reset to print to the printer, clear the value of this property by setting it to null or an empty string.

Additionally if the application displays a printer dialog which allows the user to specify a file destination, including altering an application specified file destination, the value of this property will reflect that user-specified choice, including clearing it to reset to print to the printer, if the user does so.

If the print system does not support print-to-file, then this setting will be ignored.

If the specified name specifies a non-existent path, or does not specify a user writable file, when printing the results are platform-dependent. Possible behaviours might include replacement with a default output file location, printing to the printer instead, or a platform printing error. If a SecurityManager is installed and it denies access to the specified file a SecurityException may be thrown.

public String getOutputFile()

Gets the value of the property outputFile.

public void setOutputFile(String filePath)

Sets the value of the property outputFile.

public final IntegerProperty copiesProperty()

IntegerProperty representing the number of copies of the job to print.

public int getCopies()

Get the number of copies to print.

public final void setCopies(int nCopies)

Set the number of copies to print.

public final ObjectProperty pageRangesProperty()

An ObjectProperty whose value represents the job pages to print as an array of PageRange. A null values mean print all pages. Otherwise it must be a non-overlapping array of PageRange instances ordered in increasing page number. Page numbers start from 1 (one). An empty array is considered equivalent to a null array.

An illegal or unsupported (by the printer) set of page ranges will be ignored.

Ranges which exceed beyond the number of pages imaged by the job during printing do not cause any error.

public PageRange[] getPageRanges()

The range of pages to print. null always means all pages. See pageRangesProperty() for more details.

public void setPageRanges(PageRange... pages)

The range of pages to print as an array of PageRange. The use of varargs means the common case of a single range can be auto-boxed. ((PageRange[])null) always means all pages however since this is the default it is less likely to be used. See pageRangesProperty() for more details.

public final ObjectProperty<PrintSides> printSidesProperty()

Property representing an instance of PrintSides.

public PrintSides getPrintSides()

If a printer supports it, then a job may be printed on both sides of the media (paper), ie duplex printing. This method returns the selected setting.

public void setPrintSides(PrintSides sides)

Set the PrintSides property which controls duplex printing. A null value is ignored.

public final ObjectProperty<Collation> collationProperty()

Property representing an instance of Collation.

public Collation getCollation()

Collation determines how sheets are sorted when multiple copies of a document are printed. As such it is only relevant if 2 or more copies of a document with 2 more sheets are printed. A sheet is the physical media, so documents with 2 pages that are printed N-up, or double-sided may still have only one sheet. A collated print job produces documents with sheets of a document sorted in sequence. An uncollated job collects together the multiple copies of the same sheet. Uncollated (false) is the typical default value.

public void setCollation(Collation collation)

Set the Collation property. A null value is ignored.

public final ObjectProperty<PrintColor> printColorProperty()

Property representing an instance of PrintColor.

public PrintColor getPrintColor()

Gets the value of the property printColor.

public void setPrintColor(PrintColor color)

Set the PrintColor property. A null value is ignored.

public final ObjectProperty<PrintQuality> printQualityProperty()

Property representing an instance of PrintQuality.

public PrintQuality getPrintQuality()

Gets the value of the property printQuality.

public void setPrintQuality(PrintQuality quality)

Set the PrintQuality property. A null value is ignored.

Note that quality and resolution overlapping concepts. Therefore a printer may support setting one, or the other but not both. Applications setting these programmatically should query both properties and select appropriately from the supported values. If a printer supports non-standard values, code likely cannot distinguish the printer's interpretation of these values and is safest to stick to selecting from the standard value that matches the requirement.

public final ObjectProperty<PrintResolution> printResolutionProperty()

Property representing an instance of PrintResolution.

public void setPrintResolution(PrintResolution resolution)

Set the PrintResolution property. A null value is ignored.

Note that quality and resolution overlapping concepts. Therefore a printer may support setting one, or the other but not both. Applications setting these programmatically should query both properties and select appropriately from the supported values. If a printer supports non-standard values, code likely cannot distinguish the printer's interpretation of these values and is safest to stick to selecting from the standard value that matches the requirement.

public final ObjectProperty<PaperSource> paperSourceProperty()

Property representing an instance of PaperSource.

public PaperSource getPaperSource()

Gets the value of the property paperSource.

public void setPaperSource(PaperSource value)

Sets the value of the property paperSource.

public final ObjectProperty<PageLayout> pageLayoutProperty()

Property representing an instance of PageLayout.

public PageLayout getPageLayout()

Get the current page layout for this job.

public void setPageLayout(PageLayout pageLayout)

Set the PageLayout to use.