Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> help >> internal >> [ standalone overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.eclipse.help.internal.standalone
Class StandaloneHelp  

java.lang.Object
  org.eclipse.help.internal.standalone.EclipseController
      org.eclipse.help.internal.standalone.StandaloneHelp

All Implemented Interfaces:

EclipseLifeCycleListener

---

public class StandaloneHelp

extends EclipseController

This is a standalone help system. It takes care of launching the eclipse with its help system implementation, and controling it. This class can be used instantiated and used in a Java program, or can be launched from command line to execute single help action. Usage as a Java component:

• create an instantance of this class and then hold onto this instance for the duration of your application
• call start()
• call displayHelp(...) or displayContext(..) any number of times
• at the end, call shutdown().

---

Nested Class Summary

 

Nested classes inherited from class org.eclipse.help.internal.standalone.EclipseController

EclipseController.EclipseCleaner

 

Field Summary
private static java.lang.String	HELP_APPLICATION_ID

 

Fields inherited from class org.eclipse.help.internal.standalone.EclipseController

applicationId, CMD_ADDSITE, CMD_APPLY, CMD_DISABLE, CMD_ENABLE, CMD_INSTALL, CMD_LIST, CMD_REMOVESITE, CMD_SEARCH, CMD_UNINSTALL, CMD_UPDATE, connection, eclipse

 

Constructor Summary

StandaloneHelp(java.lang.String[] args)           Constructs help system

 

Method Summary
void	displayContext(java.lang.String contextId, int x, int y)
void	displayContextInfopop(java.lang.String contextId, int x, int y)
void	displayHelp()
void	displayHelp(java.lang.String href)
private  boolean	executeCommand(java.util.List helpCommands)
static void	main(java.lang.String[] args)
private static void	printMainUsage()           Prints usage of this class as a program.

 

Methods inherited from class org.eclipse.help.internal.standalone.EclipseController

eclipseEnded, executeUpdateCommand, sendHelpCommand, shutdown, start

 

Methods inherited from class java.lang.Object

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

 

Field Detail

HELP_APPLICATION_ID

private static final java.lang.String HELP_APPLICATION_ID

See Also:

Constant Field Values

Constructor Detail

StandaloneHelp

public StandaloneHelp(java.lang.String[] args)

Constructs help system

Method Detail

main

public static void main(java.lang.String[] args)

---

displayContext

public void displayContext(java.lang.String contextId,
                           int x,
                           int y)

---

displayContextInfopop

public void displayContextInfopop(java.lang.String contextId,
                                  int x,
                                  int y)

---

displayHelp

public void displayHelp()
                 throws java.lang.Exception

---

displayHelp

public void displayHelp(java.lang.String href)
                 throws java.lang.Exception

---

executeCommand

private boolean executeCommand(java.util.List helpCommands)
                        throws java.lang.Exception

---

printMainUsage

private static void printMainUsage()

Prints usage of this class as a program.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> help >> internal >> [ standalone overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---