DZNEmptyDataSet-空白数据集显示框架的使用&扩展

DZNEmptyDataSet的GitHub地址：https://github.com/dzenbot/DZNEmptyDataSet

如何使用DZNEmptyDataSet：http://cocoadocs.org/docsets/DZNEmptyDataSet/1.8.1/

DZNEmptyDataSet介绍

DZNEmptyDataSet 是基于 UITableView／UICollectionView 的扩展（category）类，它可以在空白页面上显示提示信息。

主要是实现两个协议，分别为DZNEmptyDataSetSource和DZNEmptyDataSetDelegate。这两个协议中的协议方法均为@optional类型。默认就是简单的空白页。

文件目录

UIScrollView+EmptyDataSet.h

UIScrollView+EmptyDataSet.m

这里注意一下，在UIScrollView+EmptyDataSet.m中有DZNEmptyDataSetView类，这个类主要是展示空数据的view；以后自定义的view 也是加在DZNEmptyDataSetView中的contentView上的。

这里还要注意一下，自定义的view用该开源库点击事件无效。

首先，先介绍一下使用该库默认的展现形式DZNEmptyDataSetSource 和 DZNEmptyDataSetDelegate

@interface UIScrollView (EmptyDataSet)
//两个代理
@property (nonatomic, weak) IBOutlet id <DZNEmptyDataSetSource> emptyDataSetSource;
@property (nonatomic, weak) IBOutlet id <DZNEmptyDataSetDelegate> emptyDataSetDelegate;
/** YES if any empty dataset is visible. */
@property (nonatomic, readonly, getter = isEmptyDataSetVisible) BOOL emptyDataSetVisible;


/**
 *调用UITableView或者UICollectionView的［-reloadData］方法便会相应此方法。
 * 当且仅当列表数据源为空的时候才会触发。
 */

- (void)reloadEmptyDataSet;

@end

DZNEmptyDataSetSource

该协议主要作用：数据源为空时的对空白界面元素的设置：对Title、description、image、imageTintColor、imageAnimation、buttonTitle、buttonImage，以及元素之间间距、垂直的偏移量等属性的设置。

/**
 * 设置默认空白界面处理视图的标题Title.
 * 若需要设置富文本，则返回时设置(NSAttributedString *)类型。
 */
- (NSAttributedString *)titleForEmptyDataSet:(UIScrollView *)scrollView;

/**
 * 设置默认空白界面处理视图的描述description文本。
 * 若需要设置富文本，则返回时设置(NSAttributedString *)类型。
 */
- (NSAttributedString *)descriptionForEmptyDataSet:(UIScrollView *)scrollView;

/**
 * 设置默认空白界面布局的图片。
 */
- (UIImage *)imageForEmptyDataSet:(UIScrollView *)scrollView;

/**
 * 设置默认空白界面布局图片的前景色，默认为nil.，一般不需要实现它。
 */
- (UIColor *)imageTintColorForEmptyDataSet:(UIScrollView *)scrollView;

/**
 * 设置默认空白界面图片的动画效果。
 */
- (CAAnimation *) imageAnimationForEmptyDataSet:(UIScrollView *) scrollView;

/**
 * 设置默认空白界面响应按钮的标题，通常我们可以设置为"重新加载"等文本。
 * 如果需要显示不同的标题样式，可以返回富文本。
 * 并传入UIControlState进行设置。点击-highted或normal状态等。
 */
- (NSAttributedString *)buttonTitleForEmptyDataSet:(UIScrollView *)scrollView forState:(UIControlState)state;

/**
 * 设置默认空白界面响应按钮的图片。
 * 并传入UIControlState进行设置。点击或者普通状态等。
 */
- (UIImage *)buttonImageForEmptyDataSet:(UIScrollView *)scrollView forState:(UIControlState)state;

/**
 * 设置默认空白界面响应按钮的背景图片。默认不设置。
 * 并传入UIControlState进行设置。点击或者普通状态等。
 */
- (UIImage *)buttonBackgroundImageForEmptyDataSet:(UIScrollView *)scrollView forState:(UIControlState)state;

/**
 * 设置默认空白界面的背景颜色。默认为[UIColor clearColor]
 */
- (UIColor *)backgroundColorForEmptyDataSet:(UIScrollView *)scrollView;

/**
 * 设置默认空白界面的自定义视图View, View中可以高度自定义，包括按钮图片以及标题等元素。
 * 并传入UIControlState进行设置。点击或者普通状态等。
 * 返回自定义视图，将会忽略以下方法的配置。
 * -offsetForEmptyDataSet 和 -spaceHeightForEmptyDataSet
 */
- (UIView *)customViewForEmptyDataSet:(UIScrollView *)scrollView;

/**
 * 设置界面的垂直和水平方向的对齐约束， 默认为CGPointZero,居中显示
 */

- (CGFloat)verticalOffsetForEmptyDataSet:(UIScrollView *)scrollView;

/**
 * 设置界面元素（image，description，button）的垂直间距，默认为11px。
 */
