public class Help extends Object
| Constructor and Description |
|---|
Help(String pluginsDir)
Deprecated.
use Help#Help(String[])
|
Help(String[] options)
Constructs help system
|
| Modifier and Type | Method and Description |
|---|---|
void |
displayContext(String contextId,
int x,
int y)
Displays context sensitive help.
|
void |
displayContextInfopop(String contextId,
int x,
int y)
Displays context sensitive help in infopop.
|
void |
displayHelp()
Displays help.
|
void |
displayHelp(String href)
Displays specified help resource.
|
static void |
main(String[] args)
Controls standalone help system from command line.
|
void |
shutdown()
Shuts-down the stand alone help system.
|
void |
start()
Starts the stand alone help system.
|
public Help(String[] options)
options - array of String options and their values
Option -eclipseHome dir specifies Eclipse
installation directory. This directory is a parent to
"plugins" directory and eclipse executable. The option must be
provided, when current directory from which infocenter is
launched, is not the same as Eclipse installation directory.
Option -host helpServerHost specifies host name
of the interface that help server will use. It overrides host
name specified in the application server plugin preferences.
Option -port helpServerPort specifies port
number that help server will use. It overrides port number
specified in the application server plugin preferences.
Option -dir rtl sets right-to-left rendering
direction of help UI in the browser.
Additionally, most options accepted by Eclipse execuable are supported.
public Help(String pluginsDir)
pluginsDir - directory containing Eclipse pluginspublic void shutdown()
throws Exception
Exceptionpublic void displayHelp(String href) throws Exception
href - the href of the table of contentsExceptionpublic void displayContext(String contextId, int x, int y) throws Exception
contextId - context idx - x coordinatey - y coordinateExceptionpublic void displayContextInfopop(String contextId, int x, int y) throws Exception
contextId - context idx - x coordinatey - y coordinateExceptionpublic static void main(String[] args)
args - array of String containing options Options are:
-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]
where
href is the URL of the help resource to
display,eclipseInstallPath specifies Eclipse
installation directory; it must be provided, when current
directory is not the same as Eclipse installation directory,
helpServerHost specifies host name of the
interface that help server will use, it overrides host name
specified the application server plugin preferenceshelpServerPort specifies port number that
help server will use, it overrides port number specified the
application server plugin preferences.-dir rtl sets right-to-left rendering
direction of help UI in the browser.
platform options are other options that
are supported by Eclipse Executable.Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.