KickJava   Java API By Example, From Geeks To Geeks.

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


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