- (CGFloat)spaceHeightForEmptyDataSet:(UIScrollView *)scrollView;

DZNEmptyDataSetDelegate

该协议主要作用:处理该空白界面的代理。用于获取代理的响应回调。

@protocol DZNEmptyDataSetDelegate <NSObject>
@optional

/**
实现该方法告诉代理EmptyDataSetView显示时以淡入的模式，默认为YES。没发现yes or no的效果 😶
 */
- (BOOL)emptyDataSetShouldFadeIn:(UIScrollView *)scrollView;

/**
 实现该方法告诉代理EmptyDataSetView是否一直显示，默认为NO。若为YES，当为数据集的条数大于0时，这个空白页也一直显示。一般 不用实现
 */
- (BOOL)emptyDataSetShouldBeForcedToDisplay:(UIScrollView *)scrollView;

/**
 实现该方法告诉代理EmptyDataSetView显示时应该被渲染。默认为YES。
 */
- (BOOL)emptyDataSetShouldDisplay:(UIScrollView *)scrollView;

/**
 实现该方法告诉代理该视图可以响应点击事件，默认为YES。
 */
- (BOOL)emptyDataSetShouldAllowTouch:(UIScrollView *)scrollView;

/**
实现该方法告诉代理该视图允许滚动，默认为NO。
 */
- (BOOL)emptyDataSetShouldAllowScroll:(UIScrollView *)scrollView;

/**
实现该方法告诉代理该视图中的图片允许执行动画，默认为NO。
 */
- (BOOL)emptyDataSetShouldAnimateImageView:(UIScrollView *)scrollView;

/**
  实现该方法告诉代理emptyDataSetView被点击
使用该方法要么对textfield或者searchBar调用了resignFirstResponder方法。
 */
- (void)emptyDataSet:(UIScrollView *)scrollView didTapView:(UIView *)view;

/**
实现该方法告诉代理，响应按钮点击事件被触发
 */
- (void)emptyDataSet:(UIScrollView *)scrollView didTapButton:(UIButton *)button;

/**
 实现该方法告诉代理，emptyDataView视图即将出现。
 */
- (void)emptyDataSetWillAppear:(UIScrollView *)scrollView;

/**
实现该方法告诉代理，emptyDataView视图已经出现
 */
- (void)emptyDataSetDidAppear:(UIScrollView *)scrollView;

/**
 实现该方法告诉代理，emptyDataView视图即将消失。
 */
- (void)emptyDataSetWillDisappear:(UIScrollView *)scrollView;

/**
实现该方法告诉代理，emptyDataView视图已经消失。
 */
- (void)emptyDataSetDidDisappear:(UIScrollView *)scrollView;

@end

接下来看一下UIScrollView+EmptyDataSet.m 中的实现，发现里面大部分都是通过runtime初始化和设置的。代码中很详细，这里就不一一赘述了。

自定义View - 实现空白页的显示

这里要说一下，当要使用自定义的view 的时候，发现自定义的view 的背景颜色不显示，点击事件不响应。so 我们要稍微改动一下源码。

UIScrollView+EmptyDataSet.m 中

公共【-reloadEmptyDataSet】调用私有【-dzn_reloadEmptyDataSet 】
【-dzn_reloadEmptyDataSet 】调用【-dzn_customView】
【-dzn_customView】发现该自定义的view 加在了DZNEmptyDataSetView的contentView 上了，并且给出了customView 的autolayout 约束【-setupConstraints】

 if (_customView) {
        [self.contentView addConstraints:[NSLayoutConstraint constraintsWithVisualFormat:@"H:|[customView]|" options:0 metrics:nil views:@{@"customView":_customView}]];
        [self.contentView addConstraints:[NSLayoutConstraint constraintsWithVisualFormat:@"V:|[customView]|" options:0 metrics:nil views:@{@"customView":_customView}]];
    }

修改为


  CGFloat  height = _customView.bounds.size.height;
        [self.contentView addConstraints:[NSLayoutConstraint constraintsWithVisualFormat:@"H:|[customView]|" options:0 metrics:nil views:@{@"customView":_customView}]];
        [self.contentView addConstraints:[NSLayoutConstraint constraintsWithVisualFormat:@"V:|[customView(==height)]|" options:0 metrics:@{@"height":@(height)} views:@{@"customView":_customView}]];

DZNEmptyDataSetView实现方法中

- (UIView *)hitTest:(CGPoint)point withEvent:(UIEvent *)event
{
    UIView *hitView = [super hitTest:point withEvent:event];
    
    // Return any UIControl instance such as buttons, segmented controls, switches, etc.
    if ([hitView isKindOfClass:[UIControl class]]) {
        return hitView;
    }
    
    // Return either the contentView or customView
    if ([hitView isEqual:_contentView] || [hitView isEqual:_customView]) {
        return hitView;
    }
// 添加的部分，判断是否点击空白页
    if ([hitView isKindOfClass:[DZNEmptyDataSetView class]]) {
        return hitView;
    }
    return nil;
}

这样就可以自定义view了