Doc

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> javax >> [ print overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.print
Interface Doc

All Known Implementing Classes:: SimpleDoc

public interface Doc

Doc specifies the interface for print services how to obtain the print data and document specific attributes for printing.

The print data is always passed to a DocPrintJob object as a Doc object which allows the print services to:

Determine the actual document format of the supplied print data. This is supplied as a DocFlavor object with the MIME type and the representation class of the print data.
Obtain the print data either in its representation class or depending on the document format through convenience methods as a java.io.Reader or an java.io.InputStream.
Obtain the document's attribute set specifying the attributes which apply to this document instance.

Every method of a Doc implementation has to return always the same object on every method call. Therefore if the print job consumes the print data via a stream or a reader object it can read only once the supplied print data. Implementations of this interface have to be thread safe.

Method Summary

javax.print.attribute.DocAttributeSet getAttributes()
          Returns the unmodifiable view of the attributes of this doc object.

DocFlavor getDocFlavor()
          Returns the flavor of this doc objects print data.

java.lang.Object getPrintData()
          Returns the print data of this doc object.

java.io.Reader getReaderForText()
          Returns a Reader object for extracting character print data from this document.

java.io.InputStream getStreamForBytes()
          Returns an InputStream object for extracting byte print data from this document.

Method Detail

getAttributes

public javax.print.attribute.DocAttributeSet getAttributes()

Returns the unmodifiable view of the attributes of this doc object.

The attributes of this doc's attributes set overrides attributes of the same category in the print job's attribute set. If an attribute is not available in this doc's attributes set or null is returned the attributes of the same category of the print job are used.

getDocFlavor

public DocFlavor getDocFlavor()

Returns the flavor of this doc objects print data.

getPrintData

public java.lang.Object getPrintData()
                              throws java.io.IOException

Returns the print data of this doc object.

The returned object is an instance as described by the associated document flavor (DocFlavor.getRepresentationClassName() 55 ) and can be cast to this representation class.

getReaderForText

public java.io.Reader getReaderForText()
                                throws java.io.IOException

Returns a Reader object for extracting character print data from this document.

This method is supported if the document flavor is of type:

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

otherwise this method returns null.

getStreamForBytes

public java.io.InputStream getStreamForBytes()
                                      throws java.io.IOException

Returns an InputStream object for extracting byte print data from this document.