public final class JobSettings extends Object
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.
Type | Property and Description |
---|---|
ObjectProperty<Collation> |
collation
Property representing an instance of
Collation . |
IntegerProperty |
copies
IntegerProperty representing the number of
copies of the job to print. |
StringProperty |
jobName
StringProperty representing the name of a job. |
ObjectProperty<PageLayout> |
pageLayout
Property representing an instance of
PageLayout . |
ObjectProperty |
pageRanges
An
ObjectProperty whose value represents the job pages
to print as an array of PageRange. |
ObjectProperty<PaperSource> |
paperSource
Property representing an instance of
PaperSource . |
ObjectProperty<PrintColor> |
printColor
Property representing an instance of
PrintColor . |
ObjectProperty<PrintQuality> |
printQuality
Property representing an instance of
PrintQuality . |
ObjectProperty<PrintResolution> |
printResolution
Property representing an instance of
PrintResolution . |
ObjectProperty<PrintSides> |
printSides
Property representing an instance of
PrintSides . |
Modifier and Type | Method and Description |
---|---|
ObjectProperty<Collation> |
collationProperty()
Property representing an instance of
Collation . |
IntegerProperty |
copiesProperty()
IntegerProperty representing the number of
copies of the job to print. |
Collation |
getCollation()
Collation determines how sheets are sorted when
multiple copies of a document are printed.
|
int |
getCopies() |
String |
getJobName() |
PageLayout |
getPageLayout()
Get the current page layout for this job.
|
PageRange[] |
getPageRanges()
The range of pages to print.
|
PaperSource |
getPaperSource()
Gets the value of the property paperSource.
|
PrintColor |
getPrintColor()
Gets the value of the property printColor.
|
PrintQuality |
getPrintQuality()
Gets the value of the property printQuality.
|
PrintResolution |
getPrintResolution() |
PrintSides |
getPrintSides()
If a printer supports it, then a job may be printed on
both sides of the media (paper), ie duplex printing.
|
StringProperty |
jobNameProperty()
StringProperty representing the name of a job. |
ObjectProperty<PageLayout> |
pageLayoutProperty()
Property representing an instance of
PageLayout . |
ObjectProperty |
pageRangesProperty()
An
ObjectProperty whose value represents the job pages
to print as an array of PageRange. |
ObjectProperty<PaperSource> |
paperSourceProperty()
Property representing an instance of
PaperSource . |
ObjectProperty<PrintColor> |
printColorProperty()
Property representing an instance of
PrintColor . |
ObjectProperty<PrintQuality> |
printQualityProperty()
Property representing an instance of
PrintQuality . |
ObjectProperty<PrintResolution> |
printResolutionProperty()
Property representing an instance of
PrintResolution . |
ObjectProperty<PrintSides> |
printSidesProperty()
Property representing an instance of
PrintSides . |
void |
setCollation(Collation collation)
Set the
Collation property. |
void |
setCopies(int nCopies) |
void |
setJobName(String name) |
void |
setPageLayout(PageLayout pageLayout)
Set the PageLayout to use.
|
void |
setPageRanges(PageRange... pages)
The range of pages to print as an array of PageRange.
|
void |
setPaperSource(PaperSource value)
Sets the value of the property paperSource.
|
void |
setPrintColor(PrintColor color)
Set the
PrintColor property. |
void |
setPrintQuality(PrintQuality quality)
Set the
PrintQuality property. |
void |
setPrintResolution(PrintResolution resolution)
Set the
PrintResolution property. |
void |
setPrintSides(PrintSides sides)
Set the
PrintSides property which controls
duplex printing. |
String |
toString() |
public final StringProperty jobNameProperty
StringProperty
representing the name of a job.getJobName()
,
setJobName(String)
public final IntegerProperty copiesProperty
IntegerProperty
representing the number of
copies of the job to print.getCopies()
,
setCopies(int)
public final ObjectProperty pageRangesProperty
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.
getPageRanges()
,
setPageRanges(PageRange[])
public final ObjectProperty<PrintSides> printSidesProperty
PrintSides
.getPrintSides()
,
setPrintSides(PrintSides)
public final ObjectProperty<Collation> collationProperty
Collation
.getCollation()
,
setCollation(Collation)
public final ObjectProperty<PrintColor> printColorProperty
PrintColor
.getPrintColor()
,
setPrintColor(PrintColor)
public final ObjectProperty<PrintQuality> printQualityProperty
PrintQuality
.getPrintQuality()
,
setPrintQuality(PrintQuality)
public final ObjectProperty<PrintResolution> printResolutionProperty
PrintResolution
.public final ObjectProperty<PaperSource> paperSourceProperty
PaperSource
.getPaperSource()
,
setPaperSource(PaperSource)
public final ObjectProperty<PageLayout> pageLayoutProperty
PageLayout
.getPageLayout()
,
setPageLayout(PageLayout)
public final StringProperty jobNameProperty()
StringProperty
representing the name of a job.getJobName()
,
setJobName(String)
public String getJobName()
public void setJobName(String name)
name
- string representing the name of a job.public final IntegerProperty copiesProperty()
IntegerProperty
representing the number of
copies of the job to print.getCopies()
,
setCopies(int)
public int getCopies()
public final void setCopies(int nCopies)
nCopies
- number of copies to print.public final ObjectProperty pageRangesProperty()
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.
getPageRanges()
,
setPageRanges(PageRange[])
public PageRange[] getPageRanges()
pageRangesProperty
for more details.public void setPageRanges(PageRange... pages)
((PageRange[])null)
always means all pages however
since this is the default it is less likely to be used.
See pageRangesProperty
for more details.pages
- null or a varargs array as specified abovepublic final ObjectProperty<PrintSides> printSidesProperty()
PrintSides
.getPrintSides()
,
setPrintSides(PrintSides)
public PrintSides getPrintSides()
public void setPrintSides(PrintSides sides)
PrintSides
property which controls
duplex printing.
A null value is ignored.sides
- new setting for number of sides.public final ObjectProperty<Collation> collationProperty()
Collation
.getCollation()
,
setCollation(Collation)
public Collation getCollation()
false) is the typical default value.
-
setCollation
public void setCollation(Collation collation)
Set the Collation
property.
A null value is ignored.
- Parameters:
collation
- new setting for collation
-
printColorProperty
public final ObjectProperty<PrintColor> printColorProperty()
Property representing an instance of PrintColor
.
- See Also:
getPrintColor()
,
setPrintColor(PrintColor)
-
getPrintColor
public PrintColor getPrintColor()
Gets the value of the property printColor.
- Property description:
- Property representing an instance of
PrintColor
.
-
setPrintColor
public void setPrintColor(PrintColor color)
Set the PrintColor
property.
A null value is ignored.
- Parameters:
color
- new setting for print color.
-
printQualityProperty
public final ObjectProperty<PrintQuality> printQualityProperty()
Property representing an instance of PrintQuality
.
- See Also:
getPrintQuality()
,
setPrintQuality(PrintQuality)
-
getPrintQuality
public PrintQuality getPrintQuality()
Gets the value of the property printQuality.
- Property description:
- Property representing an instance of
PrintQuality
.
-
setPrintQuality
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.
- Parameters:
quality
- new setting for print quality.
-
printResolutionProperty
public final ObjectProperty<PrintResolution> printResolutionProperty()
Property representing an instance of PrintResolution
.
-
getPrintResolution
public PrintResolution getPrintResolution()
-
setPrintResolution
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.
- Parameters:
resolution
- new setting for print resolution.
-
paperSourceProperty
public final ObjectProperty<PaperSource> paperSourceProperty()
Property representing an instance of PaperSource
.
- See Also:
getPaperSource()
,
setPaperSource(PaperSource)
-
getPaperSource
public PaperSource getPaperSource()
Gets the value of the property paperSource.
- Property description:
- Property representing an instance of
PaperSource
.
-
setPaperSource
public void setPaperSource(PaperSource value)
Sets the value of the property paperSource.
- Property description:
- Property representing an instance of
PaperSource
.
-
pageLayoutProperty
public final ObjectProperty<PageLayout> pageLayoutProperty()
Property representing an instance of PageLayout
.
- See Also:
getPageLayout()
,
setPageLayout(PageLayout)
-
getPageLayout
public PageLayout getPageLayout()
Get the current page layout for this job.
- Returns:
- page layout to use for the job.
-
setPageLayout
public void setPageLayout(PageLayout pageLayout)
Set the PageLayout to use.
- Parameters:
pageLayout
- The page layout to use.
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2008, 2019, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.