Пакет javax.print.attribute.standard

Пакет javax.print.attribute.standard содержит классы для конкретных атрибутов печати. Родительский пакет javax.print.attribute предоставляет классы и интерфейсы, описывающие типы атрибутов службы печати Java и способы их сбора в наборы атрибутов.

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

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

Пакет javax.print.attribute.standard содержит стандартные атрибуты печати и стандартные значения атрибутов печати, которые широко используются в области печати. Поставщик службы печати может предоставлять новые атрибуты печати, специфичные для поставщика, в дополнение к стандартным. Поставщик также может предоставлять специфичные для поставщика расширения (подклассы) стандартных атрибутов печати — например, для предоставления дополнительных значений, специфичных для поставщика, для существующего стандартного атрибута. Конечно, если поставщик хочет, чтобы клиенты могли использовать любые добавленные или расширенные атрибуты, поставщик должен опубликовать новые классы атрибутов.

Многие из стандартных классов атрибутов расширяют один из абстрактных классов синтаксиса пакета javax.print.attribute. Каждый из этих абстрактных классов синтаксиса представляет собой разный тип. Например, класс EnumSyntax представляет собой безопасное по типам перечисление. Абстрактный класс синтаксиса предоставляет оболочку для значения атрибута.

Если класс атрибута расширяет EnumSyntax, и значение атрибута является совместимым со значением IPP, метод toString атрибута возвращает строковое представление значения атрибута в формате IPP, например, "processing-stopped" для атрибута JobState. Однако, поскольку класс EnumSyntax является расширяемым, поставщики могут определять свои собственные значения атрибутов. Если атрибут использует класс EnumSyntax и установлен на одно из этих определенных поставщиком значений, метод toString не вернёт строковое представление значения в формате IPP.

Как правило, приложению-клиенту для печати не нужно использовать все классы атрибутов печати в пакете javax.print.attribute.standard, только те, которые относятся к приложению.

Классы атрибутов в пакете javax.print.attribute.standard основаны на атрибутах протокола печати по Интернету (IPP), определенных в документе RFC Интернета RFC 2911 Internet Printing Protocol/1.1: Model and Semantics от сентября 2000 года. Дополнительную информацию см. в RFC 2911. Описательный текст для каждого класса атрибута в значительной степени взят из вышеупомянутых документов. Вклад авторов вышеупомянутых документов в API признателен.

Организация атрибутов

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

Атрибуты документа

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

Атрибуты запроса на печать

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

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

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

Атрибуты задания печати

Атрибуты задания печати сообщают о состоянии задания печати. Класс атрибута задания печати реализует интерфейс PrintJobAttribute. Атрибут задания печати может отображаться в PrintJobAttributeSet.

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

Атрибуты службы печати

Атрибуты службы печати сообщают о состоянии службы печати. Класс атрибута службы печати реализует интерфейс PrintServiceAttribute. Атрибут службы печати может отображаться в PrintServiceAttributeSet.

Атрибуты поддерживаемых значений

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

Таблица атрибутов

В таблице ниже перечислены все атрибуты печати. Таблица показывает реализуемые интерфейсы тегов для каждого класса атрибута в дополнение к интерфейсу Attribute, тем самым показывая, как каждый атрибут используется в API. Для каждого атрибута документа и атрибута запроса на печать столбец "SupportedValuesAttribute" перечисляет класс атрибута поддерживаемых значений, если таковой имеется, с помощью которого служба печати указывает поддерживаемые значения для этой категории атрибутов.

