|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.help.WorkbenchHelp
Provides methods for accessing the help UI.
The help UI is optional, to allow applications to be configured without one.
The various setHelp
methods allow context help to be hooked in
to SWT menus, menu items, and controls, and into JFace actions. This involves
furnishing a help context id. When the user requests help for one of the
established widgets (for instance, by hitting F1), the context id is
retrieved and passed to the help UI using
WorkbenchHelp.displayContext(helpContext, xposition, yposition)
.
In cases more dynamic situations, clients may hook their own help listener
and call WorkbenchHelp.displayContext
with an
IContext
.
This class provides static methods only; it is not intended to be instantiated or subclassed.
HelpSystem
Method Summary | |
static HelpListener |
createHelpListener(ICommand command)
Creates a new help listener for the given command. |
static void |
displayContext(IContext context,
int x,
int y)
Displays context-sensitive help for the given context. |
static void |
displayHelp()
Displays the entire help bookshelf. |
static void |
displayHelp(IContext context)
Displays context-sensitive help for the given context. |
static void |
displayHelp(String contextId)
Calls the help support system to display the given help context id. |
static void |
displayHelpResource(String href)
Displays help content for the help resource with the given URL. |
static Object |
getHelp(Control control)
Deprecated. as context computers are no longer supported |
static Object |
getHelp(Menu menu)
Deprecated. as context computers are no longer supported |
static Object |
getHelp(MenuItem menuItem)
Deprecated. as context computers are no longer supported |
static IHelp |
getHelpSupport()
Deprecated. Use the static methods on this class and on HelpSystem instead of the IHelp methods
on the object returned by this method. |
static boolean |
isContextHelpDisplayed()
Returns whether the context-sensitive help window is currently being displayed. |
static void |
setHelp(Control control,
IContextComputer computer)
Deprecated. context computers are no longer supported, clients should implement their own help listener |
static void |
setHelp(Control control,
Object[] contexts)
Deprecated. use setHelp with single context id parameter |
static void |
setHelp(Control control,
String contextId)
Sets the given help context id on the given control. |
static void |
setHelp(IAction action,
IContextComputer computer)
Deprecated. context computers are no longer supported, clients should implement their own help listener |
static void |
setHelp(IAction action,
Object[] contexts)
Deprecated. use setHelp with a single context id parameter |
static void |
setHelp(IAction action,
String contextId)
Sets the given help context id on the given action. |
static void |
setHelp(Menu menu,
IContextComputer computer)
Deprecated. context computers are no longer supported, clients should implement their own help listener |
static void |
setHelp(MenuItem item,
IContextComputer computer)
Deprecated. context computers are no longer supported, clients should implement their own help listener |
static void |
setHelp(MenuItem item,
Object[] contexts)
Deprecated. use setHelp with single context id parameter |
static void |
setHelp(MenuItem item,
String contextId)
Sets the given help context id on the given menu item. |
static void |
setHelp(Menu menu,
Object[] contexts)
Deprecated. use setHelp with single context id parameter |
static void |
setHelp(Menu menu,
String contextId)
Sets the given help context id on the given menu. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static void displayHelp()
Ignored if no help UI is available.
public static 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 static 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 static HelpListener createHelpListener(ICommand command)
command
- The command for which the listener should be created; must
not be null
.
null
.public static void displayHelp(String contextId)
May only be called from a UI thread.
contextId
- the id of the context to displaypublic static void displayHelp(IContext context)
May only be called from a UI thread.
context
- the context to displaypublic static Object getHelp(Control control)
Instances of IContextComputer
may use this method
to obtain the previously registered help contexts of a control.
control
- the control on which the contexts are registered
String
) and/or help contexts (type
IContext
) or an IContextComputer
or
null
if no contexts have been set.public static Object getHelp(Menu menu)
Instances of IContextComputer
may use this method
to obtain the previously registered help contexts of a menu.
menu
- the menu on which the contexts are registered
String
) and/or help contexts (type
IContext
) or an IContextComputer
or
null
if no contexts have been set.public static Object getHelp(MenuItem menuItem)
Instances of IContextComputer
may use this method
to obtain the previously registered help contexts of a menu.
menuItem
- the menu item on which the contexts are registered
String
) and/or help contexts (type
IContext
) or an IContextComputer
or
null
if no contexts have been set.public static IHelp getHelpSupport()
HelpSystem
instead of the IHelp methods
on the object returned by this method.
null
if nonepublic static 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 static void setHelp(IAction action, Object[] contexts)
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).
action
- the action on which to register the computercontexts
- the contexts to use when F1 help is invoked; a mixed-type
array of context ids (type String
) and/or help contexts (type
IContext
)public static void setHelp(IAction action, IContextComputer computer)
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).
action
- the action on which to register the computercomputer
- the computer to determine the help contexts for the control
when F1 help is invokedpublic static void setHelp(Control control, Object[] contexts)
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).
control
- the control on which to register the contextscontexts
- the contexts to use when F1 help is invoked; a mixed-type
array of context ids (type String
) and/or help contexts (type
IContext
)public static void setHelp(Control control, IContextComputer computer)
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).
control
- the control on which to register the computercomputer
- the computer to determine the help contexts for the control
when F1 help is invokedpublic static void setHelp(Menu menu, Object[] contexts)
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).
menu
- the menu on which to register the contextcontexts
- the contexts to use when F1 help is invoked; a mixed-type
array of context ids (type String
) and/or help contexts (type
IContext
)public static void setHelp(Menu menu, IContextComputer computer)
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).
menu
- the menu on which to register the computercomputer
- the computer to determine the help contexts for the control
when F1 help is invokedpublic static void setHelp(MenuItem item, Object[] contexts)
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).
item
- the menu item on which to register the contextcontexts
- the contexts to use when F1 help is invoked; a mixed-type
array of context ids (type String
) and/or help contexts (type
IContext
)public static void setHelp(MenuItem item, IContextComputer computer)
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).
item
- the menu item on which to register the computercomputer
- the computer to determine the help contexts for the control
when F1 help is invokedpublic static 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 static 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 static 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 static 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 invoked
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.