public interface IToc extends IUAElement, IHelpResource
IToc
represents the root node of a toc, for either a complete
toc (book) or a part of one to be assembled into a larger one.Modifier and Type | Field and Description |
---|---|
static String |
TOC
This is element name used for TOC in XML files.
|
static String |
TOPIC
This is the attribute used for description topic in XML files.
|
HREF, LABEL
Modifier and Type | Method and Description |
---|---|
ITopic |
getTopic(String href)
Returns a topic with the specified href defined by this TOC.
|
ITopic[] |
getTopics()
Obtains the topics directly contained by a toc.
|
getChildren, isEnabled
getHref, getLabel
static final String TOC
static final String TOPIC
ITopic[] getTopics()
ITopic getTopic(String href)
If no topic is specified, then the TOC description topic is returned, or null if there is no description topic for the TOC.
href
- the topic's URL or null
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.