Class JobSettings

public final StringProperty jobNameProperty

See Also:

• getJobName()
• setJobName(String)
• jobNameProperty()

public final StringProperty outputFileProperty

Default value:

an empty string

Since:

17

See Also:

• getOutputFile()
• setOutputFile(String)
• outputFileProperty()

public final IntegerProperty copiesProperty

See Also:

• getCopies()
• setCopies(int)
• copiesProperty()

public final ObjectProperty pageRangesProperty

See Also:

• getPageRanges()
• setPageRanges(PageRange[])
• pageRangesProperty()

public final ObjectProperty<PrintSides> printSidesProperty

See Also:

• getPrintSides()
• setPrintSides(PrintSides)
• printSidesProperty()

public final ObjectProperty<Collation> collationProperty

See Also:

• getCollation()
• setCollation(Collation)
• collationProperty()

public final ObjectProperty<PrintColor> printColorProperty

See Also:

• getPrintColor()
• setPrintColor(PrintColor)
• printColorProperty()

public final ObjectProperty<PrintQuality> printQualityProperty

See Also:

• getPrintQuality()
• setPrintQuality(PrintQuality)
• printQualityProperty()

public final ObjectProperty<PrintResolution> printResolutionProperty

See Also:

• getPrintResolution()
• setPrintResolution(PrintResolution)
• printResolutionProperty()

public final ObjectProperty<PaperSource> paperSourceProperty

See Also:

• getPaperSource()
• setPaperSource(PaperSource)
• paperSourceProperty()

public final ObjectProperty<PageLayout> pageLayoutProperty

See Also:

• getPageLayout()
• setPageLayout(PageLayout)
• pageLayoutProperty()

public final StringProperty jobNameProperty()

Returns:

the name of a job

See Also:

• getJobName()
• setJobName(String)

public final String getJobName()

Property description:

StringProperty representing the name of a job.

Returns:

the value of the jobName property

See Also:

• setJobName(String)
• jobNameProperty()

public final void setJobName(String name)

Property description:

StringProperty representing the name of a job.

Parameters:

name - the value for the jobName property

See Also:

• getJobName()
• jobNameProperty()

public final StringProperty outputFileProperty()

Default value:

an empty string

Returns:

the name of a printer spool file

Since:

17

See Also:

• getOutputFile()
• setOutputFile(String)

public final String getOutputFile()

Property description:

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.

Default value:

an empty string

Returns:

the value of the outputFile property

Since:

17

See Also:

• setOutputFile(String)
• outputFileProperty()

public final void setOutputFile(String filePath)

Property description:

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.

Default value:

an empty string

Parameters:

filePath - the value for the outputFile property

Since:

17

See Also:

• getOutputFile()
• outputFileProperty()

public final IntegerProperty copiesProperty()

Returns:

the number of copies of the job to print

See Also:

• getCopies()
• setCopies(int)

public final int getCopies()

Property description:

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

Returns:

the value of the copies property

See Also:

• setCopies(int)
• copiesProperty()

public final void setCopies(int nCopies)

Property description:

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

Parameters:

nCopies - the value for the copies property

See Also:

• getCopies()
• copiesProperty()

public final ObjectProperty pageRangesProperty()

Returns:

the value presents the job pages to print as an array of PageRange

See Also:

• getPageRanges()
• setPageRanges(PageRange[])

public final PageRange[] getPageRanges()

Property description:

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.

Returns:

the value of the pageRanges property

See Also:

• setPageRanges(PageRange[])
• pageRangesProperty()

public final void setPageRanges(PageRange... pages)

Parameters:

pages - null or a varargs array as specified above

public final ObjectProperty<PrintSides> printSidesProperty()

Returns:

an instance of PrintSides

See Also:

• getPrintSides()
• setPrintSides(PrintSides)

public final PrintSides getPrintSides()

Property description:

Property representing an instance of PrintSides.

Returns:

the value of the printSides property

See Also:

• setPrintSides(PrintSides)
• printSidesProperty()

public final void setPrintSides(PrintSides sides)

Property description:

Property representing an instance of PrintSides.

Parameters:

sides - the value for the printSides property

