@Deprecated
public interface InsightProvider
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:
AbstractInsight
base implementation for more info. 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.InsightData data = regularProvider.getInsightData( editor );
InsightData newData = smartProvider.updateInsightData( editor, oldData );
InsightData newData = regularProvider.updateInsightData( editor, oldData );
AbstractInsight
,
Insight
,
InsightData
,
InsightView
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.
|
InsightData getInsightData(BasicEditorPane editorPane)
editorPane
- the editor for which we want to get Insight infoInsightData updateInsightData(BasicEditorPane editorPane, InsightData lastData)
editorPane
- the editor for which we want to update the infolastData
- the last InsightData foundInsightView getInsightView()