Examples of org.eclipse.ui.help.AbstractHelpUI

org.eclipse.ui.help.AbstractHelpUI
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

   * @deprecated Use the static methods on this class and on
   *             {@link org.eclipse.help.HelpSystem HelpSystem}instead of the
   *             IHelp methods on the object returned by this method.
   */
  public IHelp getHelpSupport() {
    AbstractHelpUI helpUI = getHelpUI();
    if (helpUI != null && helpCompatibilityWrapper == null) {
      // create instance only once, and only if needed
      helpCompatibilityWrapper = new CompatibilityIHelpImplementation();
    }
    return helpCompatibilityWrapper;

View Full Code Here

   * (non-Javadoc)
   * 
   * @see org.eclipse.ui.help.IWorkbenchHelpSystem#displayHelp()
   */
  public void displayHelp() {
    AbstractHelpUI helpUI = getHelpUI();
    if (helpUI != null) {
      helpUI.displayHelp();
    }
  }

View Full Code Here

   * (non-Javadoc)
   * 
   * @see org.eclipse.ui.help.IWorkbenchHelpSystem#displaySearch()
   */
  public void displaySearch() {
    AbstractHelpUI helpUI = getHelpUI();
    if (helpUI != null) {
      helpUI.displaySearch();
    }
  }

View Full Code Here

   * (non-Javadoc)
   * 
   * @see org.eclipse.ui.help.IWorkbenchHelpSystem#displaySearch()
   */
  public void displayDynamicHelp() {
    AbstractHelpUI helpUI = getHelpUI();
    if (helpUI != null) {
      helpUI.displayDynamicHelp();
    }
  }

View Full Code Here

   * (non-Javadoc)
   * 
   * @see org.eclipse.ui.help.IWorkbenchHelpSystem#search(java.lang.String)
   */
  public void search(String expression) {
    AbstractHelpUI helpUI = getHelpUI();
    if (helpUI != null) {
      helpUI.search(expression);
    }
  }

View Full Code Here

  
  /* (non-Javadoc)
   * @see org.eclipse.ui.help.IWorkbenchHelpSystem#resolve(java.lang.String, boolean)
   */
  public URL resolve(String href, boolean documentOnly) {
    AbstractHelpUI helpUI = getHelpUI();
    if (helpUI != null) {
      return helpUI.resolve(href, documentOnly);
    }
    return null;
  }

View Full Code Here

   */
  public void displayContext(IContext context, int x, int y) {
    if (context == null) {
      throw new IllegalArgumentException();
    }
    AbstractHelpUI helpUI = getHelpUI();
    if (helpUI != null) {
      helpUI.displayContext(context, x, y);
    }
  }

View Full Code Here

   */
  public void displayHelpResource(String href) {
    if (href == null) {
      throw new IllegalArgumentException();
    }
    AbstractHelpUI helpUI = getHelpUI();
    if (helpUI != null) {
      helpUI.displayHelpResource(href);
    }
  }

View Full Code Here

   * 
   * @see org.eclipse.ui.help.IWorkbenchHelpSystem#displayHelp(org.eclipse.help.IContext)
   */
  public void displayHelp(IContext context) {
    Point point = computePopUpLocation(Display.getCurrent());
    AbstractHelpUI helpUI = getHelpUI();
    if (helpUI != null) {
      helpUI.displayContext(context, point.x, point.y);
    }
  }

View Full Code Here

   */
  public boolean isContextHelpDisplayed() {
    if (!isInitialized) {
      return false;
    }
    AbstractHelpUI helpUI = getHelpUI();
    return helpUI != null && helpUI.isContextHelpDisplayed();
  }

View Full Code Here

0 1

TOP

Related Classes of org.eclipse.ui.help.AbstractHelpUI

org.eclipse.ui.internal.help.WorkbenchHelpSystem

org.eclipse.ui.internal.help.WorkbenchHelpSystem$CompatibilityIHelpImplementation

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.