Extension SDK 10.1.2

Package oracle.javatools.editor.insight

The Code Insight package is a subset of the Editor package, and is the starting base for a code insight implementation to provide the user with code assistance features.

See:
          Description

Interface Summary
Insight The Insight interface describes the public API available for programmatically invoking code insight.
InsightData The InsightData interface is the data model that contains the Insight information generated by the InsightProvider implementation.
InsightProvider The InsightProvider interface describes the public API available for the portion of Insight responsible for looking up Insight assistance information for the user.
InsightView The InsightView interface acts as the view and controller for the Insight.
ListInsightData The ListInsightData interface contains public API routines for an InsightData model that is based on a list model (instead of say, a tree model.) The data model provides an additional method for accessing the data through a list interface.
PrototypeCellProvider The PrototypeCellProvider interface defines a way for the JList to obtain a prototype cell for the given list model.
 

Class Summary
AbstractInsight The AbstractInsight class provides some of the common functionality of all Insight implementations, such as handling the delayed timer, trapping of editor commands, displaying of the Insight window, and so on.
ListDataItem The ListDataItem can be used as an abstract starting point for data item objects stored in a ListInsightData.
ListDataItemCellRenderer The ListDataItemCellRenderer is our implementation of a ListCellRenderer for drawing the individual items that are displayed in the JList view for completion insight.
ListDataItemListModel The ListDataItemListModel is a basic implementation of an immutable ListModel which just takes an array of ListDataItem objects (or its subclasses) and can be used as the ListModel for a JList.
ListInsightView The ListInsightView class is an implementation of the InsightView to support list-type data models.
TooltipDataItem The TooltipDataItem can be used as an abstract starting point for data item objects stored in a TooltipInsightData.
TooltipDataItemCellRenderer The TooltipDataItemCellRenderer is our implementation of a ListCellRenderer for drawing the individual items that are displayed in the JList view for tooltip insight.
TooltipDataItemListModel The TooltipDataItemListModel is a basic implementation of an immutable ListModel which just takes an array of TooltipDataItem objects (or its subclasses) and can be used as the ListModel for a JList.
TooltipInsightData The TooltipInsightData interface contains public API routines for an InsightData model that is based on a list model, and is used for displaying tooltip (hint) information only.
TooltipInsightView The TooltipInsightView class is an implementation of the InsightView to support tooltip insight using a list-type data model.
 

Package oracle.javatools.editor.insight Description

The Code Insight package is a subset of the Editor package, and is the starting base for a code insight implementation to provide the user with code assistance features. This base is language-independent, and contains two separate assistance type implementations.

The first insight assistance implementation is a completion list implementation that helps the user to "complete" parts of their code. The second implementation is a parameter or tooltip implementation that displays "hints" to the user while they are coding.

For more information on what is provided by this framework, and what needs to be implemented by your own language-specific implementation, refer to the Insight interface, and AbstractInsight class as starting points.


Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.