Packagelaya.ui
Classpublic class List
InheritanceList Inheritance Box Inheritance Component Inheritance Sprite Inheritance Node Inheritance EventDispatcher Inheritance Object
Implements IRender, IItem

List 控件可显示项目列表。默认为垂直方向列表。可通过UI编辑器自定义列表。



Public Properties
 PropertyDefined By
 Inheritedalpha : Number
透明度,值为0-1,默认值为1,表示不透明。更改alpha值会影响drawcall。
Sprite
 InheritedanchorX : Number
X轴锚点,值为0-1
Component
 InheritedanchorY : Number
Y轴锚点,值为0-1
Component
  array : Array
列表数据源。
List
 InheritedautoSize : Boolean = false
指定是否自动计算宽高数据。默认值为 false 。 Sprite宽高默认为0,并且不会随着绘制内容的变化而变化,如果想根据绘制内容获取宽高,可以设置本属性为true,或者通过getBounds方法获取。设置为true,对性能有一定影响。
Sprite
 InheritedblendMode : String
指定要使用的混合模式。目前只支持"lighter"。
Sprite
 Inheritedbottom : Number
从组件底边到其内容区域底边之间的垂直距离(以像素为单位)。
Component
  cacheAs : String
[override] 指定显示对象是否缓存为静态图像,cacheAs时,子对象发生变化,会自动重新缓存,同时也可以手动调用reCache方法更新缓存。 建议把不经常变化的“复杂内容”缓存为静态图像,能极大提高渲染性能。cacheAs有"none","normal"和"bitmap"三个值可选。 默认为"none",不做任何缓存。 当值为"normal"时,canvas模式下进行画布缓存,webgl模式下进行命令缓存。 当值为"bitmap"时,canvas模式下进行依然是画布缓存,webgl模式下使用renderTarget缓存。 webgl下renderTarget缓存模式缺点:会额外创建renderTarget对象,增加内存开销,缓存面积有最大2048限制,不断重绘时会增加CPU开销。优点:大幅减少drawcall,渲染性能最高。 webgl下命令缓存模式缺点:只会减少节点遍历及命令组织,不会减少drawcall数,性能中等。优点:没有额外内存开销,无需renderTarget支持。
List
 InheritedcacheAsBitmap : Boolean
指定显示对象是否缓存为静态图像。功能同cacheAs的normal模式。建议优先使用cacheAs代替。
Sprite
  cacheContent : Boolean
是否缓存内容,如果数据源较少,并且list内无动画,设置此属性为true能大大提高性能
List
  cells : Vector.<Box>
[read-only] 单元格集合。
List
 InheritedcenterX : Number
在父容器中,此对象的水平方向中轴线与父容器的水平方向中心线的距离(以像素为单位)。
Component
 InheritedcenterY : Number
在父容器中,此对象的垂直方向中轴线与父容器的垂直方向中心线的距离(以像素为单位)。
Component
 InheritedcomXml : Object
XML 数据。
Component
  content : Box
[read-only] 获取对 List 组件所包含的内容容器 Box 组件的引用。
List
 InheritedcustomRenderEnable : Boolean
[write-only] 设置是否开启自定义渲染,只有开启自定义渲染,才能使用customRender函数渲染。
Sprite
  dataSource : *
[override] 数据赋值,通过对UI赋值来控制UI显示逻辑。 简单赋值会更改组件的默认属性,使用大括号可以指定组件的任意属性进行赋值。
List
 Inheriteddestroyed : Boolean
[只读]是否已经销毁。对象销毁后不能再使用。
Node
 Inheriteddisabled : Boolean
是否禁用页面,设置为true后,会变灰并且禁用鼠标。
Component
 InheriteddisplayedInStage : Boolean
[read-only] 表示是否在显示列表中显示。
Node
 InheriteddisplayHeight : Number
[read-only] 对象的显示高度(以像素为单位)。
Component
 InheriteddisplayWidth : Number
[read-only] 对象的显示宽度(以像素为单位)。
Component
 Inheritedfilters : Array
滤镜集合。可以设置多个滤镜组合。
Sprite
 InheritedglobalScaleX : Number
[read-only] 获得相对于stage的全局X轴缩放值(会叠加父亲节点的缩放值)。
Sprite
 InheritedglobalScaleY : Number
[read-only] 获得相对于stage的全局Y轴缩放值(会叠加父亲节点的缩放值)。
Sprite
 Inheritedgraphics : Graphics
