Eclipse Plug-in Developer Guide (Galileo) - AbstractContentExtensionProvider (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 AbstractContentExtensionProvider


java.lang.Object
  
org.eclipse.help.AbstractContentExtensionProvider

public abstract class AbstractContentExtensionProvider
extends Object
extends Object

An AbstractContentExtensionProvider is a mechanism to provide arbitrary content extensions (e.g. contributions to anchors or element replacements). AbstractContentExtensionProviders must be registered via the org.eclipse.help.contentExtension extension point.

Since:: 3.3

Constructor Summary

AbstractContentExtensionProvider ()


Method Summary

protected void contentChanged ()
          Notifies the platform that the content managed by this provider may have changed since the last time getContentExtensions() was called, and needs to be updated.

abstract IContentExtension[] getContentExtensions ( String locale)
          Returns all extensions for this provider.

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractContentExtensionProvider

public AbstractContentExtensionProvider()

Method Detail

getContentExtensions

public abstract 
IContentExtension[] getContentExtensions(
String locale)

Returns all extensions 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 content extensions for this provider

contentChanged

protected void contentChanged()

Notifies the platform that the content managed by this provider may have changed since the last time getContentExtensions() was called, and needs to be updated.