|
fop 1.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.pdf.PDFObject
org.apache.fop.pdf.PDFDictionary
org.apache.fop.pdf.PDFStructElem
public class PDFStructElem
Class representing a PDF Structure Element.
Nested Class Summary | |
---|---|
static class |
PDFStructElem.Placeholder
Class representing a placeholder for a PDF Structure Element. |
Field Summary | |
---|---|
protected java.util.List<PDFObject> |
kids
Elements to be added to the kids array. |
Fields inherited from class org.apache.fop.pdf.PDFDictionary |
---|
entries, order |
Fields inherited from class org.apache.fop.pdf.PDFObject |
---|
log |
Method Summary | |
---|---|
void |
addKid(PDFObject kid)
Add a kid to this structure element. |
protected boolean |
attachKids()
Attaches all valid kids to the kids array. |
java.lang.String |
getLanguage()
Returns the language of this structure element. |
int |
getObjectNumber()
Returns the object number of this indirect object. |
PDFStructElem |
getParentStructElem()
Returns the parent of this structure element. |
PDFName |
getStructureType()
Returns the structure type of this structure element. |
int |
output(java.io.OutputStream outputStream)
Outputs this object's content into the given stream. |
void |
setLanguage(java.util.Locale language)
Sets the language of this structure element. |
void |
setMCIDKid(int mcid)
Sets the given mcid as the kid of this structure element. |
void |
setPage(PDFPage page)
Sets the page reference of this structure element. |
void |
setParent(PDFObject parent)
Sets the direct parent object. |
protected void |
writeDictionary(java.io.OutputStream out,
java.lang.StringBuilder textBuffer)
Writes the contents of the dictionary to a StringBuffer. |
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, outputInline, referencePDF, setDocument, setObjectNumber, toPDF, toPDFString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.util.List<PDFObject> kids
Method Detail |
---|
public PDFStructElem getParentStructElem()
null
if the parent is not a structure
element (i.e., is the structure tree root)public void setParent(PDFObject parent)
setParent
in class PDFObject
parent
- the direct parentpublic void addKid(PDFObject kid)
kid
- element to be addedpublic void setMCIDKid(int mcid)
mcid
- mcid of the marked-content sequence corresponding to this
structure element's kidpublic void setPage(PDFPage page)
page
- value for the Pg entrypublic PDFName getStructureType()
public void setLanguage(java.util.Locale language)
language
- a value for the Lang entrypublic java.lang.String getLanguage()
null
if no language was specified)protected void writeDictionary(java.io.OutputStream out, java.lang.StringBuilder textBuffer) throws java.io.IOException
PDFDictionary
writeDictionary
in class PDFDictionary
out
- the OutputStream (for binary content)textBuffer
- the text buffer for text output
java.io.IOException
- if an I/O error occursprotected boolean attachKids()
public int getObjectNumber()
public int output(java.io.OutputStream outputStream) throws java.io.IOException
outputStream
- a stream, likely to be provided by the containing object stream
java.io.IOException
|
fop 1.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |