---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

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

String getKeyword()

Returns the keyword that this entry is associated with

Returns:

the keyword

---

getTopics

ITopic[] getTopics()

Obtains topics assosiated with this index entry (i.e. keyword).

Returns:

array of ITopic

---

getSubentries

IIndexEntry[] getSubentries()

Obtains the index subentries contained in the entry.

Returns:

the index subentries

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.