org.eclipse.birt.report.engine.api
Interface ITOCTree

public interface ITOCTree

Represents a whole TOC tree.

Method Summary

TOCNode	findTOC(java.lang.String tocId) Gets the TOCNode with the specified id.
java.util.List	findTOCByValue(java.lang.Object tocValue) Gets the TOCNodes with specified TOC value.
TOCNode	getRoot() Gets a TOC tree with specified format and locale.

Method Detail

findTOC

TOCNode findTOC(java.lang.String tocId)

Gets the TOCNode with the specified id. Root of the whole TOC tree will be returned if tocId is null.

Parameters:

tocNodeId - the id of the toc.

Returns:

TOCNode with specified Id. NULL if not found.

findTOCByValue

java.util.List findTOCByValue(java.lang.Object tocValue)

Gets the TOCNodes with specified TOC value.

Parameters:

tocValue - the name of the toc.

Returns:

List of all tocs with the specified name.

getRoot

TOCNode getRoot()

Gets a TOC tree with specified format and locale. The returned tree contains all the TOC nodes which are visible under the specified format and the display string are localized using the specified locale. When null is provided as format, the returned TOCs will includes all the TOCs.

Parameters:

format - the format, "pdf", e.g..

locale - the locale.

Returns:

a TOCNode tree root.