JavaFX 24 · javafx.print.JobSettings · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private ObjectProperty<Collation>	collation
private ObjectProperty<PrintColor>	color
private IntegerProperty	copies
private static final String	DEFAULT_JOBNAME
private boolean	defaultCollation
private boolean	defaultCopies
private boolean	defaultPageLayout
private boolean	defaultPaperSource
private boolean	defaultPrintColor
private boolean	defaultPrintQuality
private boolean	defaultPrintResolution
private boolean	defaultSides
private boolean	hasOldCollation
private boolean	hasOldCopies
private boolean	hasOldPageLayout
private boolean	hasOldPaperSource
private boolean	hasOldPrintColor
private boolean	hasOldPrintQuality
private boolean	hasOldPrintResolution
private boolean	hasOldSides
private PrinterJob	job
private SimpleStringProperty	jobName
private ObjectProperty<PageLayout>	layout
private Collation	oldCollation
private int	oldCopies
private PageLayout	oldPageLayout
private PaperSource	oldPaperSource
private PrintColor	oldPrintColor
private PrintQuality	oldPrintQuality
private PrintResolution	oldPrintResolution
private PrintSides	oldSides
private SimpleStringProperty	outputFile
private ObjectProperty<PageRange[]>	pageRanges
private ObjectProperty<PaperSource>	paperSource
private Printer	printer
private PrinterAttributes	printerCaps
private ObjectProperty<PrintQuality>	quality
private ObjectProperty<PrintResolution>	resolution
private ObjectProperty<PrintSides>	sides

Access	Constructor and Description
pack-priv	JobSettings(Printer printer)

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<Collation>	Returns: an instance of `Collation` collationProperty() Property representing an instance of `Collation`.
public final IntegerProperty	Returns: the number of copies of the job to print copiesProperty() `IntegerProperty` representing the number of copies of the job to print.
public final Collation	getCollation()
public final int	getCopies()
public final String	getJobName()
public final String	getOutputFile()
public final PageLayout	getPageLayout()
public final PageRange[]	getPageRanges()
public final PaperSource	getPaperSource()
public final PrintColor	getPrintColor()
public final PrintQuality	getPrintQuality()
public final PrintResolution	getPrintResolution()
public final PrintSides	getPrintSides()
private boolean	isJobNew()
public final StringProperty	Returns: the name of a job jobNameProperty() `StringProperty` representing the name of a job.
public final StringProperty	Returns: the name of a printer spool file outputFileProperty() A `StringProperty` representing the name of a filesystem file, to which the platform printer driver should spool the rendered print data.
public final ObjectProperty<PageLayout>	Returns: an instance of `PageLayout` pageLayoutProperty() Property representing an instance of `PageLayout`.
public final ObjectProperty<T>	Returns: the value presents the job pages to print as an array of PageRange pageRangesProperty() An `ObjectProperty` whose value represents the job pages to print as an array of PageRange.
public final ObjectProperty<PaperSource>	Returns: an instance of `PaperSource` paperSourceProperty() Property representing an instance of `PaperSource`.
public final ObjectProperty<PrintColor>	Returns: an instance of `PrintColor` printColorProperty() Property representing an instance of `PrintColor`.
public final ObjectProperty<PrintQuality>	Returns: an instance of `PrintQuality` printQualityProperty() Property representing an instance of `PrintQuality`.
public final ObjectProperty<PrintResolution>	Returns: an instance of `PrintResolution` printResolutionProperty() Property representing an instance of `PrintResolution`.
public final ObjectProperty<PrintSides>	Returns: an instance of `PrintSides` printSidesProperty() Property representing an instance of `PrintSides`.
public final void	setCollation(Collation collation)
public final void	setCopies(int nCopies)
public final void	setJobName(String name)
public final void	setOutputFile(String filePath)
public final void	setPageLayout(PageLayout pageLayout)
public final void	setPageRanges(PageRange... null or a varargs array as specified above pages) The range of pages to print as an array of PageRange.
public final void	setPaperSource(PaperSource value)
public final void	setPrintColor(PrintColor color)
pack-priv void	setPrinterJob(PrinterJob job)
public final void	setPrintQuality(PrintQuality quality)
public final void	setPrintResolution(PrintResolution resolution)
public final void	setPrintSides(PrintSides sides)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv void	updateForPrinter(Printer printer) If any settings are incompatible with the specified printer, they are updated to be compatible.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

collation	back to summary
private ObjectProperty<Collation> collation

color	back to summary
private ObjectProperty<PrintColor> color

copies	back to summary
private IntegerProperty copies

DEFAULT_JOBNAME	back to summary
private static final String DEFAULT_JOBNAME

defaultCollation	back to summary
private boolean defaultCollation

defaultCopies	back to summary
private boolean defaultCopies

defaultPageLayout	back to summary
private boolean defaultPageLayout

defaultPaperSource	back to summary
private boolean defaultPaperSource

defaultPrintColor	back to summary
private boolean defaultPrintColor

defaultPrintQuality	back to summary
private boolean defaultPrintQuality

defaultPrintResolution	back to summary
private boolean defaultPrintResolution

defaultSides	back to summary
private boolean defaultSides

hasOldCollation	back to summary
private boolean hasOldCollation

hasOldCopies	back to summary
private boolean hasOldCopies

hasOldPageLayout	back to summary
private boolean hasOldPageLayout

hasOldPaperSource	back to summary
private boolean hasOldPaperSource

hasOldPrintColor	back to summary
private boolean hasOldPrintColor

hasOldPrintQuality	back to summary
private boolean hasOldPrintQuality

