SCSelectionCell Class Reference
Inherits from | SCLabelCell : SCControlCell : SCCustomCell : SCTableViewCell : UITableViewCell |
Declared in | SCTableViewCell.h |
Overview
This class functions as a cell that provides the end-user with an automatically generated detail view of options to choose from, much like the Ringtone selection cell in the iPhone’s sound settings. The selection items are provided in the form of an array of NSStrings, called the items array. ‘SCSelectionCell’ can be configured to allow multiple selection and to allow no selection at all. the bound property of this cell must be of type NSNumber, NSString, or NSMutableSet. If allowMultipleSelection is TRUE, then only NSString and NSMutableSet property types are allowed.
Tasks
Creation and Initialization
-
+ cellWithText:boundObject:selectedIndexPropertyName:items:
Allocates and returns an initialized SCSelectionCell given cell text, bound object, an NSNumber bound property name, and an array of selection items.
-
+ cellWithText:boundObject:selectedIndexesPropertyName:items:allowMultipleSelection:
Allocates and returns an initialized SCSelectionCell given cell text, bound object, a bound property name, an array of selection items, and whether to allow multiple selection.
-
+ cellWithText:boundObject:selectionStringPropertyName:items:
Allocates and returns an initialized SCSelectionCell given cell text, bound object, an NSString bound property name, and an array of selection items.
-
– initWithText:boundObject:selectedIndexPropertyName:items:
Returns an initialized SCSelectionCell given cell text, bound object, an NSNumber bound property name, and an array of selection items.
-
– initWithText:boundObject:selectedIndexesPropertyName:items:allowMultipleSelection:
Returns an initialized SCSelectionCell given cell text, bound object, a bound property name, an array of selection items, and whether to allow multiple selection.
-
– initWithText:boundObject:selectionStringPropertyName:items:
Returns an initialized SCSelectionCell given cell text, bound object, an NSString bound property name, and an array of selection items.
Configuration
-
selectionItemsStore
The data store for the selection items.
property -
selectionItemsFetchOptions
The fetch options for the selection items.
property -
items
The items stored in selectionItemsStore.
property -
selectedItemIndex
This property reflects the current cell’s selection. You can set this property to define the cell’s selection.
property -
selectedItemsIndexes
This property reflects the current cell’s selection(s). You can add index(es) to the set to define the cell’s selection.
property -
allowMultipleSelection
If TRUE, the cell allows multiple selection. Default: FALSE.
property -
allowNoSelection
If TRUE, the cell allows no selection at all. Default: FALSE.
property -
maximumSelections
The maximum number of items that can be selected. Set to zero to allow an infinite number of selections. Default: 0.
property -
autoDismissDetailView
If TRUE, the detail view is automatically dismissed when an item is selected. Default: FALSE.
property -
hideDetailViewNavigationBar
If TRUE, the detail view’s navigation bar is hidder. Default: FALSE.
property -
allowAddingItems
propertyAllows/disables adding new objects to the items array. Default: FALSE.
-
allowDeletingItems
Allows/disables deleting new objects from the items array. Default: FALSE.
property -
allowMovingItems
Allows/disables moving an item from one row to another. Default: FALSE.
property -
allowEditDetailView
Allows/disables editing detail views for items. Default: FALSE.
property -
displaySelection
If TRUE, the cell displays the selected items' titles inside the cell in a left aligned label. Default: TRUE.
property -
delimeter
The delimeter that separates the titles of the selected items. Default: @“ ,”.
property
Configuring Special Cells
-
placeholderCell
When set to a valid cell object, ‘placeholderCell’ will be displayed when no items exist in the generated section. As soon as any items are added, this cell automatically disappears. Default: nil.
property -
addNewItemCell
When set to a valid cell object, ‘addNewItemCell’ will be displayed as the last cell of the generated section, and will add a new item to the section whenever it gets tapped by the user. This cell can be used as an alternative to addButtonItem. Default: nil.
property
Properties
addNewItemCell
When set to a valid cell object, ‘addNewItemCell’ will be displayed as the last cell of the generated section, and will add a new item to the section whenever it gets tapped by the user. This cell can be used as an alternative to addButtonItem. Default: nil.
@property (nonatomic, strong) SCTableViewCell *addNewItemCell
Declared In
SCTableViewCell.h
allowAddingItems
Allows/disables adding new objects to the items array. Default: FALSE.
@property (nonatomic, readwrite) BOOL allowAddingItems
Declared In
SCTableViewCell.h
allowDeletingItems
Allows/disables deleting new objects from the items array. Default: FALSE.
@property (nonatomic, readwrite) BOOL allowDeletingItems
Declared In
SCTableViewCell.h
allowEditDetailView
Allows/disables editing detail views for items. Default: FALSE.
@property (nonatomic, readwrite) BOOL allowEditDetailView
Declared In
SCTableViewCell.h
allowMovingItems
Allows/disables moving an item from one row to another. Default: FALSE.
@property (nonatomic, readwrite) BOOL allowMovingItems
Declared In
SCTableViewCell.h
allowMultipleSelection
If TRUE, the cell allows multiple selection. Default: FALSE.
@property (nonatomic, readwrite) BOOL allowMultipleSelection
Declared In
SCTableViewCell.h
allowNoSelection
If TRUE, the cell allows no selection at all. Default: FALSE.
@property (nonatomic, readwrite) BOOL allowNoSelection
Declared In
SCTableViewCell.h
autoDismissDetailView
If TRUE, the detail view is automatically dismissed when an item is selected. Default: FALSE.
@property (nonatomic, readwrite) BOOL autoDismissDetailView
Declared In
SCTableViewCell.h
delimeter
The delimeter that separates the titles of the selected items. Default: @“ ,”.
@property (nonatomic, copy) NSString *delimeter
Discussion
Note: This property is applicable only if displaySelection is TRUE.
Declared In
SCTableViewCell.h
displaySelection
If TRUE, the cell displays the selected items' titles inside the cell in a left aligned label. Default: TRUE.
@property (nonatomic, readwrite) BOOL displaySelection
Declared In
SCTableViewCell.h
hideDetailViewNavigationBar
If TRUE, the detail view’s navigation bar is hidder. Default: FALSE.
@property (nonatomic, readwrite) BOOL hideDetailViewNavigationBar
Discussion
Note: Only applicable when autoDismissDetailView is TRUE.
Declared In
SCTableViewCell.h
items
The items stored in selectionItemsStore.
@property (nonatomic, readonly) NSArray *items
Declared In
SCTableViewCell.h
maximumSelections
The maximum number of items that can be selected. Set to zero to allow an infinite number of selections. Default: 0.
@property (nonatomic, readwrite) NSUInteger maximumSelections
Discussion
Note: Only applicable when allowMultipleSelection is TRUE.
Declared In
SCTableViewCell.h
placeholderCell
When set to a valid cell object, ‘placeholderCell’ will be displayed when no items exist in the generated section. As soon as any items are added, this cell automatically disappears. Default: nil.
@property (nonatomic, strong) SCTableViewCell *placeholderCell
Declared In
SCTableViewCell.h
selectedItemIndex
This property reflects the current cell’s selection. You can set this property to define the cell’s selection.
@property (nonatomic, copy) NSNumber *selectedItemIndex
Discussion
Note: If you have bound this cell to an object or a key, you can define the cell’s selection using either the bound property value or the key value, respectively.
Declared In
SCTableViewCell.h
selectedItemsIndexes
This property reflects the current cell’s selection(s). You can add index(es) to the set to define the cell’s selection.
@property (nonatomic, readonly) NSMutableSet *selectedItemsIndexes
Discussion
Note: If you have bound this cell to an object or a key, you can define the cell’s selection using either the bound property value or the key value, respectively.
Declared In
SCTableViewCell.h
selectionItemsFetchOptions
The fetch options for the selection items.
@property (nonatomic, strong) SCDataFetchOptions *selectionItemsFetchOptions
Declared In
SCTableViewCell.h
selectionItemsStore
The data store for the selection items.
@property (nonatomic, strong) SCDataStore *selectionItemsStore
Declared In
SCTableViewCell.h
Class Methods
cellWithText:boundObject:selectedIndexPropertyName:items:
Allocates and returns an initialized SCSelectionCell given cell text, bound object, an NSNumber bound property name, and an array of selection items.
+ (id)cellWithText:(NSString *)cellText boundObject:(NSObject *)object selectedIndexPropertyName:(NSString *)propertyName items:(NSArray *)cellItems
Parameters
- cellText
The text that will appear in the cell’s textLabel.
- object
The cell’s bound object (see SCTableViewCell class overview).
- propertyName
The cell’s bound property name corresponding to the selected item index. Property must be of an NSNumber type and cannot be a readonly property.
Declared In
SCTableViewCell.h
cellWithText:boundObject:selectedIndexesPropertyName:items:allowMultipleSelection:
Allocates and returns an initialized SCSelectionCell given cell text, bound object, a bound property name, an array of selection items, and whether to allow multiple selection.
+ (id)cellWithText:(NSString *)cellText boundObject:(NSObject *)object selectedIndexesPropertyName:(NSString *)propertyName items:(NSArray *)cellItems allowMultipleSelection:(BOOL)multipleSelection
Parameters
- cellText
The text that will appear in the cell’s textLabel.
- object
The cell’s bound object (see SCTableViewCell class overview).
- propertyName
The cell’s bound property name corresponding to the selected items indexes set. Property must be of an NSMutableSet type and can be a readonly property.
- cellItems
An array of the items that the user will choose from. All items must be of an NSString type.
- multipleSelection
Determines if multiple selection is allowed.
Declared In
SCTableViewCell.h
cellWithText:boundObject:selectionStringPropertyName:items:
Allocates and returns an initialized SCSelectionCell given cell text, bound object, an NSString bound property name, and an array of selection items.
+ (id)cellWithText:(NSString *)cellText boundObject:(NSObject *)object selectionStringPropertyName:(NSString *)propertyName items:(NSArray *)cellItems
Parameters
- cellText
The text that will appear in the cell’s textLabel.
- object
The cell’s bound object (see SCTableViewCell class overview).
- propertyName
The cell’s bound property name corresponding to the selected item string. Property must be of an NSString type and cannot be a readonly property.
Declared In
SCTableViewCell.h
Instance Methods
initWithText:boundObject:selectedIndexPropertyName:items:
Returns an initialized SCSelectionCell given cell text, bound object, an NSNumber bound property name, and an array of selection items.
- (id)initWithText:(NSString *)cellText boundObject:(NSObject *)object selectedIndexPropertyName:(NSString *)propertyName items:(NSArray *)cellItems
Parameters
- cellText
The text that will appear in the cell’s textLabel.
- object
The cell’s bound object (see SCTableViewCell class overview).
- propertyName
The cell’s bound property name corresponding to the selected item index. Property must be of an NSNumber type and cannot be a readonly property.
Declared In
SCTableViewCell.h
initWithText:boundObject:selectedIndexesPropertyName:items:allowMultipleSelection:
Returns an initialized SCSelectionCell given cell text, bound object, a bound property name, an array of selection items, and whether to allow multiple selection.
- (id)initWithText:(NSString *)cellText boundObject:(NSObject *)object selectedIndexesPropertyName:(NSString *)propertyName items:(NSArray *)cellItems allowMultipleSelection:(BOOL)multipleSelection
Parameters
- cellText
The text that will appear in the cell’s textLabel.
- object
The cell’s bound object (see SCTableViewCell class overview).
- propertyName
The cell’s bound property name corresponding to the selected items indexes set. Property must be of an NSMutableSet type and can be a readonly property.
- cellItems
An array of the items that the user will choose from. All items must be of an NSString type.
- multipleSelection
Determines if multiple selection is allowed.
Declared In
SCTableViewCell.h
initWithText:boundObject:selectionStringPropertyName:items:
Returns an initialized SCSelectionCell given cell text, bound object, an NSString bound property name, and an array of selection items.
- (id)initWithText:(NSString *)cellText boundObject:(NSObject *)object selectionStringPropertyName:(NSString *)propertyName items:(NSArray *)cellItems
Parameters
- cellText
The text that will appear in the cell’s textLabel.
- object
The cell’s bound object (see SCTableViewCell class overview).
- propertyName
The cell’s bound property name corresponding to the selected item string. Property must be of an NSString type and cannot be a readonly property.
Declared In
SCTableViewCell.h