AtomicLockDocument (Editor Library) - NetBeans API Javadoc (Current Development Version)

org.netbeans.editor
Interface AtomicLockDocument

All Superinterfaces:

Document

All Known Implementing Classes:

BaseDocument, GuardedDocument

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
   addAtomicLockListener(AtomicLockListener)












Field Summary


 


Fields inherited from interface javax.swing.text.Document


StreamDescriptionProperty, TitleProperty


 






Method Summary



 void
addAtomicLockListener(AtomicLockListener l)



           



 void
atomicLock()



           



 void
atomicUndo()



           



 void
atomicUnlock()



           



 void
removeAtomicLockListener(AtomicLockListener l)



           


 


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()











atomicUnlock
void atomicUnlock()











atomicUndo
void atomicUndo()











addAtomicLockListener
void addAtomicLockListener(AtomicLockListener l)











removeAtomicLockListener
void removeAtomicLockListener(AtomicLockListener l)




















  

  
    Overview 
  
    Package 
  
  Class 
  
    Use 
  
    Tree 
  
    Deprecated 
  
    Index 
  
    Help 
  



org.netbeans.modules.editor.lib/1 1.14.0 3





 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 







  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD






Built on May 28 2007.  |  Portions Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.