Spec-Zone.ru › OpenJDK 17

Интерфейс 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)
Регистрирует слушателя для событий, происходящих во время выполнения этой задачи печати. Если listener является null, исключение не выбрасывается и никаких действий не выполняется. Если listener уже зарегистрирован, он будет зарегистрирован снова.
Параметры:
listener - объект, реализующий интерфейс слушателя
См. также:
  • removePrintJobListener(javax.print.event.PrintJobListener)

removePrintJobListener

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

addPrintJobAttributeListener

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

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

Параметры:
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 реализации), которые они получают от клиентского документа. Надежные клиенты все равно могут захотеть проверить это. Исключение всегда генерируется, если документ DocFlavor не может быть распечатан.

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

© 1993, 2021, 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/17/docs/api/java.desktop/javax/print/DocPrintJob.html

Spec-Zone.ru

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