Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.print
Class SimpleDoc

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.print.SimpleDoc
All Implemented Interfaces:
Doc sample code for javax.print.Doc definition code for javax.print.Doc 
public final class SimpleDoc
extends Object sample code for java.lang.Object definition code for java.lang.Object 
implements Doc sample code for javax.print.Doc definition code for javax.print.Doc

This class is an implementation of interface Doc that can be used in many common printing requests. It can handle all of the presently defined "pre-defined" doc flavors defined as static variables in the DocFlavor class.

In particular this class implements certain required semantics of the Doc specification as follows:

Clients who want to re-use the doc object in other jobs, or need a MultiDoc will not want to use this class.

If the print data is a stream, or a print job requests data as a stream, then SimpleDoc does not monitor if the service properly closes the stream after data transfer completion or job termination. Clients may prefer to use provide their own implementation of doc that adds a listener to monitor job completion and to validate that resources such as streams are freed (ie closed).

Constructor Summary
SimpleDoc sample code for javax.print.SimpleDoc.SimpleDoc(java.lang.Object, javax.print.DocFlavor, javax.print.attribute.DocAttributeSet) definition code for javax.print.SimpleDoc.SimpleDoc(java.lang.Object, javax.print.DocFlavor, javax.print.attribute.DocAttributeSet) (Object sample code for java.lang.Object definition code for java.lang.Object  printData, DocFlavor sample code for javax.print.DocFlavor definition code for javax.print.DocFlavor  flavor, DocAttributeSet sample code for javax.print.attribute.DocAttributeSet definition code for javax.print.attribute.DocAttributeSet  attributes)
          Constructs a SimpleDoc with the specified print data, doc flavor and doc attribute set.
 
Method Summary
 DocAttributeSet sample code for javax.print.attribute.DocAttributeSet definition code for javax.print.attribute.DocAttributeSet getAttributes sample code for javax.print.SimpleDoc.getAttributes() definition code for javax.print.SimpleDoc.getAttributes() ()
          Obtains the set of printing attributes for this doc object.
 DocFlavor sample code for javax.print.DocFlavor definition code for javax.print.DocFlavor getDocFlavor sample code for javax.print.SimpleDoc.getDocFlavor() definition code for javax.print.SimpleDoc.getDocFlavor() ()
          Determines the doc flavor in which this doc object will supply its piece of print data.
 Object sample code for java.lang.Object definition code for java.lang.Object getPrintData sample code for javax.print.SimpleDoc.getPrintData() definition code for javax.print.SimpleDoc.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.
 Reader sample code for java.io.Reader definition code for java.io.Reader getReaderForText sample code for javax.print.SimpleDoc.getReaderForText() definition code for javax.print.SimpleDoc.getReaderForText() ()
          Obtains a reader for extracting character print data from this doc.
 InputStream sample code for java.io.InputStream definition code for java.io.InputStream getStreamForBytes sample code for javax.print.SimpleDoc.getStreamForBytes() definition code for javax.print.SimpleDoc.getStreamForBytes() ()
          Obtains an input stream for extracting byte print data from this doc.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

SimpleDoc sample code for javax.print.SimpleDoc(java.lang.Object, javax.print.DocFlavor, javax.print.attribute.DocAttributeSet) definition code for javax.print.SimpleDoc(java.lang.Object, javax.print.DocFlavor, javax.print.attribute.DocAttributeSet) 

public SimpleDoc(Object sample code for java.lang.Object definition code for java.lang.Object  printData,
                 DocFlavor sample code for javax.print.DocFlavor definition code for javax.print.DocFlavor  flavor,
                 DocAttributeSet sample code for javax.print.attribute.DocAttributeSet definition code for javax.print.attribute.DocAttributeSet  attributes)
Constructs a SimpleDoc with the specified print data, doc flavor and doc attribute set.

