public abstract class StructureElement extends Element
Represents a base class for structure elements in logical structure.
Modifier and Type | Method and Description |
---|---|
void |
changeParentElement(StructureElement newParentElement)
Change parent element for current structure element
|
void |
changeParentElement(StructureElement newParentElement,
boolean checkIfParentCanBeChanged)
Change parent element for current structure element
|
void |
clearId()
Clear ID for structure element.
|
void |
generateId()
Generate ID for structure element.
|
String |
getActualText()
Gets or sets the actual text for structure element.
|
String |
getAlternativeText()
Gets or sets the alternative text for structure element.
|
StructureAttributeCollection |
getAttributes()
Gets
StructureAttributeCollection object. |
AttributeOwnerStandard |
getDefaultAttributeOwner()
Gets
/Aspose.Pdf.LogicalStructure.AttributeOwnerStandard object. |
String |
getExpansionText()
Gets or sets the expansion text for structure element.
|
String |
getID()
Gets the ID for structure element.
|
String |
getLanguage()
Gets or sets the language for structure element.
|
Page |
getPage()
Gets the page on which some or all child elements will be rendered.
|
com.aspose.pdf.engine.data.IPdfName |
getS() |
StructureTypeStandard |
getStructureType()
Gets type of structure element.
|
String |
getTitle()
Gets or sets the title for structure element.
|
void |
remove()
Removes: an element from the structure, a reference to it from the parent object, references to it from child objects,
the corresponding object from the document.
|
void |
removeAndMoveItsChildObjectsToItsParent()
Removes an element from the structure, a reference to it from the parent object, references to it from child objects,
and the corresponding object from the document.
|
void |
removeAndMoveItsChildObjectsToItsParent(boolean checkIfChildObjectsCanBeMovedToParent)
Removes an element from the structure, a reference to it from the parent object, references to it from child objects,
and the corresponding object from the document.
|
void |
setActualText(String value)
Gets or sets the actual text for structure element.
|
void |
setAlternativeText(String value)
Gets or sets the alternative text for structure element.
|
void |
setExpansionText(String value)
Gets or sets the expansion text for structure element.
|
void |
setId(String id)
Sets ID for structure element.
|
void |
setLanguage(String value)
Gets or sets the language for structure element.
|
void |
setParentElement(Element parentElement)
set Parent Element
|
void |
setTag(String newTag)
Sets custom tag for structure element.
|
void |
setTitle(String value)
Gets or sets the title for structure element.
|
OBJRElement |
tag(Annotation annotation)
Bind a structure element to the Annotation.
|
MCRElement |
tag(Artifact artifact)
Bind a structure element to the Artifact.
|
MCRElement |
tag(BDC bdc)
Bind a structure element to the content stream BDC operator.
|
OBJRElement |
tag(XForm form)
Bind a structure element to the content stream XForm.
|
OBJRElement |
tag(XImage image)
Bind a structure element to the XImage.
|
String |
toString()
Returns a string that represents the current object.
|
appendChild, appendChild, clearChilds, findElements, findElements, getChildElements, getElementEngine, getParentElement, getTaggedContent, getTrailer, insertChild, insertChild, preSave, removeChild
public final AttributeOwnerStandard getDefaultAttributeOwner()
Gets /Aspose.Pdf.LogicalStructure.AttributeOwnerStandard
object.
/Aspose.Pdf.LogicalStructure.AttributeOwnerStandard
object.public final StructureAttributeCollection getAttributes()
Gets StructureAttributeCollection
object.
StructureAttributeCollection
object.public final StructureTypeStandard getStructureType()
Gets type of structure element.
StructureTypeStandard
object of structure element.public final com.aspose.pdf.engine.data.IPdfName getS()
public final String getID()
Gets the ID for structure element.
Value: ID of the structure element.public final String getTitle()
Gets or sets the title for structure element.
public final void setTitle(String value)
Gets or sets the title for structure element.
value
- Value: Title of the structure element.public final String getLanguage()
Gets or sets the language for structure element.
public final void setLanguage(String value)
Gets or sets the language for structure element.
value
- Value: Language of the structure element.public final String getAlternativeText()
Gets or sets the alternative text for structure element.
public final void setAlternativeText(String value)
Gets or sets the alternative text for structure element.
value
- Value: Alternative text of the structure element.public final String getExpansionText()
Gets or sets the expansion text for structure element.
public final void setExpansionText(String value)
Gets or sets the expansion text for structure element.
value
- Value: Expansion text of the structure element.public final String getActualText()
Gets or sets the actual text for structure element.
public final void setActualText(String value)
Gets or sets the actual text for structure element.
value
- Value: Actual text of the structure element.public final Page getPage()
Gets the page on which some or all child elements will be rendered.
public void setParentElement(Element parentElement)
setParentElement
in class Element
parentElement
- valuepublic final void changeParentElement(StructureElement newParentElement)
Change parent element for current structure element
newParentElement
- New parent structure elementpublic final void changeParentElement(StructureElement newParentElement, boolean checkIfParentCanBeChanged)
Change parent element for current structure element
newParentElement
- New parent structure elementcheckIfParentCanBeChanged
- Check if parent be changed.public final void remove()
Removes: an element from the structure, a reference to it from the parent object, references to it from child objects, the corresponding object from the document.
public final void removeAndMoveItsChildObjectsToItsParent()
Removes an element from the structure, a reference to it from the parent object, references to it from child objects, and the corresponding object from the document. Inserts child objects of the removed object into its former parent child objects collection starting at the index of the removed object.
public final void removeAndMoveItsChildObjectsToItsParent(boolean checkIfChildObjectsCanBeMovedToParent)
Removes an element from the structure, a reference to it from the parent object, references to it from child objects, and the corresponding object from the document. Inserts child objects of the removed object into its former parent child objects collection starting at the index of the removed object.
checkIfChildObjectsCanBeMovedToParent
- Check if child objects of removed object can be inserted into its parent child objects collection.public final void generateId()
Generate ID for structure element.
public final void setId(String id)
Sets ID for structure element.
id
- ID value for structure elementpublic final void clearId()
Clear ID for structure element.
public final void setTag(String newTag)
Sets custom tag for structure element.
newTag
- Tag namepublic MCRElement tag(BDC bdc)
Bind a structure element to the content stream BDC operator.
public OBJRElement tag(XForm form)
Bind a structure element to the content stream XForm.
public OBJRElement tag(XImage image)
Bind a structure element to the XImage.
public MCRElement tag(Artifact artifact)
Bind a structure element to the Artifact.
public OBJRElement tag(Annotation annotation)
Bind a structure element to the Annotation.
Copyright © 2025 Aspose. All Rights Reserved.