|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.engine.api.TOCNode
public class 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 | |
---|---|
protected java.lang.String |
bookmark
A bookmark that is stored for the TOC |
protected java.util.List |
children
A list of children for the TOC node |
protected java.lang.String |
displayString
the string to be displayed for the TOC entry |
static java.util.List |
EMPTY_CHILDREN
|
protected java.lang.String |
nodeId
identifier for the current node |
protected TOCNode |
parent
the parent node |
protected org.eclipse.birt.report.engine.api.script.instance.IScriptStyle |
tocStyle
The TOC's style |
Constructor Summary | |
---|---|
TOCNode()
Constructor. |
|
TOCNode(TOCNode node)
Constructor. |
Method Summary | |
---|---|
java.lang.String |
getBookmark()
|
java.util.List |
getChildren()
|
java.lang.String |
getDisplayString()
|
java.lang.String |
getNodeID()
|
TOCNode |
getParent()
|
org.eclipse.birt.report.engine.api.script.instance.IScriptStyle |
getTOCStyle()
Get toc style. |
void |
setBookmark(java.lang.String bookmark)
Set bookmark |
void |
setDisplayString(java.lang.String displayStr)
|
void |
setNodeID(java.lang.String id)
Set Node id |
void |
setParent(TOCNode parent)
Set parent toc. |
void |
setTOCStyle(org.eclipse.birt.report.engine.api.script.instance.IScriptStyle tocStyle)
Set toc style. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.util.List EMPTY_CHILDREN
protected java.lang.String displayString
protected java.lang.String bookmark
protected TOCNode parent
protected java.lang.String nodeId
protected java.util.List children
protected org.eclipse.birt.report.engine.api.script.instance.IScriptStyle tocStyle
Constructor Detail |
---|
public TOCNode()
public TOCNode(TOCNode node)
node
- Method Detail |
---|
public java.lang.String getNodeID()
public TOCNode getParent()
public java.util.List getChildren()
public java.lang.String getDisplayString()
public void setDisplayString(java.lang.String displayStr)
display
- the display stringpublic java.lang.String getBookmark()
public void setBookmark(java.lang.String bookmark)
bookmark
- public void setNodeID(java.lang.String id)
id
- public void setParent(TOCNode parent)
parent
- public org.eclipse.birt.report.engine.api.script.instance.IScriptStyle getTOCStyle()
public void setTOCStyle(org.eclipse.birt.report.engine.api.script.instance.IScriptStyle tocStyle)
toc
- style
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |