fop 0.94

org.apache.fop.pdf
Class PDFFormXObject

java.lang.Object
  extended by org.apache.fop.pdf.PDFObject
      extended by org.apache.fop.pdf.AbstractPDFStream
          extended by org.apache.fop.pdf.PDFXObject
              extended by org.apache.fop.pdf.PDFFormXObject
All Implemented Interfaces:
PDFWritable

public class PDFFormXObject
extends PDFXObject

PDF Form XObject A derivative of the PDFXObject, is a PDF Stream that has not only a dictionary but a stream of image data.


Field Summary
 
Fields inherited from class org.apache.fop.pdf.PDFObject
DATE_FORMAT, log
 
Constructor Summary
PDFFormXObject(int xnumber, PDFStream cont, java.lang.String ref)
          create a FormXObject with the given number and name and load the image in the object
 
Method Summary
protected  int output(java.io.OutputStream stream)
          Output the form stream as PDF.
protected  void outputRawStreamData(java.io.OutputStream out)
          Sends the raw stream data to the target OutputStream.
 
Methods inherited from class org.apache.fop.pdf.PDFXObject
buildStreamDict, getSizeHint, getXNumber, prepareImplicitFilters, setupFilterList
 
Methods inherited from class org.apache.fop.pdf.AbstractPDFStream
encodeAndWriteStream, encodeStream, getFilterList, outputStreamData
 
Methods inherited from class org.apache.fop.pdf.PDFObject
encode, encodeString, encodeText, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, hasObjectNumber, makeReference, referencePDF, setDocument, setObjectNumber, toInlinePDFString, toPDF, toPDFString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PDFFormXObject

public PDFFormXObject(int xnumber,
                      PDFStream cont,
                      java.lang.String ref)
create a FormXObject with the given number and name and load the image in the object

Parameters:
xnumber - the pdf object X number
cont - the pdf stream contents
ref - the resource PDF reference
Method Detail

output

protected int output(java.io.OutputStream stream)
              throws java.io.IOException
Output the form stream as PDF. This sets up the form XObject dictionary and adds the content data stream.

Overrides:
output in class PDFXObject
Parameters:
stream - the output stream to write the data
Returns:
the length of the data written
Throws:
java.io.IOException - if there is an error writing the data
See Also:
PDFObject.output(OutputStream)

outputRawStreamData

protected void outputRawStreamData(java.io.OutputStream out)
                            throws java.io.IOException
Description copied from class: AbstractPDFStream
Sends the raw stream data to the target OutputStream.

Overrides:
outputRawStreamData in class PDFXObject
Parameters:
out - OutputStream to write to
Throws:
java.io.IOException - In case of an I/O problem
See Also:
PDFStream.outputRawStreamData(OutputStream)

fop 0.94

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.