org.apache.fop.pdf
Class PDFFormXObject

java.lang.Object
  org.apache.fop.pdf.PDFObject
      org.apache.fop.pdf.AbstractPDFStream
          org.apache.fop.pdf.PDFXObject
              org.apache.fop.pdf.PDFFormXObject

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, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, hasObjectNumber, referencePDF, setDocument, setObjectNumber, 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

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

Throws:

java.io.IOException

See Also:

PDFStream.outputRawStreamData(OutputStream)