fop 1.1

org.apache.fop.pdf
Class PDFStructElem.Placeholder

java.lang.Object
  extended by org.apache.fop.pdf.PDFObject
      extended by org.apache.fop.pdf.PDFDictionary
          extended by org.apache.fop.pdf.PDFStructElem
              extended by org.apache.fop.pdf.PDFStructElem.Placeholder
All Implemented Interfaces:
StructureTreeElement, PDFWritable
Enclosing class:
PDFStructElem

public static class PDFStructElem.Placeholder
extends PDFStructElem

Class representing a placeholder for a PDF Structure Element.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.fop.pdf.PDFStructElem
PDFStructElem.Placeholder
 
Field Summary
 
Fields inherited from class org.apache.fop.pdf.PDFStructElem
kids
 
Fields inherited from class org.apache.fop.pdf.PDFDictionary
entries, order
 
Fields inherited from class org.apache.fop.pdf.PDFObject
log
 
Constructor Summary
PDFStructElem.Placeholder(PDFObject parent, java.lang.String name)
          Constructor
 
Method Summary
 int getObjectNumber()
          Returns the object number of this indirect object.
 int output(java.io.OutputStream outputStream)
          Outputs this object's content into the given stream.
 void outputInline(java.io.OutputStream out, java.lang.StringBuilder textBuffer)
          Writes a "direct object" (inline object) representation to the stream.
 
Methods inherited from class org.apache.fop.pdf.PDFStructElem
addKid, attachKids, getLanguage, getParentStructElem, getStructureType, setLanguage, setMCIDKid, setPage, setParent, writeDictionary
 
Methods inherited from class org.apache.fop.pdf.PDFDictionary
get, output, put, put
 
Methods inherited from class org.apache.fop.pdf.PDFObject
contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, 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

PDFStructElem.Placeholder

public PDFStructElem.Placeholder(PDFObject parent,
                                 java.lang.String name)
Constructor

Parameters:
parent - -
name - -
Method Detail

outputInline

public void outputInline(java.io.OutputStream out,
                         java.lang.StringBuilder textBuffer)
                  throws java.io.IOException
Description copied from class: PDFObject
Writes a "direct object" (inline object) representation to the stream. A text buffer is given for optimized encoding of text content.

IMPORTANT: If you need to write out binary output, call PDFDocument.flushTextBuffer(StringBuilder, OutputStream) before writing any content to the OutputStream!

Specified by:
outputInline in interface PDFWritable
Overrides:
outputInline in class PDFObject
Parameters:
out - the OutputStream (for binary content)
textBuffer - the text buffer for text content
Throws:
java.io.IOException - if an I/O error occurs

getObjectNumber

public int getObjectNumber()
Returns the object number of this indirect object. Note that a compressed object must have a generation number of 0.

Returns:
the object number.

output

public int output(java.io.OutputStream outputStream)
           throws java.io.IOException
Outputs this object's content into the given stream.

Parameters:
outputStream - a stream, likely to be provided by the containing object stream
Returns:
the number of bytes written to the stream
Throws:
java.io.IOException

fop 1.1

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