oracle.ide.ceditor

Interface CodeEditorHelpableProvider

public interface CodeEditorHelpableProvider

Provide language specific help info for the code editor and its contents.

Register via the helpable-provider hook in ceditor.

Method Summary

Methods

Modifier and Type	Method and Description
HelpInfo	getHelpInfo(CodeEditor codeEditor, int offset) Get help for the give code editor and offset.
boolean	hasHelpInfo(CodeEditor codeEditor, int offset) Companion to getHelpInfo.

Method Detail

getHelpInfo

HelpInfo getHelpInfo(CodeEditor codeEditor,
                   int offset)

Get help for the give code editor and offset.

Parameters:

codeEditor - the code editor to find help

offset - the offset at which to get help for.

Returns:

a HelpInfo for the offset, or null

hasHelpInfo

boolean hasHelpInfo(CodeEditor codeEditor,
                  int offset)

Companion to getHelpInfo. This method returns only whether getHelpOnfo may possibly return a value. It must return quickly as it may be called as part of a controller update.

Parameters:

codeEditor - the code editor to find help

offset - the offset at which to get help for.

Returns:

true if getHelpInfo potentially has a result.