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