|
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.AbstractHelpUI
Abstract base class for the help system UI.
The Eclipse platform provides an extension point
("org.eclipse.ui.helpSupport"
) for plugging in a help system UI.
The help system UI is an optional component; applications may provide a UI
for presenting help to the user by implementing a subclass and including the
name of their class in the <config>
element in an
extension to the "org.eclipse.ui.helpSupport"
extension point.
Note that the standard implementation of the help system UI is provided by
the "org.eclipse.help.ui"
plug-in. Since the platform can only
make use of a single help system UI implementation, make sure that the
platform is not configured with more than one plug-in trying to extend
this extension point.
Constructor Summary | |
AbstractHelpUI()
|
Method Summary | |
abstract void |
displayContext(IContext context,
int x,
int y)
Displays context-sensitive help for the given context. |
abstract void |
displayHelp()
Displays the entire help bookshelf. |
abstract void |
displayHelpResource(String href)
Displays help content for the help resource with the given URL. |
abstract boolean |
isContextHelpDisplayed()
Returns whether the context-sensitive help window is currently being displayed. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AbstractHelpUI()
Method Detail |
public abstract void displayHelp()
public abstract 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 positionpublic abstract 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()
public abstract boolean isContextHelpDisplayed()
true
if the context-sensitive help
window is currently being displayed, false
if not
|
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.