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

Class TOCElement

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.TOCElement

public final class TOCElement
extends GroupingElement

Represents TOC structure element in logical structure.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	linkTocPageTitleToHeaderElement(Page tocPage, HeaderElement tocTitleHeader) Links the Table of Contents (TOC) page title to a header element for document structure.
void	preSave()

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, removeChild

Methods inherited from class java.lang.Object

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

Constructor Detail

TOCElement

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

Method Detail

linkTocPageTitleToHeaderElement

public final void linkTocPageTitleToHeaderElement(Page tocPage,
                                                  HeaderElement tocTitleHeader)

Links the Table of Contents (TOC) page title to a header element for document structure.

Parameters:

tocPage - The TOC page containing the title to which the header will be linked.

tocTitleHeader - The header element that will be linked to the title of the TOC page.

Throws:

TOCpageHasNoTitleException - Thrown if the TOC page does not have a title.

preSave

public void preSave()

Overrides:

preSave in class Element