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