派生元: NSObject
適合: IGGridViewDataSource
定義: IGGridViewDataSourceHelper.h

概要

IGGridViewDataSourceHelper はデータ ソース ヘルパーです。カスタム オブジェクトの配列を表示するために、実装した各 IGGridViewIGGridViewDataSource プロトコルを再実装するのは効率的ではありません。このクラスを使用すると、コードを追加する必要はありません。

data プロパティのみを設定します。data ソースがオブジェクトの各パブリック プロパティに相対する列を自動的に作成します。作成しない場合は、autoGenerateColumns プロパティを NO に設定し、columnDefinitions プロパティを使用してカスタム順序で columns を指定し、IGGridViewColumnDefinition オブジェクトを配列に追加します。

データ ソース ヘルパーは datasections にグループ化できます。groupingKey プロパティをカスタム オブジェクトのプロパティ名に設定します。たとえば、MyData と呼ばれるオブジェクトがあります。MyData のプロパティは firstName、lastName、および age です。data を lastName に基づいて sections に構成するには、以下のコードを使用します。

    dataSource.groupingKey = @"lastName";

同じように、IGGridView でフィルタリングを有効にするには、filteringKey プロパティを設定します。data を firstName によってフィルターするには、以下のコードを使用します。

    datasource.filteringKey= @"firstName";

dataSource ヘルパーは、セクションのヘッダーおよびフッター、行の順序変更、ショートカット バーなどの機能を簡単に有効にできます。プロパティを YES または NO に設定します。

IGCellPath または IGRowPath の実際のオブジェクトへのマッピングを取得するには、このクラスの公開された resolve メソッドを使用できます。

data を再構成することも可能です。たとえば、IGGridViewSingleRowSingleFieldDataSourceHelper クラスで行を columns に変更できます。カスタム DataSourceHelper クラスを作成できます。IGGridViewDataSource のプロトコル メソッドをオーバーライドできます。dataIGCellPath オブジェクトへのマッピングを変更する場合、data にセル パスをマップする normalizePath メソッドもオーバーライドできます。

タスク

データの構成

表示の設定

データの更新

データの変更

  •   deleteRowAnimation

    行を削除するときに再生するアニメーションのタイプを取得または設定します。

    プロパティ

データ アクセス

その他の項目を読み込みます

フィルタリング

  •   filteringKey

    基本 data オブジェクトのプロパティを表す文字列を取得または設定します。

    プロパティ
  •   filteringCaseInsensitivity

    フィルタリングが大文字と小文字を区別するかどうかを決定するブール値を取得または設定します。

    プロパティ
  •   filteringDiacriticInsensitiveFiltering

    フィルタリングが分音記号を区別するかどうかを決定するブール値を取得または設定します。

    プロパティ
  •   filterType

    filteringKey と関連付けられたプロパティに適用されるフィルタリング条件のタイプを取得または設定します。

    プロパティ
  •   filterValue

    データ ソースがフィルターされている値。

    プロパティ
  •   _0

    フィルターと一致するテキストを強調表示するために使用される iOS 6+ で使用可能な読み取り専用ディクショナリ。

    プロパティ
  •   filterShortcutbarValue

    ショートカット バーに表示される文字列を取得または設定します。

    プロパティ
  • – clearFilter:

    DataSource に適用されているフィルターを解除し、FilterCell の値をクリアします。

  • – gridView:applyFilter:

固定列

編集

  •   allowEditing

    セルがダブル タップによって編集モードに入るかどうかを取得または設定します。

    プロパティ
  •   editingTransitionDuration

    セルが編集モードにし、終了する時間 (秒単位) を取得または設定します。

    プロパティ
  •   editingStartTransitionOptions

    セルを編集モードに入るトランジションを取得または設定します。

    プロパティ
  •   editingEndTransitionOptions

    セルを編集モードから出るトランジションを取得または設定します。

    プロパティ
  •   editingDelegate

    セルの編集のデリゲート。

    プロパティ
  •   isEditing

    グリッドのセルが編集されているかどうかを確認します。

    プロパティ
  • – endEditing

    編集モードを終了します。

  • – beginEditing:inGrid:

    編集をサポートする場合、指定したセルを編集モードに入ります。

保護されたオーバーライド

プロパティ

_0

フィルターと一致するテキストを強調表示するために使用される iOS 6+ で使用可能な読み取り専用ディクショナリ。

