NbEditorKit (Editor Module) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor/3 1.32.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.editor
Class NbEditorKit

java.lang.Object
  javax.swing.text.EditorKit
      javax.swing.text.DefaultEditorKit
          org.netbeans.editor.BaseKit
              org.netbeans.editor.ext.ExtKit
                  org.netbeans.modules.editor.NbEditorKit

All Implemented Interfaces:: Serializable, Cloneable

public class NbEditorKit
extends ExtKit
extends ExtKit

Java editor kit with appropriate document

See Also:: Serialized Form

Nested Class Summary

static class NbEditorKit.GenerateFoldPopupAction


class NbEditorKit.NbBuildPopupMenuAction


static class NbEditorKit.NbBuildToolTipAction


static class NbEditorKit.NbGenerateGoToPopupAction


static class NbEditorKit.NbRedoAction


class NbEditorKit.NbStopMacroRecordingAction


static class NbEditorKit.NbToggleLineNumbersAction
          Switch visibility of line numbers in editor

static class NbEditorKit.NbUndoAction


static class NbEditorKit.ToggleToolbarAction


Nested classes/interfaces inherited from class org.netbeans.editor.ext.ExtKit

ExtKit.AllCompletionShowAction, ExtKit.BuildPopupMenuAction, ExtKit.BuildToolTipAction, ExtKit.CodeSelectAction, ExtKit.CommentAction, ExtKit.CompletionShowAction, ExtKit.CompletionTooltipShowAction, ExtKit.DocumentationShowAction, ExtKit.EscapeAction, ExtKit.ExtDefaultKeyTypedAction, ExtKit.ExtDeleteCharAction, ExtKit.FindAction, ExtKit.GotoAction, ExtKit.GotoDeclarationAction, ExtKit.MatchBraceAction, ExtKit.PrefixMakerAction, ExtKit.ReplaceAction, ExtKit.ShowPopupMenuAction, ExtKit.ToggleCaseIdentifierBeginAction, ExtKit.UncommentAction

Nested classes/interfaces inherited from class org.netbeans.editor.BaseKit

BaseKit.BackwardAction, BaseKit.BeepAction, BaseKit.BeginAction, BaseKit.BeginLineAction, BaseKit.BeginWordAction, BaseKit.CompoundAction, BaseKit.CopyAction, BaseKit.CutAction, BaseKit.DefaultKeyTypedAction, BaseKit.DeleteCharAction, BaseKit.DownAction, BaseKit.EndAction, BaseKit.EndLineAction, BaseKit.EndWordAction, BaseKit.ForwardAction, BaseKit.InsertBreakAction, BaseKit.InsertContentAction, BaseKit.InsertStringAction, BaseKit.InsertTabAction, BaseKit.KitCompoundAction, BaseKit.NextWordAction, BaseKit.PageDownAction, BaseKit.PageUpAction, BaseKit.PasteAction, BaseKit.PreviousWordAction, BaseKit.ReadOnlyAction, BaseKit.RemoveTrailingSpacesAction, BaseKit.SelectAllAction, BaseKit.SelectLineAction, BaseKit.SelectWordAction, BaseKit.SplitLineAction, BaseKit.UpAction, BaseKit.WritableAction

Field Summary

static String generateFoldPopupAction
          Name of the action for generating of code folding popup menu

static String generateGoToPopupAction
          Name of the action for generating of Go To popup menu

static String SYSTEM_ACTION_CLASS_NAME_PROPERTY
          Action property that stores the name of the corresponding nb-system-action

Fields inherited from class org.netbeans.editor.ext.ExtKit

allCompletionShowAction, buildPopupMenuAction, buildToolTipAction, codeSelectAction, commentAction, completionShowAction, completionTooltipShowAction, documentationShowAction, escapeAction, findAction, gotoAction, gotoDeclarationAction, gotoHelpAction, gotoSourceAction, gotoSuperImplementationAction, matchBraceAction, replaceAction, selectionMatchBraceAction, showPopupMenuAction, toggleCaseIdentifierBeginAction, toggleToolbarAction, TRIMMED_TEXT, uncommentAction

Fields inherited from class org.netbeans.editor.BaseKit

