鸿蒙OS ListComponent

ListComponent

java.lang.Object

|—ohos.agp.components.Component

|—|—ohos.agp.components.ComponentContainer

|—|—|—ohos.agp.components.ListComponent

public class ListComponent
extends ComponentContainer

一个容器类，用于显示可以在屏幕上上下滚动的列表。

嵌套类摘要

字段摘要

构造函数摘要

方法总结

字段详细信息

HORIZONTAL

public static final int HORIZONTAL

表示组件在 ListComponent 中水平排列。

INVALID_ID

public static final long INVALID_ID

表示 ListComponent 中的组件 ID 无效。

INVALID_POSITION

public static final int INVALID_POSITION

指示 ListComponent 中的无效组件位置。

INVALID_TYPE

public static final int INVALID_TYPE

表示 ListComponent 中的组件类型无效。

ITEM_TYPE_NO_SCALE_MASK

public static final int ITEM_TYPE_NO_SCALE_MASK

表示不使用比例。

ITEM_TYPE_NO_STICK_MASK

public static final int ITEM_TYPE_NO_STICK_MASK

表示不使用摇杆。

LIST_SCROLL_STATE_DRAGGING

public static final int LIST_SCROLL_STATE_DRAGGING

指示正在拖动 ListComponent。

LIST_SCROLL_STATE_IDLE

public static final int LIST_SCROLL_STATE_IDLE

表示 ListComponent 处于空闲状态。

LIST_SCROLL_STATE_SETTLING

public static final int LIST_SCROLL_STATE_SETTLING

表示 ListComponent 正在被滑动。

UNDEFINED_DURATION

public static final int UNDEFINED_DURATION

表示未定义滚动持续时间。

VERTICAL

public static final int VERTICAL

表示组件在 ListComponent 中垂直排列。

构造函数详细信息

ListComponent

public ListComponent(Context context)

用于根据默认属性集和样式创建 ListComponent 实例的构造函数。

参数：

ListComponent

public ListComponent(Context context, AttrSet attrSet)

用于根据指定的属性集和默认样式创建 ListComponent 实例的构造函数。

参数：

ListComponent

public ListComponent(Context context, AttrSet attrSet, String styleName)

用于根据指定的属性集和样式创建 ListComponent 实例的构造函数。

参数：

方法详情

createNativePtr

protected void createNativePtr()

addComponent

public void addComponent(Component childComponent)

通过在内部调用 ComponentContainer.addComponent(ohos.agp.components.Component,int index) 将组件添加到队列的末尾。

覆盖：

类 ComponentContainer 中的 addComponent

参数：

Throws:

addComponent

public void addComponent(Component childComponent, int width, int height)

添加一个组件并设置其宽度和高度。

覆盖：

类 ComponentContainer 中的 addComponent

参数：

Throws:

addComponent

public void addComponent(Component childComponent, ComponentContainer.LayoutConfig layoutConfig)

添加一个组件并设置其布局参数。

覆盖：

类 ComponentContainer 中的 addComponent

参数：

Throws:

addComponent

public void addComponent(Component childComponent, int index, ComponentContainer.LayoutConfig layoutConfig)

添加组件并设置其布局参数和位置。

覆盖：

类 ComponentContainer 中的 addComponent

参数：

Throws:

addComponent

public void addComponent(Component childComponent, int index)

将组件添加到指定位置。

如果没有为该子组件设置布局参数，则使用 ComponentContainer 的默认布局参数。

覆盖：

类 ComponentContainer 中的 addComponent

参数：

Throws:

removeComponent

public void removeComponent(Component component)

从父组件中移除子组件。

指定者：

接口 ComponentParent 中的 removeComponent

覆盖：

ComponentContainer 类中的 removeComponent

参数：

Throws:

removeComponentAt

public void removeComponentAt(int index)

从组件列表中的指定位置移除组件。

指定者：

接口 ComponentParent 中的 removeComponentAt

覆盖：

ComponentContainer 类中的 removeComponentAt

参数：

Throws:

removeComponentById

public void removeComponentById(int id)

根据 ID 移除组件。

覆盖：

ComponentContainer 类中的 removeComponentById

参数：

Throws:

removeComponents

public void removeComponents(int start, int count)

从组件列表中的指定位置移除所有组件。

指定者：

接口 ComponentParent 中的 removeComponents

覆盖：

ComponentContainer 类中的 removeComponents

参数：

Throws:

removeAllComponents

public void removeAllComponents()

清除 ComponentContainer 管理的所有组件。

覆盖：

ComponentContainer 类中的 removeAllComponents

Throws:

getComponentAt

public Component getComponentAt(int position)

从类复制的描述：ComponentContainer

使用索引获取子组件。

ComponentContainer 使用内部列表来存储子组件信息。 您可以使用索引获取指定的子组件。

覆盖：

类 ComponentContainer 中的 getComponentAt

参数：

返回:

返回子组件。

getChildCount

public int getChildCount()

从类复制的描述：ComponentContainer

获取子组件的数量。

覆盖：

ComponentContainer 类中的 getChildCount

返回:

返回子组件的数量。

onComponentBoundToWindow

public void onComponentBoundToWindow(Component child)

当子组件绑定到此 ListComponent 时调用。

参数：

onComponentUnboundFromWindow

public void onComponentUnboundFromWindow(Component child)

当子组件与此 ListComponent 解除绑定时调用。

参数：

setListLayoutManager

public void setListLayoutManager(ListLayoutManager layoutManager)

为此 ListComponent 设置一个 ListLayoutManager 对象。

参数：

getListLayoutManager

public ListLayoutManager getListLayoutManager()

获取此 ListComponent 使用的 ListLayoutManager 对象。

返回:

返回 ListLayoutManager 对象。

setProvider

public void setProvider(Provider provider)

设置此 ListComponent 的提供程序。

参数：

getProvider

public Provider getProvider()

获取此 ListComponent 的提供者。

返回:

如果获得，则返回提供者； 如果未设置提供程序，则返回 null。

setIsFixedSize

public void setIsFixedSize(boolean isFixedSize)

设置此 ListComponent 的提供者是否具有固定大小。

此方法可用于在提供程序更改时提高布局性能。

参数：

isSizeFixed

public boolean isSizeFixed()

检查此 ListComponent 的提供者是否具有固定大小。

返回:

如果提供者具有固定大小，则返回 true； 否则返回 false。

isCalculatingLayout

public boolean isCalculatingLayout()

检查此 ListComponent 是否正在计算布局。

返回:

如果 ListComponent 正在计算布局，则返回 true； 否则返回 false。

alignChildComponentYCoordinate

public void alignChildComponentYCoordinate(int dy)

设置此 ListComponent 中所有子组件边界的垂直像素偏移。

参数：

alignChildComponentXCoordinate

public void alignChildComponentXCoordinate(int dx)

设置此 ListComponent 中所有子组件边界的水平像素偏移。

参数：

switchProvider

public void switchProvider(Provider provider, boolean deleteAndReuseComponents)

将此 ListComponent 的提供者替换为新的提供者。

在替换provider之前，可以通过deleteAndReuseComponents参数判断是否回收ListComponent中的所有子组件。

参数：

addOnComponentBoundStatusChangeListener

public void addOnComponentBoundStatusChangeListener(ListComponent.OnComponentBoundStatusChangeListener listener)

添加一个侦听器，当子组件绑定到此 ListComponent 或从此 ListComponent 解除绑定时将通知该侦听器。

参数：

clearOnComponentBoundStatusChangeListener

public void clearOnComponentBoundStatusChangeListener()

当子组件绑定到此列表组件或从该列表组件解除绑定时，移除所有收到通知的侦听器。

removeOnComponentBoundStatusChangeListener

public void removeOnComponentBoundStatusChangeListener(ListComponent.OnComponentBoundStatusChangeListener listener)

移除在子组件绑定到此 ListComponent 或从此 ListComponent 解除绑定时收到通知的侦听器。

参数：

getChildProviderPosition

public int getChildProviderPosition(Component component)

获取提供者中子组件的位置。

参数：

返回:

如果获得，则返回子组件的位置； 如果组件为空，则返回 -1。

getChildLayoutPosition

public int getChildLayoutPosition(Component component)

获取最近一次布局计算后子组件在提供者中的位置。

参数：

返回:

如果获得，则返回子组件的位置； 如果组件为空，则返回 -1。

getChildComponentId

public long getChildComponentId(Component child)

获取此 ListComponent 中子组件的 ID。

参数：

返回:

如果获取，则返回子组件 ID； 如果 child 为 null，则返回 -1。

searchComponentOwnerForLayoutPosition

public ComponentOwner searchComponentOwnerForLayoutPosition(int position)

根据指定位置在最新布局中搜索 ComponentOwner。

参数：

返回:

如果获得，则返回 ComponentOwner； 否则返回 null。

searchComponentOwnerForProviderPosition

public ComponentOwner searchComponentOwnerForProviderPosition(int position)

根据指定位置在提供者中搜索 ComponentOwner。

参数：

返回:

如果获得，则返回 ComponentOwner； 否则返回 null。

getComponentOwnerById

public ComponentOwner getComponentOwnerById(long id)

根据子组件ID获取ComponentOwner。

参数：

返回:

如果获得，则返回 ComponentOwner； 否则返回 null。

searchChildComponentBelowPoint

public Component searchChildComponentBelowPoint(float x, float y)

