Класс JobSettings

java.lang.Object

javafx.print.JobSettings

public final class JobSettings extends Object

Класс JobSettings инкапсулирует большую часть конфигурации задания печати. Приложения не могут и не должны напрямую создавать или изменять экземпляр JobSettings. Он уже устанавливается для задания печати при его создании.

Как документировано в PrinterJob, JobSettings, установленные для задания, изначально отражают текущие настройки по умолчанию для принтера, связанного с заданием.

Делегат JobSettings остается неизменным на протяжении всего жизненного цикла задания и его свойства обновляются, чтобы быть совместимыми с изменением принтера в задании. Например, в результате пользовательского взаимодействия через диалоговое окно платформы. Несовместимая настройка, как правило, приводит к возвращению настройки к значению по умолчанию для нового принтера.

Все неявные или явные обновления настроек, полученные в результате взаимодействия пользователя с диалоговым окном, будут переданы и отображены приложению после того, как пользователь одобрит настройки, закрыв диалоговое окно с помощью опции «принять».

Для большинства приложений печати, вероятно, достаточно, чтобы пользователь установил желаемые параметры, и они были переданы заданию. Для приложений, которым они необходимы, существуют методы установки и получения отдельных параметров, которые также доступны как свойства, и изменения значений настроек можно отслеживать и обновлять с помощью этих свойств.

Не все значения настроек доступны на всех принтерах. Например, принтер может не поддерживать двустороннюю печать. Смотрите класс Printer для того, как определить поддерживаемые настройки.

Since:: JavaFX 8.0

Краткое описание свойств

Тип	Свойство	Описание
`final ObjectProperty<Collation>`	`collation`	Свойство, представляющее экземпляр `Collation`.
`final IntegerProperty`	`copies`	`IntegerProperty`, представляющее количество копий задания для печати.
`final StringProperty`	`jobName`	`StringProperty`, представляющее имя задания.
`final StringProperty`	`outputFile`	`StringProperty`, представляющее имя файла файловой системы, в который драйвер платформенного принтера должен буферизовать данные отрендеренной печати.
`final ObjectProperty<PageLayout>`	`pageLayout`	Свойство, представляющее экземпляр `PageLayout`.
`final ObjectProperty`	`pageRanges`	`ObjectProperty`, значение которого представляет страницы задания для печати в виде массива PageRange.
`final ObjectProperty<PaperSource>`	`paperSource`	Свойство, представляющее экземпляр `PaperSource`.
`final ObjectProperty<PrintColor>`	`printColor`	Свойство, представляющее экземпляр `PrintColor`.
`final ObjectProperty<PrintQuality>`	`printQuality`	Свойство, представляющее экземпляр `PrintQuality`.
`final ObjectProperty<PrintResolution>`	`printResolution`	Свойство, представляющее экземпляр `PrintResolution`.
`final ObjectProperty<PrintSides>`	`printSides`	Свойство, представляющее экземпляр `PrintSides`.

Краткое описание методов

