KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > help > IIndexEntry


1 /*******************************************************************************
2  * Copyright (c) 2005, 2007 Intel Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * Intel Corporation - initial API and implementation
10  * IBM Corporation - 122967 [Help] Remote help system
11  *******************************************************************************/
12 package org.eclipse.help;
13
14 /**
15  * IIndexEntry represents a single entry of the help index. It includes
16  * a keyword and related references into help content.
17  *
18  * @since 3.2
19  */
20 public interface IIndexEntry extends IUAElement {
21     
22     /**
23      * Returns the keyword that this entry is associated with
24      *
25      * @return the keyword
26      */
27     public String JavaDoc getKeyword();
28
29     /**
30      * Obtains topics assosiated with this index entry (i.e. keyword).
31      *
32      * @return array of ITopic
33      */
34     public ITopic[] getTopics();
35
36     /**
37      * Obtains the index subentries contained in the entry.
38      *
39      * @return the index subentries
40      */
41     public IIndexEntry[] getSubentries();
42 }
43
Popular Tags