HelpSystem.getTocs()
and
HelpSystem.getContext(String)
to obtain help resources. Use various display methods of
WorkbenchHelp
to
display help resources.public interface IHelp
Modifier and Type | Method and Description |
---|---|
void |
displayContext(IContext context,
int x,
int y)
Deprecated.
Use WorkbenchHelp.displayContext(context,x,y) instead.
|
void |
displayContext(String contextId,
int x,
int y)
Deprecated.
Use
WorkbenchHelp.displayContext(HelpSystem.getContext(contextId),x,y)
instead.
|
void |
displayHelp()
Deprecated.
Use WorkbenchHelp.displayHelp() instead.
|
void |
displayHelp(IContext context,
int x,
int y)
Deprecated.
Use WorkbenchHelp.displayContext(context,x,y) instead.
|
void |
displayHelp(String toc)
Deprecated.
Use WorkbenchHelp.displayHelpResource(toc) instead.
|
void |
displayHelp(String contextId,
int x,
int y)
Deprecated.
Use
WorkbenchHelp.displayContext(HelpSystem.getContext(contextId),x,y)
instead.
|
void |
displayHelp(String toc,
String selectedTopic)
Deprecated.
Use WorkbenchHelp.displayHelpResource(selectedTopic) instead.
|
void |
displayHelpResource(IHelpResource helpResource)
Deprecated.
Use WorkbenchHelp.displayHelpResource(helpResource.getHref())
instead.
|
void |
displayHelpResource(String href)
Deprecated.
Use WorkbenchHelp.displayHelpResource(href) instead.
|
IContext |
getContext(String contextId)
Deprecated.
Use HelpSystem.getContext(contextId) instead.
|
IToc[] |
getTocs()
Deprecated.
Use HelpSystem.getTocs() instead.
|
boolean |
isContextHelpDisplayed()
Deprecated.
Use WorkbenchHelp.isContextHelpDisplayed() instead.
|
void displayHelp()
This method is called by the platform to launch the help system UI
void displayContext(IContext context, int x, int y)
(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.
context
- the context to displayx
- horizontal positiony
- verifical positionvoid displayContext(String contextId, int x, int y)
(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.
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 positiongetContext(String)
void displayHelpResource(String href)
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.
href
- the URL of the help resource.
Valid href are as described in
IHelpResource.getHref()
void displayHelpResource(IHelpResource helpResource)
This method is called by the platform to launch the help system UI,
displaying the documentation identified by the helpResource
parameter.
The help system makes no guarantee that all the help resources can be displayed or how they are displayed.
helpResource
- the help resource to display.displayHelpResource(String)
void displayHelp(String toc)
This method is called by the platform to launch the help system UI,
displaying the documentation identified by the toc
parameter.
Valid toc are contributed through the toc
element of the
"org.eclipse.help.toc"
extension point.
toc
- the URL of the toc as specified in the
"org.eclipse.help.toc"
extenstion pointvoid displayHelp(String toc, String selectedTopic)
selectedTopic
should be a valid help topic url contained
in the specified toc
and have the following format:
/pluginID/path_to_document
where
toc
- the URL of the tocselectedTopic
- the help topic url.displayHelp(java.lang.String)
void displayHelp(String contextId, int x, int y)
(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.
contextId
- the help context identifierx
- horizontal positiony
- verifical positiongetContext(String)
void displayHelp(IContext context, int x, int y)
(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.
context
- the context to displayx
- horizontal positiony
- verifical positionIContext getContext(String contextId)
contextId
- the context idnull
if noneIToc[] getTocs()
boolean isContextHelpDisplayed()
true
if the context-sensitive help window is
currently being displayed, false
if not.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.