StructureElement
Inheritance: java.lang.Object, com.aspose.pdf.tagged.logicalstructure.elements.Element com.aspose.pdf.tagged.logicalstructure.elements.StructureElement, com.aspose.pdf.tagged.logicalstructure.elements.Element, com.aspose.pdf.tagged.logicalstructure.elements.StructureElement
public abstract class StructureElement extends Element
Represents a base class for structure elements in logical structure.
Methods
| Method | Description |
|---|---|
| changeParentElement | Change parent element for current structure element |
| changeParentElement | Change parent element for current structure element |
| clearId | Clear ID for structure element. |
| generateId | Generate ID for structure element. |
| getActualText | Gets or sets the actual text for structure element. |
| getAlternativeText | Gets or sets the alternative text for structure element. |
| getAttributes | Gets {@code StructureAttributeCollection} object. |
| getDefaultAttributeOwner | Gets {@code /Aspose.Pdf.LogicalStructure.AttributeOwnerStandard} object. Value: {@code /Aspose.Pdf.LogicalStructure.AttributeOwnerStandard} object. |
| getExpansionText | Gets or sets the expansion text for structure element. |
| getID | Gets the ID for structure element. Value: ID of the structure element. |
| getLanguage | Gets or sets the language for structure element. |
| getPage | Gets the page on which some or all child elements will be rendered. |
| getS | |
| getStructureType | Gets type of structure element. |
| getTitle | Gets or sets the title for structure element. |
| 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. |
| 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. |
| 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. |
| setActualText | Gets or sets the actual text for structure element. |
| setAlternativeText | Gets or sets the alternative text for structure element. |
| setExpansionText | Gets or sets the expansion text for structure element. |
| setId | Sets ID for structure element. |
| setLanguage | Gets or sets the language for structure element. |
| setParentElement | set Parent Element |
| setTag | Sets custom tag for structure element. |
| setTitle | Gets or sets the title for structure element. |
| tag | Bind a structure element to the Annotation. |
| tag | Bind a structure element to the Artifact. |
| tag | Bind a structure element to the content stream BDC operator. |
| tag | Bind a structure element to the content stream XForm. |
| tag | Bind a structure element to the XImage. |
| toString | Returns a string that represents the current object. |
changeParentElement
Change parent element for current structure element
changeParentElement
Change parent element for current structure element
clearId
public final void clearId()
Clear ID for structure element.
generateId
public final void generateId()
Generate ID for structure element.
getActualText
public final String getActualText()
Gets or sets the actual text for structure element.
Returns: Value: Actual text of the structure element.
getAlternativeText
public final String getAlternativeText()
Gets or sets the alternative text for structure element.
Returns: Value: Alternative text of the structure element.
getAttributes
public final StructureAttributeCollection getAttributes()
Gets {@code StructureAttributeCollection} object.
Returns: {@code StructureAttributeCollection} object.
getDefaultAttributeOwner
public final AttributeOwnerStandard getDefaultAttributeOwner()
Gets {@code /Aspose.Pdf.LogicalStructure.AttributeOwnerStandard} object. Value: {@code /Aspose.Pdf.LogicalStructure.AttributeOwnerStandard} object.
Returns: AttributeOwnerStandard instance
getExpansionText
public final String getExpansionText()
Gets or sets the expansion text for structure element.
Returns: Value: Expansion text of the structure element.
getID
public final String getID()
Gets the ID for structure element. Value: ID of the structure element.
Returns: String value
getLanguage
public final String getLanguage()
Gets or sets the language for structure element.
Returns: Value: Language of the structure element.
getPage
public final Page getPage()
Gets the page on which some or all child elements will be rendered.
Returns: Page instance
getS
public final com.aspose.pdf.engine.data.IPdfName getS()
getStructureType
public final StructureTypeStandard getStructureType()
Gets type of structure element.
Returns: Value: {@code StructureTypeStandard} object of structure element.
getTitle
public final String getTitle()
Gets or sets the title for structure element.
Returns: Value: Title of the structure element.
remove
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.
removeAndMoveItsChildObjectsToItsParent
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.
removeAndMoveItsChildObjectsToItsParent
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| checkIfChildObjectsCanBeMovedToParent | Check if child objects of removed object can be inserted into its parent child objects collection. |
setActualText
Gets or sets the actual text for structure element.
setAlternativeText
Gets or sets the alternative text for structure element.
setExpansionText
Gets or sets the expansion text for structure element.
setId
Sets ID for structure element.
setLanguage
Gets or sets the language for structure element.
setParentElement
set Parent Element
setTag
Sets custom tag for structure element.
setTitle
Gets or sets the title for structure element.
tag
Bind a structure element to the Annotation.
tag
Bind a structure element to the Artifact.
tag
Bind a structure element to the content stream BDC operator.
tag
Bind a structure element to the content stream XForm.
tag
Bind a structure element to the XImage.
toString
public String toString()
Returns a string that represents the current object.
Returns: String that represents the current object.
