blob: 22aa134d1164f12a187d6e688cbdbfee63a56136 (
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/*******************************************************************************
* Copyright (c) 2007, 2015 IBM 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help;
/**
* Represents either a complete or partial table of contents, as well as
* its metadata.
*
* @since 3.3
*/
public interface ITocContribution {
/**
* Returns the contribution's category id. Contributions with the same
* category id will be grouped together.
*
* @return the contribution's category id.
*/
public String getCategoryId();
/**
* Returns the symbolic name of the bundle that made this contribution,
* e.g. "org.eclipse.help"
*
* @return the contributor id, e.g. "org.eclipse.help"
*/
public String getContributorId();
/**
* Returns the hrefs for any additional documents that are not in this TOC
* but are associated with it, and should be indexed for searching.
*
* @return any extra documents associated with the TOC
*/
public String[] getExtraDocuments();
/**
* Returns a unique identifier for this contribution.
*
* @return the contribution's unique identifier
*/
public String getId();
/**
* Returns the locale for this contribution.
*
* @return the contribution's locale
*/
public String getLocale();
/**
* Returns the path to the anchor in another toc into which this
* one should be linked into.
*
* @return the link-to path
*/
public String getLinkTo();
/**
* Returns the table of contents data for this contribution.
*
* @return the toc data for this contribution
*/
public IToc getToc();
/**
* Returns whether or not this is a top-level contribution (a book).
*
* @return whether the contribution is top-level book
*/
public boolean isPrimary();
}
|
