【初心者向け】UITableViewDelegateで出来ること

【初心者向け】UITableViewDelegateで出来ること

Table of Contents

UITableViewDelegateとはUITableViewの操作イベントをハンドリングするプロトコルです。 単純なセルのタップイベントをはじめ、 今回はタップのみですが、それ以外にも様々なイベントフックや制御ができます。

この記事では UITableViewDelegateには何が用意されているのか？
このprotocolを使ってどのようなことが出来るのか？についてとっかかりを掴むページを想定してます。

実際の詳細に関しては記事内の随所に詳細ページへの紹介をしているので、気になるページがあれば閲覧してください。

表示と非表示のイベント

セルやセクションの表示の直前直後を検知できます。

利用ケースはそこまで高くはありませんが、例えばユーザーの視界に入ったセル数を集計したいときなどにイベントマーキングなどが考えられます。

  • セル表示直前: func tableView(_:willDisplay:forRowAt:)
  • セクションヘッダー表示直前: func tableView(_:willDisplayHeaderView:forSection:)
  • セクションフッター表示直前: func tableView(_:willDisplayFooterView:forSection:)
  • セル非表示直後: func tableView(_:didEndDisplaying:forRowAt:)
  • セクションヘッダー非表示直後: func tableView(_:didEndDisplayingHeaderView:forSection:)
  • セクションフッター非表示直後: func tableView(_:didEndDisplayingFooterView:forSection:)

セルやセクションの高さ制御

  • セルの高さを返す: func tableView(_:heightForRowAt:) -> CGFloat
  • セクションヘッダーの高さを返す: func tableView(_:heightForHeaderInSection:) -> CGFloat
  • セクションフッターの高さを返す: func tableView(_:heightForFooterInSection:) -> CGFloat
  • セルの推定高さを返す: func tableView(_:estimatedHeightForRowAt:) -> CGFloat
  • セクションヘッダーの推定高さを返す: func tableView(_:estimatedHeightForHeaderInSection:) -> CGFloat
  • セクションフッターの推定高さを返す: func tableView(_:estimatedHeightForFooterInSection:) -> CGFloat

セルやセクションヘッダー、セクションフッターの高さを調整するためのイベントになります。
このイベントを使うことで、個別に高さ制御が可能になります。

estimated は推定値

なお estimated とつくメソッドは推測値を返すイベントです。
この値をなるべくなるであろう高さに返しておくことで、セル高さ調整差が狭まり表示完了までの速度が早まります。
デフォルトは automaticDimension であり、これは自動で高さを推定します。
0にすると推定が無効となり、セル毎の実際の高さを要求されます。
Xcode9以降はSelf-Sizingがデフォルトとなるため、0にすると正常に動きません。

セル高さ可変制御する

なおセルの高さをAuto-Layoutによる算出で可変にする方法はこちらの記事をどうぞ。

【初心者向け】UITableViewCellの高さを可変にする
次の`UITableViewDelegate`のメソッドを使うことでセル毎やセクション毎の高さ設定ができますが、まず大抵のケースでは使いません。 なぜなら`UITableView.rowHeight`に `UITableView.automaticDimension` を渡し、各セルをAuto-Layoutが効くような実装にすれば 自動でセルの高さを計算してくれるためです。

一律制御もある

なお、これとは反対に全体で一律制御は次のプロパティでできます。

  • UITableView.rowHeight
  • UITableView.estimatedRowHeight
  • UITableView.sectionFooterHeight
  • UITableView.estimatedSectionFooterHeight
  • UITableView.sectionHeaderHeight
  • UITableView.estimatedSectionFooterHeight

セクションヘッダーとセクションフッターのカスタマイズ

セクションヘッダーとフッターのカスタマイズに関するイベントメソッドです。

  • func tableView(_:viewForHeaderInSection:) -> UIView?
  • func tableView(_:viewForFooterInSection:) -> UIView?

カスタマイズする方法についてはこちらの記事をどうぞ。

【初心者向け】UITableViewのヘッダーをカスタマイズする
UITableViewのヘッダーとはセクション毎の上下表示されるSectionHeader(セクションヘッダー)とSectionFooter(セクションフッター)のことを指しこれらはカスタマイズ可能です。シンプルなカスタマイズであれば`UITableDataSource`の`titleForHeaderInSection`などを変更することで簡単なカスタマイズは可能です。しかし、独自UIViewなどを設定したいなど複雑な場合は`UITableViewDelegate`を使った実装が必要になります。この記事ではその独自UIViewなどを使ったヘッダーの実装方法について説明します。

アクセサリーボタンのタップ検知

  • func tableView(_:accessoryButtonTappedForRowWith:)

セル毎のアクセサリーボタンがタップされたときに呼ばれます。
ボタンタップしたらハンドリングする処理などで使います。

アクセサリに関してはこちらの記事をどうぞ。

【初心者向け】UITableViewCellのAccessory(アクセサリ)の使い方
UITableViewCellには予めAccessory(アクセサリ)が用意されており、全部で4種類あります。

セルの選択イベント

  • セルタップ制御: func tableView(_:shouldHighlightRowAt:) -> Bool
  • セルハイライト直後: func tableView(_:didHighlightRowAt:)
  • セルハイライト解除直後: func tableView(_:didUnhighlightRowAt:)
  • セル選択直前: func tableView(_:willSelectRowAt:) -> IndexPath?
  • セル選択解除直前: func tableView(_:willDeselectRowAt:) -> IndexPath?
  • セル選択直後: func tableView(_:didSelectRowAt:)
  • セル選択解除直後: func tableView(_:didDeselectRowAt:)

セルタップ制御では、falseを返したセルはタップしてもハイライトにもタップイベントも呼ばれません。
ラベルセルとして実装する場合にここをfalseにしてタップできないようにします。

セル選択直前とセル選択解除直前の戻り値は返したセル位置が実際に選択状態を変更します。
正直使うケースに出くわしたことはありません。

セル選択直後はセルがタップされたときにここにセルごとの処理を記述することで、セルのタップハンドリングができます。

詳細はこちらの記事をどうぞ。

【初心者向け】UITableViewのセル選択を制御する方法
UITableViewのUITableViewCell(セル)をタップを検知する実装方法について説明します。

編集制御

セルを右や左にスワイプすることで横からアクションメニューを表示したり、ソートや削除するさいに使います。 メソッド一覧は量が多いので省きます。

実際にどういったことが出来るのか詳細はこちらの記事をどうぞ。

【初心者向け】UITableViewのセルの編集制御を極める
UITableViewのセルには編集モードというものがあり、セルを並び替えたり削除したり、セルを左右にスワイプすることでアクションメニューを表示したいときに使います。 実際にどういったことが出来るのかコードと動画を使って分かりやすくまとめてみました。
このエントリーをはてなブックマークに追加