HeaderElement
Overview
HeaderElement is a class in Aspose.Pdf FOSS for Java.
Inherits from: Element.
Represents a header structure element (H, H1–H6) in the logical structure tree (ISO 32000-1:2008, §14.8.4.3, Table 334).
Properties
| Name | Type | Access | Description |
|---|---|---|---|
level | int | Read | Returns the heading level (0 = H, 1–6 = H1–H6). |
text | String | Read | Returns the actual text (/ActualText) of this element. |
language | String | Read | Returns the language (/Lang) of this element. |
structureElement | StructureElement | Read | Returns the underlying structure element. |
title | String | Read | Returns the title (/T) of this element. |
alternateDescription | String | Read | Returns the alternate description (/Alt) of this element. |
structureTextState | StructureTextState | Read | Returns the structure text state for this element. |
alternativeText | String | Read | Returns the alternative text (/Alt) for this element. |
positionSettings | PositionSettings | Read | Returns the position settings for this element. |
Methods
| Signature | Description |
|---|---|
HeaderElement(se: StructureElement) | Creates a generic header element (H) wrapping the given structure element. |
HeaderElement(se: StructureElement, level: int) | Creates a header element at the specified level. |
getLevel() → int | Returns the heading level (0 = H, 1–6 = H1–H6). |
setLevel(level: int) | Sets the heading level and updates the underlying structure type. |
addEntryToTocPage(tocPage: Page, toci: Element) | Adds an entry for this header to a TOC page, linking it to a TOC item. |
setText(text: String) | Sets the actual text (/ActualText) for this element. |
getText() → String | Returns the actual text (/ActualText) of this element. |
setLanguage(lang: String) | Sets the language (/Lang) for this element. |
getLanguage() → String | Returns the language (/Lang) of this element. |
appendChild(child: Element) | Appends a child element. |
getStructureElement() → StructureElement | Returns the underlying structure element. |
setTitle(title: String) | Sets the title (/T) for this element. |
getTitle() → String | Returns the title (/T) of this element. |
setAlternateDescription(alt: String) | Sets the alternate description (/Alt) for this element. |
getAlternateDescription() → String | Returns the alternate description (/Alt) of this element. |
getStructureTextState() → StructureTextState | Returns the structure text state for this element. |
setAlternativeText(text: String) | Sets the alternative text (/Alt) for this element. |
getAlternativeText() → String | Returns the alternative text (/Alt) for this element. |
adjustPosition(settings: PositionSettings) | Adjusts the position of this element using the given settings. |
getPositionSettings() → PositionSettings | Returns the position settings for this element. |