nsITransactionListener

The nsITransactionListener interface.

This interface is implemented by an object that tracks transactions. ## Methods ## ### willDo(aManager, aTransaction) ### Called before a transaction manager calls a transaction's doTransaction() method. #### Parameters ####

aManager	the transaction manager doing the transaction.
aTransaction	the transaction being executed. @result boolean value returned by listener which indicates its desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error.

### didDo(aManager, aTransaction, aDoResult) ### Called after a transaction manager calls the doTransaction() method of a transaction. #### Parameters ####

aManager	the transaction manager that did the transaction.
aTransaction	the transaction that was executed.
aDoResult	the nsresult returned after executing the transaction.

### willUndo(aManager, aTransaction) ### Called before a transaction manager calls the Undo() method of a transaction. #### Parameters ####

aManager	the transaction manager undoing the transaction.
aTransaction	the transaction being undone. @result boolean value returned by listener which indicates its desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error. Note that listeners can also interrupt normal control flow by throwing an nsresult that indicates an error.

### didUndo(aManager, aTransaction, aUndoResult) ### Called after a transaction manager calls the Undo() method of a transaction. #### Parameters ####

aManager	the transaction manager undoing the transaction.
aTransaction	the transaction being undone.
aUndoResult	the nsresult returned after undoing the transaction.

### willRedo(aManager, aTransaction) ### Called before a transaction manager calls the Redo() method of a transaction. #### Parameters ####

aManager	the transaction manager redoing the transaction.
aTransaction	the transaction being redone. @result boolean value returned by listener which indicates its desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error. Note that listeners can also interrupt normal control flow by throwing an nsresult that indicates an error.

### didRedo(aManager, aTransaction, aRedoResult) ### Called after a transaction manager calls the Redo() method of a transaction. #### Parameters ####

aManager	the transaction manager redoing the transaction.
aTransaction	the transaction being redone.
aRedoResult	the nsresult returned after redoing the transaction.

### willBeginBatch(aManager) ### Called before a transaction manager begins a batch. #### Parameters ####

aManager

the transaction manager beginning a batch. @result boolean value returned by listener which indicates its desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error. Note that listeners can also interrupt normal control flow by throwing an nsresult that indicates an error.

### didBeginBatch(aManager, aResult) ### Called after a transaction manager begins a batch. #### Parameters ####

aManager	the transaction manager that began a batch.
aResult	the nsresult returned after beginning a batch.

### willEndBatch(aManager) ### Called before a transaction manager ends a batch. #### Parameters ####

aManager

the transaction manager ending a batch. @result boolean value returned by listener which indicates its desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error. Note that listeners can also interrupt normal control flow by throwing an nsresult that indicates an error.

### didEndBatch(aManager, aResult) ### Called after a transaction manager ends a batch. #### Parameters ####

aManager	the transaction manager ending a batch.
aResult	the nsresult returned after ending a batch.

### willMerge(aManager, aTopTransaction, aTransactionToMerge) ### Called before a transaction manager tries to merge a transaction, that was just executed, with the transaction at the top of the undo stack. #### Parameters ####

aManager	the transaction manager ending a batch.
aTopTransaction	the transaction at the top of the undo stack.
aTransactionToMerge	the transaction to merge. @result boolean value returned by listener which indicates its desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error. Note that listeners can also interrupt normal control flow by throwing an nsresult that indicates an error.

### didMerge(aManager, aTopTransaction, aTransactionToMerge, aDidMerge, aMergeResult) ### Called after a transaction manager tries to merge a transaction, that was just executed, with the transaction at the top of the undo stack. #### Parameters ####

aManager	the transaction manager ending a batch.
aTopTransaction	the transaction at the top of the undo stack.
aTransactionToMerge	the transaction to merge.
aDidMerge	true if transaction was merged, else false.
aMergeResult	the nsresult returned after the merge attempt.
aInterrupt	listeners should set this to PR_TRUE if they want to interrupt normal control flow, without throwing an error.