绘图对象。封装了绘制位图和矢量图的接口,Sprite所有的绘图操作都通过Graphics来实现的。
Sprite
 Inheritedgray : Boolean
是否变灰。
Component
  height : Number
[override] 表示显示对象的高度,以像素为单位。 注:当值为0时,高度为自适应大小。
List
 InheritedhitArea : *
可以设置一个Rectangle区域作为点击区域,或者设置一个HitArea实例作为点击区域,HitArea内可以设置可点击和不可点击区域。 如果不设置hitArea,则根据宽高形成的区域进行碰撞。
Sprite
 InheritedhitTestPrior : Boolean = false
指定鼠标事件检测是优先检测自身,还是优先检测其子对象。鼠标事件检测发生在鼠标事件的捕获阶段,此阶段引擎会从stage开始递归检测stage及其子对象,直到找到命中的目标对象或者未命中任何对象。 如果为false,优先检测子对象,当有子对象被命中时,中断检测,获得命中目标。如果未命中任何子对象,最后再检测此对象;如果为true,则优先检测本对象,如果本对象没有被命中,直接中断检测,表示没有命中目标;如果本对象被命中,则进一步递归检测其子对象,以确认最终的命中目标。 合理使用本属性,能减少鼠标事件检测的节点,提高性能。可以设置为true的情况:开发者并不关心此节点的子节点的鼠标事件检测结果,也就是以此节点作为其子节点的鼠标事件检测依据。 Stage对象和UI的View组件默认为true。
Sprite
  hScrollBarSkin : String
水平方向滚动条皮肤。
List
  itemRender : *
单元格渲染器。 取值: 单元格类对象。 UI 的 JSON 描述。
List
 InheritedlayoutEnabled : Boolean = true
是否启用相对布局
Component
 Inheritedleft : Number
从组件左边到其内容区域左边之间的水平距离(以像素为单位)。
Component
  length : int
[read-only] 列表的数据总个数。
List
 Inheritedmask : Sprite
遮罩,可以设置一个对象(支持位图和矢量图),根据对象形状进行遮罩显示。 【注意】遮罩对象坐标系是相对遮罩对象本身的,和Flash机制不同
Sprite
 InheritedmouseEnabled : Boolean
是否接受鼠标事件。 默认为false,如果监听鼠标事件,则会自动设置本对象及父节点的属性 mouseEnable 的值都为 true(如果父节点手动设置为false,则不会更改)。
Sprite
  mouseHandler : Handler
单元格鼠标事件处理器(默认返回参数e:Event,index:int)。
List
 InheritedmouseThrough : Boolean = false
鼠标事件与此对象的碰撞检测是否可穿透。碰撞检测发生在鼠标事件的捕获阶段,此阶段引擎会从stage开始递归检测stage及其子对象,直到找到命中的目标对象或者未命中任何对象。 穿透表示鼠标事件发生的位置处于本对象绘图区域内时,才算命中,而与对象宽高和值为Rectangle对象的hitArea属性无关。如果sprite.hitArea值是HitArea对象,表示显式声明了此对象的鼠标事件响应区域,而忽略对象的宽高、mouseThrough属性。 影响对象鼠标事件响应区域的属性为:width、height、hitArea,优先级顺序为:hitArea(type:HitArea)>hitArea(type:Rectangle)>width/height。
Sprite
 InheritedmouseX : Number
[read-only] 返回鼠标在此对象坐标系上的 X 轴坐标信息。
Sprite
 InheritedmouseY : Number
[read-only] 返回鼠标在此对象坐标系上的 Y 轴坐标信息。
Sprite
 Inheritedname : String
节点名称。
Node
 InheritednumChildren : int
[read-only] 子对象数量。
Node
 InheritedoptimizeScrollRect : Boolean
指定是否对使用了 scrollRect 的显示对象进行优化处理。默认为false(不优化)。 当值为ture时:将对此对象使用了scrollRect 设定的显示区域以外的显示内容不进行渲染,以提高性能(如果子对象有旋转缩放或者中心点偏移,则显示筛选会不精确)。
Sprite
  page : int
列表的当前页码。
List
 Inheritedparent : Node
[override]
Sprite
 InheritedpivotX : Number
X轴 轴心点的位置,单位为像素,默认为0。轴心点会影响对象位置,缩放中心,旋转中心。
Sprite
 InheritedpivotY : Number
Y轴 轴心点的位置,单位为像素,默认为0。轴心点会影响对象位置,缩放中心,旋转中心。
Sprite
  renderHandler : Handler
