Package org.apache.fop.pdf
Class PDFStructElem
- java.lang.Object
-
- org.apache.fop.pdf.PDFObject
-
- org.apache.fop.pdf.PDFDictionary
-
- org.apache.fop.pdf.StructureHierarchyMember
-
- org.apache.fop.pdf.PDFStructElem
-
- All Implemented Interfaces:
StructureTreeElement
,PDFWritable
- Direct Known Subclasses:
PageSequenceStructElem
,PDFStructElem.Placeholder
public class PDFStructElem extends StructureHierarchyMember implements StructureTreeElement
Class representing a PDF Structure Element.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PDFStructElem.Placeholder
Class representing a placeholder for a PDF Structure Element.
-
Field Summary
Fields Modifier and Type Field Description protected java.util.List<PDFObject>
kids
Elements to be added to the kids array.protected PDFStructElem
parentElement
-
Fields inherited from class org.apache.fop.pdf.PDFDictionary
entries, order
-
-
Constructor Summary
Constructors Constructor Description PDFStructElem()
Creates PDFStructElem with no entries.PDFStructElem(PDFObject parent, StructureType structureType)
Creates a new structure element.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addKid(PDFObject kid)
Adds a kid to this structure element.void
addKidInSpecificOrder(int position, PDFStructElem kid)
protected boolean
attachKids()
Attaches all valid kids to the kids array.java.util.List<PDFObject>
getKids()
java.lang.String
getLanguage()
Returns the language of this structure element.PDFObjectNumber
getObjectNumber()
Returns the object number of this indirect object.PDFStructElem
getParentStructElem()
Returns the parent of this structure element.StructureType
getStructureType()
Returns the structure type of this structure element.int
output(java.io.OutputStream stream)
Write the PDF represention of this objectvoid
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.void
setTableAttributeColSpan(int colSpan)
void
setTableAttributeRowSpan(int rowSpan)
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
containsKey, get, getChildren, getChildren, keySet, put, put, remove
-
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, setObjectNumber, setObjectNumber, toPDF, toPDFString
-
-
-
-
Field Detail
-
parentElement
protected PDFStructElem parentElement
-
kids
protected java.util.List<PDFObject> kids
Elements to be added to the kids array.
-
-
Constructor Detail
-
PDFStructElem
public PDFStructElem()
Creates PDFStructElem with no entries.
-
PDFStructElem
public PDFStructElem(PDFObject parent, StructureType structureType)
Creates a new structure element.- Parameters:
parent
- parent of this elementstructureType
- the structure type of this element
-
-
Method Detail
-
getParentStructElem
public PDFStructElem getParentStructElem()
Returns the parent of this structure element.- Returns:
- the parent,
null
if the parent is not a structure element (i.e., is the structure tree root)
-
setParent
public void setParent(PDFObject parent)
Sets the direct parent object.
-
addKid
public void addKid(PDFObject kid)
Adds a kid to this structure element.- Specified by:
addKid
in classStructureHierarchyMember
- Parameters:
kid
- element to be added
-
setMCIDKid
public void setMCIDKid(int mcid)
Sets the given mcid as the kid of this structure element. This element will then add itself to its parent structure element if it has not already, and so will the parent, and so on.- Parameters:
mcid
- mcid of the marked-content sequence corresponding to this structure element's kid
-
setPage
public void setPage(PDFPage page)
Sets the page reference of this structure element.- Parameters:
page
- value for the Pg entry
-
getStructureType
public StructureType getStructureType()
Returns the structure type of this structure element.- Returns:
- the value of the S entry
-
setLanguage
public void setLanguage(java.util.Locale language)
Sets the language of this structure element.- Parameters:
language
- a value for the Lang entry
-
getLanguage
public java.lang.String getLanguage()
Returns the language of this structure element.- Returns:
- the value of the Lang entry (
null
if no language was specified)
-
writeDictionary
protected void writeDictionary(java.io.OutputStream out, java.lang.StringBuilder textBuffer) throws java.io.IOException
Description copied from class:PDFDictionary
Writes the contents of the dictionary to a StringBuffer.- Overrides:
writeDictionary
in classPDFDictionary
- Parameters:
out
- the OutputStream (for binary content)textBuffer
- the text buffer for text output- Throws:
java.io.IOException
- if an I/O error occurs
-
addKidInSpecificOrder
public void addKidInSpecificOrder(int position, PDFStructElem kid)
-
attachKids
protected boolean attachKids()
Attaches all valid kids to the kids array.- Returns:
- true iff 1+ kids were added to the kids array
-
setTableAttributeColSpan
public void setTableAttributeColSpan(int colSpan)
-
setTableAttributeRowSpan
public void setTableAttributeRowSpan(int rowSpan)
-
getKids
public java.util.List<PDFObject> getKids()
-
output
public int output(java.io.OutputStream stream) throws java.io.IOException
Description copied from class:PDFDictionary
Write the PDF represention of this object- Overrides:
output
in classPDFDictionary
- Parameters:
stream
- the stream to write the PDF to- Returns:
- the number of bytes written
- Throws:
java.io.IOException
- if there is an error writing to the stream
-
getObjectNumber
public abstract PDFObjectNumber 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.
-
-