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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HELP_CONTEXT_ID

Method Summary

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

Field Detail

HELP_CONTEXT_ID

static final java.lang.String HELP_CONTEXT_ID

See Also:

Constant Field Values

Method Detail

displayHelp

void displayHelp(java.lang.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(java.lang.Object element,
             java.lang.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