根据屏幕上的坐标搜索子组件。

参数：

返回:

如果获得则返回子组件； 否则返回 null。

getChildComponentOwner

public ComponentOwner getChildComponentOwner(Component child)

获取子组件的 ComponentOwner。

参数：

返回:

如果获得，则返回 ComponentOwner； 如果 child 为 null、未获取 ComponentOwner 或发生异常，则返回 null。

searchParentComponentOfChild

public Component searchParentComponentOfChild(Component component)

搜索包含指定组件的子组件（grandchild 组件）。

参数：

返回:

如果获得则返回子组件； 否则返回 null。

searchParentComponentOwnerOfChild

public ComponentOwner searchParentComponentOwnerOfChild(Component component)

搜索包含指定组件（grandchild 组件）的子组件的 ComponentOwner。

参数：

返回:

如果获得，则返回 ComponentOwner； 否则返回 null。

hasIncomingProviderRefresh

public boolean hasIncomingProviderRefresh()

检查是否存在尚未应用于布局的提供程序更新。

返回:

如果存在未应用于布局的提供程序更新，则返回 true； 如果布局是最新的或发生异常，则返回 false。

addCachePolicyListener

public void addCachePolicyListener(ListComponent.CachePolicyListener listener)

为缓存策略添加侦听器。

参数：

removeCachePolicyListener

public void removeCachePolicyListener(ListComponent.CachePolicyListener listener)

删除缓存策略的侦听器。

参数：

getListCachedPool

public ListComponentPool getListCachedPool()

获取此 ListComponent 的回收池。

如果没有为此 ListComponent 设置回收池，则此方法创建一个并返回它。

返回:

返回回收池。

setListCachedPool

public void setListCachedPool(ListComponentPool pool)

为此 ListComponent 设置回收池。

参数：

setRequestedCacheMax

public void setRequestedCacheMax(int count)

设置可以缓存的屏幕外组件的最大数量。

参数：

scrollToPositionInSmoothMode

public void scrollToPositionInSmoothMode(int position)

将此 ListComponent 平滑滚动到特定位置。

参数：

fling

public boolean fling(int speedX, int speedY)

以水平和垂直方向的初始速度触发此 ListComponent 的投掷。

参数：

返回:

如果投掷开始，则返回 true； 如果由于初始速度低而无法启动投掷，如果 LayoutManager 不支持投掷，或者发生异常，则返回 false。

getMinFlingSpeed

public int getMinFlingSpeed()

获得触发投掷的最小速度。

返回:

返回最小速度。

getMaxFlingSpeed

public int getMaxFlingSpeed()

获得触发投掷的最大速度。

返回:

返回最大速度。

scrollToPosition

public void scrollToPosition(int position)

将此 ListComponent 滚动到特定位置。

参数：

scrollTo

public void scrollTo(int x, int y)

将此 ListComponent 滚动到指定的水平和垂直坐标。

覆盖：

类 Component 中的 scrollTo

参数：

scrollBy

public void scrollBy(int x, int y)

将此 ListComponent 滚动一个相对距离。

覆盖：

类 Component 中的 scrollBy

参数：

stopScroll

public void stopScroll()

停止当前滚动。

scrollByInSmoothMode

public void scrollByInSmoothMode(int dx, int dy)

将此 ListComponent 平滑滚动一个相对距离。

参数：

scrollByInSmoothMode

public void scrollByInSmoothMode(int dx, int dy, Animator.TimelineCurve curve)

根据滚动曲线以相对距离平滑滚动此 ListComponent。

参数：

setItemAnimation

public void setItemAnimation(ItemAnimation animation)

设置一个 ItemAnimation 对象，用于处理提供者更改时发生的动画。

如果不调用此方法，将使用 DefaultItemAnimation。

参数：

getItemAnimation

public ItemAnimation getItemAnimation()

获取 ItemAnimation 对象，该对象用于处理提供者更改时发生的动画。

返回:

如果获得，则返回 ItemAnimation 对象； 如果没有分配对象，则返回 null。

isListAnimating

public boolean isListAnimating()

检查此 ListComponent 是否正在运行动画。

返回:

如果 ListComponent 正在运行动画，则返回 true； 否则返回 false。

addListAdornment

public void addListAdornment(ListAdornment adorn, int index)

将 ListAdornment 对象添加到此 ListComponent 的指定位置。

参数：

addListAdornment

public void addListAdornment(ListAdornment adorn)

在此 ListComponent 的末尾添加一个 ListAdornment 对象。

参数：

getListAdornmentAt

public ListAdornment getListAdornmentAt(int index)

获取具有此 ListComponent 的给定索引的 ListAdornment 对象。

参数：

返回:

返回 ListAdornment 对象。

getListAdornmentCount

