As documented on PrinterJob, the JobSettings installed on that job will initially reflect the current default settings for the initially associated printer for that job.
The JobSettings delegate then remains the same for the life of the job, and will have it's member properties updated to be compatible with a change in Printer on the job. For example as a result of a user interaction via a platform's dialog. An incompatible setting will usually cause the setting to revert to the default for the new printer.
Any implicit or explicit updates to settings resulting from the user interaction with dialog will be propagated and visible to the application once the user approves the settings by dismissing the dialog using its "accept" option.
For most printing applications it is likely sufficient to let the user set the desired options and have these propagated to the job. For applications which need them, there are setter and getter methods for the individual options, which are also available as properties, and change in values of settings may be monitored and updated via these properties.
Not all values of settings are available on all printers. For example
a printer may not support two-sided printing.
See the Printer
class for how to
to determine supported settings.
- Since:
- JavaFX 8.0
-
Property Summary
TypePropertyDescriptionfinal ObjectProperty<Collation>
Property representing an instance ofCollation
.final IntegerProperty
IntegerProperty
representing the number of copies of the job to print.final StringProperty
StringProperty
representing the name of a job.final StringProperty
AStringProperty
representing the name of a filesystem file, to which the platform printer driver should spool the rendered print data.final ObjectProperty<PageLayout>
Property representing an instance ofPageLayout
.final ObjectProperty
AnObjectProperty
whose value represents the job pages to print as an array of PageRange.final ObjectProperty<PaperSource>
Property representing an instance ofPaperSource
.final ObjectProperty<PrintColor>
Property representing an instance ofPrintColor
.final ObjectProperty<PrintQuality>
Property representing an instance ofPrintQuality
.final ObjectProperty<PrintResolution>
Property representing an instance ofPrintResolution
.final ObjectProperty<PrintSides>
Property representing an instance ofPrintSides
. -
Method Summary
Modifier and TypeMethodDescriptionfinal ObjectProperty<Collation>
Property representing an instance ofCollation
.final IntegerProperty
IntegerProperty
representing the number of copies of the job to print.final Collation
Gets the value of thecollation
property.final int
Gets the value of thecopies
property.final String
Gets the value of thejobName
property.final String
Gets the value of theoutputFile
property.final PageLayout
Gets the value of thepageLayout
property.final PageRange[]
Gets the value of thepageRanges
property.final PaperSource
Gets the value of thepaperSource
property.final PrintColor
Gets the value of theprintColor
property.final PrintQuality
Gets the value of theprintQuality
property.final PrintResolution
Gets the value of theprintResolution
property.final PrintSides
Gets the value of theprintSides
property.final StringProperty
StringProperty
representing the name of a job.final StringProperty
AStringProperty
representing the name of a filesystem file, to which the platform printer driver should spool the rendered print data.final ObjectProperty<PageLayout>
Property representing an instance ofPageLayout
.final ObjectProperty
AnObjectProperty
whose value represents the job pages to print as an array of PageRange.final ObjectProperty<PaperSource>
Property representing an instance ofPaperSource
.final ObjectProperty<PrintColor>
Property representing an instance ofPrintColor
.final ObjectProperty<PrintQuality>
Property representing an instance ofPrintQuality
.final ObjectProperty<PrintResolution>
Property representing an instance ofPrintResolution
.final ObjectProperty<PrintSides>
Property representing an instance ofPrintSides
.final void
setCollation
(Collation collation) Sets the value of thecollation
property.final void
setCopies
(int nCopies) Sets the value of thecopies
property.final void
setJobName
(String name) Sets the value of thejobName
property.final void
setOutputFile
(String filePath) Sets the value of theoutputFile
property.final void
setPageLayout
(PageLayout pageLayout) Sets the value of thepageLayout
property.final void
setPageRanges
(PageRange... pages) The range of pages to print as an array of PageRange.final void
setPaperSource
(PaperSource value) Sets the value of thepaperSource
property.final void
setPrintColor
(PrintColor color) Sets the value of theprintColor
property.final void
setPrintQuality
(PrintQuality quality) Sets the value of theprintQuality
property.final void
setPrintResolution
(PrintResolution resolution) Sets the value of theprintResolution
property.final void
setPrintSides
(PrintSides sides) Sets the value of theprintSides
property.
-
Property Details
-
jobName
StringProperty
representing the name of a job.- See Also:
-
outputFile
AStringProperty
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 aSecurityException
may be thrown.- Default value:
- an empty string
- Since:
- 17
- See Also:
-
copies
IntegerProperty
representing the number of copies of the job to print.- See Also:
-
pageRanges
AnObjectProperty
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.
-
printSides
Property representing an instance ofPrintSides
. -
collation
Property representing an instance ofCollation
. 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. -
printColor
Property representing an instance ofPrintColor
. If a null value is set it is ignored. -
printQuality
Property representing an instance ofPrintQuality
.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.
-
printResolution
Property representing an instance ofPrintResolution
. 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.
-
paperSource
Property representing an instance ofPaperSource
. A null value is ignored. -
pageLayout
Property representing an instance ofPageLayout
. Setting a null value is ignored.
-
-
Method Details
-
jobNameProperty
StringProperty
representing the name of a job.- Returns:
- the name of a job
- See Also:
-
getJobName
Gets the value of thejobName
property.- Property description:
StringProperty
representing the name of a job.- Returns:
- the value of the
jobName
property - See Also:
-
setJobName
Sets the value of thejobName
property.- Property description:
StringProperty
representing the name of a job.- Parameters:
name
- the value for thejobName
property- See Also:
-
outputFileProperty
AStringProperty
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 aSecurityException
may be thrown.- Default value:
- an empty string
- Returns:
- the name of a printer spool file
- Since:
- 17
- See Also:
-
getOutputFile
Gets the value of theoutputFile
property.- 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. If a
SecurityManager
is installed and it denies access to the specified file aSecurityException
may be thrown. - Default value:
- an empty string
- Returns:
- the value of the
outputFile
property - Since:
- 17
- See Also:
-
setOutputFile
Sets the value of theoutputFile
property.- 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. If a
SecurityManager
is installed and it denies access to the specified file aSecurityException
may be thrown. - Default value:
- an empty string
- Parameters:
filePath
- the value for theoutputFile
property- Since:
- 17
- See Also:
-
copiesProperty
IntegerProperty
representing the number of copies of the job to print.- Returns:
- the number of copies of the job to print
- See Also:
-
getCopies
public final int getCopies()Gets the value of thecopies
property.- Property description:
IntegerProperty
representing the number of copies of the job to print.- Returns:
- the value of the
copies
property - See Also:
-
setCopies
public final void setCopies(int nCopies) Sets the value of thecopies
property.- Property description:
IntegerProperty
representing the number of copies of the job to print.- Parameters:
nCopies
- the value for thecopies
property- See Also:
-
pageRangesProperty
AnObjectProperty
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 presents the job pages to print as an array of PageRange
- See Also:
-
getPageRanges
Gets the value of thepageRanges
property.- 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
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. SeepageRangesProperty()
for more details.- Parameters:
pages
- null or a varargs array as specified above
-
printSidesProperty
Property representing an instance ofPrintSides
.- Returns:
- an instance of
PrintSides
- See Also:
-
getPrintSides
Gets the value of theprintSides
property.- Property description:
- Property representing an instance of
PrintSides
. - Returns:
- the value of the
printSides
property - See Also:
-
setPrintSides
Sets the value of theprintSides
property.- Property description:
- Property representing an instance of
PrintSides
. - Parameters:
sides
- the value for theprintSides
property- See Also:
-
collationProperty
Property representing an instance ofCollation
. 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:
- an instance of
Collation
- See Also:
-
getCollation
Gets the value of thecollation
property.- 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
Sets the value of thecollation
property.- 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 thecollation
property- See Also:
-
printColorProperty
Property representing an instance ofPrintColor
. If a null value is set it is ignored.- Returns:
- an instance of
PrintColor
- See Also:
-
getPrintColor
Gets the value of theprintColor
property.- 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
Sets the value of theprintColor
property.- Property description:
- Property representing an instance of
PrintColor
. If a null value is set it is ignored. - Parameters:
color
- the value for theprintColor
property- See Also:
-
printQualityProperty
Property representing an instance ofPrintQuality
.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:
- an instance of
PrintQuality
- See Also:
-
getPrintQuality
Gets the value of theprintQuality
property.- 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
Sets the value of theprintQuality
property.- 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 theprintQuality
property- See Also:
-
printResolutionProperty
Property representing an instance ofPrintResolution
. 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:
- an instance of
PrintResolution
- See Also:
-
getPrintResolution
Gets the value of theprintResolution
property.- 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
Sets the value of theprintResolution
property.- 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 theprintResolution
property- See Also:
-
paperSourceProperty
Property representing an instance ofPaperSource
. A null value is ignored.- Returns:
- an instance of
PaperSource
- See Also:
-
getPaperSource
Gets the value of thepaperSource
property.- Property description:
- Property representing an instance of
PaperSource
. A null value is ignored. - Returns:
- the value of the
paperSource
property - See Also:
-
setPaperSource
Sets the value of thepaperSource
property.- Property description:
- Property representing an instance of
PaperSource
. A null value is ignored. - Parameters:
value
- the value for thepaperSource
property- See Also:
-
pageLayoutProperty
Property representing an instance ofPageLayout
. Setting a null value is ignored.- Returns:
- an instance of
PageLayout
- See Also:
-
getPageLayout
Gets the value of thepageLayout
property.- Property description:
- Property representing an instance of
PageLayout
. Setting a null value is ignored. - Returns:
- the value of the
pageLayout
property - See Also:
-
setPageLayout
Sets the value of thepageLayout
property.- Property description:
- Property representing an instance of
PageLayout
. Setting a null value is ignored. - Parameters:
pageLayout
- the value for thepageLayout
property- See Also:
-