StructureElement
Inheritance: java.lang.Object, com.aspose.pdf.tagged.logicalstructure.elements.Element
public abstract class StructureElement extends Element
Represents a base class for structure elements in logical structure.
Methods
Method | Description |
---|---|
getDefaultAttributeOwner() | Gets /Aspose.Pdf.LogicalStructure.AttributeOwnerStandard object. |
getAttributes() | Gets StructureAttributeCollection object. |
getStructureType() | Gets type of structure element. |
getS() | |
getID() | Gets the ID for structure element. |
getTitle() | Gets or sets the title for structure element. |
setTitle(String value) | Gets or sets the title for structure element. |
getLanguage() | Gets or sets the language for structure element. |
setLanguage(String value) | Gets or sets the language for structure element. |
getAlternativeText() | Gets or sets the alternative text for structure element. |
setAlternativeText(String value) | Gets or sets the alternative text for structure element. |
getExpansionText() | Gets or sets the expansion text for structure element. |
setExpansionText(String value) | Gets or sets the expansion text for structure element. |
getActualText() | Gets or sets the actual text for structure element. |
setActualText(String value) | Gets or sets the actual text for structure element. |
setParentElement(Element parentElement) | set Parent Element |
changeParentElement(StructureElement newParentElement) | Change parent element for current structure element |
generateId() | Generate ID for structure element. |
setId(String id) | Sets ID for structure element. |
clearId() | Clear ID for structure element. |
setTag(String newTag) | Sets custom tag for structure element. |
toString() | Returns a string that represents the current object. |
getDefaultAttributeOwner()
public final AttributeOwnerStandard getDefaultAttributeOwner()
Gets /Aspose.Pdf.LogicalStructure.AttributeOwnerStandard object.
Value: /Aspose.Pdf.LogicalStructure.AttributeOwnerStandard object.
Returns: AttributeOwnerStandard - AttributeOwnerStandard instance
getAttributes()
public final StructureAttributeCollection getAttributes()
Gets StructureAttributeCollection object.
Returns: StructureAttributeCollection - StructureAttributeCollection object.
getStructureType()
public final StructureTypeStandard getStructureType()
Gets type of structure element.
Returns: StructureTypeStandard - Value: StructureTypeStandard object of structure element.
getS()
public final IPdfName getS()
Returns: IPdfName
getID()
public final String getID()
Gets the ID for structure element.
Value: ID of the structure element.
Returns: java.lang.String - String value
getTitle()
public final String getTitle()
Gets or sets the title for structure element.
Returns: java.lang.String - Value: Title of the structure element.
setTitle(String value)
public final void setTitle(String value)
Gets or sets the title for structure element.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String | Value: Title of the structure element. |
getLanguage()
public final String getLanguage()
Gets or sets the language for structure element.
Returns: java.lang.String - Value: Language of the structure element.
setLanguage(String value)
public final void setLanguage(String value)
Gets or sets the language for structure element.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String | Value: Language of the structure element. |
getAlternativeText()
public final String getAlternativeText()
Gets or sets the alternative text for structure element.
Returns: java.lang.String - Value: Alternative text of the structure element.
setAlternativeText(String value)
public final void setAlternativeText(String value)
Gets or sets the alternative text for structure element.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String | Value: Alternative text of the structure element. |
getExpansionText()
public final String getExpansionText()
Gets or sets the expansion text for structure element.
Returns: java.lang.String - Value: Expansion text of the structure element.
setExpansionText(String value)
public final void setExpansionText(String value)
Gets or sets the expansion text for structure element.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String | Value: Expansion text of the structure element. |
getActualText()
public final String getActualText()
Gets or sets the actual text for structure element.
Returns: java.lang.String - Value: Actual text of the structure element.
setActualText(String value)
public final void setActualText(String value)
Gets or sets the actual text for structure element.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String | Value: Actual text of the structure element. |
setParentElement(Element parentElement)
public void setParentElement(Element parentElement)
set Parent Element
Parameters:
Parameter | Type | Description |
---|---|---|
parentElement | Element | value |
changeParentElement(StructureElement newParentElement)
public final void changeParentElement(StructureElement newParentElement)
Change parent element for current structure element
Parameters:
Parameter | Type | Description |
---|---|---|
newParentElement | StructureElement | New parent structure element |
generateId()
public final void generateId()
Generate ID for structure element.
setId(String id)
public final void setId(String id)
Sets ID for structure element.
Parameters:
Parameter | Type | Description |
---|---|---|
id | java.lang.String | ID value for structure element |
clearId()
public final void clearId()
Clear ID for structure element.
setTag(String newTag)
public final void setTag(String newTag)
Sets custom tag for structure element.
Parameters:
Parameter | Type | Description |
---|---|---|
newTag | java.lang.String | Tag name |
toString()
public String toString()
Returns a string that represents the current object.
Returns: java.lang.String - String that represents the current object.