界面 / ListView
ListView Class
列表视图
Hierarchy
Table of contents
Accessors
clearSelectionOnClick(clearSelection : boolean ): void other |
---|
设置是否在点击空白后清除选中项(仅初始化时设置有效) |
itemPadding(): Margin |
获取视图节点边距 |
listItems(): ListViewItemDataBase [] other |
获取列表数据 |
onItemHoverChanged(): MulticastDelegate <(targetItem : Widget , hovered : boolean ) => void > other |
返回悬停状态改变代理 |
onItemRefreshed(): MulticastDelegate <(rowDatas : ListViewItemDataBase []) => void > other |
返回UI刷新生成同步代理 |
onItemReleaseShow(): MulticastDelegate <(targetItem : Widget ) => void > other |
子控件移除显示时调用,等待复用前 |
onItemSelected(): MulticastDelegate <(selectedItem : ListViewItemDataBase , selectType : SelectInfo ) => void > other |
返回选择修改代理 |
scrollBarStyle(): ScrollbarStyle other |
滚动条样式 |
scrollBarVisible(): boolean other |
滚动条可见性 |
scrollOffset(): number other |
获取当前滚动条偏移位置 |
selectionMode(): SelectionMode other |
获取选中模式 |
tableRowStyle(): ListItemStyle other |
Item项目节点样式设置 |
click
Accessors
autoSizeHorizontalEnable(): boolean client |
---|
获取是否自动水平设置大小 |
autoSizeVerticalEnable(): boolean client |
获取是否自动垂直设置大小 |
cachedGeometry(): Geometry client |
获取上一次的GetTickSpaceGeometry |
constraints(): Readonly <UIConstraintAnchors > client |
获取控件的布局 |
desiredSize(): Vector2 client |
获取期望大小 |
enable(): boolean client |
是否可用 |
guid(): string client |
获取控件GUID |
isHovered(): boolean client |
是否是hovered |
mouseCursor(): MouseCursor client |
获取控件上光标类型 |
name(): string client |
获取名字 |
onFocusChange(): Delegate <(absolutionPosition : Vector2 ) => boolean > client |
焦点改变事件 |
onFoucsLost(): Delegate <(absolutionPosition : Vector2 ) => boolean > client |
丢失焦点事件 |
onKeyDownEvent(): Delegate <(absolutionPosition : Vector2 , keyEvent : KeyEvent ) => boolean > client |
按键按下事件 |
onKeyUpEvent(): Delegate <(absolutionPosition : Vector2 , keyEvent : KeyEvent ) => boolean > client |
按键抬起事件 |
onMouseButtonDoubleClick(): Delegate <(absolutionPosition : Vector2 , pointEvent : PointerEvent ) => boolean > client |
鼠标双击事件 |
onMouseButtonDown(): Delegate <(absolutionPosition : Vector2 , pointEvent : PointerEvent ) => boolean > client |
鼠标按下事件 |
onMouseButtonUp(): Delegate <(absolutionPosition : Vector2 , pointEvent : PointerEvent ) => boolean > client |
鼠标抬起事件 |
onMouseEnter(): Delegate <(absolutionPosition : Vector2 , pointEvent : PointerEvent ) => boolean > client |
鼠标进入控件事件 |
onMouseLeave(): Delegate <(absolutionPosition : Vector2 , pointEvent : PointerEvent ) => boolean > client |
鼠标离开控件事件 |
onMouseMove(): Delegate <(absolutionPosition : Vector2 , pointEvent : PointerEvent ) => boolean > client |
鼠标移动事件 |
onMouseWheel(): Delegate <(absolutionPosition : Vector2 , pointEvent : PointerEvent ) => boolean > client |
鼠标滚轮滚动事件 |
onTouchEnded(): Delegate <(absolutionPosition : Vector2 , pointEvent : PointerEvent ) => boolean > client |
触摸结束事件 |
onTouchMoved(): Delegate <(absolutionPosition : Vector2 , pointEvent : PointerEvent ) => boolean > client |
触摸移动事件 |
onTouchStarted(): Delegate <(absolutionPosition : Vector2 , pointEvent : PointerEvent ) => boolean > client |
触摸按下事件 |
paintSpaceGeometry(): Geometry client |
获取最后一次用于渲染Widget的几何信息 |
parent(): Widget client |
获取父节点 |
position(): Readonly <Vector2 > client |
获取控件的位置 |
renderOpacity(): number client |
获取渲染透明度 |
renderScale(): Vector2 client |
获取渲染缩放 |
renderShear(): Vector2 client |
获取渲染错切形变 |
renderTransformAngle(): number client |
获取渲染的角度 |
renderTransformPivot(): Vector2 client |
获取渲染锚点 |
size(): Vector2 client |
获取大小 |
tickSpaceGeometry(): Geometry client |
获取最后一次用于驱动Widget Tick的几何信息 |
transform(): Readonly <UITransform > client |
得到控件的大小和位置 |
visibility(): SlateVisibility client |
获取可见性 |
visible(): boolean client |
是否可见 |
zOrder(): number client |
获取zorder |
Methods
addItems(newListItems : ListViewItemDataBase []): void other |
---|
添加项目节点数据 |
clearItems(): void other |
清理数据组 |
clearSelection(): void other |
清空列表的选中 |
findItemByIndex(index : number ): ListViewItemDataBase other |
根据索引查找对应的项目节点数据,如果位置越界,则返回空 |
getSelectionIndexs(): number [] other |
获取选中节点的索引 |
getSelectionItems(): ListViewItemDataBase [] other |
获取选中节点的数据 |
insertItem(newItem : ListViewItemDataBase , index : number ): void other |
插入项目节点数据,如果位置越界,则自动插入最后 |
removeItem(delItem : ListViewItemDataBase ): void other |
移除项目节点数据 |
removeItemByIndex(delIndex : number ): void other |
根据索引移除项目节点数据,如果位置越界,则移除失败 |
requestRefresh(): void other |
刷新数据 |
resetListItems(newListItems : ListViewItemDataBase []): void other |
重新设置项目节点数据组 |
scrollIntoView(targetItem : ListViewItemDataBase ): void other |
滚动条定位到对应项目的位置 |
setSelectionItem(selectedItems : ListViewItemDataBase ListViewItemDataBase [], selected : boolean , selectInfo? : SelectInfo ): void other |
设置节点选中 |
setSelectionItemByIndex(selectedIndexs : number number [], selected : boolean , selectInfo? : SelectInfo ): void other |
根据索引设置节点选中,如果位置越界,则越界对应的操作无效 |
newObject(orientation : Orientation , uiAssetGUID : string , parent? : Canvas , inName? : string ): ListView other |
创建 ListView 控件,当parent和inName与已有的对象相同时,旧的对象会被销毁 |
click
Methods
addChild(child : Widget ): void client |
---|
添加子节点 |
destroyObject(): void client |
立刻移除并销毁 不可以在使用 |
equal(that : Widget ): boolean client |
判断是不是同一个对象 |
findChildByPath(inPath : string ): Widget client |
通过相对路径查找节点 |
getChildAt(index : number ): Widget client |
获取第几位子节点 |
getChildByName<T : extends Widget <T >>(name : string ): T : extends Widget <T > client |
通过名字查找节点 |
getChildrenCount(): number client |
获取子节点数量 |
invalidateLayoutAndVolatility(): void client |
立刻触发重新渲染的和排布计算 |
removeAllChildren(): void client |
清除所有子节点,会销毁UI无法再使用 |
removeChild(child : Widget ): void client |
移除节点,会销毁UI无法在使用 |
removeChildAt(index : number ): void client |
移除第几个节点,会销毁UI无法再使用 |
removeObject(): void client |
立刻移除并添加到根节点 可以再使用 |
Accessors
clearSelectionOnClick
• | ||
---|---|---|
设置是否在点击空白后清除选中项(仅初始化时设置有效) Parameters
|
itemPadding
• | • | ||||
---|---|---|---|---|---|
获取视图节点边距 Returns
| 设置视图节点边距 Parameters
|
listItems
• | ||
---|---|---|
获取列表数据 Returns
|
onItemHoverChanged
• | ||
---|---|---|
返回悬停状态改变代理 Returns
|
onItemRefreshed
• | ||
---|---|---|
返回UI刷新生成同步代理 Returns
|
onItemReleaseShow
• | ||
---|---|---|
子控件移除显示时调用,等待复用前 Returns
|
onItemSelected
• | ||
---|---|---|
返回选择修改代理 Returns
|
scrollBarStyle
• | ||
---|---|---|
滚动条样式 Returns
|
scrollBarVisible
• | • | ||||
---|---|---|---|---|---|
滚动条可见性 Returns
| 滚动条可见性 Parameters
|
scrollOffset
• | • | ||||
---|---|---|---|---|---|
获取当前滚动条偏移位置 Returns
| 设置当前滚动条偏移位置 Parameters
|
selectionMode
• | • | ||||
---|---|---|---|---|---|
获取选中模式 Returns
| 设置选中模式 Parameters
|
tableRowStyle
• |
---|
Item项目节点样式设置 Returns |
ListItemStyle |
---|
Methods
addItems
• addItems(newListItems
): void
other
添加项目节点数据
Parameters
newListItems ListViewItemDataBase [] | 新的数据组 |
---|
clearItems
• clearItems(): void
other
清理数据组
clearSelection
• clearSelection(): void
other
清空列表的选中
findItemByIndex
• findItemByIndex(index
): ListViewItemDataBase
other
根据索引查找对应的项目节点数据,如果位置越界,则返回空
Parameters
index number | 需要查找的数据所在位置 |
---|
Returns
ListViewItemDataBase | 返回找到的数据 |
---|
getSelectionIndexs
• getSelectionIndexs(): number
[] other
获取选中节点的索引
Returns
number [] | 返回选中节点的索引 |
---|
getSelectionItems
• getSelectionItems(): ListViewItemDataBase
[] other
获取选中节点的数据
Returns
ListViewItemDataBase [] | 返回选中节点的数据 |
---|
insertItem
• insertItem(newItem
, index
): void
other
插入项目节点数据,如果位置越界,则自动插入最后
Parameters
newItem ListViewItemDataBase | 需要插入的新数据 |
---|---|
index number | 插入的位置 |
removeItem
• removeItem(delItem
): void
other
移除项目节点数据
Parameters
delItem ListViewItemDataBase | 需要移除的数据 |
---|
removeItemByIndex
• removeItemByIndex(delIndex
): void
other
根据索引移除项目节点数据,如果位置越界,则移除失败
Parameters
delIndex number | 需要移除的数据所在位置 |
---|
requestRefresh
• requestRefresh(): void
other
刷新数据
resetListItems
• resetListItems(newListItems
): void
other
重新设置项目节点数据组
Parameters
newListItems ListViewItemDataBase [] | 用于替换的新数据组 |
---|
scrollIntoView
• scrollIntoView(targetItem
): void
other
滚动条定位到对应项目的位置
Parameters
targetItem ListViewItemDataBase | 目标定位项目 |
---|
setSelectionItem
• setSelectionItem(selectedItems
, selected
, selectInfo?
): void
other
设置节点选中
Parameters
selectedItems ListViewItemDataBase ListViewItemDataBase [] | 需要修改选中的节点数据 |
---|---|
selected boolean | 确定修改目标:选中/不选中 |
selectInfo? SelectInfo | 选中方式:键盘/导航/鼠标/直接选中 |
setSelectionItemByIndex
• setSelectionItemByIndex(selectedIndexs
, selected
, selectInfo?
): void
other
根据索引设置节点选中,如果位置越界,则越界对应的操作无效
Parameters
selectedIndexs number number [] | 需要修改选中的节点所在索引 |
---|---|
selected boolean | 确定修改目标:选中/不选中 |
selectInfo? SelectInfo | 选中方式:键盘/导航/鼠标/直接选中 |
newObject
• Static
newObject(orientation
, uiAssetGUID
, parent?
, inName?
): ListView
other
创建 ListView 控件,当parent和inName与已有的对象相同时,旧的对象会被销毁
Parameters
orientation Orientation | 朝向 |
---|---|
uiAssetGUID string | 设置视图绑定的节点UI |
parent? Canvas | 创建控件的外parent对象 default:null |
inName? string | 创建控件的名称 default:null |
Returns
ListView | 创建的对象 |
---|