Editor Indentation
Under Development

See:
Description

Editor Indentation

org.netbeans.modules.editor.indent.api
org.netbeans.modules.editor.indent.spi

Editor Indentation module defines EditorIndentationAPI providing indentation and reformatting services to the clients.
It also contains SPI allowing the modules to register language-specific indenters and formatters into MimeLookup through XML layers.

What is New (see all changes)?

• Aug 13 '08 Adding org.netbeans.modules.editor.indent.spi.CodeStylePreferences

  The new CodeStylePreferences class was added in order to unify access to editor formatting/indentation preferences (ie. code style).

• Oct 29 '07 API/SPI repackaged to remove it from the official NetBeans API packages

  The API/SPI classes were moved from the official org.netbeans.api and org.netbeans.spi packages and the stability level of the API was set to devel to indicate that the module and its API is still under development. The major version of the module was set to 2 to mark the incompatible change.

  There was not enough time in the Netbeans 6.0 release timeframe for us to fully stabilize the APIs offered by this module. Therefore we decided to release the development version of the APIs and do a full API review in the next release cycle.

• Oct 13 '07 Added several methods to Context class

  Added Context.lineIndent(), Context.lineStartOffset(), Context.caretOffset(), Context.setCaretOffset() and Context.indentRegions() methods (including Context.Region class). Fixed Context.modifyIndent() signature and implementation.

• Jul 17 '07 Added Context.mimePath()

  Added Context.mimePath() method.

• Jun 14 '07 editor/indent module was created.

  The module was created.

Use Cases

API Usecases

Fix indentation of a single or multiple lines of a document.

Altghough there are formatting actions already there may be clients wishing to explicitly fix indentation of e.g. a newly inserted code into a Swing document.

The same code is used after inserting a newline into a document.

The Indent is an entry point for performing reindentation. The following code should be used by clients:

Indent indent = Indent.get(doc);
indent.lock();
try {
    doc.atomicLock();
    try {
        indent.reindent(startOffset, endOffset);
    } finally {
        doc.atomicUnlock();
    }
} finally {
    indent.unlock();
}

Code beautification of a selected area of a document.

Code beautification should not only fix line indentation but it may also perform extra changes to code according to formatting rules. For example add newlines or additional whitespace or add/remove extra braces etc.

The Reformat class should be used:

Reformat reformat = Reformat.get(doc);
reformat.lock();
try {
    doc.atomicLock();
    try {
        reformat.reformat(startOffset, endOffset);
    } finally {
        doc.atomicUnlock();
    }
} finally {
    reformat.unlock();
}

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?
EditorIndentationAPI	Exported	Under Development

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?

Nothing.

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