Интерфейс 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

Печатает документ с указанными атрибутами задания. Этот метод должен вызываться только один раз для данной задачи печати. Вызов его снова не приведет к отправке нового задания на печать. Реализация службы определит политику прерывания и восстановления службы. Когда метод print возвращает, печать может еще не завершиться, так как печать может выполняться асинхронно, возможно, в другом потоке. Клиенты приложений, которые хотят отслеживать успех или неудачу, должны зарегистрировать 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/print/DocPrintJob.html