单元格渲染处理器(默认返回参数cell:Box,index:int)。
List
  repeatX : int
水平方向显示的单元格数量。
List
  repeatY : int
垂直方向显示的单元格数量。
List
 Inheritedright : Number
从组件右边到其内容区域右边之间的水平距离(以像素为单位)。
Component
 Inheritedrotation : Number
旋转角度,默认值为0。以角度为单位。
Sprite
 InheritedscaleX : Number
[override] X轴缩放值,默认值为1。设置为负数,可以实现水平反转效果,比如scaleX=-1。
Component
 InheritedscaleY : Number
[override] Y轴缩放值,默认值为1。设置为负数,可以实现垂直反转效果,比如scaleX=-1。
Component
  scrollBar : ScrollBar
获取对 List 组件所包含的滚动条 ScrollBar 组件的引用。
List
 InheritedscrollRect : Rectangle
显示对象的滚动矩形范围,具有裁剪效果(如果只想限制子对象渲染区域,请使用viewport),设置optimizeScrollRect=true,可以优化裁剪区域外的内容不进行渲染。 srollRect和viewport的区别: 1.srollRect自带裁剪效果,viewport只影响子对象渲染是否渲染,不具有裁剪效果(性能更高)。 2.设置rect的x,y属性均能实现区域滚动效果,但scrollRect会保持0,0点位置不变。
Sprite
  selectedIndex : int
表示当前选择的项索引。selectedIndex值更改会引起list重新渲染
List
  selectedItem : Object
当前选中的单元格数据源。
List
  selectEnable : Boolean = false
指定是否可以选择,若值为true则可以选择,否则不可以选择。
List
  selectHandler : Handler
改变 List 的选择项时执行的处理器,(默认返回参数: 项索引(index:int))。
List
  selection : Box
获取或设置当前选择的单元格对象。
List
 InheritedskewX : Number
水平倾斜角度,默认值为0。以角度为单位。
Sprite
 InheritedskewY : Number
垂直倾斜角度,默认值为0。以角度为单位。
Sprite
  spaceX : int
水平方向显示的单元格之间的间距(以像素为单位)。
List
  spaceY : int
垂直方向显示的单元格之间的间距(以像素为单位)。
List
 Inheritedstage : Stage
[read-only] 对舞台 stage 的引用。
Sprite
  startIndex : int
当前显示的单元格列表的开始索引。
List
 InheritedstaticCache : Boolean
是否静态缓存此对象的当前帧的最终属性。为 true 时,子对象变化时不会自动更新缓存,但是可以通过调用 reCache 方法手动刷新。 注意: 1.
Sprite
 Inheritedtag : *
对象的标签。
Component
 Inheritedtexture : Texture
设置一个Texture实例,并显示此图片(如果之前有其他绘制,则会被清除掉)。等同于graphics.clear();graphics.drawTexture()
Sprite
 Inheritedtimer : Timer
时间控制器,默认为Laya.timer。
Node
 InheritedtoolTip : *
鼠标悬停提示。 可以赋值为文本 String 或函数 Handler ,用来实现自定义样式的鼠标提示和参数携带等。
Component
 Inheritedtop : Number
从组件顶边到其内容区域顶边之间的垂直距离(以像素为单位)。
Component
  totalPage : int = 0
最大分页数。
List
 Inheritedtransform : Matrix
对象的矩阵信息。通过设置矩阵可以实现节点旋转,缩放,位移效果。 矩阵更多信息请参考 Matrix
Sprite
 Inheritedviewport : Rectangle = null
视口大小,视口外的子对象,将不被渲染(如果想实现裁剪效果,请使用srollRect),合理使用能提高渲染性能。比如由一个个小图片拼成的地图块,viewport外面的小图片将不渲染 srollRect和viewport的区别: 1.
Sprite
 Inheritedvisible : Boolean
表示是否可见,默认为true。如果设置不可见,节点将不被渲染。
Sprite
  vScrollBarSkin : String
垂直方向滚动条皮肤。
List
  width : Number
[override] 表示显示对象的宽度,以像素为单位。 注:当值为0时,宽度为自适应大小。
List
 Inheritedx : Number
表示显示对象相对于父容器的水平方向坐标值。
Sprite
 Inheritedy : Number
表示显示对象相对于父容器的垂直方向坐标值。
Sprite
 InheritedzOrder : Number
