Класс JobSettings
public final class JobSettings
extends Object Как описано в PrinterJob, JobSettings, установленные в этом задании, изначально отражают текущие параметры по умолчанию для принтера, первоначально связанного с этим заданием.
Делегат JobSettings сохраняется на протяжении всего задания и его свойства обновляются в соответствии с изменением принтера в задании. Например, в результате взаимодействия пользователя с диалоговым окном платформы. Несовместимое значение, как правило, приводит к тому, что значение устанавливается по умолчанию для нового принтера.
Все неявные или явные обновления настроек, полученные в результате взаимодействия пользователя с диалоговым окном, будут переданы и видны приложению после того, как пользователь подтвердит настройки, закрыв диалоговое окно с помощью опции «принять».
Для большинства приложений печати достаточно, чтобы пользователь устанавливал нужные параметры, и эти параметры передавались заданию. Для приложений, которым они необходимы, существуют методы установки и получения значений отдельных параметров, которые также доступны как свойства, и изменения значений параметров можно отслеживать и обновлять с помощью этих свойств.
Не все значения параметров доступны на всех принтерах. Например, принтер может не поддерживать двустороннюю печать. См. класс Printer для того, как определить поддерживаемые параметры.
- Since:
- JavaFX 8.0
Краткое описание свойств
| Тип | Свойство | Описание |
|---|---|---|
ObjectProperty<Collation> | collation | Свойство, представляющее экземпляр Collation. |
IntegerProperty | copies | IntegerProperty, представляющее количество копий задания для печати. |
StringProperty | jobName | StringProperty, представляющее имя задания. |
StringProperty | outputFile | StringProperty, представляющее имя файла файловой системы, в который драйвер принтера платформы должен буферизовать данные отрендеренной печати. |
ObjectProperty<PageLayout> | pageLayout | Свойство, представляющее экземпляр PageLayout. |
ObjectProperty | pageRanges | ObjectProperty, значение которого представляет страницы задания для печати в виде массива PageRange. |
ObjectProperty<PaperSource> | paperSource | Свойство, представляющее экземпляр PaperSource. |
ObjectProperty<PrintColor> | printColor | Свойство, представляющее экземпляр PrintColor. |
ObjectProperty<PrintQuality> | printQuality | Свойство, представляющее экземпляр PrintQuality. |
ObjectProperty<PrintResolution> | printResolution | Свойство, представляющее экземпляр PrintResolution. |
ObjectProperty<PrintSides> | printSides | Свойство, представляющее экземпляр PrintSides. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
ObjectProperty<Collation> | collationProperty() | Свойство, представляющее экземпляр Collation. |
IntegerProperty | copiesProperty() | IntegerProperty, представляющее количество копий задания на печать. |
Collation | getCollation() | Сортировка определяет порядок листов при печати нескольких копий документа. |
int | getCopies() | Получить количество копий для печати. |
String | getJobName() | Получить имя задания. |
String | getOutputFile() | Получить значение свойства outputFile. |
PageLayout | getPageLayout() | Получить текущий макет страницы для этого задания. |
PageRange[] | getPageRanges() | Диапазон страниц для печати. |
PaperSource | getPaperSource() | Получить значение свойства paperSource. |
PrintColor | getPrintColor() | Получить значение свойства printColor. |
PrintQuality | getPrintQuality() | Получить значение свойства printQuality. |
PrintResolution | getPrintResolution() | |
PrintSides | getPrintSides() | Если принтер поддерживает, задание может быть распечатано с обеих сторон носителя (бумаги), т. е. двухсторонняя печать. |
StringProperty | jobNameProperty() | StringProperty, представляющее имя задания. |
StringProperty | outputFileProperty() | StringProperty, представляющий имя файла файловой системы, в который драйвер платформенного принтера должен буферизовать данные отрендеренной печати. |
ObjectProperty<PageLayout> | pageLayoutProperty() | Свойство, представляющее экземпляр PageLayout. |
ObjectProperty | pageRangesProperty() | ObjectProperty, значение которого представляет страницы задания для печати в виде массива PageRange. |
ObjectProperty<PaperSource> | paperSourceProperty() | Свойство, представляющее экземпляр PaperSource. |
ObjectProperty<PrintColor> | printColorProperty() | Свойство, представляющее экземпляр PrintColor. |
ObjectProperty<PrintQuality> | printQualityProperty() | Свойство, представляющее экземпляр PrintQuality. |
ObjectProperty<PrintResolution> | printResolutionProperty() | Свойство, представляющее экземпляр PrintResolution. |
ObjectProperty<PrintSides> | printSidesProperty() | Свойство, представляющее экземпляр PrintSides. |
void | setCollation(Collation collation) | Установить свойство Collation. |
void | setCopies(int nCopies) | Установить количество копий для печати. |
void | setJobName(String name) | Установить имя задания. |
void | setOutputFile(String filePath) | Установить значение свойства outputFile. |
void | setPageLayout(PageLayout pageLayout) | Установить макет страницы для использования. |
void | setPageRanges(PageRange... pages) | Диапазон страниц для печати в виде массива PageRange. |
void | setPaperSource(PaperSource value) | Установить значение свойства paperSource. |
void | setPrintColor(PrintColor color) | Установить свойство PrintColor. |
void | setPrintQuality(PrintQuality quality) | Установить свойство PrintQuality. |
void | setPrintResolution(PrintResolution resolution) | Установить свойство PrintResolution. |
void | setPrintSides(PrintSides sides) | Установить свойство PrintSides, которое управляет двухсторонней печатью. |
Подробности свойств
jobName
public final StringProperty jobNameProperty
StringProperty представляющее имя задания.- См. также:
-
getJobName(),setJobName(String)
outputFile
public final StringProperty outputFileProperty
StringProperty, представляющее имя файла файловой системы, в который драйвер платформенного принтера должен поместить отформатированные данные печати. Приложения могут использовать это для программирования поведения печати в файл, когда собственная система печати способна сохранять вывод в файл файловой системы, а не в устройство принтера.
Это часто полезно, когда драйвер принтера генерирует формат, такой как Postscript или PDF, и приложение намеревается распространить результат, а не печатать его, или по какой-либо другой причине приложение не хочет, чтобы физические носители (бумага) выпускались принтером.
Значение по умолчанию — пустая строка, которая интерпретируется как не заданное, эквивалентное null, что означает, что вывод отправляется на принтер. Таким образом, чтобы вернуть печать на принтер, очистите значение этого свойства, установив его в null или пустую строку.
Кроме того, если приложение отображает диалог принтера, который позволяет пользователю указать место назначения файла, включая изменение заданного приложением места назначения файла, значение этого свойства будет отражать выбранное пользователем место назначения, включая его очистку для возврата к печати на принтере, если пользователь так сделает.
Если система печати не поддерживает печать в файл, то это значение будет проигнорировано.
Если указанное имя задаёт несуществующий путь или не задаёт файл, доступный для записи пользователем, при печати результаты зависят от платформы. Возможные действия могут включать замену на стандартное местоположение выходного файла, печать на принтере вместо этого или ошибку платформы печати. Если установлен SecurityManager и он отказывает в доступе к указанному файлу, может быть выброшено исключение SecurityException.
- Значение по умолчанию:
- пустая строка
- С:
- 17
- См. также:
-
getOutputFile(),setOutputFile(String)
copies
public final IntegerProperty copiesProperty
IntegerProperty представляющее количество копий задания для печати.- См. также:
-
getCopies(),setCopies(int)
pageRanges
public final ObjectProperty pageRangesProperty
ObjectProperty, значение которого представляет страницы задания для печати в виде массива PageRange. Значение null означает печать всех страниц. В противном случае это должен быть массив неперекрывающихся объектов PageRange, отсортированных по возрастанию номера страницы. Номера страниц начинаются с 1. Пустой массив считается эквивалентным массиву null. Неправильный или неподдерживаемый (принтером) набор диапазонов страниц будет проигнорирован.
Диапазоны, выходящие за пределы количества страниц, отображаемых заданием во время печати, не вызывают ошибок.
- См. также:
-
getPageRanges(),setPageRanges(PageRange[])
printSides
public final ObjectProperty<PrintSides> printSidesProperty
PrintSides.- См. также:
-
getPrintSides(),setPrintSides(PrintSides)
collation
public final ObjectProperty<Collation> collationProperty
Collation.- См. также:
-
getCollation(),setCollation(Collation)
printColor
public final ObjectProperty<PrintColor> printColorProperty
PrintColor.- См. также:
-
getPrintColor(),setPrintColor(PrintColor)
printQuality
public final ObjectProperty<PrintQuality> printQualityProperty
PrintQuality.- См. также:
-
getPrintQuality(),setPrintQuality(PrintQuality)
printResolution
public final ObjectProperty<PrintResolution> printResolutionProperty
PrintResolution.- См. также:
-
getPrintResolution(),setPrintResolution(PrintResolution)
paperSource
public final ObjectProperty<PaperSource> paperSourceProperty
PaperSource.- См. также:
-
getPaperSource(),setPaperSource(PaperSource)
pageLayout
public final ObjectProperty<PageLayout> pageLayoutProperty
PageLayout.- См. также:
-
getPageLayout(),setPageLayout(PageLayout)
Подробности методов
jobNameProperty
public final StringProperty jobNameProperty()
StringProperty представляющее имя задания.- См. также:
-
getJobName(),setJobName(String)
getJobName
public String getJobName()
- Возвращает:
- строку, представляющую имя задания
setJobName
public void setJobName(String name)
- Параметры:
-
name- строка, представляющая имя задания
outputFileProperty
public final StringProperty outputFileProperty()
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.
- Значение по умолчанию:
- пустая строка
- С:
- 17
- См. также:
-
getOutputFile(),setOutputFile(String)
getOutputFile
public String getOutputFile()
- Описание свойства:
- A
StringPropertyrepresenting 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
SecurityManageris installed and it denies access to the specified file aSecurityExceptionmay be thrown. - Значение по умолчанию:
- пустая строка
- С:
- 17
setOutputFile
public void setOutputFile(String filePath)
- Описание свойства:
- Строка, представляющая имя файла в файловой системе, в который драйвер принтера платформы должен сохранить отрендеренные данные печати.
Приложения могут использовать это для программирования поведения печати в файл, где родная система печати способна сохранить вывод в файл системы, а не в устройство принтера.
Это часто полезно, когда драйвер принтера генерирует формат, такой как Postscript или PDF, и приложение намеревается распространить результат, а не печатать его, или по какой-либо другой причине приложение не хочет, чтобы принтер выводил физические носители (бумагу).
Значение по умолчанию — пустая строка, которая интерпретируется как не заданное, эквивалентно null, что означает, что вывод отправляется на принтер. Таким образом, для сброса на печать на принтер необходимо очистить значение этого свойства, установив его в null или пустую строку.
Кроме того, если приложение отображает диалог принтера, который позволяет пользователю указать место назначения файла, включая изменение места назначения файла, указанного приложением, значение этого свойства будет отражать выбранное пользователем место назначения, включая его очистку для сброса на печать на принтер, если пользователь это сделает.
Если система печати не поддерживает печать в файл, это значение будет проигнорировано.
Если указанное имя указывает на несуществующий путь или не указывает на доступный для записи файл, поведение при печати зависит от платформы. Возможные варианты включают замену на стандартное местоположение файла, печать на принтер или ошибку печати платформы. Если установлен
SecurityManagerи он запрещает доступ к указанному файлу, может быть выброшено исключениеSecurityException. - Значение по умолчанию:
- пустая строка
- С:
- 17
copiesProperty
public final IntegerProperty copiesProperty()
IntegerProperty представляющее количество копий задания для печати.
- См. также:
-
getCopies(),setCopies(int)
getCopies
public int getCopies()
- Возвращает:
- количество копий для печати
setCopies
public final void setCopies(int nCopies)
- Параметры:
-
nCopies- количество копий для печати
pageRangesProperty
public final ObjectProperty pageRangesProperty()
ObjectProperty, значение которого представляет страницы задания для печати в виде массива PageRange. Значение null означает печать всех страниц. В противном случае это должен быть массив неперекрывающихся объектов PageRange, отсортированных по возрастанию номера страницы. Номера страниц начинаются с 1 (один). Пустой массив считается эквивалентным null-массиву. Некорректный или неподдерживаемый (принтером) набор диапазонов страниц будет проигнорирован.
Диапазоны, выходящие за пределы количества страниц, отрендеренных заданием во время печати, не вызывают ошибок.
- См. также:
-
getPageRanges(),setPageRanges(PageRange[])
getPageRanges
public PageRange[] getPageRanges()
pageRangesProperty() для получения дополнительной информации.- Возвращает:
- null или массив, как указано выше
setPageRanges
public void setPageRanges(PageRange... pages)
((PageRange[])null) всегда означает все страницы, однако, поскольку это значение по умолчанию, оно используется реже. См. pageRangesProperty() для получения дополнительной информации.- Параметры:
-
pages- null или массив varargs, как указано выше
printSidesProperty
public final ObjectProperty<PrintSides> printSidesProperty()
PrintSides.- См. также:
-
getPrintSides(),setPrintSides(PrintSides)
getPrintSides
public PrintSides getPrintSides()
- Возвращает:
- значение настройки двусторонней печати.
setPrintSides
public void setPrintSides(PrintSides sides)
PrintSides, которое управляет двусторонней печатью. Значение null игнорируется.- Параметры:
-
sides- новое значение для количества сторон.
collationProperty
public final ObjectProperty<Collation> collationProperty()
Collation.- См. также:
-
getCollation(),setCollation(Collation)
getCollation
public Collation getCollation()
false) — это типовое значение по умолчанию.- Возвращает:
- сортировку
setCollation
public void setCollation(Collation collation)
Collation. Значение null игнорируется.- Параметры:
-
collation- новое значение для сортировки
printColorProperty
public final ObjectProperty<PrintColor> printColorProperty()
PrintColor.- См. также:
-
getPrintColor(),setPrintColor(PrintColor)
getPrintColor
public PrintColor getPrintColor()
- Описание свойства:
- Свойство, представляющее экземпляр
PrintColor.
setPrintColor
public void setPrintColor(PrintColor color)
PrintColor. Значение null игнорируется.- Параметры:
-
color- новое значение для цвета печати.
printQualityProperty
public final ObjectProperty<PrintQuality> printQualityProperty()
PrintQuality.- См. также:
-
getPrintQuality(),setPrintQuality(PrintQuality)
getPrintQuality
public PrintQuality getPrintQuality()
- Описание свойства:
- Свойство, представляющее экземпляр
PrintQuality.
setPrintQuality
public void setPrintQuality(PrintQuality quality)
PrintQuality. Значение null игнорируется. Обратите внимание, что качество и разрешение — перекрывающиеся понятия. Следовательно, принтер может поддерживать настройку одного или другого, но не обоих. Приложения, задающие эти значения программно, должны запросить оба свойства и соответствующим образом выбрать поддерживаемые значения. Если принтер поддерживает нестандартные значения, код, вероятно, не сможет отличить интерпретацию принтера этих значений, и ему безопаснее придерживаться выбора стандартного значения, соответствующего требованию.
- Параметры:
-
quality- новое значение качества печати.
printResolutionProperty
public final ObjectProperty<PrintResolution> printResolutionProperty()
PrintResolution.- См. также:
-
getPrintResolution(),setPrintResolution(PrintResolution)
getPrintResolution
public PrintResolution getPrintResolution()
- Возвращает:
- разрешение печати
setPrintResolution
public void setPrintResolution(PrintResolution resolution)
PrintResolution. Значение null игнорируется. Обратите внимание, что качество и разрешение — перекрывающиеся понятия. Следовательно, принтер может поддерживать настройку одного или другого, но не обоих. Приложения, задающие эти значения программно, должны запросить оба свойства и соответствующим образом выбрать поддерживаемые значения. Если принтер поддерживает нестандартные значения, код, вероятно, не сможет отличить интерпретацию принтера этих значений, и ему безопаснее придерживаться выбора стандартного значения, соответствующего требованию.
- Параметры:
-
resolution- новое значение разрешения печати.
paperSourceProperty
public final ObjectProperty<PaperSource> paperSourceProperty()
PaperSource.- См. также:
-
getPaperSource(),setPaperSource(PaperSource)
Получить источник бумаги
public PaperSource getPaperSource()
- Описание свойства:
- Свойство, представляющее экземпляр
PaperSource.
Установить источник бумаги
public void setPaperSource(PaperSource value)
- Описание свойства:
- Свойство, представляющее экземпляр
PaperSource.
pageLayoutProperty
public final ObjectProperty<PageLayout> pageLayoutProperty()
PageLayout.- См. также:
-
getPageLayout(),setPageLayout(PageLayout)
Получить макет страницы
public PageLayout getPageLayout()
- Возвращает:
- Макет страницы для использования в работе.
Установить макет страницы
public void setPageLayout(PageLayout pageLayout)
- Параметры:
-
pageLayout- Макет страницы для использования.
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.