See Also:

• getPrintSides()
• printSidesProperty()

public final ObjectProperty<Collation> collationProperty()

Returns:

an instance of Collation

See Also:

• getCollation()
• setCollation(Collation)

public final Collation getCollation()

Property description:

Property representing an instance of Collation. 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.

Returns:

the value of the collation property

See Also:

• setCollation(Collation)
• collationProperty()

public final void setCollation(Collation collation)

Property description:

Property representing an instance of Collation. 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.

Parameters:

collation - the value for the collation property

See Also:

• getCollation()
• collationProperty()

public final ObjectProperty<PrintColor> printColorProperty()

Returns:

an instance of PrintColor

See Also:

• getPrintColor()
• setPrintColor(PrintColor)

public final PrintColor getPrintColor()

Property description:

Property representing an instance of PrintColor. If a null value is set it is ignored.

Returns:

the value of the printColor property

See Also:

• setPrintColor(PrintColor)
• printColorProperty()

public final void setPrintColor(PrintColor color)

Property description:

Property representing an instance of PrintColor. If a null value is set it is ignored.

Parameters:

color - the value for the printColor property

See Also:

• getPrintColor()
• printColorProperty()

public final ObjectProperty<PrintQuality> printQualityProperty()

Returns:

an instance of PrintQuality

See Also:

• getPrintQuality()
• setPrintQuality(PrintQuality)

public final PrintQuality getPrintQuality()

Property description:

Property representing an instance of PrintQuality.

Note that quality and resolution are 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 it is safest to stick to selecting a standard value that matches the requirement.

Returns:

the value of the printQuality property

See Also:

• setPrintQuality(PrintQuality)
• printQualityProperty()

public final void setPrintQuality(PrintQuality quality)

Property description:

Property representing an instance of PrintQuality.

Note that quality and resolution are 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 it is safest to stick to selecting a standard value that matches the requirement.

Parameters:

quality - the value for the printQuality property

See Also:

• getPrintQuality()
• printQualityProperty()

public final ObjectProperty<PrintResolution> printResolutionProperty()

Returns:

an instance of PrintResolution

See Also:

• getPrintResolution()
• setPrintResolution(PrintResolution)

public final PrintResolution getPrintResolution()

Property description:

Property representing an instance of PrintResolution. A null value is ignored.

Note that quality and resolution are 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 it is safest to stick to selecting a standard value that matches the requirement.

Returns:

the value of the printResolution property

See Also:

• setPrintResolution(PrintResolution)
• printResolutionProperty()

public final void setPrintResolution(PrintResolution resolution)

Property description:

Property representing an instance of PrintResolution. A null value is ignored.

Note that quality and resolution are 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 it is safest to stick to selecting a standard value that matches the requirement.

Parameters:

resolution - the value for the printResolution property

See Also:

• getPrintResolution()
• printResolutionProperty()

public final ObjectProperty<PaperSource> paperSourceProperty()

Returns:

an instance of PaperSource

See Also:

• getPaperSource()
• setPaperSource(PaperSource)

public final PaperSource getPaperSource()

Property description:

Property representing an instance of PaperSource. A null value is ignored.

Returns:

the value of the paperSource property

See Also:

• setPaperSource(PaperSource)
• paperSourceProperty()

public final void setPaperSource(PaperSource value)

Property description:

Property representing an instance of PaperSource. A null value is ignored.

Parameters:

value - the value for the paperSource property

See Also:

• getPaperSource()
• paperSourceProperty()

public final ObjectProperty<PageLayout> pageLayoutProperty()

Returns:

an instance of PageLayout

See Also:

• getPageLayout()
• setPageLayout(PageLayout)

public final PageLayout getPageLayout()

Property description:

Property representing an instance of PageLayout. Setting a null value is ignored.

Returns:

the value of the pageLayout property

See Also:

• setPageLayout(PageLayout)
• pageLayoutProperty()

public final void setPageLayout(PageLayout pageLayout)

Property description:

Property representing an instance of PageLayout. Setting a null value is ignored.

Parameters:

pageLayout - the value for the pageLayout property

See Also:

• getPageLayout()
• pageLayoutProperty()