z排序,更改此值,则会按照值的大小对同一容器的所有对象重新排序。值越大,越靠上。默认为0,则根据添加顺序排序。
Sprite
Protected Properties
 PropertyDefined By
 InheritedmeasureHeight : Number
[read-only] 显示对象的实际显示区域高度(以像素为单位)。
Component
 InheritedmeasureWidth : Number
[read-only] 显示对象的实际显示区域宽度(以像素为单位)。
Component
Public Methods
 MethodDefined By
 Inherited
添加子节点。
Node
 Inherited
addChildAt(node:Node, index:int):Node
添加子节点到指定的索引位置。
Node
 Inherited
addChildren(... args):void
批量增加子节点
Node
  
addItem(souce:Object):void
添加单元格数据源。
List
  
addItemAt(souce:Object, index:int):void
添加单元格数据源到对应的数据索引处。
List
 Inherited
callLater(method:Function, args:Array = null):void
延迟运行指定的函数。 在控件被显示在屏幕之前调用,一般用于延迟计算数据。
Component
  
changeItem(index:int, source:Object):void
修改单元格数据源。
List
 Inherited
clearTimer(caller:*, method:Function):void
清理定时器。功能同Laya.timer.clearTimer()。
Node
 Inherited
contains(node:Node):Boolean
当前容器是否包含指定的 Node 节点对象 。
Node
 Inherited
customRender(context:RenderContext, x:Number, y:Number):void
自定义更新、呈现显示对象。一般用来扩展渲染模式,请合理使用,可能会导致在加速器上无法渲染。 注意不要在此函数内增加或删除树节点,否则会对树节点遍历造成影响。
Sprite
  
deleteItem(index:int):void
通过数据源索引删除单元格数据源。
List
  
destroy(destroyChild:Boolean = true):void
[override] 销毁此对象。destroy对象默认会把自己从父节点移除,并且清理自身引用关系,等待js自动垃圾回收机制回收。destroy后不能再使用。 destroy时会移除自身的事情监听,自身的timer监听,移除子对象及从父节点移除自己。
List
 Inherited
销毁所有子对象,不销毁自己本身。
Node
 Inherited
drawToCanvas(canvasWidth:Number, canvasHeight:Number, offsetX:Number, offsetY:Number):HTMLCanvas
绘制 当前Sprite 到 Canvas 上,并返回一个HtmlCanvas。 绘制的结果可以当作图片源,再次绘制到其他Sprite里面,示例: var htmlCanvas:HTMLCanvas = sprite.drawToCanvas(100, 100, 0, 0);//把精灵绘制到canvas上面 var texture:Texture = new Texture(htmlCanvas);//使用htmlCanvas创建Texture var sp:Sprite = new Sprite().pos(0, 200);//创建精灵并把它放倒200位置 sp.graphics.drawTexture(texture);//把截图绘制到精灵上 Laya.stage.addChild(sp);//把精灵显示到舞台 也可以获取原始图片数据,分享到网上,从而实现截图效果,示例: var htmlCanvas:HTMLCanvas = sprite.drawToCanvas(100, 100, 0, 0);//把精灵绘制到canvas上面 var canvas:= htmlCanvas.getCanvas();//获取原生的canvas对象 trace(canvas.toDataURL("image/png"));//打印图片base64信息,可以发给服务器或者保存为图片
Sprite
 Inherited
event(type:String, data:* = null):Boolean
派发事件。
EventDispatcher
 Inherited
