Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.help
Class AbstractContextProvider

java.lang.Object
  extended by 
org.eclipse.help.AbstractContextProvider

public abstract class AbstractContextProvider
extends Object

An AbstractContextProvider is a mechanism to provide arbitrary context-sensitive help for any part of the UI. AbstractContextProvider s must be registered via the org.eclipse.help.contexts extension point.

Since:
3.3

Constructor Summary
AbstractContextProvider ()
           
 
Method Summary
abstract   IContext getContext ( String id, String locale)
          Returns the context-sensitive help content for the UI element with the given context help ID, and for the given locale.
abstract   String[] getPlugins ()
          Returns an array of Strings containing the ids of the UI plug-ins for which this provider should be used.
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractContextProvider

public AbstractContextProvider()
Method Detail

getContext

public abstract 
IContext getContext(
String id,
                                    
String locale)
Returns the context-sensitive help content for the UI element with the given context help ID, and for the given locale.

Parameters:
id - the unique context help ID, e.g. "org.my.plugin.my_context_id"
Returns:
the context help, or null if not available

getPlugins

public abstract 
String[] getPlugins()
Returns an array of Strings containing the ids of the UI plug-ins for which this provider should be used. This is equivalent to the plugin attribute of the contexts element of the org.eclipse.help.contexts extension point, except you can specify any number of plug-ins.

Returns:
the UI plug-ins for which this provider should be used

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire