自定义UITableViewIndex

关于UITableViewIndex

UITableViewIndex继承自UIControl，它是一个tableView里使用的一个控件，但是不是一个公开的类，如下图中右边侧栏的索引条就是UITableViewIndex

UITableViewIndex

UITableViewIndex主要作用是，当一个有较多分类的tableView的内容比较多的时候，提供了一个快速索引的功能，可以通过点击和滑动两种方式快速索引，并在iOS10及以后，增加了一个震动的反馈效果。
UITableViewIndex的使用非常简单，只需要实现UITableViewDataSource的两个方法：

// Index

- (nullable NSArray *)sectionIndexTitlesForTableView:(UITableView *)tableView;                               
// return list of section titles to display in section index view (e.g. "ABCD...Z#")
- (NSInteger)tableView:(UITableView *)tableView sectionForSectionIndexTitle:(NSString *)title atIndex: 
(NSInteger)index;  // tell table which section corresponds to section title/index (e.g. "B",1))

第一个方法是提供UITableViewIndex显示的内容，即一个包含NSString类型的数组。第二个方法是提供tableView的section和索引Index的对应关系。完成这两步，你就可以实现一个系统通讯录的快速索引的效果了。除此之外，UITableView还提供了设置背景颜色，字的颜色的设置。遗憾的是，这在很多场景下是不够用的，缺乏灵活性。我们可能需要一些常用的功能，如改变frame，字体大小，索引用icon显示，索引的某个标题选中的颜色等。
为了实现这些功能，我们先了解一下UITableViewIndex的层级关系：

视图层级

UITableViewIndex是在tableView的一个subView，在最上层悬浮着。通过classdump分析的UITableViewIndex的头文件内容：

@interface UITableViewIndex : UIControl {
    NSArray* _titles;
    UIFont* _font;
    long long _selectedSection;
    bool _pastTop;
    bool _pastBottom;
    CGSize _cachedSize;
    CGSize _cachedSizeToFit;
    UIColor* _indexColor;
    UIColor* _indexBackgroundColor;
    UIColor* _indexTrackingBackgroundColor;
    double _topPadding;
    double _bottomPadding;
    double _verticalTextHeightEstimate;
    NSArray* _entries;
    long long _idiom;
}

我们可以通过runtime的方法修改font和frame，但是自定义标题选中的颜色就无能无力了

索引选中效果.jpg

自定义UITableViewIndex

索引的功能并不复杂，我们完全可以自定义实现更多配置的tableViewIndex。因为整个的实现思路还是很清晰的，所以本文不会详细写如何实现，只是记录实现过程中的一些重要的点。

1. tableView在滑动过程中，会不断复用cell，header，这个过程会removeSubview和addSubView，自定义的tableViewIndex需要一直在顶部，可以在

   - (void)tableView:(UITableView *)tableView willDisplayHeaderView:(UIView *)view forSection:(NSInteger)section NS_AVAILABLE_IOS(6_0);
   

中使用bringSubviewToFront调整到最上层

2. 索引的震动效果是通过UIImpactFeedbackGenerator实现的，只在iOS10上可用
3. 如果需要有索引选中的效果，在滚动tableView的时候，需要同步索引栏的选中状态。这里可以在scrollViewDidScroll事件中，使用rectForHeaderInSection方法计算当前的索引位置