public abstract class AbstractTocProvider extends Object
AbstractTocProvider
is a mechanism to provide arbitrary
content to the table of contents (TOC). AbstractTocProvider
s
must be registered via the org.eclipse.help.toc
extension point.Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_PRIORITY
Default priority for toc providers that do not override getPriority()
|
static int |
TOC_FILE_PRIORITY
Priority for toc files read from the local file system
|
Constructor and Description |
---|
AbstractTocProvider() |
Modifier and Type | Method and Description |
---|---|
protected void |
contentChanged()
Notifies the platform that the content managed by this provider may
have changed since the last time
getTocContributions()
was called, and needs to be updated. |
int |
getPriority()
If two toc contributions have the same id, the one with higher priority will be shown.
|
abstract ITocContribution[] |
getTocContributions(String locale)
Returns all toc contributions for this provider.
|
public static final int DEFAULT_PRIORITY
public static final int TOC_FILE_PRIORITY
public abstract ITocContribution[] getTocContributions(String locale)
locale
- the locale for which to get contributionsprotected void contentChanged()
getTocContributions()
was called, and needs to be updated.public int getPriority()
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.