@property (nonatomic, readonly) NSDictionary *NS_AVAILABLE_IOS ( 6 _0

定義:

IGGridViewDataSourceHelper.h

allowColumnReordering

列の順序変更が有効な場合は YES。それ以外の場合は NO。

@property (nonatomic, assign) BOOL allowColumnReordering

定義:

IGGridViewDataSourceHelper.h

allowEditing

セルがダブル タップによって編集モードに入るかどうかを取得または設定します。

@property (nonatomic, assign) BOOL allowEditing

定義:

IGGridViewDataSourceHelper.h

allowRowReordering

この data の行の順序変更が許可されるかどうかを取得または設定します。

@property (nonatomic, assign) BOOL allowRowReordering

注記

この機能を有効にするには、 IGGridView の行の順序変更を有効にする必要があります。データ ソース レベルでサポートされないためにオーバーライドするオプションがあります。

定義:

IGGridViewDataSourceHelper.h

autoGenerateColumns

columns が基本 data オブジェクトのプロパティに基づいて自動的に作成されるかどうかを制御するブール値。

@property (nonatomic, assign) BOOL autoGenerateColumns

定義:

IGGridViewDataSourceHelper.h

columnDefinitions

IGGridView で表示される開発者定義の IGColumnDefinition オブジェクトのコレクション。

@property (nonatomic, readonly) NSMutableArray *columnDefinitions

定義:

IGGridViewDataSourceHelper.h

columns

データ ソースによって表示されるすべての列を表す IGGridViewColumnDefinition オブジェクトの読み取り専用リスト。

@property (nonatomic, readonly) NSArray *columns

注記

このリストは columnDefinitions プロパティを指定した列および autoGeneratedColumns を含みます。

定義:

IGGridViewDataSourceHelper.h

data

IGGridViewDataSourceHelper に使用するデータの配列を取得または設定します。

@property (nonatomic, retain) NSArray *data

注記

データが NSObject から派生し、プロパティを 1 つ以上持つ必要があります。

定義:

IGGridViewDataSourceHelper.h

deleteRowAnimation

行を削除するときに再生するアニメーションのタイプを取得または設定します。

@property (nonatomic, assign) IGGridViewAnimation deleteRowAnimation

定義:

IGGridViewDataSourceHelper.h

displayData

表示されている data を提供する読み取り専用リスト。

@property (nonatomic, readonly) NSArray *displayData

注記

data をフィルターしたばかりの場合、displayData はフィルターと一致する項目のみを含みます。注: sections がない場合 (つまり、groupingKey プロパティが設定されない場合) のみに data を含みます。

定義:

IGGridViewDataSourceHelper.h

displayShortcutbar

ショートカット バーが表示されるかどうかを取得または設定します。

@property (nonatomic, assign) BOOL displayShortcutbar

注記

YES に設定される場合、ショートカット バーを表示するために groupingKey も設定する必要があります。

定義:

IGGridViewDataSourceHelper.h

editingDelegate

セルの編集のデリゲート。

@property (nonatomic, assign) id<> editingDelegate

注記

詳細については、IGGridViewDataSourceHelperEditingDelegate ドキュメントを参照してください。

定義:

IGGridViewDataSourceHelper.h

editingEndTransitionOptions

セルを編集モードから出るトランジションを取得または設定します。

@property (nonatomic, assign) UIViewAnimationOptions editingEndTransitionOptions

注記

注: IGGridViewColumnDefinition はこのプロパティを適用します。

定義:

IGGridViewDataSourceHelper.h

editingStartTransitionOptions

セルを編集モードに入るトランジションを取得または設定します。

@property (nonatomic, assign) UIViewAnimationOptions editingStartTransitionOptions

注記

注: IGGridViewColumnDefinition はこのプロパティを適用します。

定義:

IGGridViewDataSourceHelper.h

editingTransitionDuration

セルが編集モードにし、終了する時間 (秒単位) を取得または設定します。

@property (nonatomic, assign) CGFloat editingTransitionDuration

注記

注: IGGridViewColumnDefinition はこのプロパティを適用します。

定義:

IGGridViewDataSourceHelper.h

fieldsToIgnore

基本 data オブジェクトの自動生成されないプロパティにマップする文字列のコレクション。

@property (nonatomic, readonly) NSMutableArray *fieldsToIgnore

定義:

IGGridViewDataSourceHelper.h

filterShortcutbarValue

ショートカット バーに表示される文字列を取得または設定します。

@property (nonatomic, retain) NSString *filterShortcutbarValue

注記

デフォルトは拡大鏡です。

定義:

IGGridViewDataSourceHelper.h

filterType

filteringKey と関連付けられたプロパティに適用されるフィルタリング条件のタイプを取得または設定します。

@property (nonatomic, assign) IGGridViewFilterConditionType filterType

注記

デフォルト値は IGGridViewFilterConditionTypeStringContains です。

定義:

IGGridViewDataSourceHelper.h

filterValue

データ ソースがフィルターされている値。

@property (nonatomic, readonly) NSString *filterValue

注記

このプロパティは読み取り専用です。

定義:

IGGridViewDataSourceHelper.h

filteringCaseInsensitivity

フィルタリングが大文字と小文字を区別するかどうかを決定するブール値を取得または設定します。

@property (nonatomic, assign) BOOL filteringCaseInsensitivity

注記

デフォルト値は YES です。

定義:

IGGridViewDataSourceHelper.h

filteringDiacriticInsensitiveFiltering

フィルタリングが分音記号を区別するかどうかを決定するブール値を取得または設定します。

@property (nonatomic, assign) BOOL filteringDiacriticInsensitiveFiltering

注記

例: 単語「déjà vu」には 2 つの分音記号があります。YES の場合、無視されます。デフォルト値は YES です。

定義:

IGGridViewDataSourceHelper.h

filteringKey

基本 data オブジェクトのプロパティを表す文字列を取得または設定します。

@property (nonatomic, retain) NSString *filteringKey

注記

data が指定したプロパティに基づいてフィルターできます。data をオブジェクトの全体 (data は文字列の配列など) によってフィルターするには、プロパティの値を「self」に設定する必要があります。

定義:

IGGridViewDataSourceHelper.h

fixedLeftColumns

グリッド ビューの左側に固定される columns を表す IGGridViewColumnDefinition オブジェクトのリスト。

@property (nonatomic, readonly) NSMutableArray *fixedLeftColumns

定義:

IGGridViewDataSourceHelper.h

fixedRightColumns

グリッド ビューの右側に固定される columns を表す IGGridViewColumnDefinition オブジェクトのリスト。

@property (nonatomic, readonly) NSMutableArray *fixedRightColumns

定義:

IGGridViewDataSourceHelper.h

groupingKey

基本 data オブジェクトのプロパティを表す文字列を取得または設定します。

@property (nonatomic, retain) NSString *groupingKey

注記

データ ソースに割り当てられた data の配列で、data がこのプロパティの一意の値に基づいてグループ化されます。data をオブジェクトの全体 (data は文字列の配列など) によってグループ化するには、プロパティの値を「self」に設定する必要があります。

定義:

IGGridViewDataSourceHelper.h

groupingSortDirection

groupingKey に指定した data のグループ化で data が並べ替える順序。

@property (nonatomic, assign) IGGridViewSortedColumnDirection groupingSortDirection

注記

デフォルト値は IGGridViewSortedColumnDirectionAscending です。

定義:

IGGridViewDataSourceHelper.h

isEditing

グリッドのセルが編集されているかどうかを確認します。

@property (nonatomic, readonly) BOOL isEditing

定義:

IGGridViewDataSourceHelper.h

loadMoreDelegate

その他の行を読み込むためのデリゲート。

@property (nonatomic, assign) id<> loadMoreDelegate

注記

詳細については、IGGridViewDataSourceHelperLoadMoreDelegate ドキュメントを参照してください。

定義:

IGGridViewDataSourceHelper.h

sectionData

そのセクションの data のリストを含む sections プロパティの値であるキーを持つ読み取り専用ディクショナリ。

@property (nonatomic, readonly) NSDictionary *sectionData

定義:

IGGridViewDataSourceHelper.h

sectionFooterEnabled

sections のヘッダーが表示されるかどうかを取得または設定します。

@property (nonatomic, assign) BOOL sectionFooterEnabled

注記

groupingKey も設定する必要があります。

定義:

IGGridViewDataSourceHelper.h

sectionHeaderEnabled

sections のフッターが表示されるかどうかを取得または設定します。

@property (nonatomic, assign) BOOL sectionHeaderEnabled

注記

groupingKey も設定する必要があります。

定義:

IGGridViewDataSourceHelper.h

sections

セクションに使用されるすべての一意のキーを含む読み取り専用リスト。

@property (nonatomic, readonly) NSArray *sections

注記

これはショートカット バーで使用される値です。groupingKey が提供された場合のみに、このプロパティが設定されます。

定義:

IGGridViewDataSourceHelper.h

sortedColumns

data が並べ替える順序で開発者定義の IGGridViewSortedColumn オブジェクトのコレクション。

@property (nonatomic, readonly) NSMutableArray *sortedColumns

注記

コレクションの最初の IGGridViewSortedColumn は一番高い優先があります。datagroupingKey プロパティによってグループ化される場合、グループ化されるフィールドは優先があります。グループ化されるフィールドの方向を制御するために groupingSortDirection プロパティを使用します。

定義:

IGGridViewDataSourceHelper.h

インスタンス メソッド

appendData:

新しく指定した data をデータ ソース ヘルパーから提供された元の data に追加します。

- (void)appendData:(NSArray *)newData

パラメーター

newData

データ ソース ヘルパーに割り当てられている data の終了に追加される data の配列。

定義:

IGGridViewDataSourceHelper.h

applyFilterForValue:toData:

オーバーライドされた場合、data のカスタム フィルタリングを設定できます。

- (NSArray *)applyFilterForValue:(NSString *)value toData:(NSArray *)dataToFilter

パラメーター

value

data がフィルターされる文字列。

dataToFilter

フィルターされる data を含む NSArray。

戻り値

フィルターされた data の配列。

注記

カスタム フィルタリングを設定するために、これをオーバーライドします。

定義:

IGGridViewDataSourceHelper.h

beginEditing:inGrid:

編集をサポートする場合、指定したセルを編集モードに入ります。

- (void)beginEditing:(IGCellPath *)cellPath inGrid:(IGGridView *)gridView

パラメーター

gridView

セルを解決する gridView。

cell

編集モードになるセルのパス。

注記

セルが既に編集モードにある場合、最初にセルが編集モードを終了します。指定したセルがビューにない場合、ビューにスクロールされます。

定義:

IGGridViewDataSourceHelper.h

clearFilter:

DataSource に適用されているフィルターを解除し、FilterCell の値をクリアします。

- (void)clearFilter:(IGGridView *)gridView

定義:

IGGridViewDataSourceHelper.h

deNormalizePath:

基本 data にマップする IGCellPath を表示にマップするパスに変換します。

- (IGCellPath *)deNormalizePath:(IGCellPath *)path

パラメーター

path

基本 data にマップする IGCellPath

戻り値

グリッドのセルにマップする IGCellPath

注記

行および columns を切り替えるなどに data の表示を変更する場合、これをオーバーライドします。

定義:

IGGridViewDataSourceHelper.h

deleteColumns:

指定した IGGridViewColumnDefinition オブジェクトを削除します。

- (void)deleteColumns:(NSArray *)columns

パラメーター

columns

グリッド ビューから削除する IGGridViewColumnDefinition オブジェクトの配列。

定義:

IGGridViewDataSourceHelper.h

endEditing

編集モードを終了します。

- (void)endEditing

定義:

IGGridViewDataSourceHelper.h

gridView:applyFilter:

- (void)gridView:(IGGridView *)gridView applyFilter:(NSString *)filterText

insertColumns:atIndex:

指定したインデックスにある指定した IGGridViewColumnDefinition オブジェクトを挿入します。

- (void)insertColumns:(NSArray *)columns atIndex:(int)index

パラメーター

columns

グリッド ビューに挿入する IGGridViewColumnDefinition オブジェクトの配列。

index

columns を挿入するインデックス。

定義:

IGGridViewDataSourceHelper.h

invalidateData

データ ソース ヘルパーに data を再評価することを通知します。

- (void)invalidateData

注記

セクションの計算、フィルターまたは並べ替えの適用、データ ソースの行数の計算、columns の生成などの操作のために使用されます。

定義:

IGGridViewDataSourceHelper.h

invalidateData:

データ ソース ヘルパーに data を再評価することを通知します。

- (void)invalidateData:(BOOL)invalidateColumns

パラメーター

invalidateColumns

columns をリセットし、再生成する必要がある場合 YES。

注記

セクションの計算、フィルターまたは並べ替えの適用、データ ソースの行数の計算、columns の生成などの操作のために使用されます。

定義:

IGGridViewDataSourceHelper.h

normalizePath:

IGCellPath を基本 data にマップするパスに変換します。

- (IGCellPath *)normalizePath:(IGCellPath *)path

パラメーター

path

IGGridView のセルにマップする IGCellPath

戻り値

data ソースの実際の項目にマップするために変換された IGCellPath

注記

行および columns を切り替えるなどに data の表示を変更する場合、これをオーバーライドします。

定義:

IGGridViewDataSourceHelper.h

resolveCellPathForData:

指定した値のセルを検索するために逆引き参照を実行します。

- (IGCellPath *)resolveCellPathForData:(NSObject *)data

パラメーター

data

データソースに割り当てられた data の配列に検索する data オブジェクト。

戻り値

指定した data オブジェクトのセル位置へのパス。検索されない場合は nil。

定義:

IGGridViewDataSourceHelper.h

resolveDataObjectForRow:

特定の IGRowPath のその位置にある配列の data オブジェクトを識別します。

- (id)resolveDataObjectForRow:(IGRowPath *)path

パラメーター

path

IGGridView の行にマップする IGRowPath

戻り値

データ ソースに割り当てられた配列の項目。

定義:

IGGridViewDataSourceHelper.h

resolveDataValueForCell:

特定の IGCellPathdata オブジェクトおよびプロパティ値を識別します。

- (id)resolveDataValueForCell:(IGCellPath *)path

パラメーター

path

IGGridView のセルにマップする IGCellPath

戻り値

指定したパスのプロパティ値。

定義:

IGGridViewDataSourceHelper.h