Класс атрибута	Атрибут документа	Атрибут запроса печати	Атрибут задания печати	Атрибут службы печати	Атрибут поддерживаемых значений
Сжатие	X
Имя документа	X
Цветовой тон	X	X	X
Копии		X	X		Поддерживаемое количество копий
Отделочные работы	X	X	X
Отложенное задание до		X	X
Отпечатки задания		X	X		Поддерживаемые отпечатки задания
Задание KOctets		X	X		Поддерживаемые KOctets задания
Листы носителя задания		X	X		Поддерживаемые листы носителя задания
Имя задания		X	X
Приоритет задания		X	X		Поддерживаемый приоритет задания
Листы задания		X	X
Носитель	X	X	X
Размер носителя
Обработка нескольких документов		X	X
Многократное расположение	X	X	X		Поддерживаемое многократное расположение
Запрошенная ориентация	X	X	X
Диапазоны страниц	X	X	X
Направление презентации	X	X	X
Разрешение принтера	X	X	X
Качество печати	X	X	X
Имя пользователя, запрашивающего услугу		X	X
Сбор листов	X	X	X
Стороны	X	X	X
Дата и время завершения			X
Дата и время создания			X
Дата и время обработки			X
Завершенные отпечатки задания			X
Обработанные KOctets задания			X
Завершенные листы носителя задания			X
Сообщение оператора по заданию			X
Имя пользователя, иницировавшего задание			X
Состояние задания			X
Причины состояния задания Содержит ноль или более --			X
-- Причина состояния задания
Количество документов			X
Количество вмешавшихся заданий			X
Присвоенное устройство вывода			X
Поддержка цвета				X
Страниц в минуту				X
Страниц в минуту (цвет)				X
Поддержка переопределения PDL				X
Принтер принимает задания				X
Информация о принтере				X
Расположение принтера				X
Сообщение оператора о принтере				X
Производитель и модель принтера				X
Дополнительная информация о принтере				X
Дополнительная информация производителя о принтере				X
Название принтера				X
Состояние принтера				X
Причины состояния принтера Содержит ноль или более --				X
-- Причина состояния принтера
-- Серьезность
Количество заданий в очереди				X
Поддерживаемые схемы URI ссылок

Обратите внимание: В API javax.print, параметр ссылки null к методам неверен, если явно не задокументировано в методе как имеющий осмысленное толкование. Использование в противном случае является неправильным кодированием и может привести к исключению времени выполнения либо немедленно, либо в какой-то момент позже. IllegalArgumentException и NullPointerException являются примерами типичных и приемлемых исключений времени выполнения для таких случаев.

С момента:: 1.4

Класс	Описание
Хроматичность	Класс `Chromaticity` — это класс атрибутов печати, перечисление, которое определяет монохромную или цветную печать.
ПоддержкаЦвета	Класс `ColorSupported` — это класс атрибутов печати, перечисление, определяющее, может ли устройство выполнять цветную печать вообще, включая выделение цветом и полноцветную печать.
Сжатие	Класс `Compression` — это класс атрибутов печати, перечисление, определяющее способ сжатия данных печати.
Копии	Класс `Copies` — это класс целочисленных атрибутов печати, определяющий количество копий для печати.
ПоддерживаемыеКопии	Класс `CopiesSupported` — это класс атрибутов печати, набор целых чисел, который предоставляет поддерживаемые значения для атрибута `Copies`.
ДатаВремяЗавершения	Класс `DateTimeAtCompleted` — это класс атрибутов печати, атрибут даты и времени, который указывает дату и время завершения задания печати (или отмены или прерывания).
ДатаВремяСоздание	Класс `DateTimeAtCreation` — это класс атрибутов печати, атрибут даты и времени, который указывает дату и время создания задания печати.
ДатаВремяОбработки	Класс `DateTimeAtProcessing` — это класс атрибутов печати, атрибут даты и времени, который указывает дату и время, когда задание печати начало обработку.
Назначение	Класс `Destination` — это класс атрибутов печати, `URI`, который используется для указания альтернативного назначения для отформатированных данных принтера.
ВладелецДиалога	Класс атрибутов, используемый для поддержки запроса отображения диалога печати или настройки страницы поверх всех окон или определенного окна.
ВыборТипаДиалога	Класс `DialogTypeSelection` — это класс атрибутов печати, перечисление, которое указывает тип пользовательского диалога, используемого для задания параметров печати.
ИмяДокумента	Класс `DocumentName` — это класс атрибутов печати, текстовый атрибут, который указывает имя документа.
Точность	Класс `Fidelity` — это класс атрибутов печати, перечисление, которое указывает, требуется ли полная точность атрибутов запроса печати, предоставленных клиентом.
Доработки	Класс `Finishings` — это класс атрибутов печати, перечисление, которое определяет, применяет ли принтер операцию доработки какого-либо вида (скрепления) к каждой копии каждого напечатанного документа в задании.
ОтложитьЗаданиеДо	Класс `JobHoldUntil` — это класс атрибутов печати, атрибут даты и времени, который указывает точную дату и время, когда задание должно стать кандидатом на печать.
ОбщееКоличествоОтпечатков	Класс `JobImpressions` — это класс целочисленных атрибутов печати, определяющий общее количество отпечатков документов, которые подаются.
ЗавершенныеОтпечатки	Класс `JobImpressionsCompleted` — это класс целочисленных атрибутов печати, определяющий количество отпечатков, завершенных для задания.
ПоддерживаемыеОтпечатки	Класс `JobImpressionsSupported` — это класс атрибутов печати, набор целых чисел, который предоставляет поддерживаемые значения для атрибута `JobImpressions`.
ОбщееКоличествоКОктетов	Класс `JobKOctets` — это класс целочисленных атрибутов печати, определяющий общий объем документов в КОктетах (т. е. в единицах по 1024 октета), запрошенных для обработки в задании.
ОбработанныеКОктеты	Класс `JobKOctetsProcessed` — это класс целочисленных атрибутов печати, определяющий общее количество обработанных октетов данных печати в КОктетах (т. е. в единицах по 1024 октета).
ПоддерживаемыеКОктеты	Класс `JobKOctetsSupported` — это класс атрибутов печати, набор целых чисел, который предоставляет поддерживаемые значения для атрибута `JobKOctets`.
ЛистыНосителя	Класс `JobMediaSheets` — это класс целочисленных атрибутов печати, определяющий общее количество листов носителя, которые необходимо получить для этого задания.
ЗавершенныеЛистыНосителя	Класс `JobMediaSheetsCompleted` — это класс целочисленных атрибутов печати, определяющий количество листов носителя, завершивших маркировку и укладку для всего задания до сих пор, независимо от того, обрабатывались ли эти листы с одной или с обеих сторон.
ПоддерживаемыеЛистыНосителя	Класс `JobMediaSheetsSupported` — это класс атрибутов печати, набор целых чисел, который предоставляет поддерживаемые значения для атрибута `JobMediaSheets`.
СообщениеОтОператора	Класс `JobMessageFromOperator` — это класс атрибутов печати, текстовый атрибут, который предоставляет сообщение от оператора, системного администратора или «интеллектуального» процесса, чтобы указать конечному пользователю причины модификации или других управленческих действий, выполненных над заданием.
ИмяЗадания	Класс `JobName` — это класс атрибутов печати, текстовый атрибут, который указывает имя задания печати.
ИмяПользователяИнициатора	Класс `JobOriginatingUserName` — это класс атрибутов печати, текстовый атрибут, содержащий имя конечного пользователя, который отправил задание печати.
ПриоритетЗадания	Класс `JobPriority` — это класс целочисленных атрибутов печати, определяющий приоритет задания печати.
ПоддержкаПриоритетов	Класс `JobPrioritySupported` — это класс целочисленных атрибутов печати, определяющий, поддерживает ли экземпляр службы печати атрибут `JobPriority` и количество поддерживаемых уровней приоритета заданий.
ЛистыЗадания	Класс `JobSheets` — это класс атрибутов печати, перечисление, определяющее, какие начальные и конечные листы, если таковые имеются, должны быть напечатаны с заданием.
СостояниеЗадания	`JobState` — это класс атрибутов печати, перечисление, которое определяет текущее состояние задания печати.
ПричинаСостояния	Класс `JobStateReason` — это класс атрибутов печати, перечисление, которое предоставляет дополнительную информацию о текущем состоянии задания, то есть информацию, дополняющую значение атрибута задания `JobState`.
ПричиныСостояния	Класс `JobStateReasons` — это класс атрибутов печати, набор значений перечислений, который предоставляет дополнительную информацию о текущем состоянии задания, то есть информацию, дополняющую значение атрибута задания `JobState`.
Носитель	Класс `Media` — это класс атрибутов печати, определяющий носитель, на котором нужно печатать.
ИмяНосителя	Класс `MediaName` — это подкласс `Media`, класс атрибутов печати (перечисление), определяющий носитель задания печати как имя.
ПечатаемаяПлощадьНосителя	Класс `MediaPrintableArea` используется для определения печатаемых и непечатаемых областей носителя.
РазмерНосителя	Класс `MediaSize` — это двумерный класс атрибутов печати, указывающий размеры носителя в портретном режиме, где измерение `X` проходит по нижнему краю, а измерение `Y` — по левому краю.
MediaSize.Инженерный	Класс `MediaSize.Engineering` включает значения `MediaSize` для инженерных носителей.
MediaSize.ISO	Класс `MediaSize.ISO` включает значения `MediaSize` для носителей ISO.
MediaSize.JIS	Класс `MediaSize.JIS` включает значения `MediaSize` для носителей JIS (японских).
MediaSize.NA	Класс `MediaSize.NA` включает значения `MediaSize` для североамериканских носителей.
MediaSize.Другие	Класс `MediaSize.Other` включает значения `MediaSize` для различных носителей.
ИмяРазмерНосителя	Класс `MediaSizeName` — это подкласс `Media`.
ЛотокНосителя	Класс `MediaTray` — это подкласс `Media`.
ОбработкаНесколькихДокументов	Класс `MultipleDocumentHandling` — это класс атрибутов печати, перечисление, которое управляет операциями доработки и размещением одной или нескольких страниц потока печати на отпечатках и на листах носителя.

