org.netbeans.editor

Interface AtomicLockDocument

All Superinterfaces:

Document

All Known Implementing Classes:

BaseDocument, GuardedDocument

Deprecated.

Use AtomicLockDocument

@Deprecated
public interface AtomicLockDocument
extends Document

Document that supports atomic locking allows for transactional modifications. The document is write-locked during the whole atomic operation. All the operations since the begining of the atomic operation can be undone by using atomicUndo(). Typical scenario of the operation is the following:

   doc.atomicLock();
   try {
     ...
     modification1
     modification2
     ...
   } catch (BadLocationException e) {
     // something went wrong - undo till begining
     doc.atomicUndo();
   } finally {
     doc.atomicUnlock();
   }
   

The external clients can watch for atomic operations by registering an listener through AtomicLockDocument.addAtomicLockListener(AtomicLockListener)

Field Summary

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Method Summary

Modifier and Type	Method and Description
void	addAtomicLockListener(AtomicLockListener l) Deprecated.
void	atomicLock() Deprecated.
void	atomicUndo() Deprecated.
void	atomicUnlock() Deprecated.
void	removeAtomicLockListener(AtomicLockListener l) Deprecated.

Methods inherited from interface javax.swing.text.Document

addDocumentListener, addUndoableEditListener, createPosition, getDefaultRootElement, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeDocumentListener, removeUndoableEditListener, render

Method Detail

atomicLock

void atomicLock()

Deprecated.

atomicUnlock

void atomicUnlock()

Deprecated.

atomicUndo

void atomicUndo()

Deprecated.

addAtomicLockListener

void addAtomicLockListener(AtomicLockListener l)

Deprecated.

removeAtomicLockListener

void removeAtomicLockListener(AtomicLockListener l)

Deprecated.