鸿蒙OS ComponentContainer

ComponentContainer

java.lang.Object

|—ohos.agp.components.Component

|—|—ohos.agp.components.ComponentContainer

public abstract class ComponentContainer
extends Component
implements ComponentParent

可以包含其他组件（称为子组件）的特殊组件。

此布局基类继承自 Component。

嵌套类摘要

字段摘要

构造函数摘要

方法总结

字段详细信息

FOCUS_CHILDREN_FIRST

public static final int FOCUS_CHILDREN_FIRST

指示此组件在其任何子项之前获得焦点。

FOCUS_CHILDREN_HIDE

public static final int FOCUS_CHILDREN_HIDE

指示此组件阻止其子级获得焦点，即使它们是可聚焦的。

FOCUS_PARENT_FIRST

public static final int FOCUS_PARENT_FIRST

指示仅当其子组件均未请求焦点时，此组件才获得焦点。

mArrangeListener

protected ComponentContainer.ArrangeListener mArrangeListener

在排列过程中自定义子组件的排列

构造函数详细信息

ComponentContainer

public ComponentContainer(Context context)

默认构造函数用于使用默认属性集和样式创建 ComponentContainer 实例。

参数：

ComponentContainer

public ComponentContainer(Context context, AttrSet attrSet)

用于在 XML 文件解析后使用指定的属性集和默认样式创建 ComponentContainer 实例的构造函数。

参数：

ComponentContainer

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

一个构造函数，用于在解析 XML 文件后使用指定的属性集和指定的样式创建一个 ComponentContainer 实例。

参数：

方法详情

verifyLayoutConfig

public ComponentContainer.LayoutConfig verifyLayoutConfig(ComponentContainer.LayoutConfig config)

根据当前布局类型验证布局参数。

指定者：

接口 ComponentParent 中的 verifyLayoutConfig

参数：

返回:

返回 LayoutConfig 实例，它表示布局参数。

createLayoutConfig

public ComponentContainer.LayoutConfig createLayoutConfig(Context context, AttrSet attrSet)

使用子组件的属性集创建布局参数。

参数：

返回:

返回创建的布局参数。

setArrangeListener

protected void setArrangeListener(ComponentContainer.ArrangeListener listener)

在组件容器的排列过程中添加一个监听器。

参数：

findComponentById

public <T extends Component> T findComponentById(int id)

查找具有给定 ID 的组件。

如果当前组件本身的 ID 与给定 ID 匹配，则返回当前组件。 否则，返回 null。

覆盖：

组件类中的 findComponentById

参数：

返回:

返回 ID 与给定 ID 匹配的组件； 如果没有找到组件，则返回 null。

addComponent

public void addComponent(Component childComponent)

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

参数：

addComponent

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

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

参数：

addComponent

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

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

参数：

addComponent

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

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

参数：

addComponent

public void addComponent(Component childComponent, int index)

将组件添加到指定位置。

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

参数：

getComponentAt

public Component getComponentAt(int index)

使用索引获取子组件。

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

参数：

返回:

返回子组件。

getChildIndex

public int getChildIndex(Component component)

查询子组件的位置。

指定者：

接口 ComponentParent 中的 getChildIndex

参数：

返回:

返回一个正整数，表示子组件在父组件中的位置； 如果子组件不包含在父组件中，则返回 -1。

findComponentHolderById

public ComponentHolder findComponentHolderById(int resId)

使用资源 id 获取 componentHolder 的实例。

覆盖：

组件类中的 findComponentHolderById

参数：

返回:

componentHolder 的实例。

removeComponent

public void removeComponent(Component component)

从父组件中移除子组件。

指定者：

接口 ComponentParent 中的 removeComponent

参数：

removeComponentAt

public void removeComponentAt(int index)

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

指定者：

接口 ComponentParent 中的 removeComponentAt

参数：

removeComponentById

public void removeComponentById(int id)

根据 ID 移除组件。

参数：

removeComponents

public void removeComponents(int start, int count)

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

指定者：

接口 ComponentParent 中的 removeComponents

参数：

removeAllComponents

public void removeAllComponents()

