Package org.eclipse.help

Interface IContext

All Known Subinterfaces:
IContext2, IContext3
public interface IContext
A context registered for context-sensitive help.

This interface models the context-sensitive help that can be associated with SWT menus, menu items, and controls, and with JFace actions. A help context provides the text description of the object with which it is associated with, as well as topic links that contain more related information. This information would be displayed to the user when context sensitive help (F1) is requested.

In the current implementation of the Help system, valid contexts can be contributed through the contexts element of the "org.eclipse.help.contexts" extension point. The IHelp.findContext(String) method is used at runtime to create or fetch IContext objects using there fully qualified contextIds. If there is a need to override this behavior, then this IContext interface could be implemented by a client and registered with the SWT control or JFace action.

  • Method Summary

    Modifier and Type
    Method
    Description
    IHelpResource[]
    getRelatedTopics()
    Returns the related topics for this help context.
    String
    getText()
    Returns the text description for this context.

  • Method Details

    • getRelatedTopics

      IHelpResource[] getRelatedTopics()
      Returns the related topics for this help context.
      Returns:
      an array of related help topics. If no related topics have been defined for this context a zero length array is returned. May not return null
      Since:
      2.0

    • getText

      String getText()
      Returns the text description for this context.
      Returns:
      the text description