Количество документов	Класс `NumberOfDocuments` — целочисленное свойство печати, указывающее количество отдельных документов, принятых принтером для данной задачи, независимо от того, достиг ли печатный файл принтера или нет.
Количество вмешавшихся задач	Класс `NumberOfInterveningJobs` — целочисленное свойство печати, указывающее количество задач, которые предшествуют данной задаче в относительном хронологическом порядке ожидаемого времени завершения (т. е., текущий запланированный порядок).
Количество страниц на листе	Класс `NumberUp` — целочисленный класс атрибутов печати, который определяет количество страниц потока печати, которые нужно наложить на одну сторону экземпляра выбранного носителя.
Поддерживаемые значения количества страниц на листе	Класс `NumberUpSupported` — класс атрибутов печати, набор целых чисел, который предоставляет поддерживаемые значения для атрибута `NumberUp`.
Запрошенная ориентация	Класс `OrientationRequested` — класс атрибутов печати, перечисление, которое указывает желаемую ориентацию распечатанных страниц потока печати; он не описывает ориентацию страниц потока печати, предоставленных клиентом.
Назначенное выходное устройство	Класс `OutputDeviceAssigned` — класс атрибутов печати, текстовый атрибут, который идентифицирует выходное устройство, которому служба назначила данную задачу.
Диапазоны страниц	Класс `PageRanges` — класс атрибутов печати, набор целых чисел, который идентифицирует диапазон(ы) страниц потока печати, которые объект принтера использует для каждой копии каждого документа, который должен быть распечатан.
Страниц в минуту	Класс `PagesPerMinute` — целочисленное свойство печати, которое указывает номинальное количество страниц в минуту до ближайшего целого числа, которое может генерировать этот принтер (например, простая печать, черно-белая).
Страниц в минуту (цвет)	Класс `PagesPerMinuteColor` — целочисленное свойство печати, которое указывает номинальное количество страниц в минуту до ближайшего целого числа, которое может генерировать этот принтер при печати цветных изображений (например, простая печать, цвет).
Поддержка переопределения PDL	Класс `PDLOverrideSupported` — класс атрибутов печати, перечисление, которое выражает способность принтера пытаться переопределять инструкции по обработке, встроенные в печатные данные документов, инструкциями по обработке, указанными как атрибуты вне печатных данных.
Направление презентации	Класс `PresentationDirection` — класс атрибутов печати, перечисление, которое используется в сочетании с атрибутом `NumberUp` для указания макета нескольких страниц потока печати, которые нужно наложить на одну сторону экземпляра выбранного носителя.
Информация о принтере	Класс `PrinterInfo` — класс атрибутов печати, текстовый атрибут, который предоставляет описательную информацию о принтере.
Принтер принимает задачи	Класс `PrinterIsAcceptingJobs` — класс атрибутов печати, перечисление, которое указывает, может ли принтер в настоящее время принимать задачи.
Расположение принтера	Класс `PrinterLocation` — класс атрибутов печати, текстовый атрибут, который идентифицирует расположение устройства.
Производитель и модель принтера	Класс `PrinterMakeAndModel` — класс атрибутов печати, текстовый атрибут, который указывает производителя и модель принтера.
Сообщение от оператора принтера	Класс `PrinterMessageFromOperator` — класс атрибутов печати, текстовый атрибут, который предоставляет сообщение от оператора, системного администратора или «интеллектуального» процесса для информирования конечного пользователя о информации или статусе принтера, например, о причинах его недоступности или ожидаемом времени доступности.
Дополнительная информация о принтере	Класс `PrinterMoreInfo` — класс атрибутов печати, `URI`, который используется для получения дополнительной информации об этом конкретном принтере.
Дополнительная информация о производителе устройства	Класс `PrinterMoreInfoManufacturer` — класс атрибутов печати, `URI`, который используется для получения дополнительной информации об этом типе устройства.
Имя принтера	Класс `PrinterName` — класс атрибутов печати, текстовый атрибут, который определяет имя принтера.
Разрешение принтера	Класс `PrinterResolution` — класс атрибутов печати, который определяет точное разрешение, поддерживаемое принтером или используемое для задания печати.
Состояние принтера	Класс `PrinterState` — класс атрибутов печати, перечисление, которое идентифицирует текущее состояние принтера.
Причина состояния принтера	Класс `PrinterStateReason` — класс атрибутов печати, перечисление, которое предоставляет дополнительную информацию о текущем состоянии принтера, т. е. информацию, которая дополняет значение атрибута принтера `PrinterState`.
Причины состояния принтера	Класс `PrinterStateReasons` — класс атрибутов печати, набор значений перечисления, который предоставляет дополнительную информацию о текущем состоянии принтера, т. е. информацию, которая дополняет значение атрибута принтера `PrinterState`.
URI принтера	Класс `PrinterURI` — класс атрибутов печати, `URI`, который указывает глобально уникальное имя принтера.
Качество печати	Класс `PrintQuality` — класс атрибутов печати, перечисление, которое определяет качество печати, используемое принтером для задачи.
Количество задач в очереди	Класс `QueuedJobCount` — целочисленное свойство печати, которое указывает количество задач в принтере, у которых `JobState` равно `PENDING`, `PENDING_HELD`, `PROCESSING`, или `PROCESSING_STOPPED`.
Поддерживаемые схемы URI	Класс `ReferenceUriSchemesSupported` — класс атрибутов печати, перечисление, которое указывает «схему URI», такую как «http:» или «ftp:», которую принтер может использовать для получения данных печати, хранящихся в `URI` расположении.
Имя пользователя, запрашивающего печать	Класс `RequestingUserName` — класс атрибутов печати, текстовый атрибут, который указывает имя конечного пользователя, который отправил задачу печати.
Серьезность	Класс `Severity` — класс атрибутов печати, перечисление, которое обозначает серьезность атрибута `PrinterStateReason`.
Сортировка листов	Класс `SheetCollate` — класс атрибутов печати, перечисление, которое определяет, должны ли листы носителя каждой копии каждого распечатанного документа в задаче быть последовательными, когда несколько копий документа задаются атрибутом `Copies`.
Стороны	Класс `Sides` — класс атрибутов печати, перечисление, которое определяет, как страницы потока печати должны быть наложены на стороны экземпляра выбранного носителя, т. е. отпечатка.

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/print/attribute/standard/package-summary.html