| java.lang.Object
 org.eclipse.ui.help.WorkbenchHelp
| WorkbenchHelp | | public class WorkbenchHelp (Code) | | 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. This involves
furnishing a help context id. When the user requests help for one of the
established widgets (for instance, by hitting F1), the context id is
retrieved and passed to the help UI using
WorkbenchHelp.displayContext(helpContext, xposition, yposition).
In cases more dynamic situations, clients may hook their own help listener
and call WorkbenchHelp.displayContext with an
IContext.
This class provides static methods only; it is not intended to be instantiated
or subclassed.
See Also: org.eclipse.help.HelpSystem
See Also: org.eclipse.ui.help.IWorkbenchHelpSystem
See Also: org.eclipse.ui.IWorkbench.getHelpSystem |
| Method Summary | |
| public static HelpListener | createHelpListener(ICommand command)
Creates a new help listener for the given command. | | public static void | displayContext(IContext context, int x, int y)
Displays context-sensitive help for the given context.
(x,y) coordinates specify the location where the context sensitive
help UI will be presented. | | public static void | displayHelp()
Displays the entire help bookshelf. | | public static void | displayHelp(String contextId)
Calls the help support system to display the given help context id. | | public static void | displayHelp(IContext context)
Displays context-sensitive help for the given context. | | public static void | displayHelpResource(String href)
Displays help content for the help resource with the given URL. | | public static Object | getHelp(Control control)
Returns the help contexts on the given control. | | public static Object | getHelp(Menu menu)
Returns the help contexts on the given menu. | | public static Object | getHelp(MenuItem menuItem)
Returns the help contexts on the given menu item. | | public static IHelp | getHelpSupport()
Returns the help support system for the platform, if available. | | public static boolean | isContextHelpDisplayed()
Returns whether the context-sensitive help window is currently being
displayed. | | public static void | setHelp(IAction action, Object[] contexts)
Sets the given help contexts on the given action. | | public static void | setHelp(IAction action, IContextComputer computer)
Sets the given help context computer on the given action. | | public static void | setHelp(Control control, Object[] contexts)
Sets the given help contexts on the given control. | | public static void | setHelp(Control control, IContextComputer computer)
Sets the given help context computer on the given control. | | public static void | setHelp(Menu menu, Object[] contexts)
Sets the given help contexts on the given menu. | | public static void | setHelp(Menu menu, IContextComputer computer)
Sets the given help context computer on the given menu. | | public static void | setHelp(MenuItem item, Object[] contexts)
Sets the given help contexts on the given menu item. | | public static void | setHelp(MenuItem item, IContextComputer computer)
Sets the given help context computer on the given menu item. | | public static void | setHelp(IAction action, String contextId)
Sets the given help context id on the given action. | | public static void | setHelp(Control control, String contextId)
Sets the given help context id on the given control. | | public static void | setHelp(Menu menu, String contextId)
Sets the given help context id on the given menu. | | public static void | setHelp(MenuItem item, String contextId)
Sets the given help context id on the given menu item. |
| createHelpListener | | public static HelpListener createHelpListener(ICommand command)(Code) | | Creates a new help listener for the given command. This retrieves the
help context ID from the command, and creates an appropriate listener
based on this.
Parameters:
command - The command for which the listener should be created; mustnot be null. A help listener; never null. |
| displayContext | | public static void displayContext(IContext context, int x, int y)(Code) | | Displays context-sensitive help for the given context.
(x,y) coordinates specify the location where the context sensitive
help UI will be presented. These coordinates are screen-relative
(ie: (0,0) is the top left-most screen corner).
The platform is responsible for calling this method and supplying the
appropriate location.
Ignored if no help UI is available.
Parameters:
context - the context to display
Parameters:
x - horizontal position
Parameters:
y - verifical position
since:
3.0 |
| displayHelp | | public static void displayHelp()(Code) | | Displays the entire help bookshelf.
Ignored if no help UI is available.
since:
3.0 |
| displayHelp | | public static void displayHelp(String contextId)(Code) | | Calls the help support system to display the given help context id.
May only be called from a UI thread.
Parameters:
contextId - the id of the context to display
since:
2.0 |
| displayHelp | | public static void displayHelp(IContext context)(Code) | | Displays context-sensitive help for the given context.
May only be called from a UI thread.
Parameters:
context - the context to display
since:
2.0 |
| displayHelpResource | | public static void displayHelpResource(String href)(Code) | | Displays help content for the help resource with the given URL.
This method is called by the platform to launch the help system UI, displaying
the documentation identified by the href parameter.
The help system makes no guarantee that all the help resources can be displayed or how they are displayed.
Ignored if no help UI is available.
Parameters:
href - the URL of the help resource.Valid href are as described in org.eclipse.help.IHelpResource.getHref IHelpResource.getHref()
since:
3.0 |
| getHelp | | public static Object getHelp(Control control)(Code) | | Returns the help contexts on the given control.
Instances of IContextComputer may use this method
to obtain the previously registered help contexts of a control.
Parameters:
control - the control on which the contexts are registered contexts the contexts to use when F1 help is invoked; a mixed-typearray of context ids (type String) and/or help contexts (typeIContext) or an IContextComputer ornull if no contexts have been set. |
| getHelp | | public static Object getHelp(Menu menu)(Code) | | Returns the help contexts on the given menu.
Instances of IContextComputer may use this method
to obtain the previously registered help contexts of a menu.
Parameters:
menu - the menu on which the contexts are registered contexts the contexts to use when F1 help is invoked; a mixed-typearray of context ids (type String) and/or help contexts (typeIContext) or an IContextComputer ornull if no contexts have been set. |
| getHelp | | public static Object getHelp(MenuItem menuItem)(Code) | | Returns the help contexts on the given menu item.
Instances of IContextComputer may use this method
to obtain the previously registered help contexts of a menu.
Parameters:
menuItem - the menu item on which the contexts are registered contexts the contexts to use when F1 help is invoked; a mixed-typearray of context ids (type String) and/or help contexts (typeIContext) or an IContextComputer ornull if no contexts have been set. |
| getHelpSupport | | public static IHelp getHelpSupport()(Code) | | Returns the help support system for the platform, if available.
the help support system, or null if noneorg.eclipse.help.HelpSystem HelpSystem |
| isContextHelpDisplayed | | public static boolean isContextHelpDisplayed()(Code) | | Returns whether the context-sensitive help window is currently being
displayed. Returns false if the help UI has not been
activated yet.
true if the context-sensitive helpwindow is currently being displayed, false otherwise |
| setHelp | | public static void setHelp(IAction action, Object[] contexts)(Code) | | Sets the given help contexts on the given action.
Use this method when the list of help contexts is known in advance.
Help contexts can either supplied as a static list, or calculated with a
context computer (but not both).
Parameters:
action - the action on which to register the computer
Parameters:
contexts - the contexts to use when F1 help is invoked; a mixed-typearray of context ids (type String) and/or help contexts (typeIContext) |
| setHelp | | public static void setHelp(IAction action, IContextComputer computer)(Code) | | Sets the given help context computer on the given action.
Use this method when the help contexts cannot be computed in advance.
Help contexts can either supplied as a static list, or calculated with a
context computer (but not both).
Parameters:
action - the action on which to register the computer
Parameters:
computer - the computer to determine the help contexts for the controlwhen F1 help is invoked |
| setHelp | | public static void setHelp(Control control, Object[] contexts)(Code) | | Sets the given help contexts on the given control.
Use this method when the list of help contexts is known in advance.
Help contexts can either supplied as a static list, or calculated with a
context computer (but not both).
Parameters:
control - the control on which to register the contexts
Parameters:
contexts - the contexts to use when F1 help is invoked; a mixed-typearray of context ids (type String) and/or help contexts (typeIContext) |
| setHelp | | public static void setHelp(Control control, IContextComputer computer)(Code) | | Sets the given help context computer on the given control.
Use this method when the help contexts cannot be computed in advance.
Help contexts can either supplied as a static list, or calculated with a
context computer (but not both).
Parameters:
control - the control on which to register the computer
Parameters:
computer - the computer to determine the help contexts for the controlwhen F1 help is invoked |
| setHelp | | public static void setHelp(Menu menu, Object[] contexts)(Code) | | Sets the given help contexts on the given menu.
Use this method when the list of help contexts is known in advance.
Help contexts can either supplied as a static list, or calculated with a
context computer (but not both).
Parameters:
menu - the menu on which to register the context
Parameters:
contexts - the contexts to use when F1 help is invoked; a mixed-typearray of context ids (type String) and/or help contexts (typeIContext) |
| setHelp | | public static void setHelp(Menu menu, IContextComputer computer)(Code) | | Sets the given help context computer on the given menu.
Use this method when the help contexts cannot be computed in advance.
Help contexts can either supplied as a static list, or calculated with a
context computer (but not both).
Parameters:
menu - the menu on which to register the computer
Parameters:
computer - the computer to determine the help contexts for the controlwhen F1 help is invoked |
| setHelp | | public static void setHelp(MenuItem item, Object[] contexts)(Code) | | Sets the given help contexts on the given menu item.
Use this method when the list of help contexts is known in advance.
Help contexts can either supplied as a static list, or calculated with a
context computer (but not both).
Parameters:
item - the menu item on which to register the context
Parameters:
contexts - the contexts to use when F1 help is invoked; a mixed-typearray of context ids (type String) and/or help contexts (typeIContext) |
| setHelp | | public static void setHelp(MenuItem item, IContextComputer computer)(Code) | | Sets the given help context computer on the given menu item.
Use this method when the help contexts cannot be computed in advance.
Help contexts can either supplied as a static list, or calculated with a
context computer (but not both).
Parameters:
item - the menu item on which to register the computer
Parameters:
computer - the computer to determine the help contexts for the controlwhen F1 help is invoked |
| setHelp | | public static void setHelp(IAction action, String contextId)(Code) | | Sets the given help context id on the given action.
Parameters:
action - the action on which to register the context id
Parameters:
contextId - the context id to use when F1 help is invoked
since:
2.0 |
| setHelp | | public static void setHelp(Control control, String contextId)(Code) | | Sets the given help context id on the given control.
Parameters:
control - the control on which to register the context id
Parameters:
contextId - the context id to use when F1 help is invoked
since:
2.0 |
| setHelp | | public static void setHelp(Menu menu, String contextId)(Code) | | Sets the given help context id on the given menu.
Parameters:
menu - the menu on which to register the context id
Parameters:
contextId - the context id to use when F1 help is invoked
since:
2.0 |
| setHelp | | public static void setHelp(MenuItem item, String contextId)(Code) | | Sets the given help context id on the given menu item.
Parameters:
item - the menu item on which to register the context id
Parameters:
contextId - the context id to use when F1 help is invoked
since:
2.0 |
|
|