| java.lang.Object
 org.eclipse.ui.internal.help.WorkbenchHelpSystem
| WorkbenchHelpSystem | | final public class WorkbenchHelpSystem implements IWorkbenchHelpSystem(Code) | | This class represents a refactoring of the functionality previously contained
in WorkbenchHelp.
since:
3.1 |
| Field Summary | |
| final public static String | HELP_KEY
Key used for stashing help-related data on SWT widgets. |
| Method Summary | |
| public HelpListener | createHelpListener(ICommand command)
Creates a new help listener for the given command. | | public void | displayContext(IContext context, int x, int y)
| | public void | displayDynamicHelp()
| | public void | displayHelp()
| | public void | displayHelp(String contextId)
| | public void | displayHelp(IContext context)
| | public void | displayHelpResource(String href)
| | public void | displaySearch()
| | public void | dispose()
Dispose of any resources allocated by this instance. | | public static void | disposeIfNecessary()
Disposed of the singleton of this class if it has been created. | | public String | getDesiredHelpSystemId()
For debug purposes only. | | public IHelp | getHelpSupport()
Returns the help support system for the platform, if available. | | public static WorkbenchHelpSystem | getInstance()
Return the singleton instance of this class. | | public boolean | hasHelpUI()
| | public boolean | isContextHelpDisplayed()
| | public URL | resolve(String href, boolean documentOnly)
| | public void | search(String expression)
| | public void | setDesiredHelpSystemId(String desiredHelpSystemId)
For debug purposes only. | | public void | setHelp(IAction action, Object[] contexts)
Sets the given help contexts on the given action.
Use this method when the list of help contexts is known in advance. | | public void | setHelp(IAction action, IContextComputer computer)
Sets the given help context computer on the given action. | | public void | setHelp(Control control, Object[] contexts)
Sets the given help contexts on the given control.
Use this method when the list of help contexts is known in advance. | | public void | setHelp(Control control, IContextComputer computer)
Sets the given help context computer on the given control. | | public void | setHelp(Menu menu, Object[] contexts)
Sets the given help contexts on the given menu.
Use this method when the list of help contexts is known in advance. | | public void | setHelp(Menu menu, IContextComputer computer)
Sets the given help context computer on the given menu. | | public void | setHelp(MenuItem item, Object[] contexts)
Sets the given help contexts on the given menu item.
Use this method when the list of help contexts is known in advance. | | public void | setHelp(MenuItem item, IContextComputer computer)
Sets the given help context computer on the given menu item. | | public void | setHelp(IAction action, String contextId)
| | public void | setHelp(Control control, String contextId)
| | public void | setHelp(Menu menu, String contextId)
| | public void | setHelp(MenuItem item, String contextId)
|
| HELP_KEY | | final public static String HELP_KEY(Code) | | Key used for stashing help-related data on SWT widgets.
See Also: org.eclipse.swt.widgets.Widget.getData(java.lang.String) |
| createHelpListener | | public 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 void displayContext(IContext context, int x, int y)(Code) | | |
| displayDynamicHelp | | public void displayDynamicHelp()(Code) | | |
| displayHelp | | public void displayHelp()(Code) | | |
| displayHelp | | public void displayHelp(IContext context)(Code) | | |
| displayHelpResource | | public void displayHelpResource(String href)(Code) | | |
| displaySearch | | public void displaySearch()(Code) | | |
| dispose | | public void dispose()(Code) | | Dispose of any resources allocated by this instance.
|
| disposeIfNecessary | | public static void disposeIfNecessary()(Code) | | Disposed of the singleton of this class if it has been created.
|
| getDesiredHelpSystemId | | public String getDesiredHelpSystemId()(Code) | | For debug purposes only.
the desired help system id |
| getHelpSupport | | public 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 |
| getInstance | | public static WorkbenchHelpSystem getInstance()(Code) | | Return the singleton instance of this class.
the singleton instance |
| hasHelpUI | | public boolean hasHelpUI()(Code) | | |
| isContextHelpDisplayed | | public boolean isContextHelpDisplayed()(Code) | | |
| setDesiredHelpSystemId | | public void setDesiredHelpSystemId(String desiredHelpSystemId)(Code) | | For debug purposes only.
Parameters:
desiredHelpSystemId - the desired help system id |
| setHelp | | public 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 helpcontexts (type IContext) |
| setHelp | | public 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 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 helpcontexts (type IContext) |
| setHelp | | public 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 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 helpcontexts (type IContext) |
| setHelp | | public 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 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 helpcontexts (type IContext) |
| setHelp | | public 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 void setHelp(IAction action, String contextId)(Code) | | |
| setHelp | | public void setHelp(Control control, String contextId)(Code) | | |
| setHelp | | public void setHelp(Menu menu, String contextId)(Code) | | |
| setHelp | | public void setHelp(MenuItem item, String contextId)(Code) | | |
|
|