Class TOCNode
java.lang.Object
org.eclipse.birt.report.engine.api.TOCNode
A node that wraps around a TOC entry. To navigate to a specific TOC entry,
one starts with the TOC root and traverse down the TOC tree, obtaining list
of TOC nodes.
For each node, the user can go to a specific page by following the bookmark.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringA bookmark that is stored for the TOCprotected ListA list of children for the TOC nodeprotected Stringthe string to be displayed for the TOC entrystatic final Listprotected Stringidentifier for the current nodeprotected TOCNodethe parent nodeprotected org.eclipse.birt.report.engine.api.script.instance.IScriptStyleThe TOC's style -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.eclipse.birt.report.engine.api.script.instance.IScriptStyleGet toc style.voidsetBookmark(String bookmark) Set bookmarkvoidsetDisplayString(String displayStr) voidSet Node idvoidSet parent toc.voidsetTOCStyle(org.eclipse.birt.report.engine.api.script.instance.IScriptStyle tocStyle) Set toc style.
-
Field Details
-
EMPTY_CHILDREN
-
displayString
the string to be displayed for the TOC entry -
bookmark
A bookmark that is stored for the TOC -
parent
the parent node -
nodeId
identifier for the current node -
children
A list of children for the TOC node -
tocStyle
protected org.eclipse.birt.report.engine.api.script.instance.IScriptStyle tocStyleThe TOC's style
-
-
Constructor Details
-
TOCNode
public TOCNode()Constructor. -
TOCNode
Constructor.- Parameters:
node-
-
-
Method Details
-
getNodeID
- Returns:
- the unique ID for the TOC node
-
getParent
- Returns:
- returns the parent node of the current TOC node
-
getChildren
- Returns:
- the list of child TOC nodes
-
getDisplayString
- Returns:
- the display string for the TOC entry
-
setDisplayString
- Parameters:
display- the display string
-
getBookmark
- Returns:
- the bookmark string that the TOC item points to.
-
setBookmark
Set bookmark- Parameters:
bookmark-
-
setNodeID
Set Node id- Parameters:
id-
-
setParent
Set parent toc.- Parameters:
parent-
-
getTOCStyle
public org.eclipse.birt.report.engine.api.script.instance.IScriptStyle getTOCStyle()Get toc style.- Returns:
- toc style
-
setTOCStyle
public void setTOCStyle(org.eclipse.birt.report.engine.api.script.instance.IScriptStyle tocStyle) Set toc style.- Parameters:
toc- style
-