com.itextpdf.pdfocr.structuretree

Class LogicalStructureTreeItem

java.lang.Object

com.itextpdf.pdfocr.structuretree.LogicalStructureTreeItem

Direct Known Subclasses:

ArtifactItem, ParagraphTreeItem, SpanTreeItem, TableCellTreeItem, TableRowTreeItem, TableTreeItem

public class LogicalStructureTreeItem
extends Object

This class represents structure tree item of the text item put into the pdf document. See TextInfo.

Constructor Summary

Constructors

Constructor and Description
LogicalStructureTreeItem() Instantiate a new LogicalStructureTreeItem instance.
LogicalStructureTreeItem(com.itextpdf.kernel.pdf.tagutils.AccessibilityProperties accessibilityProperties) Instantiate a new LogicalStructureTreeItem instance.

Method Summary

Modifier and Type	Method and Description
LogicalStructureTreeItem	addChild(LogicalStructureTreeItem child) Add child structure tree item.
com.itextpdf.kernel.pdf.tagutils.AccessibilityProperties	getAccessibilityProperties() Retrieve structure tree element's properties.
List<LogicalStructureTreeItem>	getChildren() Retrieve all child structure tree items.
LogicalStructureTreeItem	getParent() Retrieve parent structure tree item.
boolean	removeChild(LogicalStructureTreeItem child) Remove child structure tree item.
LogicalStructureTreeItem	setAccessibilityProperties(com.itextpdf.kernel.pdf.tagutils.AccessibilityProperties accessibilityProperties) Set structure tree element's properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogicalStructureTreeItem

public LogicalStructureTreeItem()

Instantiate a new LogicalStructureTreeItem instance.

LogicalStructureTreeItem

public LogicalStructureTreeItem(com.itextpdf.kernel.pdf.tagutils.AccessibilityProperties accessibilityProperties)

Instantiate a new LogicalStructureTreeItem instance.

Parameters:

accessibilityProperties - properties to define and describe pdf structure elements.

Method Detail

getAccessibilityProperties

public com.itextpdf.kernel.pdf.tagutils.AccessibilityProperties getAccessibilityProperties()

Retrieve structure tree element's properties.

Returns:

structure tree element's properties.

setAccessibilityProperties

public LogicalStructureTreeItem setAccessibilityProperties(com.itextpdf.kernel.pdf.tagutils.AccessibilityProperties accessibilityProperties)

Set structure tree element's properties.

Parameters:

accessibilityProperties - structure tree element's properties.

Returns:

this LogicalStructureTreeItem instance.

getParent

public LogicalStructureTreeItem getParent()

Retrieve parent structure tree item.

Returns:

parent structure tree item.

addChild

public LogicalStructureTreeItem addChild(LogicalStructureTreeItem child)

Add child structure tree item.

Parameters:

child - child structure tree item.

Returns:

this LogicalStructureTreeItem instance.

removeChild

public boolean removeChild(LogicalStructureTreeItem child)

Remove child structure tree item.

Parameters:

child - child structure tree item.

Returns:

true if the child was removed, false otherwise.

getChildren

public List<LogicalStructureTreeItem> getChildren()

Retrieve all child structure tree items.

Returns:

all child structure tree items.