|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IToc
IToc is the table of contents. It contains help topics.
Field Summary | |
---|---|
static java.lang.String |
TOC
This is element name used for TOC in XML files. |
static java.lang.String |
TOPIC
This is the attribute used for description topic in XML files. |
Fields inherited from interface org.eclipse.help.IHelpResource |
---|
HREF, LABEL |
Method Summary | |
---|---|
ITopic |
getTopic(java.lang.String href)
Returns a topic with the specified href defined by this TOC. |
ITopic[] |
getTopics()
Obtains the topics directly contained by a toc. |
Methods inherited from interface org.eclipse.help.IHelpResource |
---|
getHref, getLabel |
Field Detail |
---|
static final java.lang.String TOC
static final java.lang.String TOPIC
Method Detail |
---|
ITopic[] getTopics()
ITopic getTopic(java.lang.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
|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.