Модификатор и тип	Метод	Описание
`final ObjectProperty<Collation>`	`collationProperty()`	Свойство, представляющее экземпляр `Collation`.
`final IntegerProperty`	`copiesProperty()`	`IntegerProperty`, представляющее количество копий задания для печати.
`final Collation`	`getCollation()`	Возвращает значение свойства `collation`.
`final int`	`getCopies()`	Возвращает значение свойства `copies`.
`final String`	`getJobName()`	Возвращает значение свойства `jobName`.
`final String`	`getOutputFile()`	Возвращает значение свойства `outputFile`.
`final PageLayout`	`getPageLayout()`	Возвращает значение свойства `pageLayout`.
`final PageRange[]`	`getPageRanges()`	Возвращает значение свойства `pageRanges`.
`final PaperSource`	`getPaperSource()`	Возвращает значение свойства `paperSource`.
`final PrintColor`	`getPrintColor()`	Возвращает значение свойства `printColor`.
`final PrintQuality`	`getPrintQuality()`	Возвращает значение свойства `printQuality`.
`final PrintResolution`	`getPrintResolution()`	Возвращает значение свойства `printResolution`.
`final PrintSides`	`getPrintSides()`	Возвращает значение свойства `printSides`.
`final StringProperty`	`jobNameProperty()`	`StringProperty`, представляющее имя задания.
`final StringProperty`	`outputFileProperty()`	`StringProperty`, представляющее имя файла файловой системы, в который драйвер платформенного принтера должен буферизовать данные отрендеренной печати.
`final ObjectProperty<PageLayout>`	`pageLayoutProperty()`	Свойство, представляющее экземпляр `PageLayout`.
`final ObjectProperty`	`pageRangesProperty()`	`ObjectProperty`, значение которого представляет страницы задания для печати в виде массива PageRange.
`final ObjectProperty<PaperSource>`	`paperSourceProperty()`	Свойство, представляющее экземпляр `PaperSource`.
`final ObjectProperty<PrintColor>`	`printColorProperty()`	Свойство, представляющее экземпляр `PrintColor`.
`final ObjectProperty<PrintQuality>`	`printQualityProperty()`	Свойство, представляющее экземпляр `PrintQuality`.
`final ObjectProperty<PrintResolution>`	`printResolutionProperty()`	Свойство, представляющее экземпляр `PrintResolution`.
`final ObjectProperty<PrintSides>`	`printSidesProperty()`	Свойство, представляющее экземпляр `PrintSides`.
`final void`	`setCollation(Collation collation)`	Устанавливает значение свойства `collation`.
`final void`	`setCopies(int nCopies)`	Устанавливает значение свойства `copies`.
`final void`	`setJobName(String name)`	Устанавливает значение свойства `jobName`.
`final void`	`setOutputFile(String filePath)`	Устанавливает значение свойства `outputFile`.
`final void`	`setPageLayout(PageLayout pageLayout)`	Устанавливает значение свойства `pageLayout`.
`final void`	`setPageRanges(PageRange... pages)`	Диапазон страниц для печати в виде массива PageRange.
`final void`	`setPaperSource(PaperSource value)`	Устанавливает значение свойства `paperSource`.
`final void`	`setPrintColor(PrintColor color)`	Устанавливает значение свойства `printColor`.
`final void`	`setPrintQuality(PrintQuality quality)`	Устанавливает значение свойства `printQuality`.
`final void`	`setPrintResolution(PrintResolution resolution)`	Устанавливает значение свойства `printResolution`.
`final void`	`setPrintSides(PrintSides sides)`	Устанавливает значение свойства `printSides`.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробности свойств

jobName

public final StringProperty jobNameProperty

StringProperty представляющее имя задания.

См. также:

outputFile

public final StringProperty outputFileProperty

A StringProperty, представляющее имя файла файловой системы, в который драйвер платформенного принтера должен поместить отформатированные данные печати.

Приложения могут использовать это для программирования поведения печати в файл, где родная система печати способна поместить вывод в файл файловой системы, а не в устройство принтера.

Это часто полезно, когда драйвер принтера генерирует формат, такой как Postscript или PDF, и приложение намерено распространить результат, а не печатать его, или по какой-либо другой причине приложение не хочет, чтобы физический носитель (бумага) выдавался принтером.

Значение по умолчанию — пустая строка, которая интерпретируется как не заданная, эквивалентная null, что означает, что вывод отправляется на принтер. Таким образом, чтобы восстановить печать на принтер, необходимо очистить значение этого свойства, задав его в null или пустую строку.

Кроме того, если приложение отображает диалоговое окно принтера, которое позволяет пользователю указать место назначения файла, включая изменение заданного приложением место назначения файла, значение этого свойства будет отражать этот выбор пользователя, включая его очистку для возврата к печати на принтер, если пользователь это сделает.

Если система печати не поддерживает печать в файл, то это значение будет проигнорировано.

Если указанное имя указывает на несуществующий путь или не указывает на доступный для пользователя файл, результаты печати зависят от платформы. Возможные действия включают замену на стандартное местоположение файла вывода, печать на принтер вместо этого или ошибку платформенной печати.

Значение по умолчанию:

пустая строка

С:

См. также:

copies

public final IntegerProperty copiesProperty

IntegerProperty представляющее количество копий задания для печати.

См. также:

pageRanges

public final ObjectProperty pageRangesProperty

An ObjectProperty, значение которого представляет страницы задания для печати в виде массива PageRange. Значение null означает печать всех страниц. В противном случае это должен быть массив непересекающихся объектов PageRange, упорядоченных по возрастанию номера страницы. Номера страниц начинаются с 1. Пустой массив эквивалентен массиву null.

