Show:

annieUI.ScrollPage Class

Extends annie.Sprite
Defined in: libs/ScrollPage.js:21
Module: annieUI

Available since 1.0.0

滚动视图，有些时候你的内容超过了一屏，需要上下或者左右滑动来查看内容，这个时候，你就应该用它了

Methods

_updateSplitBounds

() private

Inherited from annie.DisplayObject: libs/DisplayObject.js:868

更新boundsList矩阵

addChild

(
  • child
)
Void public

Inherited from annie.Sprite: libs/Sprite.js:87

Available since 1.0.0

添加一个显示对象到Sprite

Parameters:

Returns:

Void:

addChildAt

(
  • child
  • index
)
Void public

Inherited from annie.Sprite: libs/Sprite.js:177

Available since 1.0.0

添加一个child到Sprite中并指定添加到哪个层级

Parameters:

Returns:

Void:

addEventListener

(
  • type
  • listener
  • useCapture
)
Void public

Inherited from annie.EventDispatcher: libs/EventDispatcher.js:109

Available since 1.0.0

给对象添加一个侦听

Parameters:

  • type String

    侦听类型

  • listener Function

    侦听后的回调方法,如果这个方法是类实例的方法,为了this引用的正确性,请在方法参数后加上.bind(this);

  • useCapture Boolean

    true 捕获阶段 false 冒泡阶段 默认 true

Returns:

Void:

Example:

 this.addEventListener(annie.Event.ADD_TO_STAGE,function(e){console.log(this);}.bind(this));

addSound

(
  • sound
)
Void public

Inherited from annie.DisplayObject: libs/DisplayObject.js:952

Available since 2.0.0

返回一个id，这个id你要留着作为删除他时使用。 这个声音会根据这个显示对象添加到舞台时播放，移出舞台而关闭

Parameters:

Returns:

Void:

clearCustomTransform

(
  • transId
)
public

Inherited from annie.DisplayObject: libs/DisplayObject.js:1083

Available since 3.1.0

如果你在mc更改了对象的x y scale rotation alpha，最后想还原，不再需要自我控制，可以调用这方法

Parameters:

  • transId Number

    //0->x,1->y,2->scaleX,3->scaleY,4->rotation,5->alpha,-1->all

destroy

() Void public

Inherited from annie.AObject: libs/EventDispatcher.js:63

Available since 2.0.0

销毁一个对象 销毁之前一定要做完其他善后工作，否则有可能会出错 特别注意不能在对象自身方法或事件里调用此方法。 比如，不要在显示对象自身的 annie.Event.ON_REMOVE_TO_STAGE 或者其他类似事件调用，一定会报错

Returns:

Void:

dispatchEvent

(
  • event
  • data
  • useCapture
)
Boolean public

Inherited from annie.EventDispatcher: libs/EventDispatcher.js:156

Available since 1.0.0

广播侦听

Parameters:

  • event annie.Event | String

    广播所带的事件对象,如果传的是字符串则自动生成一个annie.Event对象,事件类型就是传入进来的字符串的值

  • data Object

    广播后跟着事件一起传过去的其他任信息,默认值为null

  • useCapture Boolean

    true 捕获阶段 false 冒泡阶段 默认 true

Returns:

Boolean:

如果有收听者则返回true

Example:

 var mySprite=new annie.Sprite(),
 yourEvent=new annie.Event("yourCustomerEvent");
 yourEvent.data={a:1,b:2,c:"hello",d:{aa:1,bb:2}};
 mySprite.addEventListener("yourCustomerEvent",function(e){
     console.log(e.data);
 })
 mySprite.dispatchEvent(yourEvent);

DisplayObject

() public

Inherited from annie.DisplayObject: libs/DisplayObject.js:78

Available since 1.0.0

getChildAt

(
  • index
)
annie.DisplayObject public

Inherited from annie.Sprite: libs/Sprite.js:226

Available since 1.0.0

