Пакет 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 Протокол печати по Интернету/1.1: модель и семантика от сентября 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 — класс атрибута печати, набор целых чисел, который идентифицирует диапазон(ы) страниц потока печати, которые объект Printer использует для каждой копии каждого документа, который должен быть распечатан. |
| 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, 2023, 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/21/docs/api/java.desktop/javax/print/attribute/standard/package-summary.html
