IXuniCollectionView Protocol Reference
| Conforms to | IXuniNotifyCollectionChanged |
|---|---|
| Declared in | ICollectionView.h |
Overview
Enables collections to have the functionalities of current record management, custom sorting, filtering, and grouping.
canFilter
required method
Gets a value that indicates whether this view supports filtering.
@property (readonly) BOOL canFilterDiscussion
Gets a value that indicates whether this view supports filtering.
Declared In
ICollectionView.h
canGroup
required method
Gets a value that indicates whether this view supports grouping.
@property (readonly) BOOL canGroupDiscussion
Gets a value that indicates whether this view supports grouping.
Declared In
ICollectionView.h
canSort
required method
Gets a value that indicates whether this view supports sorting.
@property (readonly) BOOL canSortDiscussion
Gets a value that indicates whether this view supports sorting.
Declared In
ICollectionView.h
currentItem
required method
Gets the current item in the view.
@property (readonly) NSObject *currentItemDiscussion
Gets the current item in the view.
Declared In
ICollectionView.h
currentPosition
required method
Gets the ordinal position of the current item in the view.
@property (readonly) int currentPositionDiscussion
Gets the ordinal position of the current item in the view.
Declared In
ICollectionView.h
filter
required method
Gets or sets a callback used to determine if an item is suitable for inclusion in the view.
@property (nonatomic, copy) IXuniPredicate filterDiscussion
Gets or sets a callback used to determine if an item is suitable for inclusion in the view.
Declared In
ICollectionView.h
groupDescriptions
required method
Gets a collection of objects that describe how the items in the collection are grouped in the view.
@property (readonly) XuniObservableArray *groupDescriptionsDiscussion
Gets a collection of objects that describe how the items in the collection are grouped in the view.
Declared In
ICollectionView.h
groups
required method
Gets the top-level groups.
@property (readonly) NSArray *groupsDiscussion
Gets the top-level groups.
Declared In
ICollectionView.h
isEmpty
required method
sortDescriptions
required method
Gets a collection of @see:SortDescription objects that describe how the items in the collection are sorted in the view.
@property (readonly) XuniObservableArray *sortDescriptionsDiscussion
Gets a collection of @see:SortDescription objects that describe how the items in the collection are sorted in the view.
Declared In
ICollectionView.h
sourceCollection
required method
Gets or sets the collection object from which to create this view.
@property NSMutableArray *sourceCollectionDiscussion
Gets or sets the collection object from which to create this view.
Declared In
ICollectionView.h
– contains:
required method
Returns a value that indicates whether a given item belongs to this view.
- (BOOL)contains:(NSObject *)itemParameters
item |
the item. |
|---|
Return Value
return a boolean value of whether a given item belongs to this view..
Discussion
Returns a value that indicates whether a given item belongs to this view.
Declared In
ICollectionView.h
– moveCurrentTo:
required method
Sets the specified item to be the current item in the view.
- (BOOL)moveCurrentTo:(NSObject *)itemParameters
item |
the item. |
|---|
Return Value
return a boolean value.
Discussion
Sets the specified item to be the current item in the view.
Declared In
ICollectionView.h
– moveCurrentToFirst
required method
Sets the first item in the view as the current item.
- (BOOL)moveCurrentToFirstReturn Value
return a boolean value.
Discussion
Sets the first item in the view as the current item.
Declared In
ICollectionView.h
– moveCurrentToLast
required method
Sets the last item in the view as the current item.
- (BOOL)moveCurrentToLastReturn Value
return a boolean value.
Discussion
Sets the last item in the view as the current item.
Declared In
ICollectionView.h
– moveCurrentToNext
required method
Sets the item after the current item in the view as the current item.
- (BOOL)moveCurrentToNextReturn Value
return a boolean value.
Discussion
Sets the item after the current item in the view as the current item.
Declared In
ICollectionView.h
– moveCurrentToPosition:
required method
Sets the item at the specified index in the view as the current item.
- (BOOL)moveCurrentToPosition:(int)indexParameters
index |
the index. |
|---|
Return Value
return a boolean value.
Discussion
Sets the item at the specified index in the view as the current item.
Declared In
ICollectionView.h
– moveCurrentToPrevious
required method
Sets the item before the current item in the view as the current item.
- (BOOL)moveCurrentToPreviousReturn Value
return a boolean value.
Discussion
Sets the item before the current item in the view as the current item.
Declared In
ICollectionView.h
– refresh
required method
– refresh:
required method
Re-creates the view using the current sort, filter, and group parameters.
- (void)refresh:(BOOL)isNotifyCollectionChangedParameters
isNotifyCollectionChanged |
YES means to trigger collectionChanged event, NO means do not trigger. |
|---|
Discussion
Re-creates the view using the current sort, filter, and group parameters.
Declared In
ICollectionView.h
currentChanged
required method
Occurs after the current item changes.
@property XuniEvent *currentChangedDiscussion
Occurs after the current item changes.
Declared In
ICollectionView.h
currentChanging
required method
Occurs before the current item changes.
@property XuniEvent *currentChangingDiscussion
Occurs before the current item changes.
Declared In
ICollectionView.h
– beginUpdate
required method
– endUpdate
required method
Resume refreshes suspended by a call to beginUpdate.
- (void)endUpdateDiscussion
Resume refreshes suspended by a call to beginUpdate.
Declared In
ICollectionView.h
– deferUpdate:
required method
items
required method
Gets the filtered, sorted, grouped items in the view.
@property (readonly) NSArray *itemsDiscussion
Gets the filtered, sorted, grouped items in the view.
Declared In
ICollectionView.h