oracle.javatools.editor.insight

Interface InsightProvider

All Known Subinterfaces:

SmartInsightProvider

Deprecated.

use oracle.ide.insight.InsightProvider in insight module

@Deprecated
public interface InsightProvider

The InsightProvider interface describes the public API available for the portion of Insight responsible for looking up Insight assistance information for the user. The search is based on the current caret position in the editor, the data of the document near the caret (and the document type.)

Results of the search for Insight information is returned by an InsightData instance, and displayed within an InsightView (also created by this class.) Currently, this implementation is limited to a single view for a given provider.

This same interface is used for "smart" InsightProvider implementations that provide a filtered or smarter data view based on the editor's context (or whatever additional criteria an implementation may choose to use.) Implementations that provide a "smart" InsightProvider must fulfill the following requirements:

• The "smart" InsightProvider instance should be returned by the Insight instance through createSmartInsightProvider(). See the AbstractInsight base implementation for more info.
• The "smart" InsightProvider instance only applies to COMPLETION_TYPE instances, and is invoked typically by means of a separate accelerator. For example, regular completion insight may be invoked by Ctrl-Space while smart completion insight may be invoked by Ctrl-Alt-Space.
• The InsightView returned by either the regular or "smart" InsightProvider must be capable of supporting the InsightData returned by either provider implementation.
• The base AbstractInsight may toggle between the updateInsightData(...) methods of the regular and "smart" InsightProvider's if the user alternately hits the two accelerators. Implementations must be able to support such data toggling.

As an example of the data toggling mentioned above, the user may perform the following sequence of events:

• User hits Ctrl-Space to invoke code insight:

  InsightData data = regularProvider.getInsightData( editor );

• With code insight still up, user hits Ctrl-Alt-Space to switch to smart code insight:

  InsightData newData = smartProvider.updateInsightData( editor, oldData );

• While code insight is still up, user hits Ctrl-Space to switch back to regular code insight:

  InsightData newData = regularProvider.updateInsightData( editor, oldData );

See Also:

AbstractInsight, Insight, InsightData, InsightView

Method Summary

Modifier and Type	Method and Description
InsightData	getInsightData(BasicEditorPane editorPane) Deprecated. Performs a search for insight information using the document and caret position in the given editor pane.
InsightView	getInsightView() Deprecated. Fetches an InsightView suitable for displaying data represented by an InsightData instance created by this provider.
InsightData	updateInsightData(BasicEditorPane editorPane, InsightData lastData) Deprecated. Requests an update of Insight information following a document or caret change in the editor.

Method Detail

getInsightData

InsightData getInsightData(BasicEditorPane editorPane)

Deprecated.

Performs a search for insight information using the document and caret position in the given editor pane. If there is no insight information available, null should be returned.

Parameters:

editorPane - the editor for which we want to get Insight info

Returns:

the InsightData instance if data is found, or null if there is no Insight information available

updateInsightData

InsightData updateInsightData(BasicEditorPane editorPane,
                              InsightData lastData)

Deprecated.

Requests an update of Insight information following a document or caret change in the editor. The Insight data from the last search or update is passed in lastData. If there is no insight information (maybe caret moved to different position), then null should be returned.

Parameters:

editorPane - the editor for which we want to update the info

lastData - the last InsightData found

Returns:

the InsightData instance of updated data, or null if there is no more Insight info available

getInsightView

InsightView getInsightView()

Deprecated.

Fetches an InsightView suitable for displaying data represented by an InsightData instance created by this provider.

Returns:

the InsightView which can be used for display Insight data