com.aspose.pdf.tagged.logicalstructure.elements.bls

Class HeaderElement

java.lang.Object

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

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

com.aspose.pdf.tagged.logicalstructure.elements.bls.BLSElement

com.aspose.pdf.tagged.logicalstructure.elements.bls.BLSTextElement

com.aspose.pdf.tagged.logicalstructure.elements.bls.HeaderElement

All Implemented Interfaces:

IAdjustPosition, ITextElement

public final class HeaderElement
extends BLSTextElement

Represents Header structure element in logical structure.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addEntryToTocPage(Page tocPage, ListLIElement tocEntry) Creates a header on the specified Table of Contents (TOC) page and associates it with a TOCI element.
void	addEntryToTocPage(Page tocPage, TOCIElement tocEntry) Creates a header on the specified Table of Contents (TOC) page and associates it with a TOCI element.
void	setText(String text) Appends text content to current text element.

Methods inherited from class com.aspose.pdf.tagged.logicalstructure.elements.bls.BLSTextElement

adjustPosition, getStructureTextState, getTextFragment

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

HeaderElement

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

HeaderElement

public HeaderElement(TaggedContext taggedContext,
                     int level,
                     com.aspose.pdf.engine.data.IPdfPrimitive pdfEngineEntity)

Method Detail

setText

public void setText(String text)

Description copied from class: BLSTextElement

Appends text content to current text element.

Specified by:

setText in interface ITextElement

Overrides:

setText in class BLSTextElement

Parameters:

text - Text content

addEntryToTocPage

public final void addEntryToTocPage(Page tocPage,
                                    TOCIElement tocEntry)

Creates a header on the specified Table of Contents (TOC) page and associates it with a TOCI element.

Parameters:

tocPage - The Page object representing the TOC page where the header should be created.

tocEntry - The TOCIElement serving as the TOC entry to associate with the header being created.

This method ensures that the header is properly linked to a TOC page and a TOCI element, maintaining the document's logical hierarchy and supporting navigation in tagged PDF structures.

addEntryToTocPage

public final void addEntryToTocPage(Page tocPage,
                                    ListLIElement tocEntry)

Creates a header on the specified Table of Contents (TOC) page and associates it with a TOCI element.

Parameters:

tocPage - The Page object representing the TOC page where the header should be created.

tocEntry - The ListLIElement object acting as the TOCI entry to associate with the created header on the specified TOC page.

This overload addresses scenarios involving nested Table of Contents (TOC) structures, as specified in PDF/UA and PDF 1.7 standards, where a TOCI element cannot be a child of another TOCI or where a TOC cannot be nested directly under a TOCI. To maintain compliance with these structural requirements, nested TOC entries should be represented using List and ListLIElement elements. This method facilitates the association of the header element with such a ListLIElement on the designated TOC page, ensuring proper logical structuring and enhancing navigation capabilities in tagged PDF documents.