Spec-Zone.ru › OpenJDK 21

Интерфейс 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(javax.print.event.PrintJobListener)

removePrintJobListener

void removePrintJobListener(PrintJobListener listener)
Удаляет слушателя из этой задачи печати. Этот метод не выполняет никакой функции и не генерирует исключение, если слушатель, указанный в аргументе, не был ранее добавлен в эту задачу печати. Если слушатель null, исключение не выбрасывается, и никаких действий не выполняется. Если слушатель был зарегистрирован более одного раза, будет удалена только одна из регистраций.
Параметры:
listener - объект, реализующий интерфейс слушателя
См. также:
  • addPrintJobListener(javax.print.event.PrintJobListener)

addPrintJobAttributeListener

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

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

Параметры:
listener - объект, реализующий интерфейс слушателя
attributes - атрибуты, за которыми нужно следить, или null для всех атрибутов, которые могут измениться, как определено задачей
См. также:
  • removePrintJobAttributeListener(javax.print.event.PrintJobAttributeListener)

removePrintJobAttributeListener

void removePrintJobAttributeListener(PrintJobAttributeListener listener)
Удаляет слушателя атрибутов из этой задачи печати. Этот метод не выполняет никакой функции, и не генерирует исключение, если слушатель, указанный в аргументе, не был ранее добавлен в эту задачу печати. Если слушатель null, исключение не выбрасывается, и никаких действий не выполняется. Если слушатель зарегистрирован более одного раза, даже для разных наборов атрибутов, нет гарантий, какой слушатель будет удален.
Параметры:
listener - объект, реализующий интерфейс слушателя
См. также:
  • addPrintJobAttributeListener(javax.print.event.PrintJobAttributeListener, javax.print.attribute.PrintJobAttributeSet)

print

void print(Doc doc, PrintRequestAttributeSet attributes) throws PrintException
Печатает документ со специфицированными атрибутами задачи. Этот метод должен вызываться только один раз для данной задачи печати. Его повторный вызов не приведет к отправке новой задачи на принтер. Реализация службы определит политику прерывания и восстановления службы. Когда метод print возвращается, печать может еще не завершиться, так как она может выполняться асинхронно, возможно, в другом потоке. Клиенты приложения, которые хотят отслеживать успех или неудачу, должны зарегистрировать PrintJobListener.

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

Параметры:
doc - документ, который необходимо распечатать. Он должен быть совместим с данной задачей печати.
attributes - атрибуты задачи, которые необходимо применить к этой задаче печати. Если этот параметр null, используются атрибуты по умолчанию.
Исключения:
PrintException - исключение дополнительно может реализовывать интерфейс, который более точно описывает причину исключения
  • FlavorException. Если формат документа не поддерживается данной задачей печати.
  • AttributeException. Если один или несколько атрибутов не действительны для этой задачи печати.

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

Spec-Zone.ru

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