SCTableViewSection Class Reference
| Inherits from | NSObject |
| Declared in | SCTableViewSection.h |
Overview
This class functions as a section for SCTableViewModel. Every ‘SCTableViewSection’ can contain any number of SCTableViewCell(s).
Tasks
Creation and Initialization
-
+ section -
+ sectionWithHeaderTitle: -
+ sectionWithHeaderTitle:footerTitle: -
– initWithHeaderTitle: -
– initWithHeaderTitle:footerTitle:
Configuration
-
ownerTableViewModelproperty -
headerTitleproperty -
headerHeightproperty -
headerViewproperty -
footerTitleproperty -
footerHeightproperty -
footerViewproperty -
sectionActionsproperty -
cellActionsproperty -
cellsImageViewsproperty -
detailViewControllerOptionsproperty -
newItemDetailViewControllerOptionsproperty
Configuring Special Cells
-
expandCollapseCellproperty
Configuring Theme Styles
-
themeStyleproperty -
firstCellThemeStyleproperty -
evenCellsThemeStyleproperty -
oddCellsThemeStyleproperty -
lastCellThemeStyleproperty
Managing Cells
-
cellCountproperty -
– addCell: -
– insertCell:atIndex: -
– cellAtIndex: -
– removeCellAtIndex: -
– removeCellIdenticalTo: -
– removeAllCells -
– indexForCell:
Managing Cell Values
-
valuesAreValidproperty -
needsCommitproperty -
commitCellChangesLiveproperty -
– commitCellChanges -
– invalidateCellCommits -
– reloadBoundValues
Internal Properties & Methods (should only be used by the framework or when subclassing)
-
boundObjectproperty -
boundObjectStoreproperty -
boundPropertyNameproperty -
boundValueproperty -
– heightForCellAtIndexPath: -
– editingModeWillChange -
– editingModeDidChange -
– setAttributesTo: -
– setDetailViewControllerOptions: -
– setNewItemDetailViewControllerOptions: -
– setExpanded: -
– generatedDetailViewControllerForCellAtIndexPath:
Properties
boundObject
Provides subclasses with the framework to bind an SCTableViewSection to an NSObject
@property (nonatomic, strong) NSObject *boundObjectDeclared In
SCTableViewSection.hboundObjectStore
The data store of the cell’s bound object.
@property (nonatomic, strong) SCDataStore *boundObjectStoreDeclared In
SCTableViewSection.hboundPropertyName
Provides subclasses with the framework to bind an SCTableViewSection to an NSObject
@property (nonatomic, readonly) NSString *boundPropertyNameDeclared In
SCTableViewSection.hboundValue
Provides subclasses with the framework to bind an SCTableViewSection to a value
@property (nonatomic, strong) NSObject *boundValueDeclared In
SCTableViewSection.hcellActions
The set of cell action blocks that get applied to all the section’s cells.
@property (nonatomic, readonly) SCCellActions *cellActionsDiscussion
Note: Cell actions defined in the section’s individual cells will override any actions set here.
Declared In
SCTableViewSection.hcellCount
The number of cells in the section.
@property (nonatomic, readonly) NSUInteger cellCountDeclared In
SCTableViewSection.hcellsImageViews
Set this property to an array of UIImageView objects to be set to each of the section’s cells.
@property (nonatomic, strong) NSArray *cellsImageViewsDeclared In
SCTableViewSection.hcommitCellChangesLive
Set this property to TRUE for the section cells to commit their values as soon as they are changed. If this value is FALSE, the user must explicitly call commitCellChanges for the cells to commit their value changes. Default: TRUE.
@property (nonatomic, readwrite) BOOL commitCellChangesLiveDeclared In
SCTableViewSection.hdetailViewControllerOptions
Options for the generated detail view controller (only applicable to subclasses with a detail view controller).
@property (nonatomic, readonly) SCDetailViewControllerOptions *detailViewControllerOptionsDeclared In
SCTableViewSection.hevenCellsThemeStyle
The theme style of the even cells in the section.
@property (nonatomic, copy) NSString *evenCellsThemeStyleDeclared In
SCTableViewSection.hexpandCollapseCell
When set to a valid SCExpandCollapseCell, the cell will control if the section’s content is expanded or collapsed.
@property (nonatomic, strong) SCExpandCollapseCell *expandCollapseCellDiscussion
Note: Setting this property automatically adds expandCollapseCell to the section at index 0, making it the first cell.
Declared In
SCTableViewSection.hfirstCellThemeStyle
The theme style of the first cell in the section.
@property (nonatomic, copy) NSString *firstCellThemeStyleDeclared In
SCTableViewSection.hfooterHeight
The section footer height.
@property (nonatomic) CGFloat footerHeightDeclared In
SCTableViewSection.hfooterTitle
The section footer title.
@property (nonatomic, copy) NSString *footerTitleDeclared In
SCTableViewSection.hfooterView
The section footer view. This can be any subclass of UIView (e.g. UILabel or UIImageView). The section automatically adjusts the height of its footer to accommodate this view.
@property (nonatomic, strong) UIView *footerViewDeclared In
SCTableViewSection.hheaderHeight
The section header height.
@property (nonatomic) CGFloat headerHeightDeclared In
SCTableViewSection.hheaderTitle
The section header title.
@property (nonatomic, copy) NSString *headerTitleDeclared In
SCTableViewSection.hheaderView
The section header view. This can be any subclass of UIView (e.g. UILabel or UIImageView). The section automatically adjusts the height of its header to accommodate this view.
@property (nonatomic, strong) UIView *headerViewDeclared In
SCTableViewSection.hlastCellThemeStyle
The theme style of the last cell in the section.
@property (nonatomic, copy) NSString *lastCellThemeStyleDeclared In
SCTableViewSection.hneedsCommit
This property is TRUE if any of the section's cells need to be commited, otherwise it's FALSE.
@property (nonatomic, readonly) BOOL needsCommitDeclared In
SCTableViewSection.hnewItemDetailViewControllerOptions
Options for the generated detail view controller for new items (only applicable to subclasses with a detail view controller).
@property (nonatomic, readonly) SCDetailViewControllerOptions *newItemDetailViewControllerOptionsDeclared In
SCTableViewSection.hoddCellsThemeStyle
The theme style of the odd cells in the section.
@property (nonatomic, copy) NSString *oddCellsThemeStyleDeclared In
SCTableViewSection.hownerTableViewModel
The owner table view model of the section.
@property (nonatomic, weak) SCTableViewModel *ownerTableViewModelDiscussion
Warning: This property gets set automatically by the section’s owner, you should never set this property manually
Declared In
SCTableViewSection.hsectionActions
The set of section action blocks.
@property (nonatomic, readonly) SCSectionActions *sectionActionsDeclared In
SCTableViewSection.hthemeStyle
The theme style of the section.
@property (nonatomic, copy) NSString *themeStyleDeclared In
SCTableViewSection.hClass Methods
section
Allocates and returns an initialized SCTableViewSection.
+ (instancetype)sectionDeclared In
SCTableViewSection.hsectionWithHeaderTitle:
Allocates and returns an initialized SCTableViewSection given a header title.
+ (instancetype)sectionWithHeaderTitle:(NSString *)sectionHeaderTitleParameters
- sectionHeaderTitle
A header title for the section.
Declared In
SCTableViewSection.hsectionWithHeaderTitle:footerTitle:
Allocates and returns an initialized SCTableViewSection given a header and a footer title.
+ (instancetype)sectionWithHeaderTitle:(NSString *)sectionHeaderTitle footerTitle:(NSString *)sectionFooterTitleParameters
- sectionHeaderTitle
A header title for the section.
- sectionFooterTitle
A footer title for the section.
Declared In
SCTableViewSection.hInstance Methods
addCell:
Adds a new cell to the section.
- (void)addCell:(SCTableViewCell *)cellParameters
- cell
Must be a valid non nil SCTableViewCell.
Declared In
SCTableViewSection.hcellAtIndex:
Returns the cell at the specified index.
- (SCTableViewCell *)cellAtIndex:(NSUInteger)indexParameters
- index
Must be less than the total number of cells.
Declared In
SCTableViewSection.hcommitCellChanges
Commits value changes for all cells in section. This method needs to be called only if the commitCellChangesLive property is FALSE.
- (void)commitCellChangesDeclared In
SCTableViewSection.heditingModeDidChange
Method called internally whenever the owner table view’s editing mode has changed.
- (void)editingModeDidChangeDeclared In
SCTableViewSection.heditingModeWillChange
Method called internally whenever the owner table view’s editing mode is about to change.
- (void)editingModeWillChangeDeclared In
SCTableViewSection.hgeneratedDetailViewControllerForCellAtIndexPath:
Internal method. *
- (UIViewController *)generatedDetailViewControllerForCellAtIndexPath:(NSIndexPath *)indexPathDeclared In
SCTableViewSection.hheightForCellAtIndexPath:
Called internally by the framework to determine the cell height at the specified indexPath.
- (CGFloat)heightForCellAtIndexPath:(NSIndexPath *)indexPathDeclared In
SCTableViewSection.hindexForCell:
Returns the index of the specified cell.
- (NSUInteger)indexForCell:(SCTableViewCell *)cellParameters
- cell
Must be a valid non nil SCTableViewCell.
Return Value
If cell is not found, method returns NSNotFound.
Declared In
SCTableViewSection.hinitWithHeaderTitle:
Returns an initialized SCTableViewSection given a header title.
- (instancetype)initWithHeaderTitle:(NSString *)sectionHeaderTitleParameters
- sectionHeaderTitle
A header title for the section.
Declared In
SCTableViewSection.hinitWithHeaderTitle:footerTitle:
Returns an initialized SCTableViewSection given a header and a footer title.
- (instancetype)initWithHeaderTitle:(NSString *)sectionHeaderTitle footerTitle:(NSString *)sectionFooterTitleParameters
- sectionHeaderTitle
A header title for the section.
- sectionFooterTitle
A footer title for the section.
Declared In
SCTableViewSection.hinsertCell:atIndex:
Inserts a new cell into the section at the specified index.
- (void)insertCell:(SCTableViewCell *)cell atIndex:(NSUInteger)indexParameters
- cell
Must be a valid non nil SCTableViewCell.
- index
Must be less than the total number of cells.
Declared In
SCTableViewSection.hinvalidateCellCommits
Overrides optimization and sets all cells as needing to be committed.
- (void)invalidateCellCommitsDeclared In
SCTableViewSection.hreloadBoundValues
Reload’s the section’s bound values in case the associated bound objects or keys valuea has changed by means other than the cells themselves (e.g. external custom code).
- (void)reloadBoundValuesDeclared In
SCTableViewSection.hremoveAllCells
Removes all cells in section.
- (void)removeAllCellsDeclared In
SCTableViewSection.hremoveCellAtIndex:
Removes the cell at the specified index.
- (void)removeCellAtIndex:(NSUInteger)indexParameters
- index
Must be less than the total number of cells.
Declared In
SCTableViewSection.hremoveCellIdenticalTo:
Removes the cell identical to the given cell. @param .
- (void)removeCellIdenticalTo:(SCTableViewCell *)cellDeclared In
SCTableViewSection.hsetAttributesTo:
Method should be overridden by subclasses to support property attributes.
- (void)setAttributesTo:(SCPropertyAttributes *)attributesDiscussion
The method should be able to set the subclass' specific attributes to its corresponding SCPropertyAttributes subclass.
Declared In
SCTableViewSection.hsetDetailViewControllerOptions:
Method called internally.
- (void)setDetailViewControllerOptions:(SCDetailViewControllerOptions *)optionsDeclared In
SCTableViewSection.hsetExpanded:
Internal method that sets the section’s expanded state. Never set this property to expand/collapse the section. Use the expandCollapseCell property instead.
- (void)setExpanded:(BOOL)expandedDeclared In
SCTableViewSection.h