OpenJDK 27 · sun.print.PageableDoc · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Pageable	pageable

Access	Constructor and Description
public	PageableDoc(Pageable pageable)

Method Summary

Modifier and Type	Method and Description
public DocAttributeSet	getAttributes() Implements javax.print.Doc.getAttributes. Obtains the set of printing attributes for this doc object.
public DocFlavor	getDocFlavor() Implements javax.print.Doc.getDocFlavor. Determines the doc flavor in which this doc object will supply its piece of print data.
public Object	getPrintData() Implements javax.print.Doc.getPrintData. Obtains the print data representation object that contains this doc object's piece of print data in the format corresponding to the supported doc flavor.
public Reader	getReaderForText() Implements javax.print.Doc.getReaderForText. Obtains a reader for extracting character print data from this doc.
public InputStream	getStreamForBytes() Implements javax.print.Doc.getStreamForBytes. Obtains an input stream for extracting byte print data from this doc.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

pageable	back to summary
private Pageable pageable

PageableDoc	back to summary
public PageableDoc(Pageable pageable)

Method Detail

getAttributes back to summary

getAttributes	back to summary
public DocAttributeSet getAttributes() Implements javax.print.Doc.getAttributes. Doc from javax.print.Doc.getAttributes. Obtains the set of printing attributes for this doc object. If the returned attribute set includes an instance of a particular attribute X, the printer must use that attribute value for this doc, overriding any value of attribute X in the job's attribute set. If the returned attribute set does not include an instance of a particular attribute X or if `null` is returned, the printer must consult the job's attribute set to obtain the value for attribute X, and if not found there, the printer must use an implementation-dependent default value. The returned attribute set is unmodifiable.

public DocAttributeSet getAttributes()

Implements javax.print.Doc.getAttributes.

Doc from javax.print.Doc.getAttributes.

Obtains the set of printing attributes for this doc object. If the returned attribute set includes an instance of a particular attribute X, the printer must use that attribute value for this doc, overriding any value of attribute X in the job's attribute set. If the returned attribute set does not include an instance of a particular attribute X or if null is returned, the printer must consult the job's attribute set to obtain the value for attribute X, and if not found there, the printer must use an implementation-dependent default value. The returned attribute set is unmodifiable.

getDocFlavor	back to summary
public DocFlavor getDocFlavor() Implements javax.print.Doc.getDocFlavor. Doc from javax.print.Doc.getDocFlavor. Determines the doc flavor in which this doc object will supply its piece of print data.

getDocFlavor

back to summary

public DocFlavor getDocFlavor()

Implements javax.print.Doc.getDocFlavor.

Doc from javax.print.Doc.getDocFlavor.

Determines the doc flavor in which this doc object will supply its piece of print data.

getPrintData back to summary

getPrintData	back to summary
public Object getPrintData() throws IOException Implements javax.print.Doc.getPrintData. Doc from javax.print.Doc.getPrintData. Obtains the print data representation object that contains this doc object's piece of print data in the format corresponding to the supported doc flavor. The `getPrintData()` method returns an instance of the representation class whose name is given by`getDocFlavor()`.`getRepresentationClassName()`, and the return value can be cast from class `Object` to that representation class. Exceptions IOException: if the representation class is a stream and there was an I/O error while constructing the stream

public Object getPrintData() throws IOException

Implements javax.print.Doc.getPrintData.

Doc from javax.print.Doc.getPrintData.

Obtains the print data representation object that contains this doc object's piece of print data in the format corresponding to the supported doc flavor. The getPrintData() method returns an instance of the representation class whose name is given bygetDocFlavor().getRepresentationClassName(), and the return value can be cast from class Object to that representation class.

Exceptions

IOException:: if the representation class is a stream and there was an I/O error while constructing the stream

getReaderForText back to summary

getReaderForText	back to summary
public Reader getReaderForText() throws IOException Implements javax.print.Doc.getReaderForText. Doc from javax.print.Doc.getReaderForText. Obtains a reader for extracting character print data from this doc. The `Doc` implementation is required to support this method if the `DocFlavor` has one of the following print data representation classes, and return `null` otherwise: char[] java.lang.String java.io.Reader The doc's print data representation object is used to construct and return a `Reader` for reading the print data as a stream of characters from the print data representation object. However, if the print data representation object is itself a `Reader`, then the print data representation object is simply returned. Exceptions IOException: if there was an I/O error while creating the reader

public Reader getReaderForText() throws IOException

Implements javax.print.Doc.getReaderForText.

Doc from javax.print.Doc.getReaderForText.

Obtains a reader for extracting character print data from this doc. The Doc implementation is required to support this method if the DocFlavor has one of the following print data representation classes, and return null otherwise:

char[]
java.lang.String
java.io.Reader

The doc's print data representation object is used to construct and return a Reader for reading the print data as a stream of characters from the print data representation object. However, if the print data representation object is itself a Reader, then the print data representation object is simply returned.

Exceptions

IOException:: if there was an I/O error while creating the reader

getStreamForBytes back to summary

getStreamForBytes	back to summary
public InputStream getStreamForBytes() throws IOException Implements javax.print.Doc.getStreamForBytes. Doc from javax.print.Doc.getStreamForBytes. Obtains an input stream for extracting byte print data from this doc. The `Doc` implementation is required to support this method if the `DocFlavor` has one of the following print data representation classes, and return `null` otherwise: byte[] java.io.InputStream This doc's print data representation object is obtained, then an input stream for reading the print data from the print data representation object as a stream of bytes is created and returned. However, if the print data representation object is itself an input stream, then the print data representation object is simply returned. Exceptions IOException: if there was an I/O error while creating the input stream

public InputStream getStreamForBytes() throws IOException

Implements javax.print.Doc.getStreamForBytes.

Doc from javax.print.Doc.getStreamForBytes.

Obtains an input stream for extracting byte print data from this doc. The Doc implementation is required to support this method if the DocFlavor has one of the following print data representation classes, and return null otherwise:

byte[]
java.io.InputStream

This doc's print data representation object is obtained, then an input stream for reading the print data from the print data representation object as a stream of bytes is created and returned. However, if the print data representation object is itself an input stream, then the print data representation object is simply returned.

Exceptions

IOException:: if there was an I/O error while creating the input stream

public Class PageableDoc

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail