com.aspose.pdf.tagged.logicalstructure.elements.grouping

Class TOCIElement

java.lang.Object

com.aspose.pdf.tagged.logicalstructure.elements.Element

com.aspose.pdf.tagged.logicalstructure.elements.StructureElement

com.aspose.pdf.tagged.logicalstructure.elements.grouping.GroupingElement

com.aspose.pdf.tagged.logicalstructure.elements.grouping.TOCIElement

All Implemented Interfaces:

ITociElement

public final class TOCIElement
extends GroupingElement
implements ITociElement

Represents TOCI structure element in logical structure.

Constructor Summary

Constructors

Constructor and Description
TOCIElement(TaggedContext taggedContext, com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

Method Summary

Modifier and Type	Method and Description
void	addRef(StructureElement referencedStructureElement) Adds a reference to the specified structure element within the Table of Contents Item (TOCI) element.
StructureElement	getGetElement() Gets the underlying PDF element that represents this TOCI structure.

Methods inherited from class com.aspose.pdf.tagged.logicalstructure.elements.StructureElement

changeParentElement, changeParentElement, clearId, generateId, getActualText, getAlternativeText, getAttributes, getDefaultAttributeOwner, getExpansionText, getID, getLanguage, getPage, getS, getStructureType, getTitle, remove, removeAndMoveItsChildObjectsToItsParent, removeAndMoveItsChildObjectsToItsParent, setActualText, setAlternativeText, setExpansionText, setId, setLanguage, setParentElement, setTag, setTitle, tag, tag, tag, tag, tag, toString

Methods inherited from class com.aspose.pdf.tagged.logicalstructure.elements.Element

appendChild, appendChild, clearChilds, findElements, findElements, getChildElements, getElementEngine, getParentElement, getTaggedContent, getTrailer, insertChild, insertChild, preSave, removeChild

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TOCIElement

public TOCIElement(TaggedContext taggedContext,
                   com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

Method Detail

addRef

public final void addRef(StructureElement referencedStructureElement)

Adds a reference to the specified structure element within the Table of Contents Item (TOCI) element.

Parameters:

referencedStructureElement - The StructureElement to be referenced by this TOCI element.

Associating a structure element, such as a header or another content section, with a TOCI element ensures correct logical structure and improves navigational behavior in tagged PDFs.

getGetElement

public final StructureElement getGetElement()

Description copied from interface: ITociElement

Gets the underlying PDF element that represents this TOCI structure.

Specified by:

getGetElement in interface ITociElement

Returns:

The Element that forms the structural representation of this table of contents entry.