清除 ComponentContainer 管理的所有组件。

moveChildToFront

public void moveChildToFront(Component component)

将子组件置于最前面。

指定者：

接口 ComponentParent 中的 moveChildToFront

参数：

getChildCount

public int getChildCount()

获取子组件的数量。

返回:

返回子组件的数量。

informConfigurationChanged

public void informConfigurationChanged(Configuration config)

从类复制的描述：组件

调度配置更改事件。 事件处理逻辑由 Component.onAttributeConfigChanged(ohos.global.configuration.Configuration) 实现。

覆盖：

类 Component 中的 informConfigurationChanged

参数：

getFocusOrder

public int getFocusOrder()

获取此组件相对于其后代的可聚焦性。

目前，这仅影响非触摸焦点更改。

返回:

返回可聚焦性，可以是 FOCUS_PARENT_FIRST、FOCUS_CHILDREN_FIRST 或 FOCUS_CHILDREN_HIDE。

setFocusOrder

public void setFocusOrder(int focusability)

设置此组件相对于其后代的可聚焦性。

目前，这仅影响非触摸焦点更改。

参数：

setAutoLayout

public void setAutoLayout(boolean autoLayout)

设置是否启用自动布局。

参数：

setAutoLayout

public void setAutoLayout(boolean autoLayout, int columnType)

设置是否启用自动布局并设置列类型。

参数：

getAutoLayout

public boolean getAutoLayout()

获取是否启用自动布局。

返回:

如果启用了自动布局，则返回 true； 否则返回 false。

onDrag

public boolean onDrag(Component component, DragEvent event)

在将拖动事件分派到组件时调用。

指定者：

接口 ComponentParent 中的 onDrag

覆盖：

类 Component 中的 onDrag

参数：

返回:

如果正确处理了拖动事件，则返回 true； 否则返回 false。

setLayoutManager

public void setLayoutManager(LayoutManager layoutManager)

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

参数：

getLayoutManager

public LayoutManager getLayoutManager()

获取一个LayoutManager对象，用于对相关子组件进行布局。

返回:

返回此组件容器的 LayoutManager 对象。

setComponentTransition

public void setComponentTransition(ComponentTransition componentTransition)

设置一个 ComponentTransition 对象。

参数：

getComponentTransition

public ComponentTransition getComponentTransition()

获取组件的 ComponentTransition 对象。

返回:

返回 ComponentTransition 对象。

setClipToChildBoundsEnabled

public void setClipToChildBoundsEnabled(boolean enable)

控制子组件的绘制范围是否可以超出子组件的边界。

参数：

isClipToChildBoundsEnabled

public boolean isClipToChildBoundsEnabled()

获取子组件的绘制范围是否可以超出子组件的边界。

返回:

返回子组件的绘制范围是否可以超出子组件的边界。

setClipToPaddingBoundsEnabled

public void setClipToPaddingBoundsEnabled(boolean enable)

控制组件的绘制范围是否可以超出其填充边界的边界。

参数：

isClipToPaddingBoundsEnabled

public boolean isClipToPaddingBoundsEnabled()

获取组件的绘制范围是否可以超出其填充边界的边界。

返回:

返回组件的绘制范围是否可以超出其填充边界的边界。

setTouchEventSplitable

public void setTouchEventSplitable(boolean enable)

控制是否将拆分触摸事件分派给多个孩子。 默认情况下禁用该功能。

参数：

isTouchEventSplitable

public boolean isTouchEventSplitable()

获取此 ComponentContainer 的触摸事件是否可以拆分。

返回:

如果派发到此 ComponentContainer 的触摸事件可以拆分到多个子级，则为 true。

dispatchSaveState

protected void dispatchSaveState(PlainArraySequenceable stateContainer)

分发状态保存过程，保存该组件及其子组件的状态。

覆盖：

组件类中的 dispatchSaveState

参数：

dispatchRestoreState

protected void dispatchRestoreState(PlainArraySequenceable stateContainer)

分发状态恢复过程来恢复该组件及其子组件的状态。

覆盖：

组件类中的 dispatchRestoreState

参数：