javax.print

Документ интерфейса

Все Известные Классы с реализацией:

SimpleDoc

public interface Doc

Документ интерфейса определяет интерфейс для объекта, который предоставляет одну часть данных печати для Задания Печати. "Документ" является коротким, термин, "легкий объявить, что" это означает "часть данных печати." Клиент передает к Заданию Печати объект, который реализует Документ интерфейса, и Задание Печати вызывает методы на том объекте получить данные печати. Интерфейс Документа позволяет Заданию Печати:

• Определите формат, или "разновидность документа" (class DocFlavor), в котором данные печати доступны. Разновидность документа определяет формат данных печати (тип MIME) и представление class объекта, из которого прибывают данные печати.

• Получите объект представления данных печати, который является экземпляром представления разновидности документа class. Задание Печати может тогда получить фактические данные печати из объекта представления.

• Получите атрибуты печати, которые определяют дополнительные характеристики документа или которые определяют инструкции обработки, которые будут применены к документу. Печатающие атрибуты определяются в пакете javax.print.attribute. Документ возвращает свои атрибуты печати, сохраненные в javax.print.attribute.DocAttributeSet.

Каждый метод в реализации Документа интерфейса разрешается всегда возвратить тот же самый объект каждый раз, когда метод вызывают. У этого есть импликации для Задания Печати или другой вызывающей стороны объекта документа, объект представления данных печати которого "использует" данные печати, поскольку вызывающая сторона получает данные печати, такие как объект представления данных печати, который является потоком. Как только Задание Печати вызвало getPrintData() и полученный поток, дальнейшие звонки getPrintData() возвратит тот же самый потоковый объект, на который чтение может уже произойти, не новый потоковый объект, который перечитает данные печати с начала. Определяя объект документа вести себя этот путь упрощает реализацию объектов документа, и выравнивается по ширине на том основании, что определенный документ предназначается, чтобы передать данные печати только одному Заданию Печати, не нескольким различным Заданиям Печати. (Чтобы передать те же самые данные печати нескольким различным Заданиям Печати, необходимо создать несколько различных объектов документа сверху того же самого источника данных печати.)

Документ интерфейса предоставляет значительную гибкость реализации. Данные печати могли бы уже быть существующими, когда объект документа создается. В этом случае объекты, возвращенные методами документа, могут быть предоставлены конструктору документа, сохранены в документе загодя, и просто быть возвращенными когда требующийся. Альтернативно, данные печати еще не могли бы существовать, когда объект документа создается. В этом случае объект документа мог бы обеспечить "ленивую" реализацию, которая генерирует объект представления данных печати (и/или данные печати) только, когда Задание Печати призывает к этому (когда Задание Печати вызывает getPrintData() метод).

Нет никакого ограничения на число клиентских потоков, которые могут одновременно получать доступ к тому же самому документу. Поэтому, все реализации Документа интерфейса должны быть разработаны, чтобы быть многократны ориентированный на многопотоковое исполнение.

Однако может только быть один потребитель данных печати, полученных из Документа.

Если данные печати получаются от клиента как поток, вызывая Документ getReaderForText() или getStreamForBytes() методы, или потому что источником данных печати уже является InputStream или Читатель, тогда служба печати, должны всегда закрывать эти потоки для клиента на всех условиях завершения задания. Со следующим протестом. Если данные печати будут самостоятельно потоком, то служба будет всегда закрывать их. Если данные печати будут иначе чем-то, что можно требовать как поток, то служба только закроет поток, если это получило поток перед завершением. Таким образом, только потому что служба печати могла бы запросить данные, поскольку поток не означает, что это будет с импликациями, что конструкторы Документа, которые полагаются на службу, чтобы закрыть их, должны создать такие потоки только в ответ на запрос от службы.

Сводка метода

Модификатор и Тип	Метод и Описание
DocAttributeSet	getAttributes() Получает набор печати атрибутов для этого объекта документа.
DocFlavor	getDocFlavor() Определяет разновидность документа, в которой этот объект документа предоставит свою часть данных печати.
Объект	getPrintData() Получает объект представления данных печати, который содержит эту часть объекта документа данных печати в формате, соответствующем поддерживаемой разновидности документа.
Читатель	getReaderForText() Получает читателя для того, чтобы извлечь символьные данные печати из этого документа.
InputStream	getStreamForBytes() Получает входной поток для того, чтобы извлечь данные печати байта из этого документа.

Деталь метода

getDocFlavor

DocFlavor getDocFlavor()

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

Возвраты:

Разновидность документа.

getPrintData

Object getPrintData()
             throws IOException

Получает объект представления данных печати, который содержит эту часть объекта документа данных печати в формате, соответствующем поддерживаемой разновидности документа. getPrintData() метод возвращает экземпляр представления class, именем которого дают getDocFlavor().getRepresentationClassName(), и возвращаемое значение может быть брошено от Объекта class до того представления class.

Возвраты:

Напечатайте объект представления данных.

Броски:

IOException - Брошенный, если представление class является потоком и была ошибка ввода-вывода, создавая поток.

getAttributes

DocAttributeSet getAttributes()

Получает набор печати атрибутов для этого объекта документа. Если возвращенный набор атрибута включает экземпляр определенного атрибута X, принтер должен использовать то значение атрибута для этого документа, переопределяя любое значение атрибута X в наборе атрибута задания. Если возвращенный набор атрибута не включает экземпляр определенного атрибута X или если нуль возвращается, принтер должен консультироваться с набором атрибута задания, чтобы получить значение для атрибута X, и если не найденный там, принтер должен использовать зависящее от реализации значение по умолчанию. Возвращенный набор атрибута является неподдающимся изменению.

Возвраты:

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

getReaderForText

Reader getReaderForText()
                 throws IOException

Получает читателя для того, чтобы извлечь символьные данные печати из этого документа. Реализация Документа обязана поддерживать этот метод, если у DocFlavor есть один из следующих классов представления данных печати, и возвратите нуль иначе:

• случайная работа []
• java.lang. Строка
• java.io. Читатель

Объект представления данных печати документа используется, чтобы создать и возвратить Читателя для того, чтобы считать данные печати как поток символов от объекта представления данных печати. Однако, если объект представления данных печати является самостоятельно Читателем, то объект представления данных печати просто возвращается.

Возвраты:

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

Броски:

IOException - Брошенный, если была ошибка ввода-вывода, создавая читателя.

getStreamForBytes

InputStream getStreamForBytes()
                       throws IOException

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

• байт []
• java.io. InputStream

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

Возвраты:

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

Броски:

IOException - Брошенный, если была ошибка ввода-вывода, создавая входной поток.