Package org.netbeans.editor.ext

Completion Design View

See:
Description

Interface Summary

DataAccessor	DataAccessor for Code Completion DB files
ExtSyntaxSupport.DeclarationTokenProcessor	Token processor extended to get declaration position of the given variable.
ExtSyntaxSupport.VariableMapTokenProcessor
FormatLayer	Formatting layer that can be added to BaseFormatter to format the tokens.
FormatTokenPosition	Position consisting of the token-item and the offset inside it.

Class Summary

AbstractFormatLayer	Abstract formatting layer offers the support for naming the layer and creation of an format-support.
CharacterArrayIterator	Character-iterator that operates on the array of characters.
ExtCaret	Extended caret implementation
ExtFinderFactory	Various finders are located here.
ExtFinderFactory.LineBlocksFinder	Finder that collects the whole lines and calls the lineFound() method that can do a local find.
ExtFinderFactory.LineBwdFinder	Finder that collects the whole lines and calls the lineFound() method that can do a local find.
ExtFinderFactory.LineFwdFinder	Finder that collects the whole lines and calls the lineFound() method that can do a local find.
ExtFormatSupport	Extended format-support offers comment-token support, token-and-text operations and other support.
ExtFormatter	Deprecated. Please use Editor Indentation API instead, for details see Editor Indentation.
ExtFormatter.Simple	Simple formatter
ExtKit	Extended kit offering advanced functionality
ExtKit.AllCompletionShowAction	Deprecated. Please use Editor Code Completion API instead, for details see Editor Code Completion.
ExtKit.BuildPopupMenuAction	Called before the popup menu is shown to possibly rebuild the popup menu.
ExtKit.BuildToolTipAction
ExtKit.CodeSelectAction	Deprecated. this action is deprecated and will be removed in future releases.
ExtKit.CommentAction
ExtKit.CompletionShowAction	Deprecated. Please use Editor Code Completion API instead, for details see Editor Code Completion.
ExtKit.CompletionTooltipShowAction	Deprecated. Please use Editor Code Completion API instead, for details see Editor Code Completion.
ExtKit.DocumentationShowAction	Deprecated. Please use Editor Code Completion API instead, for details see Editor Code Completion.
ExtKit.EscapeAction	Executed when the Escape key is pressed.
ExtKit.ExtDefaultKeyTypedAction
ExtKit.ExtDeleteCharAction
ExtKit.FindAction	Deprecated. Without any replacement.
ExtKit.GotoAction
ExtKit.GotoDeclarationAction	Action to go to the declaration of the variable under the caret.
ExtKit.MatchBraceAction	Deprecated. Please use Braces Matching SPI instead, for details see Editor Braces Matching.
ExtKit.PrefixMakerAction	Prefix maker adds the prefix before the identifier under cursor.
ExtKit.ReplaceAction
ExtKit.ShowPopupMenuAction	Show the popup menu.
ExtKit.ToggleCaseIdentifierBeginAction
ExtKit.ToggleCommentAction
ExtKit.UncommentAction
ExtSyntaxSupport	Support methods for syntax analyzes
FileAccessor	DataAccessor for Code Completion DB files via RandomAccessFile implementation
FileStorage	Management of storage of the data for the java completion.
FindDialogPanel	Deprecated. Without any replacement.
FindDialogSupport	Deprecated. Without any replacement.
FormatSupport	Format support presents a set of operations over the format-writer that is specific for the given set of formatting layers.
FormatWriter	Formatting writter accepts the input-text, formats it and writes the output to the underlying writer.
GotoDialogPanel	GotoDialogPanel is an UI object for entering line numbers to move caret to.
GotoDialogSupport	Support for displaying goto dialog
KeyEventBlocker
KeywordMatchGenerator	Generator of code used for matching the keywords or more generally some group of words.
MultiSyntax	Composition of several syntaxes together.
MultiSyntax.MultiStateInfo	Class that can contain any number of the additional state infos from other syntaxes.
StringCache	Cache holding the most commonly used strings.
ToolTipSupport	Support for editor tooltips.

Package org.netbeans.editor.ext Description

Completion Design View

Status: designing...

Entry Point Handlers

User types a character ("UT") :position, character

UT -> AWT/Swing -> kit.ExtDefaultKeyAction
  lockDocument
  detachCompletionDocumentHandler
  detachCompletionCaretHandler
  updateDocument
  switch lexsupport.codeCompletion
    cc.autoShow
    cc.refresh
    cc.hide
  attachCompletionCaretHandler
  attachCompletionDocumentHandler
  unlockDocument

User moves caret ("UM") (navigation keys or mouse click) :position

UM -> AWT/Swing -> cc.CaretListener
  cc.cancel()

User invokes code assistent ("UC") :position

UC -> AWT/Swing -> kit.AssistantAction
  cc.show

User invokes kill assistant action

UC -> AWT/Swing -> kit.AssistantAction
  cc.hide

User invokes select assistant action

UC -> AWT/Swing -> kit.AssistantAction
  cc.hide
  cc.perform  ??? [order is pending]

Module modifies document ("MM") :documentEvent

MM -> unknown thread -> cc.DocumentListener
  cc.refresh

Completion API

+ Completion:
  + autoShow(position, character) instruct completion to open sometimes
  + show(position, character) instruct completion to open in limited time
  + refresh(position, character) if open then update content
  + refresh(documentEvent) if open then update content
  + hide() hide view

+ CompletionEnvironment implements DocumentListener, CaretListener
  disableDocumentListener
  enableDocumentListener
  disableCaretListener
  enableCaretListener