PageView 组件参考

PageView 是一种页面视图容器.

pageview-inspector

点击 属性检查器 下面的添加组件按钮，然后从添加 UI 组件中选择PageView，即可添加 PageView 组件到节点上。

页面视图的脚本接口请参考 PageView API。

PageView 属性

属性功能说明
SizeMode页面视图中每个页面大小类型，目前有 Unified 和 Free 类型 [SizeMove API] (../../../api/zh/enums/PageView.SizeMode.html)
Content它是一个节点引用，用来创建 PageView 的可滚动内容
Direction页面视图滚动方向
ScrollThreshold滚动临界值，默认单位百分比，当拖拽超出该数值时，松开会自动滚动下一页，小于时则还原
AutoPageTurningThreshold快速滑动翻页临界值，当用户快速滑动时，会根据滑动开始和结束的距离与时间计算出一个速度值，该值与此临界值相比较，如果大于临界值，则进行自动翻页
Inertia否开启滚动惯性
Brake开启惯性后，在用户停止触摸后滚动多快停止，0表示永不停止，1表示立刻停止
Elastic布尔值，是否回弹
Bounce Duration浮点数，回弹所需要的时间。取值范围是 0-10
Indicator页面视图指示器组件
PageTurningEventTiming设置 PageView PageTurning 事件的发送时机
PageEvents数组，滚动视图的事件回调函数
CancelInnerEvents布尔值，是否在滚动行为时取消子节点上注册的触摸事件

PageView 事件

pageview-event

属性功能说明
Target带有脚本组件的节点
Component脚本组件名称
Handler指定一个回调函数，当 PageView 的事件发生的时候会调用此函数
CustomEventData用户指定任意的字符串作为事件回调的最后一个参数传入

PageView 的事件回调有两个参数，第一个参数是 PageView 本身，第二个参数是 PageView 的事件类型。

详细说明

PageView 组件必须有指定的 content 节点才能起作用，content 中的每个子节点为一个单独页面，该每个页面的大小为 PageView 节点的大小，操作效果分为 2 种：第一种：缓慢滑动，通过拖拽视图中的页面到达指定的 ScrollThreshold 数值（该数值是页面大小的百分比）以后松开会自动滑动到下一页，第二种：快速滑动，快速的向一个方向进行拖动，自动滑倒下一页，每次滑动最多只能一页。

通常一个 PageView 的节点树如下图：

pageview-hierarchy

CCPageViewIndicator 设置

CCPageViewIndicator 是可选的，该组件是用来显示页面的个数和标记当前显示在哪一页。

建立关联可以通过在 层级管理器 里面拖拽一个带有 PageViewIndicator 组件的节点到 PageView 的相应字段完成。

通过脚本代码添加回调

方法一

这种方法添加的事件回调和使用编辑器添加的事件回调是一样的，通过代码添加，你需要首先构造一个 cc.Component.EventHandler 对象，然后设置好对应的 target, component, handler 和 customEventData 参数。

  1. var pageViewEventHandler = new cc.Component.EventHandler();
  2. pageViewEventHandler.target = this.node; // 这个是你的事件处理代码组件所属的节点
  3. pageViewEventHandler.component = "cc.MyComponent"
  4. pageViewEventHandler.handler = "callback";
  5. pageViewEventHandler.customEventData = "foobar";
  7. pageView.pageEvents.push(pageViewEventHandler);
  9. //here is your component file
  10. cc.Class({
  11.     name: 'cc.MyComponent'
  13.     extends: cc.Component,
  15.     properties: {
  16.     },
  18.     // 注意参数的顺序和类型是固定的
  19.     callback: function(pageView, eventType, customEventData) {
  20.         // 这里 pageView 是一个 PageView 组件对象实例
  21.         // 这里的 eventType === cc.PageView.EventType.PAGE_TURNING
  22.         // 这里的 customEventData 参数就等于你之前设置的 "foobar"
  23.     }
  24. });
方法二

通过 pageView.node.on('page-turning', …) 的方式来添加

  1. // 假设我们在一个组件的 onLoad 方法里面添加事件处理回调，在 callback 函数中进行事件处理:
  3. cc.Class({
  4.     extends: cc.Component,
  6.     properties: {
  7.        pageView: cc.PageView
  8.     },
  10.     onLoad: function () {
  11.        this.pageView.node.on('click', this.callback, this);
  12.     },
  14.     callback: function (event) {
  15.        // 这里的 event 是一个 EventCustom 对象，你可以通过 event.detail 获取 PageView 组件
  16.        var pageView = event.detail;
  17.        // 另外，注意这种方式注册的事件，也无法传递 customEventData
  18.     }
  19. });