|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
void |
displayContext(IContext context,
int x,
int y)
Displays context-sensitive help for the given context. |
void |
displayDynamicHelp()
Displays the dynamic help for the current UI context. |
void |
displayHelp()
Displays the entire help bookshelf. |
void |
displayHelp(IContext context)
Displays context-sensitive help for the given context. |
void |
displayHelp(String contextId)
Calls the help support system to display the given help context id. |
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. |
void |
setHelp(Control control,
String contextId)
Sets the given help context id on the given control. |
void |
setHelp(IAction action,
String contextId)
Sets the given help context id on the given action. |
void |
setHelp(MenuItem item,
String contextId)
Sets the given help context id on the given menu item. |
void |
setHelp(Menu menu,
String contextId)
Sets the given help context id on the given menu. |
Method Detail |
public boolean hasHelpUI()
public void displayHelp()
Ignored if no help UI is available.
public void displaySearch()
Ignored if no help UI is available.
public void displayDynamicHelp()
Ignored if no help UI is available.
public void search(String expression)
Ignored if no help UI is available.
expression
- the search expression. The actual syntax rules of the
expression are dependent on the active
help system. Refer to the help system
documentation for more details.public 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.
Ignored if no help UI is available.
context
- the context to displayx
- horizontal positiony
- verifical positionpublic 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.
Ignored if no help UI is available.
href
- the URL of the help resource.
Valid href are as described in
IHelpResource.getHref()
public void displayHelp(String contextId)
May only be called from a UI thread.
contextId
- the id of the context to displaypublic void displayHelp(IContext context)
May only be called from a UI thread.
context
- the context to displaypublic boolean isContextHelpDisplayed()
false
if the help UI has not been
activated yet.
true
if the context-sensitive help window is
currently being displayed, false
otherwisepublic void setHelp(IAction action, String contextId)
action
- the action on which to register the context idcontextId
- the context id to use when F1 help is invokedpublic void setHelp(Control control, String contextId)
control
- the control on which to register the context idcontextId
- the context id to use when F1 help is invokedpublic void setHelp(Menu menu, String contextId)
menu
- the menu on which to register the context idcontextId
- the context id to use when F1 help is invokedpublic void setHelp(MenuItem item, String contextId)
item
- the menu item on which to register the context idcontextId
- the context id to use when F1 help is invokedpublic URL resolve(String href, boolean documentOnly)
href
- documentOnly
- if true
, the resulting URL must point
at the document referenced by href. Otherwise, it can be a URL that
contains additional elements like navigation that the help system
adds to the document.
null
if no help UI is
available.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.