获取Sprite中指定层级一个child

Parameters:

Returns:

annie.DisplayObject:

getChildByName

(
  • name
  • isOnlyOne
  • isRecursive
)
String | Array public

Inherited from annie.Sprite: libs/Sprite.js:141

Available since 1.0.0

通过给displayObject设置的名字来获取一个child,可以使用正则匹配查找

Parameters:

  • name String
    对象的具体名字或是一个正则表达式
  • isOnlyOne Boolean
    默认为true,如果为true,只返回最先找到的对象,如果为false则会找到所有匹配的对象数组
  • isRecursive Boolean
    false,如果为true,则会递归查找下去,而不只是查找当前对象中的child,child里的child也会找,依此类推

Returns:

String | Array: 返回一个对象,或者一个对象数组,没有找到则返回空

getChildIndex

(
  • child
)
Number public

Inherited from annie.Sprite: libs/Sprite.js:242

Available since 1.0.2

获取Sprite中一个child所在的层级索引，找到则返回索引数，未找到则返回-1

Parameters:

Returns:

Number:

getDrawRect

() annie.Rectangle public

Inherited from annie.DisplayObject: libs/DisplayObject.js:682

Available since 1.0.0

获取对象形变后外切矩形 可以从这个方法中读取到此显示对象变形后x方向上的宽和y方向上的高

Returns:

annie.Rectangle:

getSound

(
  • id
)
Array

Inherited from annie.DisplayObject: libs/DisplayObject.js:927

Available since 2.0.0

Parameters:

Returns:

Array:

这个对象里所有叫这个名字的声音引用数组

getWH

() W: number; h: number

Inherited from annie.DisplayObject: libs/DisplayObject.js:812

Available since 1.1.0

获取宽高

Returns:

W: number; h: number:

}

globalToLocal

(
  • point
)
annie.Point public

Inherited from annie.DisplayObject: libs/DisplayObject.js:579

Available since 1.0.0

将全局坐标转换到本地坐标值

Parameters:

Returns:

annie.Point:

hasEventListener

(
  • type
  • useCapture
)
Boolean public

Inherited from annie.EventDispatcher: libs/EventDispatcher.js:215

Available since 1.0.0

是否有添加过此类型的侦听

Parameters:

  • type String

    侦听类型

  • useCapture Boolean

    true 捕获阶段 false 冒泡阶段 默认 true

Returns:

Boolean:

如果有则返回true

hitTestPoint

(
  • hitPoint
  • isGlobalPoint
)
annie.DisplayObject public

Inherited from annie.DisplayObject: libs/DisplayObject.js:620

Available since 1.0.0

点击碰撞测试,就是舞台上的一个point是否在显示对象内,在则返回该对象，不在则返回null

Parameters:

  • hitPoint annie.Point

    要检测碰撞的点

  • isGlobalPoint Boolean

    是不是全局坐标的点,默认false是本地坐标

Returns:

annie.DisplayObject:

localToGlobal

(
  • point
)
annie.Point public

Inherited from annie.DisplayObject: libs/DisplayObject.js:591

Available since 1.0.0

将本地坐标转换到全局坐标值

Parameters:

Returns:

annie.Point:

removeAllChildren

() Void public

Inherited from annie.Sprite: libs/Sprite.js:334

Available since 1.0.0

移除Sprite上的所有child

Returns:

Void:

removeAllEventListener

() Void public

Inherited from annie.EventDispatcher: libs/EventDispatcher.js:268

Available since 1.0.0

移除对象中所有的侦听

Returns:

Void:

removeChild

(
  • child
)
Void public

Inherited from annie.Sprite: libs/Sprite.js:98

Available since 1.0.0

从Sprite中移除一个child

Parameters:

Returns:

Void:

removeChildAt

(
  • index
)
Void public

Inherited from annie.Sprite: libs/Sprite.js:295

Available since 1.0.0

移除指定层级上的孩子

