| org.eclipse.ui.help |
Package-level Javadoc
Classes for integration with the help support system
in the Eclipse Platform User Interface.
Package Specification
Within the Eclipse Platform UI each user interface component should integrate
with the help support system. The simplest form of help integration
is accomplished using WorkbenchHelp. This class provides the
client with methods to define a help context for SWT Controls. Once
defined, the help support system will automatically launch help with the
appropriate context if a user request for help occurs.
|
| Java Source File Name | Type | Comment |
| AbstractHelpUI.java | Class | Abstract base class for the help system UI.
The Eclipse platform provides an extension point ("org.eclipse.ui.helpSupport")
for plugging in a help system UI. |
| DialogPageContextComputer.java | Class | For determining the help context for controls in a dialog page. |
| IContextComputer.java | Interface | A content computer is used to dynamically calculate help support contexts at the
time the user requests help. |
| IWorkbenchHelpSystem.java | Interface |
The interface that is used to access the workbench help system. |
| ViewContextComputer.java | Class | For determining the help context for controls in a view. |
| WorkbenchHelp.java | Class | Provides methods for accessing the help UI.
The help UI is optional, to allow applications to be configured
without one.
The various setHelp methods allow context help to be hooked in
to SWT menus, menu items, and controls, and into JFace actions. |