hasOldPrintResolution	back to summary
private boolean hasOldPrintResolution

hasOldSides	back to summary
private boolean hasOldSides

job	back to summary
private PrinterJob job

jobName	back to summary
private SimpleStringProperty jobName

layout	back to summary
private ObjectProperty<PageLayout> layout

layout

back to summary

private ObjectProperty<PageLayout> layout

oldCollation	back to summary
private Collation oldCollation

oldCopies	back to summary
private int oldCopies

oldPageLayout	back to summary
private PageLayout oldPageLayout

oldPaperSource	back to summary
private PaperSource oldPaperSource

oldPrintColor	back to summary
private PrintColor oldPrintColor

oldPrintQuality	back to summary
private PrintQuality oldPrintQuality

oldPrintResolution	back to summary
private PrintResolution oldPrintResolution

oldSides	back to summary
private PrintSides oldSides

outputFile	back to summary
private SimpleStringProperty outputFile

pageRanges	back to summary
private ObjectProperty<PageRange[]> pageRanges

paperSource	back to summary
private ObjectProperty<PaperSource> paperSource

printer	back to summary
private Printer printer

printerCaps	back to summary
private PrinterAttributes printerCaps

quality	back to summary
private ObjectProperty<PrintQuality> quality

resolution	back to summary
private ObjectProperty<PrintResolution> resolution

sides	back to summary
private ObjectProperty<PrintSides> sides

Constructor Detail

JobSettings	back to summary
pack-priv JobSettings(Printer printer)

Method Detail

collationProperty back to summary

collationProperty	back to summary
public final ObjectProperty<Collation> collationProperty() 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:ObjectProperty<Collation> an instance of `Collation`

public final ObjectProperty<Collation> collationProperty()

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:ObjectProperty<Collation>: an instance of Collation

copiesProperty back to summary

copiesProperty	back to summary
public final IntegerProperty copiesProperty() `IntegerProperty` representing the number of copies of the job to print. Returns:IntegerProperty the number of copies of the job to print

public final IntegerProperty copiesProperty()

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

Returns:IntegerProperty: the number of copies of the job to print

getCollation	back to summary
public final Collation getCollation()

getCopies	back to summary
public final int getCopies()

getJobName	back to summary
public final String getJobName()

getOutputFile	back to summary
public final String getOutputFile()

getPageLayout	back to summary
public final PageLayout getPageLayout()

getPageRanges	back to summary
public final PageRange[] getPageRanges()

getPaperSource	back to summary
public final PaperSource getPaperSource()

getPrintColor	back to summary
public final PrintColor getPrintColor()

getPrintQuality	back to summary
public final PrintQuality getPrintQuality()

getPrintResolution	back to summary
public final PrintResolution getPrintResolution()

getPrintSides	back to summary
public final PrintSides getPrintSides()

isJobNew	back to summary
private boolean isJobNew()

jobNameProperty back to summary

public final StringProperty jobNameProperty()

StringProperty representing the name of a job.

Returns:StringProperty: the name of a job

outputFileProperty back to summary

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.

Returns:StringProperty: the name of a printer spool file
Default Value: an empty string
Since: 17

pageLayoutProperty back to summary

public final ObjectProperty<PageLayout> pageLayoutProperty()

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

Returns:ObjectProperty<PageLayout>: an instance of PageLayout

pageRangesProperty back to summary

public final ObjectProperty<T> 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.

Returns:ObjectProperty<T>: the value presents the job pages to print as an array of PageRange

paperSourceProperty back to summary

public final ObjectProperty<PaperSource> paperSourceProperty()

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

Returns:ObjectProperty<PaperSource>: an instance of PaperSource

printColorProperty back to summary

public final ObjectProperty<PrintColor> printColorProperty()

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

Returns:ObjectProperty<PrintColor>: an instance of PrintColor

printQualityProperty back to summary

public final ObjectProperty<PrintQuality> printQualityProperty()

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:ObjectProperty<PrintQuality>: an instance of PrintQuality

printResolutionProperty back to summary

public final ObjectProperty<PrintResolution> printResolutionProperty()

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

Returns:ObjectProperty<PrintResolution>: an instance of PrintResolution

printSidesProperty back to summary

public final ObjectProperty<PrintSides> printSidesProperty()

Property representing an instance of PrintSides.

Returns:ObjectProperty<PrintSides>: an instance of PrintSides

setCollation	back to summary
public final void setCollation(Collation collation)

setCopies	back to summary
public final void setCopies(int nCopies)

setJobName	back to summary
public final void setJobName(String name)

setOutputFile	back to summary
public final void setOutputFile(String filePath)

setPageLayout	back to summary
public final void setPageLayout(PageLayout pageLayout)

setPageRanges back to summary

public final 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.

Parameters

pages:PageRange[]: null or a varargs array as specified above

setPaperSource	back to summary
public final void setPaperSource(PaperSource value)

setPrintColor	back to summary
public final void setPrintColor(PrintColor color)

setPrinterJob	back to summary
pack-priv void setPrinterJob(PrinterJob job)

setPrintQuality	back to summary
public final void setPrintQuality(PrintQuality quality)

setPrintResolution	back to summary
public final void setPrintResolution(PrintResolution resolution)

setPrintSides	back to summary
public final void setPrintSides(PrintSides sides)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

updateForPrinter	back to summary
pack-priv void updateForPrinter(Printer printer) If any settings are incompatible with the specified printer, they are updated to be compatible. This method could be useful as a public one.

public final Class JobSettings

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail