[iOS]UIPageViewController使用--API篇

关于** UIPageViewController**, 在之前做翻书效果的时候使用过一次(iOS UIPageViewController - 使用总结), 之后就再没怎么接触, 后来发现这个类值得学习的地方, 还是很多的, 在这里再重新学习一下这个类.

打开底层的API, 会发现其接口十分简单, 主要是其代理方法和一个初始化方法, 其他的很多属性都是只读的 , 但并不是就不需要设置, 这些都放在了其初始化方法里了.

初始化

系统提供的初始化方法主要是下面这个:

- (instancetype)initWithTransitionStyle:(UIPageViewControllerTransitionStyle)style navigationOrientation:(UIPageViewControllerNavigationOrientation)navigationOrientation options:(nullable NSDictionary<NSString *, id> *)options

简单介绍下这里的几个参数:

  • style : 控制器的类型, 枚举, 有以下两种
typedef NS_ENUM(NSInteger, UIPageViewControllerTransitionStyle) {
// 上下翻页, 类似翻书
    UIPageViewControllerTransitionStylePageCurl = 0, // Navigate between views via a page curl transition.
// 左右滑动 
    UIPageViewControllerTransitionStyleScroll = 1 // Navigate between views by scrolling. 
};
  • navigationOrientation : 导航方向, 枚举
typedef NS_ENUM(NSInteger, UIPageViewControllerNavigationOrientation) {
// 水平方向(左右滑动或翻页)
    UIPageViewControllerNavigationOrientationHorizontal = 0,
// 竖直方向(上下滑动或翻页)
    UIPageViewControllerNavigationOrientationVertical = 1
};
  • options: 其他配置, 是一个字典, 包含两个key
  • **UIPageViewControllerOptionSpineLocationKey : **
仅在style为UIPageViewControllerTransitionStylePageCurl时有效;
对应的值为NSNumber对象, 包含的数值也是一个枚举:
typedef NS_ENUM(NSInteger, UIPageViewControllerSpineLocation) {
    UIPageViewControllerSpineLocationNone = 0, // Returned if 'spineLocation' is queried when 'transitionStyle' is not 'UIPageViewControllerTransitionStylePageCurl'.
// 单页显示, 从上往下翻页
    UIPageViewControllerSpineLocationMin = 1,  // Requires one view controller.
// 双页显示
    UIPageViewControllerSpineLocationMid = 2,  // Requires two view controllers.
// 单页显示, 从下往上翻
    UIPageViewControllerSpineLocationMax = 3   // Requires one view controller.
};   // Only pertains to 'UIPageViewControllerTransitionStylePageCurl'.

使用举例: 设置为双页显示

NSDictionary * options = [NSDictionary dictionaryWithObject:[NSNumber numberWithInteger:UIPageViewControllerSpineLocationMid] forKey:UIPageViewControllerOptionSpineLocationKey];
  • UIPageViewControllerOptionInterPageSpacingKey :
    仅在style为UIPageViewControllerTransitionStyleScroll时有效;
    对应的值为NSNumber对象, 包含的数值为CGFloat类型, 用于设置页边距, 即: 两个控制器的view之间的间隔
    使用举例: 设置页面间距为10
NSDictionary *option = [NSDictionary dictionaryWithObject:[NSNumber numberWithInteger:10.0] forKey:UIPageViewControllerOptionInterPageSpacingKey];
属性

这里仅介绍可设置的属性, 大部分的属性都是只读的

  • delegate 代理协议
  • dataSource 数据源协议
  • doubleSided 是否双面显示, 当UIPageViewControllerSpineLocationMid时, 默认为YES, 其他情况默认为NO
实例方法

这个方法主要是设置某个控制器可视化, 也就是显示某个控制器

- (void)setViewControllers:(nullable NSArray<UIViewController *> *)viewControllers direction:(UIPageViewControllerNavigationDirection)direction animated:(BOOL)animated completion:(void (^ __nullable)(BOOL finished))completion

参数:

  • viewControllers: 待显示的控制器
  • direction: 切换方向, 是一个枚举
typedef NS_ENUM(NSInteger, UIPageViewControllerNavigationDirection) {
// 正向切换
    UIPageViewControllerNavigationDirectionForward,
// 反向切换
    UIPageViewControllerNavigationDirectionReverse
};
  • animated : 是否带有动画
  • completion: 切换完成后的回调

以上便是UIPageViewController的初始化, 一些可配置属性以及实例方法, 下面就是其代理方法和数据源方法了;

UIPageViewControllerDataSource 数据源方法

主要使用到的, 而且是必须实现的数据源方法是以下两个, 用于返回下一个控制器

// 返回当前控制器的前一个控制器
- (nullable UIViewController *)pageViewController:(UIPageViewController *)pageViewController viewControllerBeforeViewController:(UIViewController *)viewController;
// 返回当前控制器的后一个控制器
- (nullable UIViewController *)pageViewController:(UIPageViewController *)pageViewController viewControllerAfterViewController:(UIViewController *)viewController;

还有两个可选实现的数据源方法:

- (NSInteger)presentationCountForPageViewController:(UIPageViewController *)pageViewController NS_AVAILABLE_IOS(6_0); // The number of items reflected in the page indicator.
- (NSInteger)presentationIndexForPageViewController:(UIPageViewController *)pageViewController 

这两个方法使用, 可以参考这个回答stackoverflow

UIPageViewControllerDelegate 代理方法
// 手势滑动(或翻页)开始时回调
- (void)pageViewController:(UIPageViewController *)pageViewController willTransitionToViewControllers:(NSArray<UIViewController *> *)pendingViewControllers 
// 滑动结束时的回调
- (void)pageViewController:(UIPageViewController *)pageViewController didFinishAnimating:(BOOL)finished previousViewControllers:(NSArray<UIViewController *> *)previousViewControllers transitionCompleted:(BOOL)completed

上面第二个方法的参数中的两个BOOL值简单说明一下:

  • finished : 滑动(或者翻页)动画是否完成
  • completed: 是否切换成功

在我们进行滑动(或翻页)的时候, 如果滑动(或翻页)的幅度不够, 控制器会恢复至原有的控制器状态, 不会切换到下一个, 这两个BOOL值就是用来标识动画的状态, 和是否切换成功的状态;

// 根据orientation切换UIPageViewControllerSpineLocation
- (UIPageViewControllerSpineLocation)pageViewController:(UIPageViewController *)pageViewController spineLocationForInterfaceOrientation:(UIInterfaceOrientation)orientation __TVOS_PROHIBITED;
// 返回支持的方法
- (UIInterfaceOrientationMask)pageViewControllerSupportedInterfaceOrientations:(UIPageViewController *)pageViewController NS_AVAILABLE_IOS(7_0) __TVOS_PROHIBITED;
// 优先使用的方向
- (UIInterfaceOrientation)pageViewControllerPreferredInterfaceOrientationForPresentation:(UIPageViewController *)pageViewController 

下一篇文章, [iOS]UIPageViewController使用--实战

(完)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,858评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,372评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,282评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,842评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,857评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,679评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,406评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,311评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,767评论 1 315
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,945评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,090评论 1 350
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,785评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,420评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,988评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,101评论 1 271
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,298评论 3 372
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,033评论 2 355

推荐阅读更多精彩内容