Overview (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 NEXT

FRAMES NO FRAMES

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

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)?

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.
Feb 26 '07 Moving CustomizableSideBar and CustomizableSideBarClass2LayerFolder to a private package

The CustomizableSideBar and CustomizableSideBarClass2LayerFolder classes were accidentaly exposed in an API visible package. We moved them to a private package, because they have no API use. They implement support for editor side bars, which can be registered using the SideBar subfolders in MimeLookup.
Feb 19 '07 Moving PopupActions and PopupInitializer to a private package

The PopupActions and PopupInitializer classes were accidentaly exposed in an API visible package. We moved them to a private package, because they have no API use. They implement support for editor popup menu, which can be registered using the Popup subfolders in MimeLookup.
Feb 16 '07 Adding NbEditorUtilities.getMimeType(JTextComponent)

Adding NbEditorUtilities.getMimeType(JTextComponent) as a standard way of determining a mime type of a Netbeans document loaded in JTextComponent. It complements the NbEditorUtilities.getMimeType(Document) method.
Jan 16 '07 Deprecating AllOptionsFolder.loadMimeOption methods

Deprecating AllOptionsFolder.loadMimeOption(Class kitClass) and AllOptionsFolder.loadMimeOption(Class kitClass, boolean processOldTypeOption). There is no reason anybody should need to call these methods. MimeLookup should be used for accessing editor settings including BaseOptions.

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.