Пакет javax.print.attribute.standard
javax.print.attribute.standard содержит классы для специфических атрибутов печати. Родительский пакет javax.print.attribute предоставляет классы и интерфейсы, которые описывают типы атрибутов Java Print Service и как они могут быть собраны в наборы атрибутов. Атрибут представляет собой функцию печати, которую может предоставить служба печати. Для каждого атрибута служба печати либо поддерживает его, либо нет. Для каждого возможного значения поддерживаемого атрибута служба печати либо поддерживает его, либо нет.
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 — это класс атрибутов печати, перечисление, которое указывает желаемую ориентацию печатных страниц потока печати; он не описывает ориентацию страниц потока печати, предоставленных клиентом. |
| OutputBin | Класс OutputBin — это класс атрибутов печати, перечисление, которое определяет лоток вывода для задачи. |
| 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, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/print/attribute/standard/package-summary.html