组件参数说明组件参数为在组件参数面板中可设置的属性,这些参数在组件显示之前已被接受并初始化。通过对组件参数的设置,可相应改变组件的表现形式和效果。
具体参数说明如下表所示:
参数变量
名称
类型
说明
pageId
Page Linkage ID
字符串
页面的影片剪辑关联名(Linkage设置)。
各页面的内容放在该影片剪辑之下,默认每帧为一页,第1帧对应第一页,依次类推。
adjustEvenPage
Adjust Even Page
布尔值
是否对偶数页进行位置调整。
若为true则表示无论奇偶页在页面影片剪辑中都放置于右侧(左上角坐标[0,0]),若为false则表示奇页放右侧,偶页放左侧(右上角坐标[0,0]),这种模式对于制作左右开页时比较方便。
autoPage
Auto Page
布尔值
是否当页面影片剪辑创建时自动跳至相应帧。
若为true则当页面创建时自动会跳至与页编号相对应的帧(如第五页创建时自动跳至第5帧),若为false则页面创建时不做任何操作。
firstPage
First Page
整数
第一页对应序号。
页序号在内部以0开始记,左边为偶数,右边为奇数。一般带封面的可设第一页序号为1,不带封面的可设第一页序号为0。
lastPage
Last Page
整数
最后一页对应序号。
只有在第一页至最后一页的序号范围内的页面才是可用的。
curPage
Current Page
整数
当前页序号。
设置当前页可让翻页动画初始化时即跳至指定的页进行显示。
visiblePages
Visible Pages
整数
可见页数。
常规情况下左右都只需显示一张静止页面即可,但若需要显示透明页面或者不规则边界的页面时,就需要同时显示多张页面。可将该值设为最多可能看见的静止页数。
showRearPage
Show Rear Page
布尔值
是否显示反页。
在特殊情况下需要将页面背部的内容也显示出来(如半透明页面),这时需将该值设为true。
shade
Shade
结构体
页中缝阴影区域设定。
结构体中的成员参数如下:
show:表示是否显示该阴影(1表示是、0表示否)
color:阴影的基色(16进制值可用0xHHHH表示)
sizeMin:最小宽度(当为页角状态时)的百分比(相对页面宽度)
sizeMax:最大宽度(当为展开状态时)的百分比
alphaMin:最小不透明度的百分比
alphaMax:最大不透明度的百分比
pageShadow
Page Shadow
结构体
页面印在下一页上的影子。
结构体成员参数含义同shade。
flipArea
Flip Area
结构体
可翻动的区域设定。
结构体中的成员参数如下:
leftTop:左上页角是否可翻动(1表示是、0表示否)
rightTop:右上页角是否可翻动
leftBottom:左下页角是否可翻动
rightBottom:右下页角是否可翻动
leftTopInner:左上页面是否可翻动
rightTopInner:右上页面是否可翻动
leftBottomInner:左下页面是否可翻动
rightBottomInner:右下页面是否可翻动
flipSize
Flip Size
结构体
可翻动区域的大小。
结构体中的成员参数如下:
width:页角翻动区域宽度占页面宽度的百分比
height:页角翻动区域高度占页面高度的百分比
innerWidth:页面翻动区域宽度占页面宽度的百分比
innerHeight:页角翻动区域高度占页面高度的百分比
dragAccRatio
Drag Accelerate Ratio
浮点数
页面拖动时的跟随加速度。
取值在0~1。越接近0则跟随越慢,越接近1则越快。为1时则表示拖动时没有任何延迟。
moveAccRatio
Move Accelerate Ratio
浮点数
页面移动(非拖动)时的加速度。
取值在0~1。越接近0则移动越慢,越接近1则越快。为1时则表示直接移动到指定坐标。
multiFlip
Multiple Flip
布尔值
是否使用多页联翻。
多页联翻即指在某一页尚未翻动完成时,另一页可同时进行翻动。多页联翻比单页翻更具有真实的手感,但要耗费相对较多的系统资源。
active
Active
布尔值
是否激活。
当未激活时页面不能移动且不相应鼠标事件。
1.2
事件函数说明事件函数可在组件参数面板中设置(event参数),也可在Action中通过:[翻页组件对象名称].[事件名称] = [事件调用函数或事件调用函数路径]来指定。
若直接指定事件调用函数,则该函数的格式需写为:function 函数名 (事件参数1, 事件参数2, …)。可用无名函数直接赋给到事件。
若通过事件调用函数的路径来指定(组件参数面板中设置的事件即为这种情况),则该函数的格式需写为:function 函数名 (sender, 事件参数1, 事件参数2, …)。其中sender参数接收到的值为产生该事件的组件句柄。
具体事件说明如下表所示:
件名称
参数说明
功能说明
onCreatePage
pageMC:新创建的页面影片剪辑对象。该对象有一个初始化参数index,保存了该页面的页序号。
isRear:该页面是否为另一页面的背页。
当有新的页面被创建时调用,以便对新页面进行个性化设置。
onRemovePage
pageMC:将被删除的页面影片剪辑对象。
isRear:该页面是否为另一页面的背页。
当有页面被删除时调用,以便对删除的页面进行附加操作。
onAdjustPage
pageObj:页面描述对象。该对象包含以下成员参数:main(指向翻页组件本身)、index(当前页序号)、side(-1左页、1右页)、rearPage(是否为背页)、face(书页影片剪辑)、pageMask(书页蒙板影片剪辑)、shade(书中缝阴影影片剪辑)、shadow(书页影子影片剪辑)、position(页面位置描述结构体,参数含x,y坐标、aimX,aimY目标点坐标及trackMouse是否跟随鼠标)
range:页面形状描述对象。该对象包含以下成员参数:type(形状类型)、a(上沿宽度)、b(下沿宽度)、angle(页面转角)、angle2(中缝阴影转角)、height(侧沿长度)。该对象含义较晦涩,一般情况下不推荐调用。
当页面轮廓形状发生变化时调用,以便对页面内容进行相应调整。
onResizePage
pageObj:页面描述对象。
width:新的页面宽度。
height:新的页面高度。
当页面大小变化时调用,以便对页面内容进行相应调整。
onSetFlipArea
pageObj:页面描述对象。
当页面可翻动区域创建后调用,以便对可翻动区域做相应调整。
onStartFlip
pageObj:页面描述对象。
当页面开始翻动时调用。
onStopFlip
pageObj:页面描述对象。
当页面停止翻动时调用(非停止移动)。
onFinishFlip
pageObj:页面描述对象。
当页面最终移动到目标静止页面状态时调用。
onDragPage
pageObj:页面描述对象。
x:当前页面x坐标。
y:当前页面y坐标。
trackMouse:是否为跟随鼠标拖动。
当拖动页面时调用。
onMovePage
pageObj:页面描述对象。
x:当前页面x坐标。
y:当前页面y坐标。
当页面移动时调用。