| java.lang.Object
 org.eclipse.ui.help.AbstractHelpUI
| AbstractHelpUI | | abstract public class AbstractHelpUI (Code) | | 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.
since:
3.0 |
| Method Summary | |
| abstract public void | displayContext(IContext context, int x, int y)
Displays context-sensitive help for the given context.
(x,y) coordinates specify the location where the context sensitive help
UI will be presented. | | public void | displayDynamicHelp()
Displays the dynamic help for the active context. | | abstract public void | displayHelp()
Displays the entire help bookshelf. | | abstract public void | displayHelpResource(String href)
Displays help content for the help resource with the given URL. | | public void | displaySearch()
Displays the help search facility. | | abstract public boolean | isContextHelpDisplayed()
Returns whether the context-sensitive help window is currently being
displayed. | | public URL | resolve(String href, boolean documentOnly)
Resolves the help resource href according to the help system
implementation.
Parameters:
href - the help resource
Parameters:
documentOnly - if true, the resulting URL must point at thedocument referenced by href. | | public void | search(String expression)
Starts the help search using the help search facility. |
| displayContext | | abstract public void displayContext(IContext context, int x, int y)(Code) | | 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 display
Parameters:
x - horizontal position
Parameters:
y - verifical position |
| displayDynamicHelp | | public void displayDynamicHelp()(Code) | | Displays the dynamic help for the active context. For backward
compatibility, the default implementation does nothing.
since:
3.1 |
| displayHelp | | abstract public void displayHelp()(Code) | | Displays the entire help bookshelf.
|
| displayHelpResource | | abstract public void displayHelpResource(String href)(Code) | | 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 href
parameter.
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 inorg.eclipse.help.IHelpResource.getHref IHelpResource.getHref() |
| displaySearch | | public void displaySearch()(Code) | | Displays the help search facility. For backward compatibility, the
default implementation does nothing.
since:
3.1 |
| isContextHelpDisplayed | | abstract public boolean isContextHelpDisplayed()(Code) | | Returns whether the context-sensitive help window is currently being
displayed.
true if the context-sensitive help window iscurrently being displayed, false if not |
| resolve | | public URL resolve(String href, boolean documentOnly)(Code) | | Resolves the help resource href according to the help system
implementation.
Parameters:
href - the help resource
Parameters:
documentOnly - if true, the resulting URL must point at thedocument referenced by href. Otherwise, it can be a URL thatcontains additional elements like navigation that the helpsystem adds to the document. the fully resolved URL of the help resource or nullif not supported. Help systems that use application serverstypically return URLs with http: protocol. Simple help systemimplementations can return URLs with file: protocol.
since:
3.1 |
| search | | public void search(String expression)(Code) | | Starts the help search using the help search facility. For backward
compatibility, the default implementation does nothing.
Parameters:
expression - the search expression
since:
3.1 |
|
|