API
Return to top
ListView
编辑

界面 / ListView

ListView Class
​

列表视图

Hierarchy ​

Table of contents ​

Properties
​

click

Properties
​

onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> client
监听自定义属性同步事件

Accessors
​

clearSelectionOnClick(clearSelection: boolean): void client
设置是否在点击空白后清除选中项（仅初始化时设置有效）
itemPadding(): Margin
获取视图节点边距
listItems(): ListViewItemDataBase[] client
获取列表数据
onItemClicked(): MulticastDelegate<(clickedItem: ListViewItemDataBase, doubleClick: boolean) => void>
返回点击代理
onItemHoverChanged(): MulticastDelegate<(targetItem: Widget, hovered: boolean) => void>
返回悬停状态改变代理
onItemRefreshed(): MulticastDelegate<(rowDatas: ListViewItemDataBase[]) => void> client
返回UI刷新生成同步代理
onItemReleaseShow(): MulticastDelegate<(targetItem: Widget) => void>
子控件移除显示时调用，等待复用前
onItemSelected(): MulticastDelegate<(selectedItem: ListViewItemDataBase, selectType: SelectInfo) => void> client
返回选择修改代理,取消选中/清空也会触发选中修改，返回参数selectedItem == null, 请注意判断
scrollBarStyle(): ScrollbarStyle other
滚动条样式
scrollBarVisible(): boolean other
滚动条可见性
scrollOffset(): number client
获取当前滚动条偏移位置
selectionMode(): SelectionMode client
获取选中模式
tableRowStyle(): ListItemStyle other
Item项目节点样式设置
click

Accessors
​

alignPosition(): Readonly<Vector2> client
获取控件的对齐位置,在对齐方式为靠右对齐、靠下对齐、中心对齐时，alignPosition的值与positon不同；
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
获取名字
paintSpaceGeometry(): Geometry client
获取最后一次用于渲染Widget的几何信息
parent(): Widget client
获取父节点
pivot(): Vector2 client
获取控件锚点位置,这个属性决定了控件图形与锚点的相对位置；(0,0)时，锚点位于控件左上角；(0.5,0.5)时，锚点位于控件正中心
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 client
添加项目节点数据
clearItems(): void client
清理数据组
clearSelection(): void client
清空列表的选中
findItemByIndex(index: number): ListViewItemDataBase client
根据索引查找对应的项目节点数据，如果位置越界，则返回空
getSelectionIndexs(): number[] client
获取选中节点的索引
getSelectionItems(): ListViewItemDataBase[] client
获取选中节点的数据
getTouchCanControlThisScroll(): boolean client
获取是否受Touch事件影响滚动
insertItem(newItem: ListViewItemDataBase, index: number): void client
插入项目节点数据，如果位置越界，则自动插入最后
removeItem(delItem: ListViewItemDataBase): void client
移除项目节点数据
removeItemByIndex(delIndex: number): void client
根据索引移除项目节点数据，如果位置越界，则移除失败
requestRefresh(): void client
刷新数据
resetListItems(newListItems: ListViewItemDataBase[]): void client
重新设置项目节点数据组
scrollIntoView(targetItem: ListViewItemDataBase): void client
滚动条定位到对应项目的位置
setSelectionItem(selectedItems: ListViewItemDataBase ListViewItemDataBase[], selected: boolean, selectInfo?: SelectInfo): void client
设置节点选中
setSelectionItemByIndex(selectedIndexs: number number[], selected: boolean, selectInfo?: SelectInfo): void client
根据索引设置节点选中，如果位置越界，则越界对应的操作无效
setTouchCanControlThisScroll(bCanControl: boolean): void client
设置是否受Touch事件影响滚动
newObject(orientation: Orientation, uiAssetGUID: string, parent?: Canvas, inName?: string): ListView client
创建 ListView 控件，当parent和inName与已有的对象相同时，旧的对象会被销毁
click

Methods
​