frameLoop(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时重复执行某函数(基于帧率)。功能同Laya.timer.frameLoop()。
Node
 Inherited
frameOnce(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时执行一次某函数(基于帧率)。功能同Laya.timer.frameOnce()。
Node
 Inherited
fromImage(url:String):Sprite
[static] 根据图片地址创建一个新的 Sprite 对象用于加载并显示此图片。
Sprite
 Inherited
将父容器坐标系坐标转换到本地坐标系。
Sprite
 Inherited
获取本对象在父容器坐标系的矩形显示区域。 注意: 1.计算量较大,尽量少用,如果需要频繁使用,可以通过手动设置 setBounds 来缓存自身边界信息,从而避免比较消耗性能的计算。2.
Sprite
  
getCell(index:int):Box
通过可视单元格索引,获取单元格。
List
 Inherited
getChildAt(index:int):Node
根据子节点的索引位置,获取子节点对象。
Node
 Inherited
getChildByName(name:String):Node
根据子节点的名字,获取子节点对象。
Node
 Inherited
根据子节点对象,获取子节点的索引位置。
Node
 Inherited
getGraphicBounds(realSize:Boolean = false):Rectangle
返回此实例中的绘图对象( Graphics )的显示区域,不包括子对象。
Sprite
  
getItem(index:int):Object
获取单元格数据源。
List
 Inherited
获得相对于本对象上的鼠标坐标信息。
Sprite
 Inherited
获取对象在自身坐标系的边界范围。与 setBounds 对应。 注意:计算量较大,尽量少用,如果需要频繁使用,可以提前手动设置 setBounds 来缓存自身边界信息,从而避免比较消耗性能的计算。
Sprite
 Inherited
globalToLocal(point:Point, createNewPoint:Boolean = false):Point
把stage的全局坐标转换为本地坐标。
Sprite
 Inherited
hasListener(type:String):Boolean
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
EventDispatcher
 Inherited
hitTestPoint(x:Number, y:Number):Boolean
检测某个点是否在此对象内。
Sprite
  
initItems():void
初始化单元格信息。
List
 Inherited
isMouseEvent(type:String):Boolean
检测指定事件类型是否是鼠标事件。
EventDispatcher
 Inherited
loadImage(url:String, x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0, complete:Handler = null):Sprite
加载并显示一个图片。功能等同于graphics.loadImage方法。支持异步加载。 注意:多次调用loadImage绘制不同的图片,会同时显示。
Sprite
 Inherited
localToGlobal(point:Point, createNewPoint:Boolean = false):Point
把本地坐标转换为相对stage的全局坐标。
Sprite
 Inherited
off(type:String, caller:*, listener:Function, onceOnly:Boolean = false):EventDispatcher
从 EventDispatcher 对象中删除侦听器。
EventDispatcher
 Inherited
offAll(type:String = null):EventDispatcher
从 EventDispatcher 对象中删除指定事件类型的所有侦听器。
EventDispatcher
 Inherited
on(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher
[override] 增加事件侦听器,以使侦听器能够接收事件通知。 如果侦听鼠标事件,则会自动设置自己和父亲节点的属性 mouseEnabled 的值为 true(如果父节点mouseEnabled=false,则停止设置父节点mouseEnabled属性)。
Sprite
 Inherited
once(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher
[override] 增加事件侦听器,以使侦听器能够接收事件通知,此侦听事件响应一次后则自动移除侦听。 如果侦听鼠标事件,则会自动设置自己和父亲节点的属性 mouseEnabled 的值为 true(如果父节点mouseEnabled=false,则停止设置父节点mouseEnabled属性)。
Sprite
 Inherited
cacheAs时,设置所有父对象缓存失效。
Sprite
 Inherited
pivot(x:Number, y:Number):Sprite
设置轴心点。相当于分别设置pivotX和pivotY属性。 因为返回值为Sprite对象本身,所以可以使用如下语法:spr.pivot(...).pos(...);
Sprite
 Inherited
pos(x:Number, y:Number, speedMode:Boolean = false):Sprite
设置坐标位置。相当于分别设置x和y属性。 因为返回值为Sprite对象本身,所以可以使用如下语法:spr.pos(...).scale(...);
Sprite
 Inherited
reCache():void
在设置cacheAs的情况下,调用此方法会重新刷新缓存。
Sprite
  
refresh():void
刷新列表数据源。
List
 Inherited
删除子节点。
Node
 Inherited
removeChildAt(index:int):Node
根据子节点索引位置,删除对应的子节点对象。
Node
 Inherited
removeChildByName(name:String):Node
根据子节点名字删除对应的子节点对象,如果找不到不会抛出异常。
Node
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):Node
删除指定索引区间的所有子对象。
Node
 Inherited
从父容器删除自己,如已经被删除不会抛出异常。
Node
 Inherited
render(context:RenderContext, x:Number, y:Number):void
更新、呈现显示对象。由系统调用。
Sprite
 Inherited
repaint():void
cacheAs后,设置自己和父对象缓存失效。
Sprite
 Inherited
replaceChild(newNode:Node, oldNode:Node):Node
替换子节点。
Node
 Inherited
runCallLater(method:Function):void
如果有需要延迟调用的函数(通过 callLater 函数设置),则立即执行延迟调用函数。
Component
 Inherited
scale(scaleX:Number, scaleY:Number, speedMode:Boolean = false):Sprite
设置缩放。相当于分别设置scaleX和scaleY属性。 因为返回值为Sprite对象本身,所以可以使用如下语法:spr.scale(...).pos(...);
Sprite
  
scrollTo(index:int):void
滚动列表,以设定的数据索引对应的单元格为当前可视列表的第一项。
List
 Inherited
setBounds(bound:Rectangle):void
设置对象在自身坐标系下的边界范围。与 getSelfBounds 对应。当 autoSize==true 时,会影响对象宽高。设置后,当需要获取自身边界范围时,就不再需要计算,合理使用能提高性能。比如 getBounds 会优先使用 setBounds 指定的值,如果没有指定则进行计算,此计算会对性能消耗比较大。 注意: setBounds 与 getBounds 并非对应相等关系, getBounds 获取的是本对象在父容器坐标系下的边界范围,通过设置 setBounds 会影响 getBounds 的结果。
Sprite
 Inherited
setChildIndex(node:Node, index:int):Node
设置子节点的索引位置。
Node
  
setContentSize(width:Number, height:Number):void
设置可视区域大小。 以(0,0,width参数,height参数)组成的矩形区域为可视区域。
List
  
setItem(index:int, source:Object):void
设置单元格数据源。
List
 Inherited
size(width:Number, height:Number):Sprite
设置宽高。相当于分别设置width和height属性。 因为返回值为Sprite对象本身,所以可以使用如下语法:spr.size(...).pos(...);
Sprite
 Inherited
skew(skewX:Number, skewY:Number):Sprite
设置倾斜角度。相当于分别设置skewX和skewY属性。 因为返回值为Sprite对象本身,所以可以使用如下语法:spr.skew(...).pos(...);
Sprite
 Inherited
startDrag(area:Rectangle = null, hasInertia:Boolean = false, elasticDistance:Number = 0, elasticBackTime:int = 300, data:* = null, disableMouseEvent:Boolean = false, ratio:Number = 0.92):void
开始拖动此对象。
Sprite
 Inherited
stopDrag():void
停止拖动此对象。
Sprite
 Inherited
timerLoop(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true, jumpFrame:Boolean = false):void
定时重复执行某函数。功能同Laya.timer.timerLoop()。
Node
 Inherited
timerOnce(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时执行某函数一次。功能同Laya.timer.timerOnce()。
Node
 Inherited
将本地坐标系坐标转转换到父容器坐标系。
Sprite
  
tweenTo(index:int, time:int = 200, complete:Handler = null):void
缓动滚动列表,以设定的数据索引对应的单元格为当前可视列表的第一项。
List
 Inherited
根据zOrder进行重新排序。
Sprite
Protected Methods
 MethodDefined By
  
changeSize():void
[override] 重新调整对象的大小。
List
  
[override]
List
  
[override] 创建并添加控件子节点。
List
  
List
 Inherited
initialize():void
控件初始化。
Component
 Inherited
父容器的 Event.RESIZE 事件侦听处理函数。
Component
 Inherited
预初始化。
Component
  
renderItem(cell:Box, index:int):void
渲染一个单元格。
List
 Inherited
重置对象的 X 轴(水平方向)布局。
Component
 Inherited
重置对象的 Y 轴(垂直方向)布局。
Component
Events
 Event Summary Defined By
 Inherited添加到父对象后调度。Node
  当对象的 selectedIndex 属性发生变化时调度。List
 Inherited鼠标点击对象后调度。Sprite
 Inherited加入节点树时调度。Node
 Inherited拖动结束后调度。Sprite
 Inherited拖动中调度。Sprite
 Inherited开始拖动后调度。Sprite
 Inherited在显示对象上按下后调度。Sprite
 Inherited鼠标在对象身上进行移动后调度Sprite
 Inherited鼠标离开对象后调度。Sprite
 Inherited鼠标经过对象后调度。Sprite
 Inherited在显示对象抬起后调度。Sprite
 Inherited被父对象移除后调度。Node
  渲染列表的单元项对象时调度。List
 Inherited对象的大小经过重新调整时进行调度。Component
 Inherited从节点树移除时调度。Node
Property Detail
arrayproperty
array:Array

列表数据源。


Implementation
    public function get array():Array
    public function set array(value:Array):void
cacheAsproperty 
cacheAs:String[override]

指定显示对象是否缓存为静态图像,cacheAs时,子对象发生变化,会自动重新缓存,同时也可以手动调用reCache方法更新缓存。

建议把不经常变化的“复杂内容”缓存为静态图像,能极大提高渲染性能。cacheAs有"none","normal"和"bitmap"三个值可选。

  • 默认为"none",不做任何缓存。
  • 当值为"normal"时,canvas模式下进行画布缓存,webgl模式下进行命令缓存。
  • 当值为"bitmap"时,canvas模式下进行依然是画布缓存,webgl模式下使用renderTarget缓存。
  • webgl下renderTarget缓存模式缺点:会额外创建renderTarget对象,增加内存开销,缓存面积有最大2048限制,不断重绘时会增加CPU开销。优点:大幅减少drawcall,渲染性能最高。 webgl下命令缓存模式缺点:只会减少节点遍历及命令组织,不会减少drawcall数,性能中等。优点:没有额外内存开销,无需renderTarget支持。


    Implementation
        public function get cacheAs():String
        public function set cacheAs(value:String):void
    cacheContentproperty 
    public var cacheContent:Boolean

    是否缓存内容,如果数据源较少,并且list内无动画,设置此属性为true能大大提高性能

    cellsproperty 
    cells:Vector.<Box>  [read-only]

    单元格集合。


    Implementation
        public function get cells():Vector.<Box>
    contentproperty 
    content:Box  [read-only]

    获取对 List 组件所包含的内容容器 Box 组件的引用。


    Implementation
        public function get content():Box
    dataSourceproperty 
    dataSource:*[override]

    数据赋值,通过对UI赋值来控制UI显示逻辑。

    简单赋值会更改组件的默认属性,使用大括号可以指定组件的任意属性进行赋值。


    Implementation
        public function get dataSource():*
        public function set dataSource(value:any):void
    heightproperty 
    height:Number[override]

    表示显示对象的高度,以像素为单位。

    注:当值为0时,高度为自适应大小。


    Implementation
        public function get height():Number
        public function set height(value:Number):void
    hScrollBarSkinproperty 
    hScrollBarSkin:String

    水平方向滚动条皮肤。


    Implementation
        public function get hScrollBarSkin():String
        public function set hScrollBarSkin(value:String):void
    itemRenderproperty 
    itemRender:*

    单元格渲染器。

    取值:

    1. 单元格类对象。
    2. UI 的 JSON 描述。


    Implementation
        public function get itemRender():*
        public function set itemRender(value:any):void
    lengthproperty 
    length:int  [read-only]

    列表的数据总个数。


    Implementation
        public function get length():int
    mouseHandlerproperty 
    public var mouseHandler:Handler

    单元格鼠标事件处理器(默认返回参数e:Event,index:int)。

    pageproperty 
    page:int

    列表的当前页码。


    Implementation
        public function get page():int
        public function set page(value:int):void
    renderHandlerproperty 
    public var renderHandler:Handler

    单元格渲染处理器(默认返回参数cell:Box,index:int)。

    repeatXproperty 
    repeatX:int

    水平方向显示的单元格数量。


    Implementation
        public function get repeatX():int
        public function set repeatX(value:int):void
    repeatYproperty 
    repeatY:int

    垂直方向显示的单元格数量。


    Implementation
        public function get repeatY():int
        public function set repeatY(value:int):void
    scrollBarproperty 
    scrollBar:ScrollBar

    获取对 List 组件所包含的滚动条 ScrollBar 组件的引用。


    Implementation
        public function get scrollBar():ScrollBar
        public function set scrollBar(value:ScrollBar):void
    selectedIndexproperty 
    selectedIndex:int

    表示当前选择的项索引。selectedIndex值更改会引起list重新渲染


    Implementation
        public function get selectedIndex():int
        public function set selectedIndex(value:int):void
    selectedItemproperty 
    selectedItem:Object

    当前选中的单元格数据源。


    Implementation
        public function get selectedItem():Object
        public function set selectedItem(value:Object):void
    selectEnableproperty 
    public var selectEnable:Boolean = false

    指定是否可以选择,若值为true则可以选择,否则不可以选择。

    The default value is false.

    selectHandlerproperty 
    public var selectHandler:Handler

    改变 List 的选择项时执行的处理器,(默认返回参数: 项索引(index:int))。

    selectionproperty 
    selection:Box

    获取或设置当前选择的单元格对象。


    Implementation
        public function get selection():Box
        public function set selection(value:Box):void
    spaceXproperty 
    spaceX:int

    水平方向显示的单元格之间的间距(以像素为单位)。


    Implementation
        public function get spaceX():int
        public function set spaceX(value:int):void
    spaceYproperty 
    spaceY:int

    垂直方向显示的单元格之间的间距(以像素为单位)。


    Implementation
        public function get spaceY():int
        public function set spaceY(value:int):void
    startIndexproperty 
    startIndex:int

    当前显示的单元格列表的开始索引。


    Implementation
        public function get startIndex():int
        public function set startIndex(value:int):void
    totalPageproperty 
    public var totalPage:int = 0

    最大分页数。

    vScrollBarSkinproperty 
    vScrollBarSkin:String

    垂直方向滚动条皮肤。


    Implementation
        public function get vScrollBarSkin():String
        public function set vScrollBarSkin(value:String):void
    widthproperty 
    width:Number[override]

    表示显示对象的宽度,以像素为单位。

    注:当值为0时,宽度为自适应大小。


    Implementation
        public function get width():Number
        public function set width(value:Number):void
    Method Detail
    addItem()method
    public function addItem(souce:Object):void

    添加单元格数据源。

    Parameters

    souce:Object — 数据源。

    addItemAt()method 
    public function addItemAt(souce:Object, index:int):void

    添加单元格数据源到对应的数据索引处。

    Parameters

    souce:Object — 单元格数据源。
     
    index:int — 索引。

    changeItem()method 
    public function changeItem(index:int, source:Object):void

    修改单元格数据源。

    Parameters

    index:int — 单元格索引。
     
    source:Object — 单元格数据源。

    changeSize()method 
    override protected function changeSize():void

    重新调整对象的大小。

    commitMeasure()method 
    override protected function commitMeasure():void

    createChildren()method 
    override protected function createChildren():void

    创建并添加控件子节点。

    createItem()method 
    protected function createItem():Box

    Returns
    Box
    deleteItem()method 
    public function deleteItem(index:int):void

    通过数据源索引删除单元格数据源。

    Parameters

    index:int — 需要删除的数据源索引值。

    destroy()method 
    override public function destroy(destroyChild:Boolean = true):void

    销毁此对象。destroy对象默认会把自己从父节点移除,并且清理自身引用关系,等待js自动垃圾回收机制回收。destroy后不能再使用。

    destroy时会移除自身的事情监听,自身的timer监听,移除子对象及从父节点移除自己。

    Parameters

    destroyChild:Boolean (default = true) — (可选)是否同时销毁子节点,若值为true,则销毁子节点,否则不销毁子节点。

    getCell()method 
    public function getCell(index:int):Box

    通过可视单元格索引,获取单元格。

    Parameters

    index:int — 可视单元格索引。

    Returns
    Box — 单元格对象。
    getItem()method 
    public function getItem(index:int):Object

    获取单元格数据源。

    Parameters

    index:int — 单元格索引。

    Returns
    Object
    initItems()method 
    public function initItems():void

    初始化单元格信息。

    refresh()method 
    public function refresh():void

    刷新列表数据源。

    renderItem()method 
    protected function renderItem(cell:Box, index:int):void

    渲染一个单元格。

    Parameters

    cell:Box — 需要渲染的单元格对象。
     
    index:int — 单元格索引。

    scrollTo()method 
    public function scrollTo(index:int):void

    滚动列表,以设定的数据索引对应的单元格为当前可视列表的第一项。

    Parameters

    index:int — 单元格在数据列表中的索引。

    setContentSize()method 
    public function setContentSize(width:Number, height:Number):void

    设置可视区域大小。

    以(0,0,width参数,height参数)组成的矩形区域为可视区域。

    Parameters

    width:Number — 可视区域宽度。
     
    height:Number — 可视区域高度。

    setItem()method 
    public function setItem(index:int, source:Object):void

    设置单元格数据源。

    Parameters

    index:int — 单元格索引。
     
    source:Object — 单元格数据源。

    tweenTo()method 
    public function tweenTo(index:int, time:int = 200, complete:Handler = null):void

    缓动滚动列表,以设定的数据索引对应的单元格为当前可视列表的第一项。

    Parameters

    index:int — 单元格在数据列表中的索引。
     
    time:int (default = 200) — 缓动时间。
     
    complete:Handler (default = null) — 缓动结束回掉

    Event Detail
    change Event
    Event Object Type: laya.events.Event
    Event.type property = laya.events.Event

    当对象的 selectedIndex 属性发生变化时调度。

    render Event  
    Event Object Type: laya.events.Event
    Event.type property = Event.RENDER

    渲染列表的单元项对象时调度。