org.eclipse.help

Interface ITocContribution

public interface ITocContribution

Represents either a complete or partial table of contents, as well as its metadata.

Since:

3.3

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategoryId() Returns the contribution's category id.
java.lang.String	getContributorId() Returns the symbolic name of the bundle that made this contribution, e.g.
java.lang.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.
java.lang.String	getId() Returns a unique identifier for this contribution.
java.lang.String	getLinkTo() Returns the path to the anchor in another toc into which this one should be linked into.
java.lang.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

getCategoryId

java.lang.String getCategoryId()

Returns the contribution's category id. Contributions with the same category id will be grouped together.

Returns:

the contribution's category id.

getContributorId

java.lang.String getContributorId()

Returns the symbolic name of the bundle that made this contribution, e.g. "org.eclipse.help"

Returns:

the contributor id, e.g. "org.eclipse.help"

getExtraDocuments

java.lang.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.

Returns:

any extra documents associated with the TOC

getId

java.lang.String getId()

Returns a unique identifier for this contribution.

Returns:

the contribution's unique identifier

getLocale

java.lang.String getLocale()

Returns the locale for this contribution.

Returns:

the contribution's locale

getLinkTo

java.lang.String getLinkTo()

Returns the path to the anchor in another toc into which this one should be linked into.

Returns:

the link-to path

getToc

IToc getToc()

Returns the table of contents data for this contribution.

Returns:

the toc data for this contribution

isPrimary

boolean isPrimary()

Returns whether or not this is a top-level contribution (a book).

Returns:

whether the contribution is top-level book