| org.eclipse.pde.internal.core.text.toc.TocObject
 org.eclipse.pde.internal.core.text.toc.TocTopic
org.eclipse.pde.internal.core.text.toc.Toc
| Toc | | public class Toc extends TocTopic (Code) | | Toc - represents the root element of a Table of Contents
The TOC root element, like TOC topics, can hold many child topics,
links and anchors. Aside from being the root element of the TOC,
the element differs from regular topics by having an optional
anchor attribute that determines which anchors this TOC will plug
into.
|
| Constructor Summary | |
| public | Toc(TocModel model)
Constructs a new Toc. |
| Toc | | public Toc(TocModel model)(Code) | | Constructs a new Toc. Only takes a model,
since the root element cannot have a parent.
Parameters:
model - The model associated with this TOC. |
| getFieldAnchorTo | | public String getFieldAnchorTo()(Code) | | the anchor path associated with this TOC |
| getFieldRef | | public String getFieldRef()(Code) | | the link associated with this topic,
or null if none exists. |
| getType | | public int getType()(Code) | | |
| isRoot | | public boolean isRoot()(Code) | | |
| setFieldAnchorTo | | public void setFieldAnchorTo(String name)(Code) | | Change the value of the anchor field and
signal a model change if needed.
Parameters:
The - new anchor path to associate with this TOC |
| setFieldRef | | public void setFieldRef(String value)(Code) | | Change the value of the link field and
signal a model change if needed.
Parameters:
value - The new page location to be linked by this topic |
|
|