public int getListAdornmentCount()

获取此 ListComponent 中的 ListAdornment 对象的数量。

返回:

返回 ListAdornment 对象的数量。

removeListAdornmentAt

public void removeListAdornmentAt(int index)

移除具有此 ListComponent 的给定索引的 ListAdornment 对象。

参数：

removeListAdornment

public void removeListAdornment(ListAdornment decor)

从此 ListComponent 中移除给定的 ListAdornment 对象。

参数：

refreshListAdornments

public void refreshListAdornments()

主动刷新此 ListComponent 中的 ListAdornment 对象。

getAdornedBoundryIncludeMargin

public void getAdornedBoundryIncludeMargin(Component component, Rect outBounds)

获取子组件的边界，包括其装饰和边距。

参数：

postponeLayout

public void postponeLayout(boolean isPostponeLayout)

设置是否推迟此 ListComponent 的布局请求。

如果布局请求被推迟，ListComponent 的布局和滚动将被禁用。

参数：

isPostponeLayout

public boolean isPostponeLayout()

检查此 ListComponent 的布局请求是否被推迟。

返回:

如果布局请求被推迟，则返回 true； 否则返回 false。

setOnFlingListener

public void setOnFlingListener(ListComponent.OnFlingListener listener)

为此 ListComponent 设置一个 OnFlingListener。 该监听器用于观察 ListComponent 的 fling 事件。

参数：

setRecoverfocusAfterRefresh

public void setRecoverfocusAfterRefresh(boolean recoverFocusAfterRefresh)

设置此 ListComponent 在布局计算后是否保持同一个子组件的焦点。

参数：

getRecoverfocusAfterRefresh

public boolean getRecoverfocusAfterRefresh()

检查此 ListComponent 在布局计算后是否保持同一个子组件的焦点。

返回:

如果 ListComponent 在布局计算后保持同一个子组件为焦点，则返回 true； 否则返回 false。

postLayout

public void postLayout()

从类复制的描述：组件

请求重新排列组件的布局。

指定者：

ComponentParent 接口中的 postLayout

覆盖：

类 Component 中的 postLayout

setReboundEffect

public void setReboundEffect(boolean enabled)

设置是否开启反弹效果。

参数：

getReboundEffect

public boolean getReboundEffect()

检查反弹效果是否开启。

返回:

如果启用了反弹效果，则返回 true； 否则返回 false。

setReboundEffectParams

public void setReboundEffectParams(int overscrollPercent, float overscrollRate, int remainVisiblePercent)

设置回弹效果参数。

参数：

setReboundEffectParams

public void setReboundEffectParams(ListComponent.ReboundEffectParams reboundEffectParams)

使用 ReboundEffectParams 对象设置回弹效果参数。

参数：

getReboundEffectParams

public ListComponent.ReboundEffectParams getReboundEffectParams()

以 ReboundEffectParams 对象的形式获取回弹效果参数。

返回:

返回包含反弹效果参数的 ReboundEffectParams 对象。

setLayoutManager

public void setLayoutManager(LayoutManager layoutManager)

从类复制的描述：ComponentContainer

设置一个 LayoutManager 实例，用于布局相关子组件。

覆盖：

ComponentContainer 类中的 setLayoutManager

参数：

isScrollingSmoothly

public boolean isScrollingSmoothly()

检查此 ListComponent 是否正在平滑滚动。

返回:

如果 ListComponent 正在平滑滚动，则返回 true； 否则返回 false。

verifyLayoutConfig

public ComponentContainer.LayoutConfig verifyLayoutConfig(ComponentContainer.LayoutConfig config)

自定义一个 LayoutConfig 对象，使 ComponentOwner 拥有 ListLayoutManager 的元数据。

指定者：

接口 ComponentParent 中的 verifyLayoutConfig

覆盖：

ComponentContainer 类中的 verifyLayoutConfig

参数：

返回:

返回包含布局参数的 ComponentContainer.LayoutConfig 实例。

onBounceBackStart

public void onBounceBackStart(int xOverScrolled, int yOverScrolled)

反弹开始时调用。

参数：

onBounceBackChange

public void onBounceBackChange(int xOverScrolled, int yOverScrolled)

在反弹过程中调用。

参数：

onBounceBackEnd

public void onBounceBackEnd(int xOverScrolled, int yOverScrolled)

反弹结束时调用。

参数：

addBounceBackListener

public void addBounceBackListener(ListComponent.BounceBackListener listener)

为反弹状态更改添加侦听器。

参数：

removeBounceBackListener

public void removeBounceBackListener(ListComponent.BounceBackListener listener)

删除反弹状态更改的侦听器。

参数：

clearBounceBackListeners

public void clearBounceBackListeners()

删除反弹状态更改的所有侦听器。