前言:
若只是想做垂直方向的單一列表,UITableView 綽綽有餘;一旦需要橫向滑動清單、gridView 這類線性版面,用 UICollectionView 搭配 UICollectionViewFlowLayout 就是最合適的組合;碰上更複雜的版面,則可以動用 UICollectionView 加上自訂 Layout 來實現。本文就來把 UICollectionViewLayout 這個關鍵角色徹底拆解。
先看官方定義:UICollectionViewLayout 是一個應該被子類化的抽象基底類別,用來產生 collection view 的版面資訊。版面物件決定 cell、追加視圖(supplementary views)與裝飾視圖(decoration views)在 collection view 內部的位置,並在 collection view 索取時提供這些資訊,最後由 collection view 把這些資訊套用到各個視圖上呈現在螢幕裡。
想動用 UICollectionViewLayout,就非得把它子類化不可。但在子類化之前,建議先認識一下 UICollectionViewFlowLayout,確認它是否已經滿足你的版面需求——畢竟它是官方提供、能解決絕大多數情境的現成子類。
版面物件主要負責為 collection view 的元素提供位置資訊與狀態資訊(例如選中、未選中)。要特別澄清的是,版面物件並不負責建立視圖——視圖是由 collection view 的資料來源(data source)所產生,版面物件只定義了這些視圖的位置與大小。
Collection view 有三種需要排版的視圖元素:
Cells:cell 是版面裡的主角,每個 cell 代表一筆獨立的資料項。一個 collection view 可能只有唯一一組 cell,也可能把這組 cell 拆進多個 section。版面物件的核心職責,就是在 collection view 的內容區裡妥善安排這些 cell。
Supplementary views(追加視圖):追加視圖代表與 cell 完全不同的資料。它不支援選中/未選中狀態,可用來替某個 section 加上段首、段尾,或替整個 collection view 加上頭尾。追加視圖並非必備,做不做都行,其使用與版面安排同樣由版面物件決定。
Decoration views(裝飾視圖):裝飾視圖純粹用來點綴,同樣不支援選中/未選中狀態,也和資料沒有內在關聯(不像 cell 和 section 得回傳個數)。你可以把它看作另一種追加視圖,其使用與版面同樣交由版面物件定奪。
Collection view 會在不同時刻向它的版面物件索取這些元素的版面資訊。螢幕上出現的每一個 cell 與 view,其資訊都源自版面物件;同樣地,當 collection view 插入或刪除 item 時,對應的版面物件也會被加入或移除。這裡有個關鍵:collection view 的排版僅限於螢幕可見的範圍。也就是說,即便你替所有元素都建好了版面物件,真正被排版的也只有可見區域,超出螢幕的部分並不會被處理。
每個版面物件都得實作以下幾個方法:
- (CGSize)collectionViewContentSize;
回傳 collectionView 內容區的寬與高,子類必須重載。返回值代表所有內容的整體尺寸,而非僅是可見範圍。collectionView 靠它來設定滾動範圍,預設回傳 CGSizeZero。
- (NSArray<__kindof UICollectionViewLayoutAttributes *> *)layoutAttributesForElementsInRect:(CGRect)rect;
回傳一個 UICollectionViewLayoutAttributes 型別的陣列,每個物件都承載著 cell 或 view 的版面資訊。子類必須重載,並回傳該矩形區域內所有元素(含 cell、追加視圖與裝飾視圖)的版面資訊。
建立 layout attributes 時,要針對不同元素類型建立對應的 attributes 物件,例如:
+ (instancetype)layoutAttributesForCellWithIndexPath:(NSIndexPath *)indexPath;
+ (instancetype)layoutAttributesForSupplementaryViewOfKind:(NSString *)elementKind withIndexPath:(NSIndexPath *)indexPath;
+ (instancetype)layoutAttributesForDecorationViewOfKind:(NSString*)decorationViewKind withIndexPath:(NSIndexPath *)indexPath;
Collection view 會依據類型區分屬性,並據此決定該建立怎樣的視圖、如何管理。
-(UICollectionViewLayoutAttributes *)layoutAttributesForItemAtIndexPath:(NSIndexPath *)indexPath
回傳指定 indexPath 的 item 版面資訊,子類必須重載。要注意:此方法只能為 cell 提供資訊,無法服務補充視圖與裝飾視圖。
- (UICollectionViewLayoutAttributes *)layoutAttributesForSupplementaryViewOfKind:(NSString *)kind atIndexPath:(NSIndexPath *)indexPath;
只要你的版面支援追加視圖,就必須重載此方法。kind 參數用來區分段首還是段尾,在 collection view 註冊時會用到。
- (UICollectionViewLayoutAttributes *)layoutAttributesForDecorationViewOfKind:(NSString*)decorationViewKind atIndexPath:(NSIndexPath *)indexPath;
只要你的版面支援裝飾視圖,就必須重載此方法。decorationViewKind 參數同樣在 collection view 註冊時派上用場。
- (BOOL)shouldInvalidateLayoutForBoundsChange:(CGRect)newBounds
此方法用來決定是否需要更新版面:collection view 需要重新排版就回傳 YES,否則回傳 NO,預設為 NO。子類重載時,要根據「bounds 改變是否會引發 cell 與 view 的版面變化」給出正確答案。若回傳 YES,collection view 便會呼叫 invalidateLayoutWithContext 讓原本的版面失效。
以上方法為 collection view 在螢幕上排版提供了最基礎的資訊。若你不想為追加視圖與裝飾視圖排版,不去重載對應方法也無妨。
當 collection view 的資料發生變化(例如插入或刪除 item),它會要求版面物件更新對應資訊。移動、新增、刪除 item 時都必須更新版面,才能反映元素最新的位置。對於移動的元素,collection view 提供了標準方法取得更新後的資訊;而新增或刪除時,則會呼叫幾個不同方法,你應該重載它們以提供正確資訊:
- (UICollectionViewLayoutAttributes *)initialLayoutAttributesForAppearingItemAtIndexPath:(NSIndexPath *)itemIndexPath
當一個 item 被插入 collection view 時,回傳起始的版面資訊。此方法在 prepareForCollectionViewUpdates: 之後、finalizeCollectionViewUpdates 之前呼叫。collection view 會把它當作動畫的起點(終點則是該 item 在 collection view 中的最新位置)。若回傳 nil,版面物件會拿 item 的最終 attributes 同時充當起點與終點。
- (UICollectionViewLayoutAttributes *)initialLayoutAttributesForAppearingSupplementaryElementOfKind:(NSString *)elementKind atIndexPath:(NSIndexPath *)elementIndexPath
回傳追加視圖插入 collection view 時的版面資訊,用法同上。
- (UICollectionViewLayoutAttributes *)initialLayoutAttributesForAppearingDecorationElementOfKind:(NSString *)elementKind atIndexPath:(NSIndexPath *)elementIndexPath
回傳裝飾視圖插入 collection view 時的版面資訊,用法同上。
- (UICollectionViewLayoutAttributes *)finalLayoutAttributesForDisappearingItemAtIndexPath:(NSIndexPath *)itemIndexPath
回傳 item 即將從 collection view 移除時的版面資訊。對即將刪除的 item 而言,此方法同樣在 prepareForCollectionViewUpdates: 之後、finalizeCollectionViewUpdates 之前呼叫,回傳的資訊需包含 item 的狀態與位置。collection view 會把它當作動畫的終點(起點則是 item 目前的位置)。若回傳 nil,版面物件會拿目前的 attribute 同時作為起點與終點。
- (UICollectionViewLayoutAttributes *)finalLayoutAttributesForDisappearingSupplementaryElementOfKind:(NSString *)elementKind atIndexPath:(NSIndexPath *)elementIndexPath
- (UICollectionViewLayoutAttributes *)finalLayoutAttributesForDisappearingDecorationElementOfKind:(NSString *)elementKind atIndexPath:(NSIndexPath *)elementIndexPath
這兩個方法分別回傳追加視圖與裝飾視圖即將消失時的版面資訊,道理與上面完全相同。
除了這些,你也可以重載 - (void)prepareForCollectionViewUpdates:(NSArray *)updateItems; 來做一些與版面相關的準備工作,或重載 - (void)finalizeCollectionViewUpdates; 把動畫塞進 block,或處理與最終版面相關的收尾。
自訂版面時,應該設法只讓「真正改變的部分」失效,以此提升效能。當你改動 item 時,若直接呼叫 invalidateLayout 強制 collection view 重算全部版面並套用,開銷不小。更好的做法是只重算改變的部分——這正是 Invalidation Contexts 存在的意義。你可以透過它標明版面何處發生改變,版面物件便能據此大幅減少重算的資料量。
做法是:透過子類化 UICollectionViewLayoutInvalidationContext,為你的版面定義一個自訂的 invalidation context。在子類中宣告一些代表「可獨立重算資料」的屬性。當你需要讓版面失效時,就建立一個該子類的實例、設定好自訂屬性,再把它傳給 invalidateLayoutWithContext: 方法;你的方法便能依 context 中的資訊只重算改變的區塊。
若你定義了自訂的 invalidation context 類別,也別忘了重載 invalidationContextClass 方法並回傳該類別。如此一來,collection view 每次需要 context 時都會建立你指定的類別實例,確保自訂物件拿到正確的 context。
@property(nonatomic, readonly) UICollectionView *collectionView:當一個新的版面物件被指派給 collection view 時,collection view 會設定此屬性。
+ (Class)layoutAttributesClass:回傳建立版面資訊時所用的類別。若你建立了繼承自 UICollectionViewLayoutAttributes 的子類,也應重載此方法並回傳該子類。此方法純為子類化而設,無需在程式碼中主動呼叫。
- (void)prepareLayout:通知版面物件更新目前的版面。版面更新發生在 collection view 首次呈現內容時,以及因 view 改變導致版面失效時。更新期間,collection view 會第一步就呼叫此方法,讓版面物件有機會做準備。預設不做任何事,子類可重載它以進行資料建立或計算。
- (UICollectionViewLayoutAttributes *)layoutAttributesForInteractivelyMovingItemAtIndexPath:(NSIndexPath *)indexPath withTargetPosition:(CGPoint)position:當 item 在手勢互動下移動時,回傳該 item 的版面 attributes。預設實作會複製既有的 attributes,改掉中心點與 z 軸座標(設為最大值,使其浮於最上層)。子類重載時,可先呼叫 super 取得 attributes,再依需求自訂回傳。
- (CGPoint)targetContentOffsetForProposedContentOffset:(CGPoint)proposedContentOffset:進行動畫式版面時,回傳內容區的偏移量,作為動畫的終點。若動畫或轉場造成 item 位置改變並非以最佳方式呈現,可重載此方法加以優化。collection view 會在呼叫 prepareLayout 與 collectionViewContentSize 之後呼叫它。
- (CGPoint)targetContentOffsetForProposedContentOffset:(CGPoint)proposedContentOffset withScrollingVelocity:(CGPoint)velocity:回傳滑動停止的點。若你希望內容區快速滑到指定區域,可重載它。例如讓滑動停在兩個 item 中間,而非某個 item 正中。
- (void)prepareForCollectionViewUpdates:(NSArray *)updateItems:插入或刪除 item 時,collection view 會通知版面物件即將調整版面,第一步就是呼叫它告知發生了什麼改變,同時也可用來取得插入、刪除、移動 item 的版面資訊。
- (void)finalizeCollectionViewUpdates:上文已介紹。
- (NSArray
- (NSArray
- (NSArray
- (NSArray
- (NSIndexPath *)targetIndexPathForInteractivelyMovingItem:(NSIndexPath *)previousIndexPath withPosition:(CGPoint)position:依據 item 在 collection view 中的位置取得其 index path。第一個參數是 item 原本的 index path,第二個是 item 目前的位置。移動過程中,此方法把位置映射為對應的 index path,預設會找出該位置既有的 cell 並回傳其 index path;若同一位置有多個 cell,預設回傳最上層者。你可重載它以改變判定方式(例如回傳 z 軸最底層的 cell),重載時不必呼叫 super。
- (void)invalidateLayout:讓目前的版面失效並觸發更新,任何時刻都能呼叫。它會使 collection view 的版面立即失效,你可在同一個 block 內多次呼叫而不觸發多次更新。重載時必須呼叫 super。
- (void)invalidateLayoutWithContext:(UICollectionViewLayoutInvalidationContext *)context:只讓版面的部分區域失效,是對 invalidateLayout 的優化,效力取決於 UICollectionViewLayoutInvalidationContext 型別的屬性。若你自訂了該型別,就應重載並使用自訂型別,重載時同樣必須呼叫 super。
+ (Class)invalidationContextClass:當你子類化 UICollectionViewLayout 並以自訂 context 優化更新時,重載它並回傳 UICollectionViewLayoutInvalidationContext 的子類。
- (BOOL)shouldInvalidateLayoutForBoundsChange:(CGRect)newBounds:決定 collection view 是否能進行版面更新,預設 NO。子類重載時,依 cell 或追加視圖是否發生版面改變回傳正確值。
- (UICollectionViewLayoutInvalidationContext *)invalidationContextForBoundsChange:(CGRect)newbounds:collection view 的 bounds 改變時回傳的無效 context,描述 bounds 變化後需調整的部分。預設會透過 invalidationContextClass 建立實例並回傳。若想自訂,可重載此方法:第一步先呼叫 super 取得 context,再為它設定自訂屬性後回傳。
- (BOOL)shouldInvalidateLayoutForPreferredLayoutAttributes:(UICollectionViewLayoutAttributes *)preferredAttributes withOriginalAttributes:(UICollectionViewLayoutAttributes *)originalAttributes:當 collection view 含 self-sizing(自排列)cell 時,這些 cell 能在 attributes 套用前更改它們。當一個自排列 cell 指出不同於版面物件給出的 size 時,就會觸發此方法判斷是否需更新,預設回傳 NO。
- (UICollectionViewLayoutInvalidationContext *)invalidationContextForPreferredLayoutAttributes:(UICollectionViewLayoutAttributes *)preferredAttributes withOriginalAttributes:(UICollectionViewLayoutAttributes *)originalAttributes:回傳一個含「需改變資訊」的 context,預設用 invalidationContextClass 建立實例。自訂時同樣先呼叫 super 取得 context,再設屬性後回傳。
- (UICollectionViewLayoutInvalidationContext *)invalidationContextForInteractivelyMovingItems:(NSArray *)targetIndexPaths withTargetPosition:(CGPoint)targetPosition previousIndexPaths:(NSArray *)previousIndexPaths previousPosition:(CGPoint)previousPosition
- (UICollectionViewLayoutInvalidationContext *)invalidationContextForEndingInteractiveMovementOfItemsToFinalIndexPaths:(NSArray *)indexPaths previousIndexPaths:(NSArray *)previousIndexPaths movementCancelled:(BOOL)movementCancelled
- (void)prepareForAnimatedBoundsChange:(CGRect)oldBounds:collection view 在 bounds 動態改變或插入、刪除 items 之前呼叫。可在此進行相關計算,例如算出插入、刪除 item 的初始與最終位置,也能添加處理插入、刪除與 bounds 改變的動畫。
- (void)finalizeAnimatedBoundsChange:在 item 插入、刪除與 bounds 改變動畫完成後,清空相關操作。
- (void)prepareForTransitionFromLayout:(UICollectionViewLayout *)oldLayout:告知版面物件將作為新版面被導入 collection view,此方法先於轉場之前執行,可在此做初始化、生成版面 attributes。
- (void)prepareForTransitionToLayout:(UICollectionViewLayout *)newLayout:告知版面物件即將從 collection view 移除,同樣先於轉場之前執行,可在此做初始化、生成版面 attributes。
- (void)finalizeLayoutTransition:collection view 取得從一個版面轉向另一個版面所需的全部版面 attributes 後呼叫。可用它清空前兩個方法所生成的資料與快取。
- (void)registerClass:(Class)viewClass forDecorationViewOfKind:(NSString *)decorationViewKind;
- (void)registerNib:(UINib *)nib forDecorationViewOfKind:(NSString *)decorationViewKind;