Parameters:
printData - the print data object
flavor - the DocFlavor object
attributes - a DocAttributeSet, which can be null
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if flavor or printData is null, or the printData does not correspond to the specified doc flavor--for example, the data is not of the type specified as the representation in the DocFlavor.
Method Detail

getDocFlavor sample code for javax.print.SimpleDoc.getDocFlavor() definition code for javax.print.SimpleDoc.getDocFlavor() 

public DocFlavor sample code for javax.print.DocFlavor definition code for javax.print.DocFlavor  getDocFlavor()
Determines the doc flavor in which this doc object will supply its piece of print data.

Specified by:
getDocFlavor sample code for javax.print.Doc.getDocFlavor() definition code for javax.print.Doc.getDocFlavor() in interface Doc sample code for javax.print.Doc definition code for javax.print.Doc
Returns:
Doc flavor.

getAttributes sample code for javax.print.SimpleDoc.getAttributes() definition code for javax.print.SimpleDoc.getAttributes() 

public DocAttributeSet sample code for javax.print.attribute.DocAttributeSet definition code for javax.print.attribute.DocAttributeSet  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.

Specified by:
getAttributes sample code for javax.print.Doc.getAttributes() definition code for javax.print.Doc.getAttributes() in interface Doc sample code for javax.print.Doc definition code for javax.print.Doc
Returns:
Unmodifiable set of printing attributes for this doc, or null to obtain all attribute values from the job's attribute set.

getPrintData sample code for javax.print.SimpleDoc.getPrintData() definition code for javax.print.SimpleDoc.getPrintData() 

public Object sample code for java.lang.Object definition code for java.lang.Object  getPrintData()
                    throws IOException sample code for java.io.IOException definition code for java.io.IOException
Description copied from interface: Doc sample code for javax.print.Doc.getPrintData() definition code for 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() sample code for javax.print.Doc.getDocFlavor() definition code for javax.print.Doc.getDocFlavor() .getRepresentationClassName() sample code for javax.print.DocFlavor.getRepresentationClassName() definition code for javax.print.DocFlavor.getRepresentationClassName() , and the return value can be cast from class Object to that representation class.

Specified by:
getPrintData sample code for javax.print.Doc.getPrintData() definition code for javax.print.Doc.getPrintData() in interface Doc sample code for javax.print.Doc definition code for javax.print.Doc
Returns:
Print data representation object.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - Thrown if the representation class is a stream and there was an I/O error while constructing the stream.

getReaderForText sample code for javax.print.SimpleDoc.getReaderForText() definition code for javax.print.SimpleDoc.getReaderForText() 

public Reader sample code for java.io.Reader definition code for java.io.Reader  getReaderForText()
                        throws IOException sample code for java.io.IOException definition code for java.io.IOException
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: 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.

Specified by:
getReaderForText sample code for javax.print.Doc.getReaderForText() definition code for javax.print.Doc.getReaderForText() in interface Doc sample code for javax.print.Doc definition code for javax.print.Doc
Returns:
a Reader for reading the print data characters from this doc. If a reader cannot be provided because this doc does not meet the criteria stated above, null is returned.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if there was an I/O error while creating the reader.

getStreamForBytes sample code for javax.print.SimpleDoc.getStreamForBytes() definition code for javax.print.SimpleDoc.getStreamForBytes() 

public InputStream sample code for java.io.InputStream definition code for java.io.InputStream  getStreamForBytes()
                              throws IOException sample code for java.io.IOException definition code for java.io.IOException
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; otherwise this method returns null: The 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.

Specified by:
getStreamForBytes sample code for javax.print.Doc.getStreamForBytes() definition code for javax.print.Doc.getStreamForBytes() in interface Doc sample code for javax.print.Doc definition code for javax.print.Doc
Returns:
an InputStream for reading the print data bytes from this doc. If an input stream cannot be provided because this doc does not meet the criteria stated above, null is returned.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if there was an I/O error while creating the input stream.
Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD