Editor Module
Under Development

The editor functionality are mainly implementations of the Swing Text package APIs plus extension features such as Syntax Coloring, Code Completion, Word Matching, Abbreviations or Macros.

See:
Description

Editor Module

org.netbeans.modules.editor
org.netbeans.modules.editor.options

The editor functionality are mainly implementations of the Swing Text package APIs plus extension features such as Syntax Coloring, Code Completion, Word Matching, Abbreviations or Macros.

The editor consists of a library part (located under editor/lib and described in a separate arch document) and the module part (under src subfolder) that depends on NetBeans APIs specified in this document.

What is New (see all changes)?

• Jun 4 '08 Deprecating old settings API

  The old settings API (org.netbeans.modules.editor.options.BaseOptions & co.) has been deprecated and moved to editor.deprecated.pre61settings module.

  The exact API changes are listed in the sigtest report below.

  SignatureTest report
  Base version: 1.39.0
  Tested version: 1.41.0
  Check mode: src [throws normalized]
  Constant checking: on
  
  
  Missing Classes
  ---------------
  
  org.netbeans.modules.editor.NbEditorSettingsInitializer
  org.netbeans.modules.editor.options.AbbrevInputPanel
  org.netbeans.modules.editor.options.AbbrevsEditor
  org.netbeans.modules.editor.options.AbbrevsEditorPanel
  org.netbeans.modules.editor.options.AbbrevsMIMEOptionFile
  org.netbeans.modules.editor.options.AbbrevsMIMEProcessor
  org.netbeans.modules.editor.options.AllOptions
  org.netbeans.modules.editor.options.AllOptionsBeanInfo
  org.netbeans.modules.editor.options.AllOptionsFolder
  org.netbeans.modules.editor.options.AllOptionsFolderBeanInfo
  org.netbeans.modules.editor.options.AllOptionsNode
  org.netbeans.modules.editor.options.BaseOptions
  org.netbeans.modules.editor.options.BaseOptionsBeanInfo
  org.netbeans.modules.editor.options.BaseOptionsBeanInfo$CaretTypeEditor
  org.netbeans.modules.editor.options.BasePrintOptions
  org.netbeans.modules.editor.options.BasePrintOptionsBeanInfo
  org.netbeans.modules.editor.options.ColoringArrayEditor
  org.netbeans.modules.editor.options.ColoringArrayEditorPanel
  org.netbeans.modules.editor.options.ColoringBean
  org.netbeans.modules.editor.options.ColoringBeanBeanInfo
  org.netbeans.modules.editor.options.ColoringEditor
  org.netbeans.modules.editor.options.ColoringEditorPanel
  org.netbeans.modules.editor.options.FontsColorsMIMEOptionFile
  org.netbeans.modules.editor.options.FontsColorsMIMEProcessor
  org.netbeans.modules.editor.options.InstalledOptionsFolder
  org.netbeans.modules.editor.options.KeyBindingsEditor
  org.netbeans.modules.editor.options.KeyBindingsEditorPanel
  org.netbeans.modules.editor.options.KeyBindingsMIMEOptionFile
  org.netbeans.modules.editor.options.KeyBindingsMIMEProcessor
  org.netbeans.modules.editor.options.MIMEOptionFile
  org.netbeans.modules.editor.options.MIMEOptionFolder
  org.netbeans.modules.editor.options.MIMEOptionNode
  org.netbeans.modules.editor.options.MIMEProcessor
  org.netbeans.modules.editor.options.MacroInputPanel
  org.netbeans.modules.editor.options.MacrosEditor
  org.netbeans.modules.editor.options.MacrosEditorPanel
  org.netbeans.modules.editor.options.MacrosMIMEOptionFile
  org.netbeans.modules.editor.options.MacrosMIMEProcessor
  org.netbeans.modules.editor.options.MultiPropertyFolder
  org.netbeans.modules.editor.options.OptionSupport
  org.netbeans.modules.editor.options.OptionUtilities
  org.netbeans.modules.editor.options.PopupMultiPropertyFolder
  org.netbeans.modules.editor.options.PropertiesMIMEOptionFile
  org.netbeans.modules.editor.options.PropertiesMIMEProcessor
  org.netbeans.modules.editor.options.ScrollInsetsCustomEditor
  org.netbeans.modules.editor.options.ScrollInsetsEditor
  
  Missing Superclasses or Superinterfaces
  ---------------------------------------
  
  org.netbeans.modules.editor.IndentEngineFormatter:          interface java.util.EventListener
  org.netbeans.modules.editor.IndentEngineFormatter:          interface org.netbeans.editor.SettingsChangeListener
  org.netbeans.modules.editor.NbEditorDocument:               interface java.util.EventListener
  org.netbeans.modules.editor.NbEditorDocument:               interface org.netbeans.editor.SettingsChangeListener
  org.netbeans.modules.editor.NbEditorUI: interface org.netbeans.editor.SettingsChangeListener
  org.netbeans.modules.editor.NbEditorUI: superclass org.netbeans.editor.ext.ExtEditorUI
  
  Missing Methods
  ---------------
  
  org.netbeans.modules.editor.IndentEngineFormatter:          method public void org.netbeans.editor.Formatter.settingsChange(org.netbeans.editor.SettingsChangeEvent)
  org.netbeans.modules.editor.NbEditorDocument:               method public void org.netbeans.modules.editor.NbEditorDocument.settingsChange(org.netbeans.editor.SettingsChangeEvent)
  org.netbeans.modules.editor.NbEditorKit:method public java.util.List org.netbeans.editor.BaseKit.translateActionNameList(java.util.List)
  org.netbeans.modules.editor.NbEditorKit:method public org.netbeans.editor.ext.Completion org.netbeans.editor.ext.ExtKit.createCompletion(org.netbeans.editor.ext.ExtEditorUI)
  org.netbeans.modules.editor.NbEditorKit:method public org.netbeans.editor.ext.CompletionJavaDoc org.netbeans.editor.ext.ExtKit.createCompletionJavaDoc(org.netbeans.editor.ext.ExtEditorUI)
  org.netbeans.modules.editor.NbEditorKit$GenerateFoldPopupAction:                method protected void org.netbeans.editor.BaseAction.settingsChange(org.netbeans.editor.SettingsChangeEvent,java.lang.Class)
  org.netbeans.modules.editor.NbEditorKit$NbBuildPopupMenuAction:                 method protected void org.netbeans.editor.BaseAction.settingsChange(org.netbeans.editor.SettingsChangeEvent,java.lang.Class)
  org.netbeans.modules.editor.NbEditorKit$NbBuildToolTipAction:                   method protected void org.netbeans.editor.BaseAction.settingsChange(org.netbeans.editor.SettingsChangeEvent,java.lang.Class)
  org.netbeans.modules.editor.NbEditorKit$NbGenerateGoToPopupAction:              method protected void org.netbeans.editor.BaseAction.settingsChange(org.netbeans.editor.SettingsChangeEvent,java.lang.Class)
  org.netbeans.modules.editor.NbEditorKit$NbRedoAction:       method protected void org.netbeans.editor.BaseAction.settingsChange(org.netbeans.editor.SettingsChangeEvent,java.lang.Class)
  org.netbeans.modules.editor.NbEditorKit$NbStopMacroRecordingAction:             method protected void org.netbeans.editor.BaseAction.settingsChange(org.netbeans.editor.SettingsChangeEvent,java.lang.Class)
  org.netbeans.modules.editor.NbEditorKit$NbToggleLineNumbersAction:              method protected void org.netbeans.editor.BaseAction.settingsChange(org.netbeans.editor.SettingsChangeEvent,java.lang.Class)
  org.netbeans.modules.editor.NbEditorKit$NbUndoAction:       method protected void org.netbeans.editor.BaseAction.settingsChange(org.netbeans.editor.SettingsChangeEvent,java.lang.Class)
  org.netbeans.modules.editor.NbEditorKit$ToggleToolbarAction:method protected void org.netbeans.editor.BaseAction.settingsChange(org.netbeans.editor.SettingsChangeEvent,java.lang.Class)
  org.netbeans.modules.editor.NbEditorUI: method public org.netbeans.editor.ext.Completion org.netbeans.editor.ext.ExtEditorUI.getCompletion()
  org.netbeans.modules.editor.NbEditorUI: method public org.netbeans.editor.ext.CompletionJavaDoc org.netbeans.editor.ext.ExtEditorUI.getCompletionJavaDoc()
  org.netbeans.modules.editor.NbEditorUI: method public void org.netbeans.editor.EditorUI.settingsChange(org.netbeans.editor.SettingsChangeEvent)
  
  Added Superclasses or Superinterfaces
  -------------------------------------
  
  org.netbeans.modules.editor.NbEditorUI: superclass org.netbeans.editor.EditorUI
  
  Added Constructors
  ------------------
  
  org.netbeans.modules.editor.NbEditorDocument:               constructor public org.netbeans.modules.editor.NbEditorDocument.NbEditorDocument(java.lang.String)
  
  Added Methods
  -------------
  
  org.netbeans.modules.editor.IndentEngineFormatter:          method public static org.netbeans.editor.Formatter org.netbeans.editor.Formatter.getFormatter(java.lang.String)
  org.netbeans.modules.editor.NbEditorKit:method public java.util.List<javax.swing.Action> org.netbeans.editor.BaseKit.translateActionNameList(java.util.List<java.lang.String>)
  

• May 26 '08 Deprecating kit class related API in NbEditorDocument

  The use of editor kit implementation class for identifying the type of a document has been deprecated in favor of mime types and MimeLookup. This change deprecates API methods and construction in BaseDocument that accept editor kit implementation class and adds their equivalents accepting EditorKit.

  Deprecated: NbEditorDocument(Class)

  Added: NbEditorDocument(EditorKit)

• May 21 '08 Editor Actions can be supplied in 'Actions' folder

  The editor actions (ie. actions that are installed in JEditorPanes for Netbeans editors) can now be registered in XML layers under the Actions subfolder. For example adding an action to the java editor can be achieved by adding .instance file to Editors/text/x-java/Actions folder.

• Jun 16 '07 Change of attribute name for SideBar instances to location

  The position of SideBar instances (East etc.) used to be given by the position attribute. Since that clashes with folder ordering, this attribute was deprecated in favor of location. The old attribute is still read as a backup.

• Feb 28 '07 Deprecating Editors/text/base/Toolbars/Default

  The Editors/text/base/Toolbars/Default folder has been deprecated in favor of Editors/Toolbars/Default. The artificial mime type text/base should not be used for registering toolbar actions that apply to all editors anymore, instead use the root of the folders hierarchy.

Use Cases

No answer

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
EditorModuleAPI	Exported	Under Development	Editor defines APIs and SPIs both by Providing java classes in public packages for further reuse. Most of the classes were created spontaneously (several years ago) without fulfilling of the rules imposed on APIs and SPIs at the present time. There is an ongoing work to revisit the existing classes and create stable APIs and SPIs (and possibly extract functionality into a submodule where appropriate). However this is a long-term task spanning several promotions. Being sensitive to content of certain directories in xml layer.

Group of property interfaces

Interface Name	In/Out	Stability	Specified in What Document?
DefaultEditorKit.EndOfLineStringProperty	Exported	Stable	Document property containing line separator that was used when the document content was loaded from a java.io.Reader by an EditorKit.read().
line-limit	Exported	Private	Document property that determines the number of characters in the longest line determined during the document loading from a reader by the editor kit.

Implementation Details

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

Nothing.

Read more about the implementation in the answers to architecture questions.