- Preparing search index...
- The search index is not available
IEditableCollectionView Interface
Type parameters
-
T
Heirarchy
-
ICollectionView
- IEditableCollectionView
Implemented by
Properties
Methods
Events
Properties
canAddNew
Gets a value that indicates whether a new item can be added to the collection.
canCancelEdit
Gets a value that indicates whether the collection view can discard pending changes and restore the original values of an edited object.
canFilter
Gets a value that indicates whether this view supports filtering via the filter property.
canGroup
Gets a value that indicates whether this view supports grouping via the groupDescriptions property.
canRemove
Gets a value that indicates whether items can be removed from the collection.
canSort
Gets a value that indicates whether this view supports sorting via the sortDescriptions property.
currentAddItem
Gets the item that is being added during the current add transaction.
currentEditItem
Gets the item that is being edited during the current edit transaction.
currentItem
Gets the current item in the view.
currentPosition
Gets the ordinal position of the current item in the view.
filter
Gets or sets a callback used to determine if an item is suitable for inclusion in the view.
NOTE: If the filter function needs a scope (i.e. a meaningful 'this' value), then remember to set the filter using the 'bind' function to specify the 'this' object. For example:
collectionView.filter = this._filter.bind(this);
groupDescriptions
Gets a collection of GroupDescription objects that describe how the items in the collection are grouped in the view.
groups
Gets the top-level groups.
isAddingNew
Gets a value that indicates whether an add transaction is in progress.
isEditingItem
Gets a value that indicates whether an edit transaction is in progress.
isEmpty
Gets a value that indicates whether this view contains no items.
items
Gets the filtered, sorted, grouped items in the view.
sortDescriptions
Gets a collection of SortDescription objects that describe how the items in the collection are sorted in the view.
sourceCollection
Gets or sets the collection object from which to create this view.
Methods
addNew
-
Adds a new item to the collection.
Returns any
The item that was added to the collection.
beginUpdate
-
Suspends refreshes until the next call to endUpdate.
Returns void
cancelEdit
-
Ends the current edit transaction and, if possible, restores the original value to the item.
Returns void
cancelNew
-
Ends the current add transaction and discards the pending new item.
Returns void
commitEdit
-
Ends the current edit transaction and saves the pending changes.
Returns void
commitNew
-
Ends the current add transaction and saves the pending new item.
Returns void
contains
-
Returns a value that indicates whether a given item belongs to this view.
Parameters
-
item: T
The item to locate in the collection.
Returns boolean
-
deferUpdate
-
Executes a function within a beginUpdate/endUpdate block.
The collection will not be refreshed until the function has been executed. This method ensures endUpdate is called even if the function throws.
Parameters
-
fn: Function
Function to be executed within the beginUpdate/endUpdate block.
-
Optional force: boolean
Whether to force a refresh when ending the update.
Returns void
-
editItem
-
Begins an edit transaction of the specified item.
Parameters
-
item: any
Item to edit.
Returns void
-
endUpdate
-
Resumes refreshes suspended by a call to beginUpdate.
Parameters
-
Optional force: boolean
Whether to force a refresh when ending the update.
Returns void
-
implementsInterface
-
Returns true if the object implements a given interface.
Parameters
-
interfaceName: string
Name of the interface to look for.
Returns boolean
-
moveCurrentTo
-
Sets the specified item to be the current item in the view.
Parameters
-
item: T
The item to set as the currentItem.
Returns boolean
-
moveCurrentToFirst
-
Sets the first item in the view as the current item.
Returns boolean
moveCurrentToLast
-
Sets the last item in the view as the current item.
Returns boolean
moveCurrentToNext
-
Sets the item after the current item in the view as the current item.
Returns boolean
moveCurrentToPosition
-
Sets the item at the specified index in the view as the current item.
Parameters
-
index: number
The index of the item to set as the currentItem.
Returns boolean
-
moveCurrentToPrevious
-
Sets the item before the current item in the view as the current item.
Returns boolean
refresh
-
Re-creates the view using the current sort, filter, and group parameters.
Returns void
remove
-
Removes the specified item from the collection.
Parameters
-
item: any
Item to remove from the collection.
Returns void
-
removeAt
-
Removes the item at the specified index from the collection.
Parameters
-
index: number
Index of the item to remove from the collection.
Returns void
-
Events
collectionChanged
Occurs when the collection changes.
currentChanged
Occurs after the current item changes.
currentChanging
Occurs before the current item changes.
Defines methods and properties that extend ICollectionView to provide editing capabilities.