Неправильный или неподдерживаемый (принтером) набор диапазонов страниц будет проигнорирован.

Диапазоны, которые превышают количество страниц, отображаемых заданием во время печати, не вызывают никаких ошибок.

См. также:

printSides

public final ObjectProperty<PrintSides> printSidesProperty

Свойство, представляющее экземпляр PrintSides.

См. также:

collation

public final ObjectProperty<Collation> collationProperty

Свойство, представляющее экземпляр Collation. Сортировка определяет, как листы сортируются при печати нескольких копий документа. Поэтому это актуально только если печатаются 2 или более копии документа с 2 или более листами. Лист — это физический носитель, поэтому документы с 2 страницами, которые печатаются n-странично или двусторонне, могут все еще иметь только один лист. Задание печати с сортировкой производит документы с листами документа, отсортированными последовательно. Задание без сортировки собирает вместе несколько копий одного листа. Без сортировки (false) — это типичное значение по умолчанию.

См. также:

printColor

public final ObjectProperty<PrintColor> printColorProperty

Свойство, представляющее экземпляр PrintColor. Если установлено значение null, оно игнорируется.

См. также:

printQuality

public final ObjectProperty<PrintQuality> printQualityProperty

Свойство, представляющее экземпляр PrintQuality.

Обратите внимание, что качество и разрешение — перекрывающиеся понятия. Поэтому принтер может поддерживать установку одного из них, но не обоих. Приложения, которые устанавливают эти значения программно, должны запросить оба свойства и выбрать подходящие значения из поддерживаемых. Если принтер поддерживает нестандартные значения, код, скорее всего, не сможет определить интерпретацию принтера этих значений, и безопаснее всего выбрать стандартное значение, соответствующее требованию.

См. также:

printResolution

public final ObjectProperty<PrintResolution> printResolutionProperty

Свойство, представляющее экземпляр PrintResolution. Значение null игнорируется.

См. также:

paperSource

public final ObjectProperty<PaperSource> paperSourceProperty

Свойство, представляющее экземпляр PaperSource. Значение null игнорируется.

См. также:

pageLayout

public final ObjectProperty<PageLayout> pageLayoutProperty

Свойство, представляющее экземпляр PageLayout. Установка значения null игнорируется.

См. также:

Подробности методов

jobNameProperty

public final StringProperty jobNameProperty()

StringProperty представляющее имя задания.

Возвращает:

имя задания

См. также:

getJobName

public final String getJobName()

Получает значение свойства jobName.

Описание свойства:

StringProperty представляющее имя задания.

Возвращает:

значение свойства jobName

См. также:

setJobName

public final void setJobName(String name)

Устанавливает значение свойства jobName.

Описание свойства:

StringProperty представляющее имя задания.

Параметры:

name - значение свойства jobName

См. также:

outputFileProperty

public final StringProperty outputFileProperty()

Строка, представляющая имя файла файловой системы, в который драйвер платформенного принтера должен поместить отформатированные данные печати.

Приложения могут использовать это для программирования поведения печати в файл, когда система печати по умолчанию может сохранять вывод в файл файловой системы, а не в устройство принтера.

Это часто полезно в случаях, когда драйвер принтера генерирует формат, такой как Postscript или PDF, и приложение намерено распространить результат, а не печатать его, или по какой-либо другой причине приложение не хочет, чтобы физический носитель (бумага) выдавался принтером.

Значение по умолчанию — пустая строка, которая интерпретируется как не установленное значение, эквивалентное null, что означает, что вывод отправляется на принтер. Таким образом, чтобы вернуть печать на принтер, необходимо очистить значение этого свойства, установив его в null или пустую строку.

Кроме того, если приложение отображает диалоговое окно принтера, которое позволяет пользователю указать место назначения файла, включая изменение указанного приложением места назначения файла, значение этого свойства будет отражать выбранный пользователем вариант, включая его сброс для печати на принтере, если пользователь это сделает.

Если система печати не поддерживает печать в файл, то это настройка будет проигнорирована.

Если указанное имя указывает на несуществующий путь или не указывает на файл, доступный для записи пользователем, при печати результаты зависят от платформы. Возможные варианты поведения могут включать замену на стандартное местоположение выходного файла, печать на принтер вместо него или ошибку печати платформы.

Значение по умолчанию:

пустая строка

Возвращает:

имя файла очереди печати принтера

С:

См. также:

