nsITransactionList

IID:97f863f3-f886-11d4-9d39-0060b0f8baff
Inherits From:nsISupports

Properties

readonly PRInt32 numItems

The number of transactions contained in this list.


Methods

nsITransactionList getChildListForItem ( PRInt32 index ) nsITransaction getItem ( PRInt32 index ) PRInt32 getNumChildrenForItem ( PRInt32 index ) PRBool itemIsBatch ( PRInt32 index )

nsITransactionList getChildListForItem ( PRInt32 index )

GetChildListForItem() returns the list of children associated with the item at index. Implementations may return null if there are no children, or an empty list. The list returned is AddRef'd so it is up to the caller to Release the transaction when it is done.

Arguments:
index: The index of the item in the list.

nsITransaction getItem ( PRInt32 index )

GetItem() returns the transaction at the given index in the list. Note that a null can be returned here if the item is a batch. The transaction returned is AddRef'd so it is up to the caller to Release the transaction when it is done.

Arguments:
index: The index of the item in the list.

PRInt32 getNumChildrenForItem ( PRInt32 index )

GetNumChildrenForItem() returns the number of child (auto-aggreated) transactions the item at index has.

Arguments:
index: The index of the item in the list.

PRBool itemIsBatch ( PRInt32 index )

ItemIsBatch() returns true if the item at index is a batch. Note that currently there is no requirement for a TransactionManager implementation to associate a toplevel nsITransaction with a batch so it is possible for itemIsBatch() to return true and getItem() to return null. However, you can still access the transactions contained in the batch with a call to getChildListForItem().

Arguments:
index: The index of the item in the list.

References

This interface is returned from the following methods:

nsITransactionList.getChildListForItem, nsITransactionManager.getRedoList, nsITransactionManager.getUndoList

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com