Eclipse Platform
Release 3.2

org.eclipse.help
Interface IIndexEntry


public interface IIndexEntry

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.
 IHelpResource[] getTopics()
          Obtains help resources assosiated with this index entry (i.e. keyword).
 

Method Detail

getKeyword

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

Returns:
the keyword

getTopics

public IHelpResource[] getTopics()
Obtains help resources assosiated with this index entry (i.e. keyword).

Returns:
Array of IHelpResource

getSubentries

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


Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

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