getOutputFile

public final String getOutputFile()

Получает значение свойства outputFile.

Описание свойства:

Если система печати не поддерживает печать в файл, то это настройка будет проигнорирована.

Значение по умолчанию:

пустая строка

Возвращает:

значение свойства outputFile

С:

См. также:

setOutputFile

public final void setOutputFile(String filePath)

Устанавливает значение свойства outputFile.

Описание свойства:

Если система печати не поддерживает печать в файл, то это настройка будет проигнорирована.

Значение по умолчанию:

пустая строка

Параметры:

filePath - значение свойства outputFile

С:

См. также:

copiesProperty

public final IntegerProperty copiesProperty()

IntegerProperty представляющее количество копий задания для печати.

Возвращает:

количество копий задания для печати

См. также:

getCopies

public final int getCopies()

Получает значение свойства copies.

Описание свойства:

IntegerProperty представляющее количество копий задания для печати.

Возвращает:

значение свойства copies

См. также:

setCopies

public final void setCopies(int nCopies)

Устанавливает значение свойства copies.

Описание свойства:

IntegerProperty представляющее количество копий задания для печати.

Параметры:

nCopies - значение для свойства copies

См. также:

pageRangesProperty

public final ObjectProperty pageRangesProperty()

Массив объектов PageRange, представляющий страницы задания для печати. Значение null означает печать всех страниц. В противном случае это должен быть массив неперекрывающихся объектов PageRange, отсортированных по возрастанию номера страницы. Номера страниц начинаются с 1 (одного). Пустой массив считается эквивалентным массиву null.

Неправильный или неподдерживаемый (принтером) набор диапазонов страниц будет проигнорирован.

Диапазоны, которые превышают количество страниц, отформатированных заданием во время печати, не вызывают ошибок.

Возвращает:

значение представляет страницы задания для печати в виде массива PageRange

См. также:

getPageRanges

public final PageRange[] getPageRanges()

Получает значение свойства pageRanges.

Описание свойства:

Неправильный или неподдерживаемый (принтером) набор диапазонов страниц будет проигнорирован.

Возвращает:

значение свойства pageRanges

См. также:

setPageRanges

public final void setPageRanges(PageRange... pages)

Диапазон страниц для печати в виде массива PageRange. Использование varargs означает, что в общем случае одного диапазона достаточно. ((PageRange[])null) всегда означает все страницы, но, поскольку это значение по умолчанию, оно используется реже. Подробности см. в pageRangesProperty().

Параметры:: pages - null или массив varargs, как указано выше

свойство printSides

public final ObjectProperty<PrintSides> printSidesProperty()

Свойство, представляющее экземпляр PrintSides.

Возвращает:

экземпляр PrintSides

См. также:

getPrintSides

public final PrintSides getPrintSides()

Получает значение свойства printSides.

Описание свойства:

Свойство, представляющее экземпляр PrintSides.

Возвращает:

значение свойства printSides

См. также:

setPrintSides

public final void setPrintSides(PrintSides sides)

Устанавливает значение свойства printSides.

Описание свойства:

Свойство, представляющее экземпляр PrintSides.

Параметры:

sides - значение для свойства printSides

См. также:

свойство collation

public final ObjectProperty<Collation> collationProperty()

Свойство, представляющее экземпляр Collation. Сортировка определяет порядок листов при печати нескольких копий документа. Это актуально только при печати двух или более копий документа, содержащего два или более листа. Лист — это физическое носитель, поэтому документы с 2 страницами, напечатанные N-страничными или двусторонними, все равно могут иметь только один лист. Задание печати с сортировкой (collation) упорядочивает листы документа в последовательности. При печати без сортировки собираются все копии одного и того же листа. Без сортировки (false) — типичное значение по умолчанию.

Возвращает:

экземпляр Collation

См. также:

getCollation

public final Collation getCollation()

Получает значение свойства collation.

Описание свойства:

Возвращает:

значение свойства collation

См. также:

setCollation

public final void setCollation(Collation collation)

Устанавливает значение свойства collation.

Описание свойства:

Параметры:

collation - значение для свойства collation

См. также:

свойство printColor

public final ObjectProperty<PrintColor> printColorProperty()

Свойство, представляющее экземпляр PrintColor. Если установлено значение null, оно игнорируется.

Возвращает:

экземпляр PrintColor

См. также:

getPrintColor

