Skip navigation links


This document lists changes made to the Editor Settings Storage API.

Index of APIs

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

All changes by date

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: > 1.20

Changes by affected class

Details of all changes by API and date

Uncategorized changes

Adding Color definitions in Color Schema XML-s

Nov 24 '19; API spec. version: 1.59; made by: lkishalmi; issues: NETBEANS-3440

Adding new element <colordef name="" color="" /> to fontcolors XML schema, which makes possible custom string to color mapping. It allows to define a color palette, then lookup colors from that palette, making porting color schemas easier.

Module split

Mar 6 '15; API spec. version: 1.49; affected top-level classes:; made by: sdedic
Basic infrastructure for settings separated to a library.

Implement profiles for annotations coloring

Sep 17 '13; API spec. version: 1.43; made by: mkristofic; issues: #231735

EditorSettings is extended to handle saving and loading annotations colorings for any profile.

  [sigtest]   "E5.2 - Adding abstract methods" : method public abstract void,java.util.Map)
  [sigtest]   "E5.2 - Adding abstract methods" : method public abstract java.util.Map
  [sigtest]   "E5.2 - Adding abstract methods" : method public abstract java.util.Map

Detect preferences override and support inheritance

Feb 21 '13; API spec. version: 1.38; affected top-level classes:; made by: sdedic; issues: #226111

OverridePreferences can be used to detect whether the setting is defined for the specific MIME type, or inherited from default ('all languages') settings.

During options editing, MemoryPreferences can be used to create Preferences object, that propagates changes to its (persistent) delegate upon flush().


Jul 16 '09; API spec. version: 1.21; made by: vstejskal

Adding EditorSettings.PROP_MIME_TYPES to notify about changes in mimetypes returned from EditorSettings.getAllMimeTypes() and EditorSettings.getMimeTypes().

SPI refinements

Feb 14 '08; API spec. version: 1.17; made by: vstejskal

The createReader and createWriter methods of StorageDescription now have second parameter, which is a mime path string of the file being read or writter respectively.

The StorageReader.getMimePath method was added alongside with a new constructor that takse two parameters FileObject that the reader is dealing with and the mime path String of that file.

Added StorageSupport.stringToKeyStrokes and keyStrokesToString

Dec 6 '07; API spec. version: 1.16; made by: vstejskal

Two methods were added for the benefit of keymaps and macros storage implementations. The added methods are - StorageSupport.stringToKeyStrokes and StorageSupport.keyStrokesToString.

Moving code templates storage to editor/codetemplates

Nov 28 '07; API spec. version: 1.12; made by: vstejskal

The classes related to the code templates storage were moved to the editor/codetemplates module, which is no using the new SPI to plugin its own storage files reader/writer.

#90403 - phase 1

Mar 21 '07; API spec. version: 1.10; made by: vstejskal

The phase 1 of the editor settings enhancements, please see issue 90403 for details. Briefly, the changes involve introducing a special folder for each setting type, profiles are always stored in their own folder, modules are allowed to register multiple settings files, platform specific settings, the use of 'text/base' for all-editors settings has been deprecated in favor of the hierarchy root (ie. 'Editors' folder), etc.

The changes are documented in the Architecture Description document and marked with the module version.

Adding EditorSettings.getAllMimeTypes()

Feb 5 '07; API spec. version: 1.9; made by: vstejskal

Adding EditorSettings.getAllMimeTypes() method, which lists all top-level mime types registered in MimeLookup.

Deprecating several methods and attributes in EditorSettings

Dec 30 '06; API spec. version: 1.8; made by: vstejskal

The getDefaultFontColors, getDefaultFontColorDefaults and setDefaultFontColors methods in the EditorSettings classe were deprecated in favor of using EditorSettings.getFontColorSettings(String[]) with an empty mime path, which is the standard way of getting defaults for all document types.

The PROP_DEFAULT_FONT_COLORS and PROP_EDITOR_FONT_COLORS should have never been made public. They are only used internally.

OpenIDE-Module-Provides: org.netbeans.api.editor.settings.implementation

Nov 13 '06; API spec. version: 1.7; made by: vstejskal

The module is now 'eager' and it provides the org.netbeans.api.editor.settings.implementation token required by the editor/settings module. Also the API was properly marked as for-friends-only.