Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure » [javadoc | source]
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
public class: PDStructureElement [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
      org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement

All Implemented Interfaces:
    COSObjectable

A structure element.
Field Summary
public static final  String TYPE     
Constructor:
 public PDStructureElement(COSDictionary dic) 
    Constructor for an existing structure element.
    Parameters:
    dic - The existing dictionary.
 public PDStructureElement(String structureType,
    PDStructureNode parent) 
    Constructor with required values.
    Parameters:
    structureType - the structure type
    parent - the parent structure node
Method from org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement Summary:
addAttribute,   addClassName,   appendKid,   appendKid,   appendKid,   attributeChanged,   getActualText,   getAlternateDescription,   getAttributes,   getClassNames,   getElementIdentifier,   getExpandedForm,   getLanguage,   getPage,   getParent,   getRevisionNumber,   getStandardStructureType,   getStructureType,   getTitle,   incrementRevisionNumber,   insertBefore,   insertBefore,   insertBefore,   removeAttribute,   removeClassName,   removeKid,   removeKid,   removeKid,   setActualText,   setAlternateDescription,   setAttributes,   setClassNames,   setElementIdentifier,   setExpandedForm,   setLanguage,   setPage,   setParent,   setRevisionNumber,   setStructureType,   setTitle
Methods from org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode:
appendKid,   appendKid,   appendObjectableKid,   create,   createObject,   getCOSDictionary,   getCOSObject,   getKids,   getType,   insertBefore,   insertBefore,   insertObjectableBefore,   removeKid,   removeKid,   removeObjectableKid,   setKids
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement Detail:
 public  void addAttribute(PDAttributeObject attributeObject) 
    Adds an attribute object.
 public  void addClassName(String className) 
    Adds a class name.
 public  void appendKid(PDMarkedContent markedContent) 
    Appends a marked-content sequence kid.
 public  void appendKid(PDMarkedContentReference markedContentReference) 
    Appends a marked-content reference kid.
 public  void appendKid(PDObjectReference objectReference) 
    Appends an object reference kid.
 public  void attributeChanged(PDAttributeObject attributeObject) 
    Updates the revision number for the given attribute object.
 public String getActualText() 
    Returns the actual text (ActualText).
 public String getAlternateDescription() 
    Returns the alternate description (Alt).
 public Revisions<PDAttributeObject> getAttributes() 
    Returns the attributes together with their revision numbers (A).
 public Revisions<String> getClassNames() 
    Returns the class names together with their revision numbers (C).
 public String getElementIdentifier() 
    Returns the element identifier (ID).
 public String getExpandedForm() 
    Returns the expanded form (E).
 public String getLanguage() 
    Returns the language (Lang).
 public PDPage getPage() 
    Returns the page on which some or all of the content items designated by the K entry shall be rendered (Pg).
 public PDStructureNode getParent() 
    Returns the parent in the structure hierarchy (P).
 public int getRevisionNumber() 
    Returns the revision number (R).
 public String getStandardStructureType() 
    Returns the standard structure type, the actual structure type is mapped to in the role map.
 public String getStructureType() 
    Returns the structure type (S).
 public String getTitle() 
    Returns the title (T).
 public  void incrementRevisionNumber() 
    Increments th revision number
 public  void insertBefore(COSInteger markedContentIdentifier,
    Object refKid) 
    Inserts a marked-content identifier kid before a reference kid.
 public  void insertBefore(PDMarkedContentReference markedContentReference,
    Object refKid) 
    Inserts a marked-content reference kid before a reference kid.
 public  void insertBefore(PDObjectReference objectReference,
    Object refKid) 
    Inserts an object reference kid before a reference kid.
 public  void removeAttribute(PDAttributeObject attributeObject) 
    Removes an attribute object.
 public  void removeClassName(String className) 
    Removes a class name.
 public  void removeKid(COSInteger markedContentIdentifier) 
    Removes a marked-content identifier kid.
 public  void removeKid(PDMarkedContentReference markedContentReference) 
    Removes a marked-content reference kid.
 public  void removeKid(PDObjectReference objectReference) 
    Removes an object reference kid.
 public  void setActualText(String actualText) 
    Sets the actual text (ActualText).
 public  void setAlternateDescription(String alternateDescription) 
    Sets the alternate description (Alt).
 public  void setAttributes(Revisions<PDAttributeObject> attributes) 
    Sets the attributes together with their revision numbers (A).
 public  void setClassNames(Revisions<String> classNames) 
    Sets the class names together with their revision numbers (C).
 public  void setElementIdentifier(String id) 
    Sets the element identifier (ID).
 public  void setExpandedForm(String expandedForm) 
    Sets the expanded form (E).
 public  void setLanguage(String language) 
    Sets the language (Lang).
 public  void setPage(PDPage page) 
    Sets the page on which some or all of the content items designated by the K entry shall be rendered (Pg).
 public  void setParent(PDStructureNode structureNode) 
    Sets the parent in the structure hierarchy (P).
 public  void setRevisionNumber(int revisionNumber) 
    Sets the revision number (R).
 public  void setStructureType(String structureType) 
    Sets the structure type (S).
 public  void setTitle(String title) 
    Sets the title (T).