|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITocContribution
Represents either a complete or partial table of contents, as well as its metadata.
Method Summary | |
---|---|
String |
getCategoryId()
Returns the contribution's category id. |
String |
getContributorId()
Returns the symbolic name of the bundle that made this contribution, e.g. |
String[] |
getExtraDocuments()
Returns the hrefs for any additional documents that are not in this TOC but are associated with it, and should be indexed for searching. |
String |
getId()
Returns a unique identifier for this contribution. |
String |
getLinkTo()
Returns the path to the anchor in another toc into which this one should be linked into. |
String |
getLocale()
Returns the locale for this contribution. |
IToc |
getToc()
Returns the table of contents data for this contribution. |
boolean |
isPrimary()
Returns whether or not this is a top-level contribution (a book). |
Method Detail |
---|
String getCategoryId()
String getContributorId()
String[] getExtraDocuments()
String getId()
String getLocale()
String getLinkTo()
IToc getToc()
boolean isPrimary()
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.