Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

SWT LPEX
v3.0.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.lpex.alef
Interface LpexLanguageHelp

public interface LpexLanguageHelp

Interface LpexLanguageHelp defines a language-sensitive help (LSH) provider for LpexSourceViewer, or an editor using it. Create a class that implements this interface, and register an instance of it with the text editor of your LPEX-based solution plug-in, whenever its document parser is one for which you wish to provide LSH. When notified of a help request, determine the appropriate help panel to be displayed. This help panel is usually located in a separate language-documentation plug-in installed in the workbench.

LpexCommonParser provides a few basic services for the implementation of language-sensitive help.

See Also:

LpexAbstractTextEditor.setLanguageHelp(com.ibm.lpex.alef.LpexLanguageHelp), LpexSourceViewer.setLanguageHelp(com.ibm.lpex.alef.LpexLanguageHelp), Language sensitive help (LSH)

Method Summary

String

getHelpPage(LpexView lpexView) This method is invoked when a language-sensitive help request is received in the LpexSourceViewer.

Method Detail

getHelpPage

public String getHelpPage(LpexView lpexView)

This method is invoked when a language-sensitive help request is received in the LpexSourceViewer. Return the fully-qualified help panel to be displayed. This may be the appropriate documentation for the current token, or a general help topic (such as the language manual's table of contents) if no suitable language element can be determined.

Parameters:

lpexView - the view of the editor document that help is asked for

Returns:

the appropriate help panel, for example "/com.ibm.etools.iseries.cbl400.doc/html/evfeb5ls05.htm"