addChild(child: Widget): void client
添加子节点
clone(position: Vector2, Parent?: Widget): Widget client
克隆UI控件及其子节点到指定父控件位置（默认到其父节点）
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
获取子节点数量
getCustomProperties(): string[] client
获取所有自定义属性
getCustomProperty<T: extends CustomPropertyType>(propertyName: string): T: extends CustomPropertyType client
获取自定义属性
getCustomPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> client
给定对象属性修改时触发的事件代理
invalidateLayoutAndVolatility(): void client
立刻触发重新渲染的和排布计算
isValid(): boolean client
判断控件有没有被销毁，是否是有效的控件
removeAllChildren(): void client
清除所有子节点,会销毁UI无法再使用
removeChild(child: Widget): void client
移除节点,会销毁UI无法在使用
removeChildAt(index: number): void client
移除第几个节点,会销毁UI无法再使用
removeObject(): void client
立刻移除并添加到根节点 可以再使用
serialize(): string client
序列化UI控件
setCustomProperty(propertyName: string, value: undefined CustomPropertyType): void client
设置自定义属性
deserialize(Data: string, Parent?: Widget): Widget client
反序列化UI

Properties ​

Accessors ​

clearSelectionOnClick
​

• set clearSelectionOnClick(clearSelection): void client

设置是否在点击空白后清除选中项（仅初始化时设置有效）

Parameters ​

clearSelectionboolean

itemPadding
​

• get itemPadding(): Margin

• set itemPadding(padding): void

获取视图节点边距

Returns ​

Margin边距数据

设置视图节点边距

Parameters ​

padding Margin设置的边距数据

listItems
​

• get listItems(): ListViewItemDataBase[] client

获取列表数据

Returns ​

ListViewItemDataBase[]返回列表数据

onItemClicked
​

• get onItemClicked(): MulticastDelegate<(clickedItem: ListViewItemDataBase, doubleClick: boolean) => void>

返回点击代理 @effect只在客户端调用生效

Returns ​

MulticastDelegate<(clickedItem: ListViewItemDataBase, doubleClick: boolean) => void>返回点击代理

onItemHoverChanged
​

• get onItemHoverChanged(): MulticastDelegate<(targetItem: Widget, hovered: boolean) => void>

返回悬停状态改变代理 @effect只在客户端调用生效

Returns ​

MulticastDelegate<(targetItem: Widget, hovered: boolean) => void>返回选择修改代理

onItemRefreshed
​

• get onItemRefreshed(): MulticastDelegate<(rowDatas: ListViewItemDataBase[]) => void> client

返回UI刷新生成同步代理

Returns ​

MulticastDelegate<(rowDatas: ListViewItemDataBase[]) => void>返回UI刷新生成同步代理

onItemReleaseShow
​

• get onItemReleaseShow(): MulticastDelegate<(targetItem: Widget) => void>

子控件移除显示时调用，等待复用前 @effect只在客户端调用生效

Returns ​

MulticastDelegate<(targetItem: Widget) => void>返回选择修改代理

onItemSelected
​

• get onItemSelected(): MulticastDelegate<(selectedItem: ListViewItemDataBase, selectType: SelectInfo) => void> client

返回选择修改代理,取消选中/清空也会触发选中修改，返回参数selectedItem == null, 请注意判断

Returns ​

MulticastDelegate<(selectedItem: ListViewItemDataBase, selectType: SelectInfo) => void>返回选择修改代理

scrollBarStyle
​

• get scrollBarStyle(): ScrollbarStyle other

滚动条样式

Returns ​

ScrollbarStyle

scrollBarVisible
​

• get scrollBarVisible(): boolean other

• set scrollBarVisible(bVisible): void other

滚动条可见性

Returns ​

boolean

滚动条可见性

Parameters ​

bVisibleboolean

scrollOffset
​

• get scrollOffset(): number client

• set scrollOffset(scrollOffset): void client

获取当前滚动条偏移位置

Returns ​

number返回当前滚动条偏移位置

设置当前滚动条偏移位置

Parameters ​

scrollOffset number偏移量，0为初始，1为最后

selectionMode
​

