Spec-Zone.ru › OpenJDK 24

Класс SimpleDoc

java.lang.Object
javax.print.SimpleDoc
Все реализованные интерфейсы:
Doc
public final class SimpleDoc extends Object implements Doc
Этот класс является реализацией интерфейса Doc, который может использоваться во многих распространённых запросах печати. Он может обрабатывать все в настоящее время определённые «предопределённые» типы документов, определённые как статические переменные в классе DocFlavor.

В частности, этот класс реализует определённые необходимые семантические функции спецификации Doc следующим образом:

  • создаёт поток для службы, если запрошено и уместно.
  • обеспечивает возврат одного и того же объекта при каждом вызове метода.
  • обеспечивает доступ к объекту Doc из нескольких потоков.
  • выполняет некоторую проверку соответствия данных типу документа.
Клиенты, которые хотят повторно использовать объект документа в других заданиях или нуждаются в MultiDoc, не должны использовать этот класс.

Если данные печати представляют собой поток, или задание печати запрашивает данные в виде потока, то SimpleDoc не отслеживает, правильно ли служба закрывает поток после завершения передачи данных или завершения задания. Клиенты могут предпочесть использовать собственную реализацию документа, добавляющую слушатель для мониторинга завершения задания и проверки того, что ресурсы, такие как потоки, освобождаются (т.е. закрываются).

Краткое описание конструкторов

Конструктор Описание
SimpleDoc(Object printData, DocFlavor flavor, DocAttributeSet attributes)
Создаёт SimpleDoc с указанными данными печати, типом документа и набором атрибутов документа.

Краткое описание методов

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

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

SimpleDoc

public SimpleDoc(Object printData, DocFlavor flavor, DocAttributeSet attributes)
Создаёт SimpleDoc с указанными данными печати, типом документа и набором атрибутов документа.
Параметры:
printData - объект данных печати
flavor - объект типа DocFlavor
attributes - набор DocAttributeSet, который может быть null
Исключения:
IllegalArgumentException - если flavor или printData является null, или printData не соответствует указанному типу документа — например, данные не имеют типа, указанного в качестве представления в DocFlavor

Подробное описание методов

getDocFlavor

public DocFlavor getDocFlavor()
Определяет тип документа, в котором данный объект документа предоставит свои данные печати.
Задано интерфейсом:
getDocFlavor в интерфейсе Doc
Возвращает:
тип документа

getAttributes

public DocAttributeSet getAttributes()
Получает набор атрибутов печати для данного объекта документа. Если возвращаемый набор атрибутов включает экземпляр определённого атрибута X, принтер должен использовать это значение атрибута для данного документа, перезаписывая любое значение атрибута X в наборе атрибутов задания. Если возвращаемый набор атрибутов не включает экземпляр определённого атрибута X или если возвращается null, принтер должен обратиться к набору атрибутов задания, чтобы получить значение для атрибута X, и если оно там не найдено, принтер должен использовать значение по умолчанию, зависящее от реализации. Возвращаемый набор атрибутов неизменяемый.
Задано интерфейсом:
getAttributes в интерфейсе Doc
Возвращает:
неизменяемый набор атрибутов печати для данного документа или null, чтобы получить все значения атрибутов из набора атрибутов задания

getPrintData

public Object getPrintData() throws IOException
Получает объект представления данных печати, содержащий фрагмент данных печати данного объекта документа в формате, соответствующем поддерживаемому типу документа. Метод getPrintData() возвращает экземпляр класса представления, имя которого задано в getDocFlavor().getRepresentationClassName(), и возвращаемое значение может быть приведено к типу этого класса представления.
Задано интерфейсом:
getPrintData в интерфейсе Doc
Возвращает:
объект представления данных печати
Исключения:
IOException - если класс представления — поток, и произошла ошибка ввода-вывода при построении потока

getReaderForText

public Reader getReaderForText() throws IOException
Получает чтец для извлечения текстовых данных печати из данного документа. Реализация Doc обязана поддерживать этот метод, если у DocFlavor есть один из следующих классов представления данных печати, и возвращать null в противном случае:
  • char[]
  • java.lang.String
  • java.io.Reader
Объект представления данных печати документа используется для построения и возврата Reader для чтения данных печати в виде потока символов из объекта представления данных печати. Однако, если сам объект представления данных печати является Reader, то возвращается сам объект представления данных печати.
Задано интерфейсом:
getReaderForText в интерфейсе Doc
Возвращает:
Reader для чтения символов данных печати из данного документа. Если чтец не может быть предоставлен, потому что этот документ не соответствует вышеуказанным критериям, возвращается null.
Исключения:
IOException - если произошла ошибка ввода-вывода при создании читателя

getStreamForBytes

public InputStream getStreamForBytes() throws IOException
Получает входной поток для извлечения данных печати в байтах из данного документа. Реализация Doc обязана поддерживать этот метод, если у DocFlavor есть один из следующих классов представления данных печати; в противном случае этот метод возвращает null:
  • byte[]
  • java.io.InputStream
Получается объект представления данных печати документа. Затем создаётся и возвращается входной поток для чтения данных печати из объекта представления данных печати в виде потока байтов.
Задано интерфейсом:
getStreamForBytes в интерфейсе Doc
Возвращает:
InputStream для чтения байтов данных печати из данного документа. Если входной поток не может быть предоставлен, потому что этот документ не соответствует вышеуказанным критериям, возвращается null.
Исключения:
IOException - если произошла ошибка ввода-вывода при создании входного потока

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

Spec-Zone.ru

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