| org.eclipse.ui.help.IWorkbenchHelpSystem
All known Subclasses: org.eclipse.ui.internal.help.WorkbenchHelpSystem,
| IWorkbenchHelpSystem | | public interface IWorkbenchHelpSystem (Code) | |
The interface that is used to access the workbench help system. Replaces
static methods on WorkbenchHelp.
This interface is not intended to be implemented by clients.
since:
3.1 |
| Method Summary | |
| 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. | | void | displayDynamicHelp()
Displays the dynamic help for the current UI context. | | void | displayHelp()
Displays the entire help bookshelf. | | void | displayHelp(String contextId)
Calls the help support system to display the given help context id. | | void | displayHelp(IContext context)
Displays context-sensitive help for the given context. | | void | displayHelpResource(String href)
Displays help content for the help resource with the given URL. | | void | displaySearch()
Displays the help search system. | | boolean | hasHelpUI()
Returns whether there is a UI help system installed. | | boolean | isContextHelpDisplayed()
Returns whether the context-sensitive help window is currently being
displayed. | | URL | resolve(String href, boolean documentOnly)
Resolves the help resource href by converting it into a legitimate URL
according to the implementation of the help system. | | void | search(String expression)
Starts the search using the help search system.
Ignored if no help UI is available.
Parameters:
expression - the search expression. | | void | setHelp(IAction action, String contextId)
Sets the given help context id on the given action. | | void | setHelp(Control control, String contextId)
Sets the given help context id on the given control. | | void | setHelp(Menu menu, String contextId)
Sets the given help context id on the given menu. | | void | setHelp(MenuItem item, String contextId)
Sets the given help context id on the given menu item. |
| displayContext | | 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 |
| displayDynamicHelp | | void displayDynamicHelp()(Code) | | Displays the dynamic help for the current UI context.
Ignored if no help UI is available.
|
| displayHelp | | void displayHelp()(Code) | | Displays the entire help bookshelf.
Ignored if no help UI is available.
|
| displayHelp | | 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 |
| displayHelp | | 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 |
| displayHelpResource | | 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 inorg.eclipse.help.IHelpResource.getHref IHelpResource.getHref() |
| displaySearch | | void displaySearch()(Code) | | Displays the help search system.
Ignored if no help UI is available.
|
| hasHelpUI | | boolean hasHelpUI()(Code) | | Returns whether there is a UI help system installed.
whether there is a UI help system installed |
| isContextHelpDisplayed | | 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 help window iscurrently being displayed, false otherwise |
| resolve | | URL resolve(String href, boolean documentOnly)(Code) | | Resolves the help resource href by converting it into a legitimate URL
according to the implementation of the help system. Help resources that
already have a protocol will be unchanged.
Parameters:
href -
Parameters:
documentOnly - if true, the resulting URL must pointat the document referenced by href. Otherwise, it can be a URL thatcontains additional elements like navigation that the help systemadds to the document. the resolved URL or null if no help UI isavailable. |
| search | | void search(String expression)(Code) | | Starts the search using the help search system.
Ignored if no help UI is available.
Parameters:
expression - the search expression. The actual syntax rules of theexpression are dependent on the activehelp system. Refer to the help systemdocumentation for more details. |
| setHelp | | 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 |
| setHelp | | 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 |
| setHelp | | 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 |
| setHelp | | 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 |
|
|