org.netbeans.api.editor

Class EditorUtilities

java.lang.Object

org.netbeans.api.editor.EditorUtilities

public final class EditorUtilities
extends Object

Various utility methods related to editor.

Since:

1.13

Field Summary

Fields

Modifier and Type	Field and Description
static String	CARET_OVERWRITE_MODE_PROPERTY Client property of editor component which determines whether caret is currently in overwrite mode (Boolean.TRUE) or insert mode (Boolean.FALSE or null).

Method Summary

Modifier and Type	Method and Description
static void	addCaretUndoableEdit(Document doc, Caret caret) Add an undoable edit describing current state of caret(s) during document's atomic section.
static Action	getAction(EditorKit editorKit, String actionName) Find an action with the given name in the editor kit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CARET_OVERWRITE_MODE_PROPERTY

public static final String CARET_OVERWRITE_MODE_PROPERTY

Client property of editor component which determines whether caret is currently in overwrite mode (Boolean.TRUE) or insert mode (Boolean.FALSE or null).
It's modified by appropriate editor actions.

Since:

2.6

See Also:

Constant Field Values

Method Detail

getAction

public static Action getAction(EditorKit editorKit,
                               String actionName)

Find an action with the given name in the editor kit.

Parameters:

editorKit - non-null editor kit in which search is performed.

actionName - non-null action name to search for.

Returns:

action instance with the given name or null if action not found.

addCaretUndoableEdit

public static void addCaretUndoableEdit(Document doc,
                                        Caret caret)

Add an undoable edit describing current state of caret(s) during document's atomic section.
This method is typically called at the beginning of the atomic section over the document so that a subsequent undo would restore original caret offsets that were not yet modified by the actual changes performed during the atomic section.
The method may also be called at the end of the atomic section in case the atomic section performed explicit caret movements.
The created undoable edit will be added to document's compound undoable edit created for the atomic section. That edit will be fired by the document to an undo manager's listener upon completion of the atomic section. Therefore the document should adhere to CustomUndoDocument otherwise the method would do nothing.

Parameters:

doc - document to which the created undoable edit will be added. Null may be passed then the method has no effect.

caret - non-null caret which state should be stored

Throws:

IllegalStateException - if this method is called outside of an atomic section.

Since:

2.11

See Also:

CustomUndoDocument, AtomicLockDocument