Интерфейс 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. Если один или несколько атрибутов не являются допустимыми для этого задания печати.