Интерфейс DocPrintJob

Все известные подинтерфейсы:: CancelablePrintJob, MultiDocPrintJob

public interface DocPrintJob

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

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`addPrintJobAttributeListener(PrintJobAttributeListener listener, PrintJobAttributeSet attributes)`	Регистрирует слушателя изменений указанных атрибутов.
`void`	`addPrintJobListener(PrintJobListener listener)`	Регистрирует слушателя событий, происходящих во время этого задания печати.
`PrintJobAttributeSet`	`getAttributes()`	Возвращает набор атрибутов печати этого задания печати.
`PrintService`	`getPrintService()`	Определяет объект `PrintService`, с которым связан этот объект задания печати.
`void`	`print(Doc doc, PrintRequestAttributeSet attributes)`	Печатает документ с указанными атрибутами задания.
`void`	`removePrintJobAttributeListener(PrintJobAttributeListener listener)`	Удаляет слушателя атрибутов из этого задания печати.
`void`	`removePrintJobListener(PrintJobListener listener)`	Удаляет слушателя из этого задания печати.

Подробное описание методов

getPrintService

PrintService getPrintService()

Определяет объект PrintService, с которым связан этот объект задания печати.

Возвращает:: объект PrintService

getAttributes

PrintJobAttributeSet getAttributes()

Возвращает набор атрибутов печати этого задания печати. Возвращаемый объект набора атрибутов не допускает изменений. Возвращаемый объект набора атрибутов представляет собой «снимок» набора атрибутов этого задания печати на момент вызова метода getAttributes(); то есть содержимое возвращаемого объекта набора атрибутов не будет обновляться при последующем изменении содержимого набора атрибутов этого задания печати. Чтобы обнаружить изменения значений атрибутов, снова вызовите getAttributes() и сравните новый набор атрибутов с предыдущим; другой вариант — зарегистрировать слушателя событий задания печати. Возвращаемое значение может быть пустым набором, но не должно быть null.

Возвращает:: атрибуты задания печати

addPrintJobListener

void addPrintJobListener(PrintJobListener listener)

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

Параметры:

listener — объект, реализующий интерфейс слушателя

См. также:

removePrintJobListener

void removePrintJobListener(PrintJobListener listener)

Удаляет слушателя из этого задания печати. Этот метод ничего не делает и не выбрасывает исключение, если указанный аргументом слушатель ранее не был добавлен в это задание печати. Если слушатель равен null, исключение не выбрасывается и никаких действий не выполняется. Если слушатель был зарегистрирован несколько раз, будет удалена только одна из регистраций.

Параметры:

listener — объект, реализующий интерфейс слушателя

См. также:

addPrintJobAttributeListener

void addPrintJobAttributeListener(PrintJobAttributeListener listener, PrintJobAttributeSet attributes)

Регистрирует слушателя изменений указанных атрибутов. Если слушатель равен null, исключение не выбрасывается и никаких действий не выполняется. Чтобы определить обновления атрибутов, о которых может сообщать это задание, клиент может вызвать getAttributes() и выделить подмножество атрибутов, представляющих интерес и об изменениях которых, вероятно, будет сообщено слушателю. Клиентам, ожидающим уведомления об изменениях определенного атрибута задания, следует проверить, входит ли он в этот набор; однако обновления атрибута будут выполняться только в случае его изменения и обнаружения этого изменения заданием. Кроме того, задание может группировать обновления. Чтобы свести к минимуму накладные расходы при обработке задания печати, рекомендуется отслеживать только подмножество атрибутов, которые могут измениться. Если указанный набор пуст, слушателю не будут сообщаться обновления атрибутов. Если набор атрибутов равен null, это означает, что нужно отслеживать все динамические атрибуты, поддерживаемые заданием. Это может привести к отсутствию уведомлений об обновлениях, если задание не может сообщать об обновлениях атрибутов.

Если слушатель уже зарегистрирован, он будет зарегистрирован повторно.

Параметры:

listener — объект, реализующий интерфейс слушателя

attributes — атрибуты для отслеживания или null, означающее все атрибуты, которые могут измениться, по определению задания

См. также:

removePrintJobAttributeListener

void removePrintJobAttributeListener(PrintJobAttributeListener listener)

Удаляет слушателя атрибутов из этого задания печати. Этот метод ничего не делает и не выбрасывает исключение, если указанный аргументом слушатель ранее не был добавлен в это задание печати. Если слушатель равен null, исключение не выбрасывается и никаких действий не выполняется. Если слушатель зарегистрирован несколько раз, даже для разных наборов атрибутов, не гарантируется, какая именно регистрация будет удалена.

Параметры:

listener — объект, реализующий интерфейс слушателя

См. также:

print

void print(Doc doc, PrintRequestAttributeSet attributes) throws PrintException

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

Реализации служб печати должны закрывать все потоки данных печати (то есть реализации Reader или InputStream), которые они получают от документа клиента. Надежным клиентам все же может потребоваться проверить это. Если DocFlavor невозможно напечатать, всегда генерируется исключение.

Параметры:

doc — документ для печати. Его формат должен поддерживаться этим заданием печати.

attributes — атрибуты задания, применяемые к этому заданию печати. Если этот параметр равен null, используются атрибуты по умолчанию.

Выбрасывает:

PrintException — исключение может дополнительно реализовывать интерфейс, более точно описывающий причину исключения

FlavorException. Если формат документа не поддерживается этим заданием печати.
AttributeException. Если один или несколько атрибутов недопустимы для этого задания печати.

© 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/DocPrintJob.html