mirror of
https://github.com/zhigang1992/RestKit.git
synced 2026-04-02 17:57:22 +08:00
3d0f0ab39e
RKTableController provides a flexible, integrated system for driving iOS table views using the RestKit object mapping engine. Local domain objects can be mapped into table cells within a collection or presented for editing as part of a form. There are three flavors of table controllers available: * Static Tables: RKTableController can be used to render simple static tables that are composed of RKTableItems presented in RKTableSections. Table items can quickly be built and added to a table without a backing model or can have content object mapped into them for presentation. * Network Tables: RKTableController can also render a table with the results of a network load. The typical use case here is to have RestKit retrieve a JSON/XML payload from your remote system and then render the content into a table. * Core Data Tables: RKFetchedResultsTableController can efficiently drive a table view using objects pulled from a Core Data managed object context. Typical use-cases here are for the presentation of large collections that are pulled from a remote system, offering offline access, or speeding up a UI by using Core Data as a fast local cache. RKTableController supports a number of bells and whistles including integrated searching/filtering and pull to refresh.
151 lines
5.2 KiB
Objective-C
151 lines
5.2 KiB
Objective-C
//
|
|
// RKTableController.h
|
|
// RestKit
|
|
//
|
|
// Created by Blake Watters on 8/1/11.
|
|
// Copyright (c) 2011 RestKit.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
#ifdef TARGET_OS_IPHONE
|
|
#import <UIKit/UIKit.h>
|
|
#import "RKAbstractTableController.h"
|
|
#import "RKTableSection.h"
|
|
#import "RKTableViewCellMappings.h"
|
|
#import "RKTableItem.h"
|
|
#import "RKForm.h"
|
|
#import "../ObjectMapping/RKObjectManager.h"
|
|
#import "../ObjectMapping/RKObjectMapping.h"
|
|
#import "../ObjectMapping/RKObjectLoader.h"
|
|
|
|
@interface RKTableController : RKAbstractTableController
|
|
|
|
/////////////////////////////////////////////////////////////////////////
|
|
/// @name Static Tables
|
|
/////////////////////////////////////////////////////////////////////////
|
|
|
|
- (void)loadObjects:(NSArray *)objects;
|
|
- (void)loadObjects:(NSArray *)objects inSection:(NSUInteger)sectionIndex;
|
|
- (void)loadEmpty;
|
|
|
|
/**
|
|
Return the index path of the object within the table
|
|
*/
|
|
// TODO: Move to superclass???
|
|
- (NSIndexPath *)indexPathForObject:(id)object;
|
|
|
|
/**
|
|
*/
|
|
// TODO: Move to superclass???
|
|
- (id)objectAtIndexPath:(NSIndexPath *)indexPath;
|
|
|
|
// TODO: Move to superclass???
|
|
- (UITableViewCell *)cellForObject:(id)object;
|
|
|
|
// Move to superclass???
|
|
- (void)reloadRowForObject:(id)object withRowAnimation:(UITableViewRowAnimation)rowAnimation;
|
|
|
|
/**
|
|
Load an array of RKTableItems into table cells of the specified class. A table cell
|
|
mapping will be constructed on your behalf and yielded to the block for configuration.
|
|
After the block is invoked, the objects will be loaded into the specified section.
|
|
*/
|
|
// TODO: Update comments...
|
|
- (void)loadTableItems:(NSArray *)tableItems withMappingBlock:(void (^)(RKTableViewCellMapping *))block;
|
|
- (void)loadTableItems:(NSArray *)tableItems withMapping:(RKTableViewCellMapping *)cellMapping;
|
|
- (void)loadTableItems:(NSArray *)tableItems
|
|
inSection:(NSUInteger)sectionIndex
|
|
withMapping:(RKTableViewCellMapping *)cellMapping;
|
|
|
|
/**
|
|
Load an array of RKTableItem objects into the table using the default
|
|
RKTableViewCellMapping. An instance of the cell mapping will be created on your
|
|
behalf and configured with the default table view cell attribute mappings.
|
|
|
|
@param tableItems An array of RKTableItem instances to load into the table
|
|
|
|
@see RKTableItem
|
|
@see [RKTableViewCellMapping addDefaultMappings]
|
|
*/
|
|
- (void)loadTableItems:(NSArray *)tableItems;
|
|
|
|
/**
|
|
Load an array of RKTableItem objects into the specified section with the table using the default
|
|
RKTableViewCellMapping. An instance of the cell mapping will be created on your
|
|
behalf and configured with the default table view cell attribute mappings.
|
|
|
|
@param tableItems An array of RKTableItem instances to load into the table
|
|
@param sectionIndex The section to load the table items into. Must be less than sectionCount.
|
|
|
|
@see RKTableItem
|
|
@see [RKTableViewCellMapping addDefaultMappings]
|
|
*/
|
|
- (void)loadTableItems:(NSArray *)tableItems inSection:(NSUInteger)sectionIndex;
|
|
|
|
/** @name Forms */
|
|
|
|
/**
|
|
The form that the table has been loaded with (if any)
|
|
*/
|
|
@property (nonatomic, retain) RKForm *form;
|
|
|
|
/**
|
|
Loads the table with the contents of the specified form object.
|
|
Forms are used to build content entry and editing interfaces for objects.
|
|
|
|
@see RKForm
|
|
*/
|
|
- (void)loadForm:(RKForm *)form;
|
|
|
|
/////////////////////////////////////////////////////////////////////////
|
|
/// @name Managing Sections
|
|
/////////////////////////////////////////////////////////////////////////
|
|
|
|
// Coalesces a series of table view updates performed within the block into
|
|
// a single animation using beginUpdates: and endUpdates: on the table view
|
|
// TODO: Move to super-class?
|
|
- (void)updateTableViewUsingBlock:(void (^)())block;
|
|
|
|
/** Adds a new section to the model.
|
|
* @param section Must be a valid non nil RKTableViewSection. */
|
|
// NOTE: connects cellMappings if section.cellMappings is nil...
|
|
- (void)addSection:(RKTableSection *)section;
|
|
|
|
/**
|
|
Creates an section and yields it to the block for configuration. After the block
|
|
is evaluated, the section is added to the table.
|
|
*/
|
|
- (void)addSectionUsingBlock:(void (^)(RKTableSection *section))block;
|
|
|
|
/** Inserts a new section at the specified index.
|
|
* @param section Must be a valid non nil RKTableViewSection.
|
|
* @param index Must be less than the total number of sections. */
|
|
- (void)insertSection:(RKTableSection *)section atIndex:(NSUInteger)index;
|
|
|
|
/** Removes the specified section from the model.
|
|
* @param section The section to remove. */
|
|
- (void)removeSection:(RKTableSection *)section;
|
|
|
|
/** Removes the section at the specified index from the model.
|
|
* @param index Must be less than the total number of section. */
|
|
- (void)removeSectionAtIndex:(NSUInteger)index;
|
|
|
|
/** Removes all sections from the model. */
|
|
// NOTE: Adds a new section 0
|
|
- (void)removeAllSections;
|
|
|
|
@end
|
|
|
|
#endif // TARGET_OS_IPHONE
|