• get selectionMode(): SelectionMode client

• set selectionMode(newSelectionMode): void client

获取选中模式

Returns ​

SelectionMode返回选中模式

设置选中模式

Parameters ​

newSelectionMode SelectionMode选中模式

tableRowStyle
​

• get tableRowStyle(): ListItemStyle other

Item项目节点样式设置

Returns ​

ListItemStyle

Methods ​

addItems
​

• addItems(newListItems): void client

添加项目节点数据

Parameters ​

newListItems ListViewItemDataBase[]新的数据组

clearItems
​

• clearItems(): void client

清理数据组

clearSelection
​

• clearSelection(): void client

清空列表的选中

findItemByIndex
​

• findItemByIndex(index): ListViewItemDataBase client

根据索引查找对应的项目节点数据，如果位置越界，则返回空

Parameters ​

index number需要查找的数据所在位置 range: 无 type: 整形

Returns ​

ListViewItemDataBase返回找到的数据

getSelectionIndexs
​

• getSelectionIndexs(): number[] client

获取选中节点的索引

Returns ​

number[]返回选中节点的索引

getSelectionItems
​

• getSelectionItems(): ListViewItemDataBase[] client

获取选中节点的数据

Returns ​

ListViewItemDataBase[]返回选中节点的数据

getTouchCanControlThisScroll
​

• getTouchCanControlThisScroll(): boolean client

获取是否受Touch事件影响滚动

Returns ​

boolean能否touch能控制滚动

insertItem
​

• insertItem(newItem, index): void client

插入项目节点数据，如果位置越界，则自动插入最后

Parameters ​

newItem ListViewItemDataBase需要插入的新数据
index number插入的位置 range: 无 type: 整形

removeItem
​

• removeItem(delItem): void client

移除项目节点数据

Parameters ​

delItem ListViewItemDataBase需要移除的数据

removeItemByIndex
​

• removeItemByIndex(delIndex): void client

根据索引移除项目节点数据，如果位置越界，则移除失败

Parameters ​

delIndex number需要移除的数据所在位置 range: 无 type: 整形

requestRefresh
​

• requestRefresh(): void client

刷新数据

resetListItems
​

• resetListItems(newListItems): void client

重新设置项目节点数据组

Parameters ​

newListItems ListViewItemDataBase[]用于替换的新数据组

scrollIntoView
​

• scrollIntoView(targetItem): void client

滚动条定位到对应项目的位置

Parameters ​

targetItem ListViewItemDataBase目标定位项目

setSelectionItem
​

• setSelectionItem(selectedItems, selected, selectInfo?): void client

设置节点选中

Parameters ​

selectedItems ListViewItemDataBase ListViewItemDataBase[]需要修改选中的节点数据
selected boolean确定修改目标：选中/不选中 range:[true, false]
selectInfo? SelectInfo选中方式：键盘/导航/鼠标/直接选中 default: SelectInfo.Direct

setSelectionItemByIndex
​

• setSelectionItemByIndex(selectedIndexs, selected, selectInfo?): void client

根据索引设置节点选中，如果位置越界，则越界对应的操作无效

Parameters ​

selectedIndexs number number[]需要修改选中的节点所在索引
selected boolean确定修改目标：选中/不选中 range:[true, false]
selectInfo? SelectInfo选中方式：键盘/导航/鼠标/直接选中 default: SelectInfo.Direct

setTouchCanControlThisScroll
​

• setTouchCanControlThisScroll(bCanControl): void client

设置是否受Touch事件影响滚动

Parameters ​

bCanControl boolean能否touch控制滚动

newObject
​

• Static newObject(orientation, uiAssetGUID, parent?, inName?): ListView client

创建 ListView 控件，当parent和inName与已有的对象相同时，旧的对象会被销毁

Parameters ​

orientation Orientation朝向
uiAssetGUID string设置视图绑定的节点UI range: 无
parent? Canvas创建控件的外parent对象 default:null
inName? string创建控件的名称 default:null range: 无 default:null

Returns ​

ListView创建的对象