Package org.eclipse.e4.ui.services.help

Interface EHelpService

public interface EHelpService
The help service provides clients with the functionalities of dealing with the help system.

You can use it to define the help context id for an object and for displaying the help based on this help context id.

Since:
1.3
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    HELP_CONTEXT_ID
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    displayHelp(String contextId)
    Calls the help support system to display the given help context ID.
    boolean
    hasHelp(String helpContextId)
    Check if help is available for the given id
    void
    setHelp(Object element, String helpContextId)
    Sets the given id for the help system on the given object.

  • Field Details

  • Method Details

    • displayHelp

      void displayHelp(String contextId)
      Calls the help support system to display the given help context ID.
      Parameters:
      contextId - the ID of the context to display

    • setHelp

      void setHelp(Object element, String helpContextId)
      Sets the given id for the help system on the given object.
      Parameters:
      element - the element on which to register the help id
      helpContextId - the id to use when help system is invoked

    • hasHelp

      boolean hasHelp(String helpContextId)
      Check if help is available for the given id
      Parameters:
      helpContextId - the id to use when help system is invoked
      Returns:
      true if help is available for the given id, false otherwise
      Since:
      1.5