public final PrintColor getPrintColor()

Получает значение свойства printColor.

Описание свойства:

Свойство, представляющее экземпляр PrintColor. Если установлено значение null, оно игнорируется.

Возвращает:

значение свойства printColor

См. также:

setPrintColor

public final void setPrintColor(PrintColor color)

Устанавливает значение свойства printColor.

Описание свойства:

Свойство, представляющее экземпляр PrintColor. Если установлено значение null, оно игнорируется.

Параметры:

color - значение для свойства printColor

См. также:

свойство printQuality

public final ObjectProperty<PrintQuality> printQualityProperty()

Свойство, представляющее экземпляр PrintQuality.

Обратите внимание, что качество и разрешение — это перекрывающиеся понятия. Поэтому принтер может поддерживать установку одного или другого, но не обоих. Приложения, устанавливающие эти значения программно, должны запросить оба свойства и выбрать соответствующие значения из поддерживаемых. Если принтер поддерживает нестандартные значения, код, вероятно, не сможет различить интерпретацию этих значений принтером, и безопаснее всего будет выбрать стандартное значение, соответствующее требованию.

Возвращает:

экземпляр PrintQuality

См. также:

getPrintQuality

public final PrintQuality getPrintQuality()

Получает значение свойства printQuality.

Описание свойства:

Свойство, представляющее экземпляр PrintQuality.

Возвращает:

значение свойства printQuality

См. также:

setPrintQuality

public final void setPrintQuality(PrintQuality quality)

Устанавливает значение свойства printQuality.

Описание свойства:

Свойство, представляющее экземпляр PrintQuality.

Параметры:

quality - значение для свойства printQuality

См. также:

свойство printResolution

public final ObjectProperty<PrintResolution> printResolutionProperty()

Свойство, представляющее экземпляр PrintResolution. Значение null игнорируется.

Возвращает:

экземпляр PrintResolution

См. также:

getPrintResolution

public final PrintResolution getPrintResolution()

Получение значения свойства printResolution.

Описание свойства:

Свойство, представляющее экземпляр PrintResolution. Значение null игнорируется.

Обратите внимание, что качество и разрешение — перекрывающиеся понятия. Поэтому принтер может поддерживать установку одного из них, но не обоих. Приложения, устанавливающие эти значения программно, должны запросить оба свойства и соответствующим образом выбрать из поддерживаемых значений. Если принтер поддерживает нестандартные значения, код, вероятно, не сможет различить интерпретацию этих значений принтером, и безопаснее всего придерживаться выбора стандартного значения, соответствующего требованию.

Возвращает:

значение свойства printResolution

См. также:

setPrintResolution

public final void setPrintResolution(PrintResolution resolution)

Устанавливает значение свойства printResolution.

Описание свойства:

Свойство, представляющее экземпляр PrintResolution. Значение null игнорируется.

Параметры:

resolution - значение для свойства printResolution

См. также:

paperSourceProperty

public final ObjectProperty<PaperSource> paperSourceProperty()

Свойство, представляющее экземпляр PaperSource. Значение null игнорируется.

Возвращает:

экземпляр PaperSource

См. также:

getPaperSource

public final PaperSource getPaperSource()

Получение значения свойства paperSource.

Описание свойства:

Свойство, представляющее экземпляр PaperSource. Значение null игнорируется.

Возвращает:

значение свойства paperSource

См. также:

setPaperSource

public final void setPaperSource(PaperSource value)

Устанавливает значение свойства paperSource.

Описание свойства:

Свойство, представляющее экземпляр PaperSource. Значение null игнорируется.

Параметры:

value - значение для свойства paperSource

См. также:

pageLayoutProperty

public final ObjectProperty<PageLayout> pageLayoutProperty()

Свойство, представляющее экземпляр PageLayout. Установка значения null игнорируется.

Возвращает:

экземпляр PageLayout

См. также:

getPageLayout

public final PageLayout getPageLayout()

Получение значения свойства pageLayout.

Описание свойства:

Свойство, представляющее экземпляр PageLayout. Установка значения null игнорируется.

Возвращает:

значение свойства pageLayout

См. также:

setPageLayout

public final void setPageLayout(PageLayout pageLayout)

Устанавливает значение свойства pageLayout.

Описание свойства:

Свойство, представляющее экземпляр PageLayout. Установка значения null игнорируется.

Параметры:

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.