Parameters:

Returns:

Void:

removeEventListener

(
  • type
  • listener
  • useCapture
)
Void public

Inherited from annie.EventDispatcher: libs/EventDispatcher.js:239

Available since 1.0.0

移除对应类型的侦听

Parameters:

  • type String

    要移除的侦听类型

  • listener Function

    侦听时绑定的回调方法

  • useCapture Boolean

    true 捕获阶段 false 冒泡阶段 默认 true

Returns:

Void:

removeSound

(
  • id
)
Void public

Inherited from annie.DisplayObject: libs/DisplayObject.js:968

Available since 2.0.0

删除一个已经添加进来的声音

Parameters:

Returns:

Void:

ScrollPage

(
  • view
  • viewWidth
  • viewHeight
  • scrollWidth
  • scrollHeight
)

Defined in libs/ScrollPage.js:30

构造函数

Parameters:

  • view annie.DisplayObject

    需要滚动的显示对象，可为空，为空的话则会自动生成一个显示容器。

  • viewWidth Number

    可视区域宽

  • viewHeight Number

    可视区域高

  • scrollWidth Number

    可滚动的宽度

  • scrollHeight Number

    可滚动的高度

Example:

 s.sPage=new annieUI.ScrollPage(null,640,1040,640,1040*4);
     s.addChild(s.sPage);
     s.sPage.view.addChild(new home.Content());
     s.sPage.y=s.stage.viewRect.y;
     s.sPage.mouseEnable=false;

setViewWH

(
  • viewWidth
  • viewHeight
)
public

Defined in libs/ScrollPage.js:140

Available since 3.1.5

设置可见区域，可见区域的坐标始终在本地坐标中0,0点位置，如果只需要一个方向上可滑动，可以将view的宽或者高等于滑动的宽或者高

Parameters:

  • viewWidth Number

    设置可见区域的宽

  • viewHeight Number

    设置可见区域的高

Sprite

() public

Inherited from annie.Sprite: libs/Sprite.js:31

Available since 1.0.0

构造函数

startDrag

(
  • isCenter
  • bounds
)
Void public

Inherited from annie.DisplayObject: libs/DisplayObject.js:1046

Available since 1.1.2

启动鼠标或者触摸拖动

Parameters:

  • isCenter Boolean

    指定将可拖动的对象锁定到指针位置中心 (true)，还是锁定到用户第一次单击该对象的位置 (false) 默认false

  • bounds annie.Rectangle

    相对于显示对象父级的坐标的值，用于指定 Sprite 约束矩形

Returns:

Void:

stopAllSounds

() Void public

Inherited from annie.DisplayObject: libs/DisplayObject.js:853

Available since 2.0.0

停止这个显示对象上的所有声音

Returns:

Void:

stopDrag

()

Inherited from annie.DisplayObject: libs/DisplayObject.js:1076

停止鼠标跟随

swapChild

(
  • child1
  • child2
)
Boolean

Inherited from annie.Sprite: libs/Sprite.js:260

Available since 2.0.0

交换两个显示对象的层级

Parameters:

  • child1 Object
    显示对象，或者显示对象的索引
  • child2 Object
    显示对象，或者显示对象的索引

Returns:

Boolean:

updateCache

() Void

Inherited from annie.Sprite: libs/Sprite.js:325

Available since 3.2.0

如果对容器缓存为位图过,则会更新缓存,没事别乱调用

Returns:

Void:

Properties

alpha

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:339

Available since 1.0.0

显示对象透明度

Default: 1

anchorX

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:410

Available since 1.0.0

显示对象上x方向的缩放或旋转点

Default: 0

anchorY

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:432

Available since 1.0.0

显示对象上y方向的缩放或旋转点

Default: 0

blendMode

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:476

Available since 1.0.0

显示对象的混合模式 支持的混合模式大概有23种，具体查看annie.BlendMode

Default: 0

cacheAsBitmap

Unknown

