Eclipse Plug-in Developer Guide (Galileo) - AbstractTocProvider (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.help
Class AbstractTocProvider


java.lang.Object
  
org.eclipse.help.AbstractTocProvider

public abstract class AbstractTocProvider
extends Object
extends Object

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.

Since:: 3.3

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.

abstract ITocContribution[] getTocContributions ( 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

Constructor Detail

AbstractTocProvider

public AbstractTocProvider()

Method Detail

getTocContributions

public abstract 
ITocContribution[] getTocContributions(
String locale)

Returns all toc contributions for this provider. Providers are free to provide any number of contributions (zero or more).

Parameters:: locale - the locale for which to get contributions
Returns:: all the contributions for this provider

contentChanged

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.