Spec-Zone.ru › OpenJDK 25

Package javax.print.attribute.standard

package 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 основаны на атрибутах Internet Printing Protocol (IPP), определенных в документе Internet 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. Для каждого атрибута документа и атрибута запроса на печать в столбце "Атрибут поддерживаемых значений" указан класс атрибута поддерживаемых значений, если он имеется, с помощью которого служба печати сообщает поддерживаемые значения для соответствующей категории атрибутов.
Перечень всех описанных выше атрибутов печати
Класс атрибута Атрибут
документа
Атрибут
запроса
на печать
Атрибут
задания
печати
Атрибут
службы
печати
Атрибут поддерживаемых значений
Compression X
DocumentName X
Chromaticity X X X
Copies X X CopiesSupported
Finishings X X X
JobHoldUntil X X
JobImpressions X X JobImpressionsSupported
JobKOctets X X JobKOctetsSupported
JobMediaSheets X X JobMediaSheetsSupported
JobName X X
JobPriority X X JobPrioritySupported
JobSheets X X
Media X X X
MediaSize
MultipleDocumentHandling X X
NumberUp X X X NumberUpSupported
OrientationRequested X X X
PageRanges X X X
PresentationDirection X X X
PrinterResolution X X X
PrintQuality X X X
RequestingUserName X X
SheetCollate X X X
Sides X X X
OutputBin X X
DateTimeAtCompleted X
DateTimeAtCreation X
DateTimeAtProcessing X
JobImpressionsCompleted X
JobKOctetsProcessed X
JobMediaSheetsCompleted X
JobMessageFromOperator X
JobOriginatingUserName X
JobState X
JobStateReasons
Содержит ноль или более элементов --
X
-- JobStateReason
NumberOfDocuments X
NumberOfInterveningJobs X
OutputDeviceAssigned X
ColorSupported X
PagesPerMinute X
PagesPerMinuteColor X
PDLOverrideSupported X
PrinterIsAcceptingJobs X
PrinterInfo X
PrinterLocation X
PrinterMessageFromOperator X
PrinterMakeAndModel X
PrinterMoreInfo X
PrinterMoreInfoManufacturer X
PrinterName X
PrinterState X
PrinterStateReasons
Содержит ноль или более элементов --
X
-- PrinterStateReason
-- Severity
QueuedJobCount X
ReferenceUriSchemesSupported

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

С версии:
1.4
Внешние спецификации
  • RFC 2911: Internet Printing Protocol/1.1: Model and Semantics
Пакет Описание
javax.print.attribute
Предоставляет классы и интерфейсы, описывающие типы атрибутов Java Print Service и способы их объединения в наборы атрибутов.
Класс Описание
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 — это класс атрибута печати с целочисленным значением, указывающий, поддерживает ли экземпляр Print Service атрибут 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 — это класс атрибута печати, представляющий набор целых чисел и указывающий диапазон или диапазоны страниц потока печати, которые объект 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 — это класс атрибута печати, перечисление, задающее способ размещения страниц потока печати на сторонах листа выбранного носителя, то есть на оттисках.

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе Документация Java SE, где приведены более подробные описания для разработчиков, включая обзоры концепций, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/print/attribute/standard/package-summary.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API