Inherited from annie.DisplayObject: libs/DisplayObject.js:201

Available since 3.2.0

是否将这个对象缓存为位图了

children

Array public

Inherited from annie.Sprite: libs/Sprite.js:60

Available since 1.0.0

显示对象的child列表

Default: []

filters

Array public

Inherited from annie.DisplayObject: libs/DisplayObject.js:545

Available since 1.0.0

小游戏不支持 小程序不支持

显示对象的滤镜数组

Default: null

height

Unknown public

Inherited from annie.DisplayObject: libs/DisplayObject.js:824

Available since 1.0.3

获取或者设置显示对象在父级里的y方向的高,不到必要不要用此属性获取高 如果你要同时获取宽高，建议使用getWH()方法获取宽和高

hitArea

Unknown

Inherited from annie.DisplayObject: libs/DisplayObject.js:607

Available since 3.0.1

annie.Sprite显示容器的接受鼠标点击的区域。一但设置，容器里所有子级将不会触发任何鼠标相关的事件。 相当于 mouseChildren=false,但在有大量子级显示对象的情况下，此方法的性能搞出mouseChildren几个数量级，建议使用。

Sub-properties:

hitTestWithPixel

Boolean

Inherited from annie.DisplayObject: libs/DisplayObject.js:157

Available since 1.1.0

小游戏不支持 小程序不支持

是否对图片对象使用像素碰撞检测透明度，默认关闭

Default: false

instanceId

Number public

Inherited from annie.AObject: libs/EventDispatcher.js:31

Available since 1.0.0

每一个annie引擎对象都会有一个唯一的id码。

Example:

 //获取 annie引擎类对象唯一码
 console.log(this.instanceId);

instanceType

String public

Inherited from annie.AObject: libs/EventDispatcher.js:49

Available since 1.0.3

每一个annie类都有一个实例类型字符串，通过这个字符串，你能知道这个实例是从哪个类实例而来

isCache

Boolean

Inherited from annie.DisplayObject: libs/DisplayObject.js:188

Available since 3.2.0

是否被缓存了

mask

annie.DisplayObject public

Inherited from annie.DisplayObject: libs/DisplayObject.js:516

Available since 1.0.0

显示对象的遮罩, 是一个Shape显示对象或是一个只包含shape显示对象的MovieClip

Default: null

matrix

annie.Matrix public

Inherited from annie.DisplayObject: libs/DisplayObject.js:500

Available since 1.0.0

显示对象的变形矩阵

Default: null

mcSpeed

Number public

Inherited from annie.Sprite: libs/Sprite.js:39

Available since 3.1.5

容器类所有动画的播放速度，默认是1.如果有嵌套的话，速度相乘；

Default: 1

mouseChildren

Boolean public

Inherited from annie.Sprite: libs/Sprite.js:50

Available since 1.0.0

是否可以让children接收鼠标事件 鼠标事件将不会往下冒泡

Default: true

mouseEnable

Boolean public

Inherited from annie.DisplayObject: libs/DisplayObject.js:116

Available since 1.0.0

是否可以接受点击事件,如果设置为false,此显示对象将无法接收到点击事件

Default: false

name

String public

Inherited from annie.DisplayObject: libs/DisplayObject.js:127

Available since 1.0.0

每一个显示对象都可以给他命一个名字,这样我们在查找子级的时候就可以直接用this.getChildrndByName("name")获取到这个对象的引用

Default: ""

parent

annie.Sprite public

Inherited from annie.DisplayObject: libs/DisplayObject.js:101

Available since 1.0.0

显示对象的父级

Default: null

rotation

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:314

Available since 1.0.0

显示对象旋转角度

Default: 0

scaleX

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:268

Available since 1.0.0

显示对象x方向的缩放值

Default: 1

scaleY

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:291

Available since 1.0.0

显示对象y方向的缩放值

Default: 1

scroller

Unknown public

Defined in libs/ScrollPage.js:127