abbrevExpandAction, abbrevResetAction, adjustCaretBottomAction, adjustCaretCenterAction, adjustCaretTopAction, adjustWindowBottomAction, adjustWindowCenterAction, adjustWindowTopAction, annotationsCyclingAction, collapseAllFoldsAction, collapseFoldAction, cutToLineBeginAction, cutToLineEndAction, DOC_REPLACE_SELECTION_PROPERTY, expandAllFoldsAction, expandFoldAction, findNextAction, findPreviousAction, findSelectionAction, firstNonWhiteAction, formatAction, generateGutterPopupAction, insertDateTimeAction, jumpListNextAction, jumpListNextComponentAction, jumpListPrevAction, jumpListPrevComponentAction, lastNonWhiteAction, lineFirstColumnAction, macroActionPrefix, MAGIC_POSITION_MAX, pasteFormatedAction, redoAction, reindentLineAction, removeLineAction, removeLineBeginAction, removeNextWordAction, removePreviousWordAction, removeSelectionAction, removeTabAction, removeTrailingSpacesAction, scrollDownAction, scrollUpAction, selectIdentifierAction, selectionFirstNonWhiteAction, selectionLastNonWhiteAction, selectionLineFirstColumnAction, selectionPageDownAction, selectionPageUpAction, selectNextParameterAction, shiftLineLeftAction, shiftLineRightAction, splitLineAction, startMacroRecordingAction, startNewLineAction, stopMacroRecordingAction, switchCaseAction, toggleHighlightSearchAction, toggleLineNumbersAction, toggleTypingModeAction, toLowerCaseAction, toUpperCaseAction, undoAction, wordMatchNextAction, wordMatchPrevAction

Fields inherited from class javax.swing.text.DefaultEditorKit

backwardAction, beepAction, beginAction, beginLineAction, beginParagraphAction, beginWordAction, copyAction, cutAction, defaultKeyTypedAction, deleteNextCharAction, deletePrevCharAction, downAction, endAction, endLineAction, EndOfLineStringProperty, endParagraphAction, endWordAction, forwardAction, insertBreakAction, insertContentAction, insertTabAction, nextWordAction, pageDownAction, pageUpAction, pasteAction, previousWordAction, readOnlyAction, selectAllAction, selectionBackwardAction, selectionBeginAction, selectionBeginLineAction, selectionBeginParagraphAction, selectionBeginWordAction, selectionDownAction, selectionEndAction, selectionEndLineAction, selectionEndParagraphAction, selectionEndWordAction, selectionForwardAction, selectionNextWordAction, selectionPreviousWordAction, selectionUpAction, selectLineAction, selectParagraphAction, selectWordAction, upAction, writableAction

Constructor Summary

NbEditorKit()


Method Summary

protected void addSystemActionMapping(String editorActionName, Class systemActionClass)


protected Action[] createActions()


Document createDefaultDocument()


protected EditorUI createEditorUI()


String getContentType()


protected void toolTipAnnotationsLock(Document doc)
          Do any locking necessary prior evaluation of tooltip annotations.

protected void toolTipAnnotationsUnlock(Document doc)
          Release any locking requested previously by #toolTipAnnotationsLock().

protected void updateActions()


Methods inherited from class org.netbeans.editor.ext.ExtKit

createCaret, createCompletion, createCompletionJavaDoc, createSyntaxSupport

Methods inherited from class org.netbeans.editor.BaseKit

actionsToMap, clone, createFormatSyntax, createFormatter, createPrintEditorUI, createPrintEditorUI, createSyntax, createTextUI, deinstall, executeDeinstallActions, executeInstallActions, getActionByName, getActions, getCustomActions, getKeymap, getKit, getMacroActions, getViewFactory, initDocument, install, mapToActions, read, translateActionNameList, write

Methods inherited from class javax.swing.text.DefaultEditorKit

read, write

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Nested Class Summary
`static class`	`NbEditorKit.GenerateFoldPopupAction`
`class`	`NbEditorKit.NbBuildPopupMenuAction`
`static class`	`NbEditorKit.NbBuildToolTipAction`
`static class`	`NbEditorKit.NbGenerateGoToPopupAction`
`static class`	`NbEditorKit.NbRedoAction`
`class`	`NbEditorKit.NbStopMacroRecordingAction`
`static class`	`NbEditorKit.NbToggleLineNumbersAction` Switch visibility of line numbers in editor
`static class`	`NbEditorKit.NbUndoAction`
`static class`	`NbEditorKit.ToggleToolbarAction`

