Overview (Text API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.openide.text 6.16

PREV NEXT

FRAMES NO FRAMES

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.

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

What is New (see all changes)?

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.
Mar 5 '07 Adding Line.SHOW_REUSE and Line.SHOW_REUSE_NEW constants for Line.show method

The Line.show() method accepts show mode constant, that influences the way the Line is displayed on the request. These additional constants provide new modes for opening the line in a shared editor window that can be replaced by subsequent calls of Line.show(SHOW_REUSE) on Lines from different Document. This is useful for quick source browsing without cluttering the UI with too many opened editors.

Use Cases

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

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. `DocumentListener`s 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`.

Implementation Details

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