Available since 3.1.5

scroller滑动控制器

skewX

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:362

Available since 1.0.0

显示对象x方向的斜切值

Default: 0

skewY

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:386

Available since 1.0.0

显示对象y方向的斜切值

Default: 0

soundList

Array public

Inherited from annie.DisplayObject: libs/DisplayObject.js:170

Available since 2.0.0

当前对象包含的声音列表

Default: []

stage

Stage public

Inherited from annie.DisplayObject: libs/DisplayObject.js:91

Available since 1.0.0

此显示对象所在的舞台对象,如果此对象没有被添加到显示对象列表中,此对象为空。

Default: null;

view

annie.Sprite public

Defined in libs/ScrollPage.js:113

Available since 1.0.0

真正的被滚动的显示对象

visible

Boolean public

Inherited from annie.DisplayObject: libs/DisplayObject.js:454

Available since 1.0.0

显未对象是否可见

Default: 0

width

Unknown public

Inherited from annie.DisplayObject: libs/DisplayObject.js:783

Available since 1.0.3

获取或者设置显示对象在父级里的x方向的宽，不到必要不要用此属性获取高 如果你要同时获取宽高，建议使用 getWH()方法获取宽和高

x

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:222

Available since 1.0.0

显示对象位置x

Default: 0

y

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:245

Available since 1.0.0

显示对象位置y

Default: 0

Events

ADD_TO_STAGE

Inherited from annie.DisplayObject: libs/DisplayObject.js:31

Available since 1.0.0

annie.DisplayObject显示对象加入到舞台事件

annie.Event.ON_SCROLL_ING

Defined in libs/ScrollPage.js:53

Available since 3.1.0

annieUI.ScrollPage 组件滑动到开始位置事件

annie.Event.ON_SCROLL_START

Defined in libs/ScrollPage.js:63

Available since 1.1.0

annieUI.ScrollPage组件开始滑动事件

annie.Event.ON_SCROLL_STOP

Defined in libs/ScrollPage.js:58

Available since 1.1.0

annieUI.ScrollPage组件停止滑动事件

annie.Event.ON_SCROLL_TO_END

Defined in libs/ScrollPage.js:68

Available since 1.1.0

annieUI.ScrollPage组件滑动到结束位置事件

annie.Event.ON_SCROLL_TO_HEAD

Defined in libs/ScrollPage.js:48

Available since 1.1.0

annieUI.ScrollPage 组件滑动到开始位置事件

CLICK

String

Inherited from annie.DisplayObject: libs/DisplayObject.js:57

annie.DisplayObject鼠标或者手指单击

ENTER_FRAME

Inherited from annie.DisplayObject: libs/DisplayObject.js:41

Available since 1.0.0

annie.DisplayObject显示对象 循环帧事件

MOUSE_DOWN

Inherited from annie.DisplayObject: libs/DisplayObject.js:47

Available since 1.0.0

annie.DisplayObject鼠标或者手指按下事件

MOUSE_MOVE

Inherited from annie.DisplayObject: libs/DisplayObject.js:62

Available since 1.0.0

annie.DisplayObject鼠标或者手指移动事件

MOUSE_OUT

Inherited from annie.DisplayObject: libs/DisplayObject.js:72

Available since 1.0.0

annie.DisplayObject鼠标或者手指移出显示对象边界触发的事件

MOUSE_OVER

Inherited from annie.DisplayObject: libs/DisplayObject.js:67

Available since 1.0.0

annie.DisplayObject鼠标或者手指移入到显示对象上里触发的事件

MOUSE_UP

Inherited from annie.DisplayObject: libs/DisplayObject.js:52

Available since 1.0.0

annie.DisplayObject鼠标或者手指抬起事件

REMOVE_TO_STAGE

Inherited from annie.DisplayObject: libs/DisplayObject.js:36

Available since 1.0.0

annie.DisplayObject显示对象从舞台移出事件