|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.help.AbstractTocProvider
public abstract class AbstractTocProvider
An AbstractTocProvider is a mechanism to provide arbitrary
content to the table of contents (TOC). AbstractTocProviders
must be registered via the org.eclipse.help.toc extension point.
| Field Summary | |
|---|---|
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 Summary | |
|---|---|
AbstractTocProvider()
|
|
| Method Summary | |
|---|---|
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(java.lang.String locale)
Returns all toc contributions for this provider. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int DEFAULT_PRIORITY
public static final int TOC_FILE_PRIORITY
| Constructor Detail |
|---|
public AbstractTocProvider()
| Method Detail |
|---|
public abstract ITocContribution[] getTocContributions(java.lang.String locale)
locale - the locale for which to get contributions
protected void contentChanged()
getTocContributions()
was called, and needs to be updated.
public int getPriority()
|
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.