Eclipse Platform
Release 3.3

org.eclipse.help
Interface IIndexEntry

All Superinterfaces:
IUAElement

public interface IIndexEntry
extends IUAElement

IIndexEntry represents a single entry of the help index. It includes a keyword and related references into help content.

Since:
3.2

Method Summary
 String getKeyword()
          Returns the keyword that this entry is associated with
 IIndexEntry[] getSubentries()
          Obtains the index subentries contained in the entry.
 ITopic[] getTopics()
          Obtains topics assosiated with this index entry (i.e. keyword).
 
Methods inherited from interface org.eclipse.help.IUAElement
getChildren, isEnabled
 

Method Detail

getKeyword

public String getKeyword()
Returns the keyword that this entry is associated with

Returns:
the keyword

getTopics

public ITopic[] getTopics()
Obtains topics assosiated with this index entry (i.e. keyword).

Returns:
array of ITopic

getSubentries

public IIndexEntry[] getSubentries()
Obtains the index subentries contained in the entry.

Returns:
the index subentries

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.