Text API
Official

See:
Description

Text API

org.openide.cookies
org.openide.text	NetBeans is able to integrate multiple editors for different content types and mechanically access their content.

XXX no answer for arch-overall

What is New (see all changes)?

• Jul 7 '08 Improve Line.show

  Improve Line.show to have better control over its open/visibility behavior. Previous version of Line.show mixes open and visibility behavior into one parameter. New version separates this into 2 parameters. It is possible to use any combination of these 2 parameters without need to add new constants for previous version. 2 enum types ShowOpenType and ShowVisibilityType are added.

• May 16 '08 "beforeSaveRunnable" document property

  CloneableEditorSupport.saveDocument() checks document's "beforeSaveDocument" property for a Runnable to be executed before the actual save will be done.

• Mar 25 '08 EditorKit, Document and co. are loaded on background by default

  In order to speedup, or remove the load of initialization of kit in AWT during startup, the initialization is done outside of AWT thread as much as possible. This provides new API for editor kits, one component and one system property.

• May 22 '07 Public static inner class NbDocument.Colors moved to org.openide.options.

  Class NbDocument.Colors was removed to remove dependency on org.openide.options. Runtime backward compatibility was ensured by moving into org.openide.options module which is already deprecated.

• May 22 '07 Remove public field NbDocument.COLORS

  Field NbDocument.COLORS was removed to remove dependency on org.openide.options.

• May 22 '07 Adding PrintPreferences

  Class PrintPreferences was added as replacement for original class PrintSettings.

• May 22 '07 Removing PrintSettings

  Classes PrintSettings and PrintSettingsBeanInfo were removed. Runtime backward compatibility was ensured by moving both into org.openide.options module which is already deprecated.

Use Cases

XXX no answer for arch-usecases

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?
EditorAPI	Exported	Official	.../org/openide/text/doc-files/api.html
EditorKitInitialization	Exported	Friend	In order to speedup, or remove the load of initialization of kit in AWT during startup, there is a special API that allows to ask the kit to pre-initialize. If the kit implements Callable interface from JDK, it is called in non-AWT thread. This works since version 6.18 and can be disabled by property oldInitialization.

Group of property interfaces

Interface Name	In/Out	Stability	Specified in What Document?
indentEngine	Exported	Stable	Property hold instance of IndentEngine and this indentation engine is used instead of system one.
javax.swing.text.Document.modificationListener	Exported	Friend	In order to fix issue 51872 the openide needs a way how to be notified about change of a document outside of its Document lock. DocumentListeners are always notified under the lock, so a special contract has been established (since version 5.3) by registering an instance of VetoableListener by calling putProperty ("modificationListener", listener). The NetBeans aware documents are adviced to honor this property and call the listener outside of the document lock when a modification is made. The actual contract of the call can be seen in NbLikeEditorKit.java in methods insertString and remove.
beforeSaveRunnable	Exported	Friend	Document property that allows to execute a runnable before save of a document is performed. For example an extra whitespace accumulated during typing can be removed by exploiting this property.
expectedTime	Exported	Friend	CloneableEditorSupport understands not only its Env.TIME property, but also special "expectedTime". When this one arrives, it means refresh its internal last saved time, but without any refresh. This functionality is used from DataEditorSupport when the DataObject is moved to new location and we need to adjust the time to the new file object.
oldInitialization	Exported	Under Development	As the speedup of startup done in version 6.18 is not fully compatible, there is a way to get back the original behaviour: just use this.putClientProperty("oldInitialization", Boolean.TRUE) and the whole initialization will be done in AWT thread. This is generally slower, but compatible.
org.openide.text.CloneableEditor.oldInitialization	Exported	Private	In order to measure startup improvements between AWT and non-AWT startup, we have a property dedicated to testing that can switch all editors to be opened in AWT. Just start NetBeans with -J-Dorg.openide.text.CloneableEditor.oldInitialization=true. This property may be discontiued anytime.

Implementation Details

Where are the sources for the module?

The sources for the module are in the NetBeans Mercurial repositories.

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

XXX no answer for deploy-dependencies

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