Interface IHelp
-
Method Summary
Modifier and TypeMethodDescriptionvoiddisplayContext(String contextId, int x, int y) Deprecated.Use WorkbenchHelp.displayContext(HelpSystem.getContext(contextId),x,y) instead.voiddisplayContext(IContext context, int x, int y) Deprecated.Use WorkbenchHelp.displayContext(context,x,y) instead.voidDeprecated.Use WorkbenchHelp.displayHelp() instead.voiddisplayHelp(String toc) Deprecated.Use WorkbenchHelp.displayHelpResource(toc) instead.voiddisplayHelp(String contextId, int x, int y) Deprecated.Use WorkbenchHelp.displayContext(HelpSystem.getContext(contextId),x,y) instead.voiddisplayHelp(String toc, String selectedTopic) Deprecated.Use WorkbenchHelp.displayHelpResource(selectedTopic) instead.voiddisplayHelp(IContext context, int x, int y) Deprecated.Use WorkbenchHelp.displayContext(context,x,y) instead.voiddisplayHelpResource(String href) Deprecated.Use WorkbenchHelp.displayHelpResource(href) instead.voiddisplayHelpResource(IHelpResource helpResource) Deprecated.Use WorkbenchHelp.displayHelpResource(helpResource.getHref()) instead.getContext(String contextId) Deprecated.Use HelpSystem.getContext(contextId) instead.IToc[]getTocs()Deprecated.Use HelpSystem.getTocs() instead.booleanDeprecated.Use WorkbenchHelp.isContextHelpDisplayed() instead.
-
Method Details
-
displayHelp
Deprecated.Use WorkbenchHelp.displayHelp() instead.Displays the entire help bookshelf.This method is called by the platform to launch the help system UI
- Since:
- 2.0
-
displayContext
Deprecated.Use WorkbenchHelp.displayContext(context,x,y) instead.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.
- Parameters:
context- the context to displayx- horizontal positiony- verifical position- Since:
- 2.0
-
displayContext
Deprecated.Use WorkbenchHelp.displayContext(HelpSystem.getContext(contextId),x,y) instead.Displays context-sensitive help for context with the given context id.(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.
- Parameters:
contextId- the help context identifier; the parameter needs to have a form pluginID.pluginContextId, where pluginID is ID of plug-in contributing a context, and pluginContextID is ID of context contributed in a plug-in.x- horizontal positiony- verifical position- Since:
- 2.0
- See Also:
-
displayHelpResource
Deprecated.Use WorkbenchHelp.displayHelpResource(href) instead.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
hrefparameter.The help system makes no guarantee that all the help resources can be displayed or how they are displayed.
- Parameters:
href- the URL of the help resource.Valid href are as described in
IHelpResource.getHref()- Since:
- 2.0
-
displayHelpResource
Deprecated.Use WorkbenchHelp.displayHelpResource(helpResource.getHref()) instead.Displays help content for the help resource.This method is called by the platform to launch the help system UI, displaying the documentation identified by the
helpResourceparameter.The help system makes no guarantee that all the help resources can be displayed or how they are displayed.
- Parameters:
helpResource- the help resource to display.- Since:
- 2.0
-
displayHelp
Deprecated.Use WorkbenchHelp.displayHelpResource(toc) instead.Displays help content for the toc with the given URL.This method is called by the platform to launch the help system UI, displaying the documentation identified by the
tocparameter.Valid toc are contributed through the
tocelement of the"org.eclipse.help.toc"extension point.- Parameters:
toc- the URL of the toc as specified in the"org.eclipse.help.toc"extenstion point
-
displayHelp
Deprecated.Use WorkbenchHelp.displayHelpResource(selectedTopic) instead.This method is an extension to the displayHelp(String toc) method, providing the ability to open the specified help topic.selectedTopicshould be a valid help topic url contained in the specifiedtocand have the following format: /pluginID/path_to_document
where- pluginID is the unique identifier of the plugin containing the help topic,
- path_to_document is the help topic path, relative to the plugin directory
- Parameters:
toc- the URL of the tocselectedTopic- the help topic url.- See Also:
-
displayHelp
Deprecated.Use WorkbenchHelp.displayContext(HelpSystem.getContext(contextId),x,y) instead.Displays context-sensitive help for context with the given context id.(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.
- Parameters:
contextId- the help context identifierx- horizontal positiony- verifical position- See Also:
-
displayHelp
Deprecated.Use WorkbenchHelp.displayContext(context,x,y) instead.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.
- Parameters:
context- the context to displayx- horizontal positiony- verifical position
-
getContext
Deprecated.Use HelpSystem.getContext(contextId) instead.Computes and returns context information for the given context id.- Parameters:
contextId- the context id- Returns:
- the context, or
nullif none
-
getTocs
Deprecated.Use HelpSystem.getTocs() instead.Returns the list of all integrated tables of contents available.- Returns:
- an array of TOC's
- Since:
- 2.0
-
isContextHelpDisplayed
Deprecated.Use WorkbenchHelp.isContextHelpDisplayed() instead.Returnstrueif the context-sensitive help window is currently being displayed,falseif not.
-
HelpSystem.getTocs()andHelpSystem.getContext(String)to obtain help resources. Use various display methods of org.eclipse.ui.help.IWorkbenchHelpSystem to display help resources.