鸿蒙OS开发文档 鸿蒙OS ComponentProvider.Action

2024-02-25 开发教程 鸿蒙OS开发文档 匿名 1

ComponentProvider.Action

java.lang.Object
|---ohos.agp.components.ComponentProvider.Action

public abstract static class ComponentProvider.Action
extends Object
implements Sequenceable

描述可以对远程组件执行的操作。

远程组件是可以在另一个应用程序中显示和更新的组件层次结构。

嵌套类摘要

从接口 ohos.utils.Sequenceable 继承的嵌套类/接口
Sequenceable.ProducerT

字段摘要

修饰符和类型字段描述
static intMERGE_REPLACE允许合并和替换。
intviewId表示组件ID。

构造函数摘要

构造函数描述
Action()

方法总结

修饰符和类型方法描述
abstract voidapply(ComponentContainer root)应用更新组件内容的动作。
StringgetActionKey()获取操作键。
abstract intgetActionTag()获取动作类型。
intmergeOperation()返回合并行为。
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口 ohos.utils.Sequenceable 继承的方法
hasFileDescriptor, marshalling, unmarshalling

字段详细信息

MERGE_REPLACE

public static final int MERGE_REPLACE

允许合并和替换。

当多个 ComponentProvider.Action 应用于同一个组件的同一个属性时,这些动作可以被合并。

viewId

public int viewId

表示组件ID。

构造函数详细信息

Action

public Action()

方法详情

apply

public abstract void apply(ComponentContainer root) throws ComponentProvider.ComponentProviderException

应用更新组件内容的动作。

参数:

参数名称参数描述
root表示 ComponentProvider 定义的所有组件的根节点。

Throws:

Throw名称Throw描述
ComponentProvider.ComponentProviderException如果系统无法处理错误,则抛出此异常。

mergeOperation

public int mergeOperation()

返回合并行为。 默认值为 MERGE_REPLACE。

返回:

默认情况下返回 MERGE_REPLACE。

getActionTag

public abstract int getActionTag()

获取 Action 类型。

返回的操作类型取决于 ComponentProvider.Action。

返回:

返回 Action 类型。

getActionKey

public String getActionKey()

获取操作键。

每个动作都有一个唯一的识别键。

返回:

返回操作键。