Пакет 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" перечисляет класс атрибута поддерживаемых значений, если таковой имеется, с помощью которого служба печати указывает поддерживаемые значения для этой категории атрибутов. Обратите внимание: в API javax.print параметр ссылки null к методам некорректен, если явно не указано в документации к методу, что он имеет осмысленное значение. Использование в противоположном случае является неправильным кодированием и может привести к исключению во время выполнения сразу или позже. Примерами типичных и допустимых исключений во время выполнения в таких случаях являются IllegalArgumentException и NullPointerException.
- С момента:
- 1.4
| Класс | Описание |
|---|---|
| Chromaticity | Класс Chromaticity — класс атрибутов печати, перечисление, которое определяет монохромную или цветную печать. |
| ColorSupported | Класс ColorSupported — класс атрибутов печати, перечисление, определяющее, способен ли аппарат на печать любого типа цвета, включая выделение цветом и полноцветную печать. |
| Compression | Класс Compression — класс атрибутов печати, перечисление, которое определяет способ сжатия данных печати. |
| Copies | Класс Copies — целочисленный класс атрибутов печати, определяющий количество копий для печати. |
| CopiesSupported | Класс CopiesSupported — класс атрибутов печати, множество целых чисел, которое предоставляет поддерживаемые значения для атрибута Copies. |
| DateTimeAtCompleted | Класс DateTimeAtCompleted — класс атрибутов печати, атрибут даты и времени, указывающий дату и время завершения задания печати (или отмены или прерывания). |
| DateTimeAtCreation | Класс DateTimeAtCreation — класс атрибутов печати, атрибут даты и времени, указывающий дату и время создания задания печати. |
| DateTimeAtProcessing | Класс DateTimeAtProcessing — класс атрибутов печати, атрибут даты и времени, указывающий дату и время, когда задание печати начало обработку. |
| Destination | Класс Destination — класс атрибутов печати, URI, используемый для указания альтернативного назначения для буферизованных данных формата принтера. |
| DialogOwner | Класс атрибутов, используемый для запроса отображения диалога печати или настройки страницы поверх всех окон или некоторых конкретных окон. |
| DialogTypeSelection | Класс DialogTypeSelection — класс атрибутов печати, перечисление, указывающее тип пользовательского диалога, который будет использоваться для задания параметров печати. |
| DocumentName | Класс DocumentName — класс атрибутов печати, текстовый атрибут, определяющий имя документа. |
| Fidelity | Класс Fidelity — класс атрибутов печати, перечисление, которое указывает, требуется ли полное соответствие атрибутам запроса на печать, предоставленным клиентом. |
| Finishings | Класс Finishings — класс атрибутов печати, перечисление, определяющее, применяет ли принтер операцию обработки, такую как переплет, к каждой копии каждого отпечатанного документа в задании. |
| JobHoldUntil | Класс JobHoldUntil — класс атрибутов печати, атрибут даты и времени, указывающий точную дату и время, когда задание должно стать кандидатом на печать. |
| JobImpressions | Класс JobImpressions — целочисленный класс атрибутов печати, определяющий общий размер в количестве отпечатков подаваемого документа(ов). |
| JobImpressionsCompleted | Класс JobImpressionsCompleted — целочисленный класс атрибутов печати, определяющий количество отпечатков, завершённых для задания до настоящего момента. |
| JobImpressionsSupported | Класс JobImpressionsSupported — класс атрибутов печати, множество целых чисел, которое предоставляет поддерживаемые значения для атрибута JobImpressions. |
| JobKOctets | Класс JobKOctets — целочисленный класс атрибутов печати, определяющий общий размер документа(ов) в К октетах, т. е. в единицах 1024 октетов, запрошенных для обработки в задании. |
| JobKOctetsProcessed | Класс JobKOctetsProcessed — целочисленный класс атрибутов печати, определяющий общее количество обработанных октетов данных печати до настоящего момента в К октетах, т. е. в единицах 1024 октетов. |
| JobKOctetsSupported | Класс JobKOctetsSupported — класс атрибутов печати, множество целых чисел, которое предоставляет поддерживаемые значения для атрибута JobKOctets. |
| JobMediaSheets | Класс JobMediaSheets — целочисленный класс атрибутов печати, определяющий общее количество листов носителя, которые должны быть произведены для этого задания. |
| JobMediaSheetsCompleted | Класс JobMediaSheetsCompleted — целочисленный класс атрибутов печати, определяющий количество листов носителя, которые завершили маркировку и укладку для всего задания до настоящего момента, независимо от того, были ли эти листы обработаны с одной или с обеих сторон. |
| JobMediaSheetsSupported | Класс JobMediaSheetsSupported — класс атрибутов печати, множество целых чисел, которое предоставляет поддерживаемые значения для атрибута JobMediaSheets. |
| JobMessageFromOperator | Класс JobMessageFromOperator — класс атрибутов печати, текстовый атрибут, который содержит сообщение от оператора, системного администратора или «интеллектуального» процесса, чтобы указать конечному пользователю причины модификации или других действий по управлению заданием. |
| JobName | Класс JobName — класс атрибутов печати, текстовый атрибут, определяющий имя задания печати. |
| JobOriginatingUserName | Класс JobOriginatingUserName — класс атрибутов печати, текстовый атрибут, содержащий имя конечного пользователя, который отправил задание печати. |
| JobPriority | Класс JobPriority — целочисленный класс атрибутов печати, определяющий приоритет задания печати. |
| JobPrioritySupported | Класс JobPrioritySupported — целочисленный класс атрибутов печати, определяющий, поддерживает ли экземпляр службы печати атрибут JobPriority и количество поддерживаемых уровней приоритетов заданий. |
| JobSheets | Класс JobSheets — класс атрибутов печати, перечисление, которое определяет, какие начальные и конечные листы задания, если таковые имеются, должны быть напечатаны с заданием. |
| JobState | JobState — класс атрибутов печати, перечисление, которое определяет текущее состояние задания печати. |
| JobStateReason | Класс JobStateReason — класс атрибутов печати, перечисление, предоставляющее дополнительную информацию о текущем состоянии задания, т. е. информацию, дополняющую значение атрибута задания JobState. |
| JobStateReasons | Класс JobStateReasons — класс атрибутов печати, набор значений перечисления, предоставляющий дополнительную информацию о текущем состоянии задания, т. е. информацию, дополняющую значение атрибута задания JobState. |
| Media | Класс Media — класс атрибутов печати, определяющий носитель для печати. |
| MediaName | Класс MediaName — подкласс Media, класс атрибутов печати (перечисление), определяющий носитель для задания печати как имя. |
| MediaPrintableArea | Класс MediaPrintableArea — атрибут печати, используемый для различения печатных и непечатных областей носителя. |
| MediaSize | Класс MediaSize — двухмерный атрибут класса печати, определяющий размеры носителя в портретном формате, где измерение X проходит по нижнему краю, а измерение Y — по левому краю. |
| MediaSize.Engineering | Класс MediaSize.Engineering содержит значения MediaSize для инженерных носителей. |
| MediaSize.ISO | Класс MediaSize.ISO содержит значения MediaSize для носителей ISO. |
| MediaSize.JIS | Класс MediaSize.JIS содержит значения MediaSize для носителей JIS (японских). |
| MediaSize.NA | Класс MediaSize.NA содержит значения MediaSize для североамериканских носителей. |
| MediaSize.Other | Класс MediaSize.Other содержит значения MediaSize для различных носителей. |
| MediaSizeName | Класс MediaSizeName является подклассом Media. |
| MediaTray | Класс MediaTray является подклассом Media. |
| MultipleDocumentHandling | Класс MultipleDocumentHandling — класс атрибутов печати, перечисление, которое управляет операциями финиширования и размещением одной или нескольких страниц потока печати в оттисках и на листах носителя. |
| NumberOfDocuments | Класс NumberOfDocuments — целочисленный атрибут печати, указывающий количество отдельных документов, принятых принтером для этой работы, независимо от того, достигла ли данных документов принтер или нет. |
| NumberOfInterveningJobs | Класс NumberOfInterveningJobs — целочисленный атрибут печати, указывающий количество работ, которые предшествуют этой работе в относительном хронологическом порядке ожидаемого времени завершения (т.е., текущем запланированном порядке). |
| NumberUp | Класс NumberUp — целочисленный класс атрибутов печати, который определяет количество страниц потока печати для нанесения на одну сторону экземпляра выбранного носителя. |
| NumberUpSupported | Класс NumberUpSupported — класс атрибутов печати, набор целых чисел, который предоставляет поддерживаемые значения для атрибута NumberUp. |
| OrientationRequested | Класс OrientationRequested — класс атрибутов печати, перечисление, указывающее желаемую ориентацию для распечатанных страниц потока печати; он не описывает ориентацию страниц потока печати, предоставленных клиентом. |
| OutputDeviceAssigned | Класс OutputDeviceAssigned — класс атрибутов печати, текстовый атрибут, который идентифицирует устройство вывода, которому служба назначила эту задачу. |
| PageRanges | Класс PageRanges — класс атрибутов печати, набор целых чисел, который идентифицирует диапазон(ы) страниц потока печати, которые объект принтера использует для каждой копии каждого документа, который должен быть распечатан. |
| PagesPerMinute | Класс PagesPerMinute — целочисленный атрибут печати, указывающий номинальное количество страниц в минуту до ближайшего целого числа, которое может быть сгенерировано этим принтером (например, простая, черно-белая). |
| PagesPerMinuteColor | Класс PagesPerMinuteColor — целочисленный атрибут печати, указывающий номинальное количество страниц в минуту до ближайшего целого числа, которое может быть сгенерировано этим принтером при печати цветных изображений (например, простая, цветная). |
| PDLOverrideSupported | Класс PDLOverrideSupported — класс атрибутов печати, перечисление, которое выражает способность принтера пытаться переопределить инструкции обработки, встроенные в данные документов для печати, с инструкциями обработки, указанными как атрибуты вне данных печати. |
| PresentationDirection | Класс PresentationDirection — класс атрибутов печати, перечисление, которое используется совместно с атрибутом NumberUp, чтобы указать макет нескольких страниц потока печати для нанесения на одну сторону экземпляра выбранного носителя. |
| PrinterInfo | Класс PrinterInfo — класс атрибутов печати, текстовый атрибут, который предоставляет описательную информацию о принтере. |
| PrinterIsAcceptingJobs | Класс PrinterIsAcceptingJobs — класс атрибутов печати, перечисление, которое указывает, может ли принтер в настоящее время принимать задания. |
| PrinterLocation | Класс PrinterLocation — класс атрибутов печати, текстовый атрибут, который идентифицирует местоположение устройства. |
| PrinterMakeAndModel | Класс PrinterMakeAndModel — класс атрибутов печати, текстовый атрибут, который содержит марку и модель принтера. |
| PrinterMessageFromOperator | Класс PrinterMessageFromOperator — класс атрибутов печати, текстовый атрибут, который предоставляет сообщение от оператора, системного администратора или «интеллектуального» процесса, чтобы сообщить конечному пользователю информацию или статус принтера, например, почему он недоступен или когда ожидается его доступность. |
| PrinterMoreInfo | Класс PrinterMoreInfo — класс атрибутов печати, URI, который используется для получения дополнительной информации об этом конкретном принтере. |
| PrinterMoreInfoManufacturer | Класс PrinterMoreInfoManufacturer — класс атрибутов печати, URI, который используется для получения дополнительной информации об этом типе устройства. |
| PrinterName | Класс PrinterName — класс атрибутов печати, текстовый атрибут, который определяет имя принтера. |
| PrinterResolution | Класс PrinterResolution — класс атрибутов печати, который определяет точную разрешающую способность, поддерживаемую принтером, или которая должна использоваться для задания печати. |
| PrinterState | Класс PrinterState — класс атрибутов печати, перечисление, которое определяет текущее состояние принтера. |
| PrinterStateReason | Класс PrinterStateReason — класс атрибутов печати, перечисление, которое предоставляет дополнительную информацию о текущем состоянии принтера, то есть информацию, которая дополняет значение атрибута принтера PrinterState. |
| PrinterStateReasons | Класс PrinterStateReasons — класс атрибутов печати, набор значений перечисления, который предоставляет дополнительную информацию о текущем состоянии принтера, то есть информацию, которая дополняет значение атрибута принтера PrinterState. |
| PrinterURI | Класс PrinterURI — класс атрибутов печати, URI, который определяет глобально уникальное имя принтера. |
| PrintQuality | Класс PrintQuality — это класс атрибутов печати, перечисление, которое указывает качество печати, используемое принтером для задания. |
| QueuedJobCount | Класс QueuedJobCount — целочисленный атрибут печати, который указывает количество заданий в принтере, состояние которых JobState равно либо PENDING, либо PENDING_HELD, либо PROCESSING, либо PROCESSING_STOPPED. |
| ReferenceUriSchemesSupported | Класс ReferenceUriSchemesSupported — это класс атрибутов печати, перечисление, которое указывает "схему URI", такую как "http:" или "ftp:", которую принтер может использовать для получения данных печати, хранящихся в URI местоположении. |
| RequestingUserName | Класс RequestingUserName — это класс атрибутов печати, текстовый атрибут, который указывает имя конечного пользователя, который отправил задание печати. |
| Severity | Класс Severity — это класс атрибутов печати, перечисление, которое обозначает степень серьезности атрибута PrinterStateReason. |
| SheetCollate | Класс SheetCollate — это класс атрибутов печати, перечисление, которое указывает, будут ли листы носителя каждой копии каждого распечатанного документа в задании расположены последовательно, если количество копий документа указано атрибутом Copies. |
| Sides | Класс Sides — это класс атрибутов печати, перечисление, которое определяет, как страницы печатного потока должны быть наложены на стороны экземпляра выбранного носителя, то есть отпечаток. |
© 1993, 2021, 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/17/docs/api/java.desktop/javax/print/attribute/standard/package-summary.html
