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

---

org.eclipse.help.ui.internal
Class DefaultHelpUI  

java.lang.Object
  org.eclipse.ui.help.AbstractHelpUI
      org.eclipse.help.ui.internal.DefaultHelpUI

---

public class DefaultHelpUI

extends org.eclipse.ui.help.AbstractHelpUI

This class is an implementation of the Help UI. In is registered into the helpSupport extension point, and is responsible for handling requests to display help. The methods on this class interact with the actual UI component handling the display.

Most methods delegate most work to HelpDisplay class; only the UI specific ones implemented in place.

---

Field Summary
private  ContextHelpDialog	f1Dialog

 

Constructor Summary

DefaultHelpUI()           Constructor.

 

Method Summary
void	displayContext(org.eclipse.help.IContext context, int x, int y)           Displays context-sensitive help for specified context
void	displayHelp()           Displays help.
void	displayHelpResource(java.lang.String href)           Displays a help resource specified as a url.
boolean	isContextHelpDisplayed()           Returns true if the context-sensitive help window is currently being displayed, false if not.
private  boolean	useExternalBrowser(java.lang.String url)

 

Methods inherited from class java.lang.Object

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

 

Field Detail

f1Dialog

private ContextHelpDialog f1Dialog

Constructor Detail

DefaultHelpUI

public DefaultHelpUI()

Constructor.

Method Detail

displayHelp

public void displayHelp()

Displays help.

---

displayHelpResource

public void displayHelpResource(java.lang.String href)

Displays a help resource specified as a url.

• a URL in a format that can be returned by IHelpResource.getHref() 55
• a URL query in the format format key=value&key=value ... The valid keys are: "tab", "toc", "topic", "contextId". For example, toc="/myplugin/mytoc.xml"&topic="/myplugin/references/myclass.html" is valid.

---

displayContext

public void displayContext(org.eclipse.help.IContext context,
                           int x,
                           int y)

Displays context-sensitive help for specified context

---

isContextHelpDisplayed

public boolean isContextHelpDisplayed()

Returns true if the context-sensitive help window is currently being displayed, false if not.

---

useExternalBrowser

private boolean useExternalBrowser(java.lang.String url)

---

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

---