Nested classes/interfaces inherited from class org.netbeans.editor.ext.ExtKit
ExtKit.AllCompletionShowAction, ExtKit.BuildPopupMenuAction, ExtKit.BuildToolTipAction, ExtKit.CodeSelectAction, ExtKit.CommentAction, ExtKit.CompletionShowAction, ExtKit.CompletionTooltipShowAction, ExtKit.DocumentationShowAction, ExtKit.EscapeAction, ExtKit.ExtDefaultKeyTypedAction, ExtKit.ExtDeleteCharAction, ExtKit.FindAction, ExtKit.GotoAction, ExtKit.GotoDeclarationAction, ExtKit.MatchBraceAction, ExtKit.PrefixMakerAction, ExtKit.ReplaceAction, ExtKit.ShowPopupMenuAction, ExtKit.ToggleCaseIdentifierBeginAction, ExtKit.UncommentAction

Nested classes/interfaces inherited from class org.netbeans.editor.BaseKit
BaseKit.BackwardAction, BaseKit.BeepAction, BaseKit.BeginAction, BaseKit.BeginLineAction, BaseKit.BeginWordAction, BaseKit.CompoundAction, BaseKit.CopyAction, BaseKit.CutAction, BaseKit.DefaultKeyTypedAction, BaseKit.DeleteCharAction, BaseKit.DownAction, BaseKit.EndAction, BaseKit.EndLineAction, BaseKit.EndWordAction, BaseKit.ForwardAction, BaseKit.InsertBreakAction, BaseKit.InsertContentAction, BaseKit.InsertStringAction, BaseKit.InsertTabAction, BaseKit.KitCompoundAction, BaseKit.NextWordAction, BaseKit.PageDownAction, BaseKit.PageUpAction, BaseKit.PasteAction, BaseKit.PreviousWordAction, BaseKit.ReadOnlyAction, BaseKit.RemoveTrailingSpacesAction, BaseKit.SelectAllAction, BaseKit.SelectLineAction, BaseKit.SelectWordAction, BaseKit.SplitLineAction, BaseKit.UpAction, BaseKit.WritableAction

Field Summary
`static String`	`generateFoldPopupAction` Name of the action for generating of code folding popup menu
`static String`	`generateGoToPopupAction` Name of the action for generating of Go To popup menu
`static String`	`SYSTEM_ACTION_CLASS_NAME_PROPERTY` Action property that stores the name of the corresponding nb-system-action

Fields inherited from class org.netbeans.editor.ext.ExtKit
`allCompletionShowAction, buildPopupMenuAction, buildToolTipAction, codeSelectAction, commentAction, completionShowAction, completionTooltipShowAction, documentationShowAction, escapeAction, findAction, gotoAction, gotoDeclarationAction, gotoHelpAction, gotoSourceAction, gotoSuperImplementationAction, matchBraceAction, replaceAction, selectionMatchBraceAction, showPopupMenuAction, toggleCaseIdentifierBeginAction, toggleToolbarAction, TRIMMED_TEXT, uncommentAction`

Fields inherited from class org.netbeans.editor.BaseKit
abbrevExpandAction, abbrevResetAction, adjustCaretBottomAction, adjustCaretCenterAction, adjustCaretTopAction, adjustWindowBottomAction, adjustWindowCenterAction, adjustWindowTopAction, annotationsCyclingAction, collapseAllFoldsAction, collapseFoldAction, cutToLineBeginAction, cutToLineEndAction, DOC_REPLACE_SELECTION_PROPERTY, expandAllFoldsAction, expandFoldAction, findNextAction, findPreviousAction, findSelectionAction, firstNonWhiteAction, formatAction, generateGutterPopupAction, insertDateTimeAction, jumpListNextAction, jumpListNextComponentAction, jumpListPrevAction, jumpListPrevComponentAction, lastNonWhiteAction, lineFirstColumnAction, macroActionPrefix, MAGIC_POSITION_MAX, pasteFormatedAction, redoAction, reindentLineAction, removeLineAction, removeLineBeginAction, removeNextWordAction, removePreviousWordAction, removeSelectionAction, removeTabAction, removeTrailingSpacesAction, scrollDownAction, scrollUpAction, selectIdentifierAction, selectionFirstNonWhiteAction, selectionLastNonWhiteAction, selectionLineFirstColumnAction, selectionPageDownAction, selectionPageUpAction, selectNextParameterAction, shiftLineLeftAction, shiftLineRightAction, splitLineAction, startMacroRecordingAction, startNewLineAction, stopMacroRecordingAction, switchCaseAction, toggleHighlightSearchAction, toggleLineNumbersAction, toggleTypingModeAction, toLowerCaseAction, toUpperCaseAction, undoAction, wordMatchNextAction, wordMatchPrevAction

Fields inherited from class javax.swing.text.DefaultEditorKit
backwardAction, beepAction, beginAction, beginLineAction, beginParagraphAction, beginWordAction, copyAction, cutAction, defaultKeyTypedAction, deleteNextCharAction, deletePrevCharAction, downAction, endAction, endLineAction, EndOfLineStringProperty, endParagraphAction, endWordAction, forwardAction, insertBreakAction, insertContentAction, insertTabAction, nextWordAction, pageDownAction, pageUpAction, pasteAction, previousWordAction, readOnlyAction, selectAllAction, selectionBackwardAction, selectionBeginAction, selectionBeginLineAction, selectionBeginParagraphAction, selectionBeginWordAction, selectionDownAction, selectionEndAction, selectionEndLineAction, selectionEndParagraphAction, selectionEndWordAction, selectionForwardAction, selectionNextWordAction, selectionPreviousWordAction, selectionUpAction, selectLineAction, selectParagraphAction, selectWordAction, upAction, writableAction

Constructor Summary
`NbEditorKit()`

Method Summary
`protected void`	`addSystemActionMapping(String editorActionName, Class systemActionClass)`
`protected Action[]`	`createActions()`
`Document`	`createDefaultDocument()`
`protected EditorUI`	`createEditorUI()`
`String`	`getContentType()`
`protected void`	`toolTipAnnotationsLock(Document doc)` Do any locking necessary prior evaluation of tooltip annotations.
`protected void`	`toolTipAnnotationsUnlock(Document doc)` Release any locking requested previously by `#toolTipAnnotationsLock()`.
`protected void`	`updateActions()`

Methods inherited from class org.netbeans.editor.ext.ExtKit
`createCaret, createCompletion, createCompletionJavaDoc, createSyntaxSupport`

Methods inherited from class org.netbeans.editor.BaseKit
`actionsToMap, clone, createFormatSyntax, createFormatter, createPrintEditorUI, createPrintEditorUI, createSyntax, createTextUI, deinstall, executeDeinstallActions, executeInstallActions, getActionByName, getActions, getCustomActions, getKeymap, getKit, getMacroActions, getViewFactory, initDocument, install, mapToActions, read, translateActionNameList, write`

Methods inherited from class javax.swing.text.DefaultEditorKit
`read, write`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

SYSTEM_ACTION_CLASS_NAME_PROPERTY

public static final String SYSTEM_ACTION_CLASS_NAME_PROPERTY

Action property that stores the name of the corresponding nb-system-action

See Also:: Constant Field Values

generateGoToPopupAction

public static final String generateGoToPopupAction

Name of the action for generating of Go To popup menu

See Also:: Constant Field Values

generateFoldPopupAction

public static final String generateFoldPopupAction

Name of the action for generating of code folding popup menu

See Also:: Constant Field Values

Constructor Detail

NbEditorKit

public NbEditorKit()

Method Detail

createDefaultDocument

public Document createDefaultDocument()

Overrides:: createDefaultDocument in class BaseKit

toolTipAnnotationsLock

protected void toolTipAnnotationsLock(Document doc)

Do any locking necessary prior evaluation of tooltip annotations.
This method will always be followed by #toolTipAnnotationsUnlock() by using try ... finally.
This method is called prior read locking of the document.

toolTipAnnotationsUnlock

protected void toolTipAnnotationsUnlock(Document doc)

Release any locking requested previously by #toolTipAnnotationsLock().
This method is called after read unlocking of the document.

createEditorUI

protected EditorUI createEditorUI()

Overrides:: createEditorUI in class ExtKit

createActions

protected Action[] createActions()

Overrides:: createActions in class ExtKit

addSystemActionMapping

protected void addSystemActionMapping(String editorActionName,
                                      Class systemActionClass)

updateActions

protected void updateActions()

Overrides:: updateActions in class BaseKit

getContentType

public String getContentType()

Overrides:: getContentType in class DefaultEditorKit