com.ibm.as400.ui.framework.java
Class EclipseHelpViewer

java.lang.Object
  com.ibm.as400.ui.framework.java.EclipseHelpViewer

public class EclipseHelpViewer
extends Object

Constructor and Description

EclipseHelpViewer()
Constructs a default eclipse help veiwer.

Method Summary

Modifier and Type	Method and Description
void	displayEclipse() Causes Eclipse help system to show the default page.
void	displayEclipse(String plugin) Causes Eclipse help system to retrieve and show the passed-in plugin.
void	displayEclipse(String plugin, String topic) Causes Eclipse help system to retrieve and show the passed-in plugin and topic.
void	dispose() Shuts down the help system and releases all help system resources.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EclipseHelpViewer

public EclipseHelpViewer()

Constructs a default eclipse help veiwer. The eclipse runtime location is assumened to be in an "eclipse" directory directly under the current working directory, and eclipse randomly picks an available port number to use.

Method Detail

displayEclipse

public void displayEclipse()

Causes Eclipse help system to show the default page.

displayEclipse

public void displayEclipse(String plugin)

Causes Eclipse help system to retrieve and show the passed-in plugin.

Parameters:

plugin - the plugin to be displayed - format: com.ibm.ui.test.scen.global.advancedeclipsehelp.usinghelpauimle.help.doc

displayEclipse

public void displayEclipse(String plugin,
                           String topic)

Causes Eclipse help system to retrieve and show the passed-in plugin and topic.

Parameters:

plugin - the plugin to be displayed. format: com.ibm.ui.test.scen.global.advancedeclipsehelp.usinghelpauimle.help.doc

topic - the topic to be displayed. format: com/ibm/ui/test/scen/global/advancedeclipsehelp/usinghelpauimle/UsingHelpMain.html

dispose

public void dispose()

Shuts down the help system and releases all help system resources.