
OpenHarmony应用开发-组件通用信息-通用属性
版本:v3.2 Release
悬浮态效果
设置组件的鼠标悬浮态显示效果。
说明:
从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
属性
名称 | 参数类型 | 描述 |
hoverEffect | 设置当前组件悬停态下的悬浮效果。 默认值:HoverEffect.Auto |
示例
组件标识
id为组件的唯一标识,在整个应用内唯一。本模块提供组件标识相关接口,可以获取指定id组件的属性,也提供向指定id组件发送事件的功能。
说明:
从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
属性
名称 | 参数说明 | 描述 |
id | string | 组件的唯一标识,唯一性由使用者保证。 默认值:‘’ 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
接口
getInspectorByKey9+
getInspectorByKey(id: string): string
获取指定id的组件的所有属性,不包括子组件信息。
此接口仅用于对应用的测试。
参数:
参数 | 类型 | 必填 | 描述 |
id | string | 是 | 要获取属性的组件id。 |
返回值:
类型 | 描述 |
string | 组件属性列表的JSON字符串。 |
getInspectorTree9+
getInspectorTree(): Object
获取组件树及组件属性。
此接口仅用于对应用的测试。
返回值:
类型 | 描述 |
Object | 组件树及组件属性列表的JSON对象。 |
sendEventByKey9+
sendEventByKey(id: string, action: number, params: string): boolean
给指定id的组件发送事件。
此接口仅用于对应用的测试。
参数:
参数 | 类型 | 必填 | 描述 |
id | string | 是 | 要触发事件的组件的id。 |
action | number | 是 | 要触发的事件类型,目前支持取值: - 点击事件Click: 10 - 长按事件LongClick: 11。 |
params | string | 是 | 事件参数,无参数传空字符串 “”。 |
返回值:
类型 | 描述 |
boolean | 找不到指定id的组件时返回false,其余情况返回true。 |
sendTouchEvent9+
sendTouchEvent(event: TouchObject): boolean
发送触摸事件。
此接口仅用于对应用的测试。
参数:
参数 | 类型 | 必填 | 描述 |
event | 是 | 触发触摸事件的位置,event参数见TouchEvent中TouchObject的介绍。 |
返回值:
类型 | 描述 |
boolean | 事件发送失败时返回false,其余情况返回true。 |
sendKeyEvent9+
sendKeyEvent(event: KeyEvent): boolean
发送按键事件。
此接口仅用于对应用的测试。
参数:
参数 | 类型 | 必填 | 描述 |
event | 是 | 按键事件,event参数见KeyEvent介绍。 |
返回值:
类型 | 描述 |
boolean | 事件发送失败时时返回false,其余情况返回true。 |
sendMouseEvent9+
sendMouseEvent(event: MouseEvent): boolean
发送鼠标事件。
此接口仅用于对应用的测试。
参数:
参数 | 类型 | 必填 | 描述 |
event | 是 | 鼠标事件,event参数见MouseEvent介绍。 |
返回值:
类型 | 描述 |
boolean | 事件发送失败时返回false,其余情况返回true。 |
示例
触摸热区设置
适用于支持通用点击事件、通用触摸事件、通用手势处理的组件。
说明:
从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
属性
名称 | 参数类型 | 描述 |
responseRegion | Array<Rectangle> | Rectangle | 设置一个或多个触摸热区,包括位置和大小。 默认触摸热区为整个组件,默认值: { x:0, y:0, width:‘100%’, height:‘100%’ } 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
Rectangle对象说明
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 类型 | 必填 | 描述 |
x | Length | 否 | 触摸点相对于组件左上角的x轴坐标。 默认值:0vp |
y | Length | 否 | 触摸点相对于组件左上角的y轴坐标。 默认值:0vp |
width | Length | 否 | 触摸热区的宽度。 默认值:‘100%’ |
height | Length | 否 | 触摸热区的高度。 默认值:‘100%’ |
说明:
x和y可以设置正负值百分比。当x设置为’100%‘时表示热区往右偏移组件本身宽度大小,当x设置为’-100%'时表示热区往左偏移组件本身宽度大小。当y设置为’100%‘时表示热区往下偏移组件本身高度大小,当y设置为’-100%'时表示热区往上偏移组件本身高度大小。
width和height只能设置正值百分比。width:'100%'表示热区宽度设置为该组件本身的宽度。比如组件本身宽度是100vp,那么’100%'表示热区宽度也为100vp。height:'100%'表示热区高度设置为该组件本身的高度。
百分比相对于组件自身宽高进行计算。
示例
多态样式
设置组件不同状态下的样式。
说明:
从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
属性
名称 | 参数类型 | 描述 |
stateStyles | StateStyles | 设置组件不同状态的样式。 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
StateStyles接口说明
从API version 9开始,该接口支持在ArkTS卡片中使用。
名称 | 类型 | 必填 | 描述 |
normal | ()=>void | 否 | 组件无状态时的样式。 |
pressed | ()=>void | 否 | 组件按下状态的样式。 |
disabled | ()=>void | 否 | 组件禁用状态的样式。 |
focused | ()=>void | 否 | 组件获焦状态的样式。 |
clicked | ()=>void | 否 | 组件点击状态的样式。 |
示例
触摸测试控制
设置组件的触摸测试类型。ArkUI开发框架在处理触屏事件时,会在触屏事件触发前,进行按压点和组件区域的触摸测试来收集需要响应触屏事件的组件,然后基于触摸测试结果分发相应的触屏事件。hitTestBehavior属性可以设置不同的触摸测试响应模式,影响组件的触摸测试收集结果,最终影响后续的触屏事件分发,具体影响参考HitTestMode枚举说明。
说明:
- 从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
- 当Stack组件中有多个节点触摸区域重叠时,如两个节点,默认只会对显示在最上层的节点做触摸测试,若需要显示在下层的节点触发触摸测试,请给显示在上层的节点设置hitTestBehavior为HitTestMode.Transparent。
属性
名称 | 参数类型 | 描述 |
hitTestBehavior | 设置当前组件的触摸测试类型。 默认值: HitTestMode.Default |
HitTestMode枚举说明
名称 | 描述 |
Default | 默认触摸测试效果,自身和子节点都响应触摸测试,但会阻塞兄弟节点的触摸测试。 |
Block | 自身响应触摸测试,阻塞子节点和兄弟节点的触摸测试。 |
Transparent | 自身和子节点都响应触摸测试,不会阻塞兄弟节点的触摸测试。 |
None | 自身不响应触摸测试,不会阻塞子节点和兄弟节点的触摸测试。 |
示例
Text组件设置hitTestBehavior为HitTestMode.Transparent,不会阻塞内层Stack的触摸测试,因此Text和内层Stack的onTouch事件都会触发。
内层Stack设置hitTestBehavior为HitTestMode.Block,会阻塞子节点和外层Button进行触摸测试,因此内层Button和外层Button组件不会响应onTouch事件。
组件背景模糊
为当前组件添加背景模糊效果。
说明:
从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
此接口为系统接口。
属性
名称 | 参数类型 | 描述 |
backgroundBlurStyle | 为当前组件提供一种在背景和内容之间的模糊能力,入参为模糊材质。 该接口支持在ArkTS卡片中使用。 |
BlurStyle
该接口支持在ArkTS卡片中使用。
名称 | 描述 |
Thin | 轻薄材质。 |
Regular | 普通厚度材质。 |
Thick | 厚材质。 |
示例
分布式迁移标识
组件的分布式迁移标识,指明了该组件在分布式迁移场景下可以将特定状态恢复到对端设备。
说明:
从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
属性
名称 | 参数类型 | 描述 |
restoreId | number | 标记支持分布式迁移的组件Id,用于两端设备组件的配对。同一个应用中各个支持分布式迁移组件的Id必须不同。 |
支持的组件
组件名称 | 起始API版本 | 迁移状态 |
List | 8 | 迁移当前设备显示在顶部ListItem的索引值,迁移后在对端设备上,将迁移索引值对应的ListItem在List中完整地置顶显示。 |
Grid | 9 | 迁移当前设备显示在顶部GridItem的索引值,迁移后在对端设备上,将迁移索引值对应的GridItem在Grid中完整地置顶显示。ScrollBar位置无法迁移。 |
Scroll | 9 | 迁移距顶部滚动的绝对距离。两端设备显示规格不同等原因导致布局不一致,会影响迁移效果。 |
TextArea | 9 | 迁移输入的文本内容和光标位置。 |
TextInput | 9 | 迁移输入的文本内容和光标位置。 |
示例
