鸿蒙OS AccessibilityEventInfo

AccessibilityEventInfo

java.lang.Object

|---ohos.accessibility.AccessibilityEventInfo

public class AccessibilityEventInfo
extends Object

描述无障碍事件信息并为无障碍服务提供信息。

信息包括无障碍事件类型、触发无障碍事件的操作、事件源的包名、用于阅读文本的移动步骤、无障碍事件列表。

当对 UI 进行任何更改时，例如，当视图控件获得焦点时，您的应用可以向无障碍服务发送 AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT 无障碍事件以触发无障碍功能。

字段摘要

修饰符和类型	字段	描述
static int	TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED_EVENT	描述清除辅助功能焦点的事件。
static int	TYPE_VIEW_ACCESSIBILITY_FOCUSED_EVENT	描述获得可访问性焦点的事件。
static int	TYPE_VIEW_CLICKED_EVENT	描述单击控件的事件，例如单击按钮。
static int	TYPE_VIEW_FOCUSED_EVENT	描述控件获得焦点的事件。
static int	TYPE_VIEW_HOVER_ENTER_EVENT	描述悬停进入控件的事件。
static int	TYPE_VIEW_HOVER_EXIT_EVENT	描述悬停离开控件的事件。
static int	TYPE_VIEW_LONG_CLICKED_EVENT	描述按住控件的事件。
static int	TYPE_VIEW_SCROLLED_EVENT	描述滚动视图的事件。
static int	TYPE_VIEW_SELECTED_EVENT	描述选择控件的事件。
static int	TYPE_VIEW_TEXT_CHANGED_EVENT	描述控件文本已更改的事件。
static int	TYPE_VIEW_TEXT_SELECTION_CHANGED_EVENT	描述所选文本已更改的事件。
static int	WINDOWS_CHANGE_ACCESSIBILITY_FOCUSED	描述所选辅助功能窗口已更改的窗口更改事件。
static int	WINDOWS_CHANGE_ACTIVE	描述窗口变为活动或不活动的窗口更改事件。
static int	WINDOWS_CHANGE_ADDED	描述添加窗口的窗口更改事件。
static int	WINDOWS_CHANGE_BOUNDS	描述窗口边界已更改的窗口更改事件。
static int	WINDOWS_CHANGE_CHILDREN	描述子窗口已更改的窗口更改事件。
static int	WINDOWS_CHANGE_FOCUSED	描述所选窗口已更改的窗口更改事件。
static int	WINDOWS_CHANGE_LAYER	描述窗口层已更改的窗口更改事件。
static int	WINDOWS_CHANGE_PARENT	描述父窗口已更改的窗口更改事件。
static int	WINDOWS_CHANGE_PIP	描述窗口进入或退出画中画 (PIP) 模式的窗口更改事件。
static int	WINDOWS_CHANGE_REMOVED	描述一个窗口被删除的窗口更改事件。
static int	WINDOWS_CHANGE_TITLE	描述窗口标题已更改的窗口更改事件。

构造函数摘要

构造函数	描述
AccessibilityEventInfo()	用于创建 AccessibilityEventInfo 实例的构造函数。
AccessibilityEventInfo(int eventType)	用于创建具有指定事件类型的 AccessibilityEventInfo 实例的构造函数，例如 TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED_EVENT、TYPE_VIEW_CLICKED_EVENT 和 TYPE_VIEW_ACCESSIBILITY_FOCUSED_EVENT。
AccessibilityEventInfo(AccessibilityEventInfo eventInfo)	用于通过复制指定的可访问性事件信息来创建 AccessibilityEventInfo 实例的构造函数。

方法总结

修饰符和类型	方法	描述
void	addContent(CharSequence in)	将元素添加到内容列表。
void	addRecord(AccessibilityEventInfo eventInfo)	将可访问性事件添加到事件列表。
int	getAccessibilityEventType()	获取可访问性事件的类型。
CharSequence	getBundleName()	获取事件源的bundle名，即目标应用的bundle名。
CharSequence	getClassName()	获取类名。
ArrayListCharSequence	getContentList()	获取事件中的内容列表。
int	getCount()	获取可访问性事件的数量。
CharSequence	getDescription()	获取可访问性事件描述。
int	getEndIndex()	获取屏幕上列出的项目的结束索引。
CharSequence	getLastContent()	获取组件的最后一个内容。
int	getPresentIndex()	获取当前事件的索引。
ArrayListAccessibilityEventInfo	getRecords()	获取可访问性事件列表。
int	getStartIndex()	获取屏幕上列出的项目的开始索引。
int	getTextMoveStep()	获取用于阅读文本的移动步长。
int	getTriggerAction()	获取触发无障碍事件的动作，例如点击或聚焦视图。
int	getViewId()	获取与可访问性事件关联的视图 ID。
int	getWindowChangeTypes()	获取窗口变化事件的类型，可以是内容变化，也可以是状态变化。
void	setAccessibilityEventType(int accessibilityEventType)	设置可访问性事件的类型。
void	setBundleName(CharSequence bundleName)	设置事件源的包名称。
void	setClassName(CharSequence className)	设置类名。
void	setCount(int count)	设置可访问性事件的数量。
void	setDescription(CharSequence description)	设置可访问性事件描述。
void	setEndIndex(int endIndex)	设置屏幕上列出项目的结束索引。
void	setLastContent(CharSequence lastContent)	设置组件的最后一个内容。
void	setPresentIndex(int presentIndex)	设置当前事件的索引。
void	setStartIndex(int startIndex)	设置屏幕上列出的项目的开始索引。
void	setTextMoveStep(int moveStep)	设置用于阅读文本的移动步长。
void	setTriggerAction(int action)	设置触发可访问性事件的操作。
void	setViewId(int viewId)	设置与可访问性事件关联的视图 ID。
void	setWindowChangeTypes(int changeTypes)	设置窗口改变事件的类型，可以是内容改变或状态改变。

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细信息

TYPE_VIEW_ACCESSIBILITY_FOCUSED_EVENT

public static final int TYPE_VIEW_ACCESSIBILITY_FOCUSED_EVENT

描述获得可访问性焦点的事件。

TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED_EVENT

public static final int TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED_EVENT

描述清除辅助功能焦点的事件。

TYPE_VIEW_CLICKED_EVENT

public static final int TYPE_VIEW_CLICKED_EVENT

描述单击控件的事件，例如单击按钮。

TYPE_VIEW_FOCUSED_EVENT

public static final int TYPE_VIEW_FOCUSED_EVENT

描述控件获得焦点的事件。

TYPE_VIEW_HOVER_ENTER_EVENT

public static final int TYPE_VIEW_HOVER_ENTER_EVENT

描述悬停进入控件的事件。

TYPE_VIEW_HOVER_EXIT_EVENT

public static final int TYPE_VIEW_HOVER_EXIT_EVENT

描述悬停离开控件的事件。

TYPE_VIEW_LONG_CLICKED_EVENT

public static final int TYPE_VIEW_LONG_CLICKED_EVENT

描述按住控件的事件。

TYPE_VIEW_SCROLLED_EVENT

public static final int TYPE_VIEW_SCROLLED_EVENT

描述滚动视图的事件。

TYPE_VIEW_SELECTED_EVENT

public static final int TYPE_VIEW_SELECTED_EVENT

描述选择控件的事件。

TYPE_VIEW_TEXT_CHANGED_EVENT

public static final int TYPE_VIEW_TEXT_CHANGED_EVENT

描述控件文本已更改的事件。

TYPE_VIEW_TEXT_SELECTION_CHANGED_EVENT

public static final int TYPE_VIEW_TEXT_SELECTION_CHANGED_EVENT

描述所选文本已更改的事件。

WINDOWS_CHANGE_ACCESSIBILITY_FOCUSED

public static final int WINDOWS_CHANGE_ACCESSIBILITY_FOCUSED

描述所选辅助功能窗口已更改的窗口更改事件。

WINDOWS_CHANGE_ACTIVE

public static final int WINDOWS_CHANGE_ACTIVE

描述窗口变为活动或不活动的窗口更改事件。

WINDOWS_CHANGE_ADDED

public static final int WINDOWS_CHANGE_ADDED

描述添加窗口的窗口更改事件。

WINDOWS_CHANGE_BOUNDS

public static final int WINDOWS_CHANGE_BOUNDS

描述窗口边界已更改的窗口更改事件。

WINDOWS_CHANGE_CHILDREN

public static final int WINDOWS_CHANGE_CHILDREN

描述子窗口已更改的窗口更改事件。

WINDOWS_CHANGE_FOCUSED

public static final int WINDOWS_CHANGE_FOCUSED

描述所选窗口已更改的窗口更改事件。

WINDOWS_CHANGE_LAYER

public static final int WINDOWS_CHANGE_LAYER

描述窗口层已更改的窗口更改事件。

WINDOWS_CHANGE_PARENT

public static final int WINDOWS_CHANGE_PARENT

描述父窗口已更改的窗口更改事件。

WINDOWS_CHANGE_PIP

public static final int WINDOWS_CHANGE_PIP

描述窗口进入或退出画中画 (PIP) 模式的窗口更改事件。

WINDOWS_CHANGE_REMOVED

public static final int WINDOWS_CHANGE_REMOVED

描述一个窗口被删除的窗口更改事件。

WINDOWS_CHANGE_TITLE

public static final int WINDOWS_CHANGE_TITLE

描述窗口标题已更改的窗口更改事件。

构造函数详细信息

AccessibilityEventInfo

public AccessibilityEventInfo()

用于创建 AccessibilityEventInfo 实例的构造函数。

AccessibilityEventInfo

public AccessibilityEventInfo(int eventType)

用于创建具有指定事件类型的 AccessibilityEventInfo 实例的构造函数，例如 TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED_EVENT、TYPE_VIEW_CLICKED_EVENT 和 TYPE_VIEW_ACCESSIBILITY_FOCUSED_EVENT。

参数：

参数名称	参数描述
eventType	指示可访问性事件的类型。

AccessibilityEventInfo

public AccessibilityEventInfo(AccessibilityEventInfo eventInfo)

用于通过复制指定的可访问性事件信息来创建 AccessibilityEventInfo 实例的构造函数。

参数：

参数名称	参数描述
eventInfo	表示可访问性事件信息。

方法详情

getTriggerAction

public int getTriggerAction()

获取触发无障碍事件的动作，例如点击或聚焦视图。

返回:

返回触发可访问性事件的操作。

getWindowChangeTypes

public int getWindowChangeTypes()

获取窗口变化事件的类型，可以是内容变化，也可以是状态变化。

返回:

返回窗口更改事件的类型。

getAccessibilityEventType

public int getAccessibilityEventType()

获取可访问性事件的类型。

返回:

返回可访问性事件的类型。

getTextMoveStep

public int getTextMoveStep()

获取用于阅读文本的移动步长。

返回:

返回移动步骤，例如，移动到下一个字符、单词或行。

getBundleName

public CharSequence getBundleName()

获取事件源的bundle名，即目标应用的bundle名。

返回:

返回事件源的包名称。

getViewId

public int getViewId()

获取与可访问性事件关联的视图 ID。

返回:

返回视图 ID。

addRecord

public void addRecord(AccessibilityEventInfo eventInfo)

将可访问性事件添加到事件列表。

参数：

参数名称	参数描述
eventInfo	指示要添加的可访问性事件。

getRecords

public ArrayListAccessibilityEventInfo getRecords()

获取可访问性事件列表。

返回:

返回可访问性事件列表。

setTriggerAction

public void setTriggerAction(int action)

设置触发可访问性事件的操作。

参数：

参数名称	参数描述
action	指示触发可访问性事件的操作。

setTextMoveStep

public void setTextMoveStep(int moveStep)

设置用于阅读文本的移动步长。

参数：

参数名称	参数描述
moveStep	表示移动步骤，例如移动到下一个字符、单词或行。

setBundleName

public void setBundleName(CharSequence bundleName)

设置事件源的包名称。

参数：

参数名称	参数描述
bundleName	指示事件源的包名称。

setAccessibilityEventType

public void setAccessibilityEventType(int accessibilityEventType)

设置可访问性事件的类型。

参数：

参数名称	参数描述
accessibilityEventType	指示可访问性事件的类型。

setWindowChangeTypes

public void setWindowChangeTypes(int changeTypes)

设置窗口改变事件的类型，可以是内容改变或状态改变。

参数：

参数名称	参数描述
changeTypes	指示窗口更改事件的类型。

setViewId

public void setViewId(int viewId)

设置与可访问性事件关联的视图 ID。

参数：

参数名称	参数描述
viewId	表示视图 ID。

getClassName

public CharSequence getClassName()

获取类名。

返回:

返回类名。

setClassName

public void setClassName(CharSequence className)

设置类名。

参数：

参数名称	参数描述
className	表示要设置的类名。

getDescription

public CharSequence getDescription()

获取可访问性事件描述。

返回:

返回描述。

setDescription

public void setDescription(CharSequence description)

设置可访问性事件描述。

参数：

参数名称	参数描述
description	表示要设置的描述。

getCount

public int getCount()

获取可访问性事件的数量。

返回:

返回可访问性事件的数量。

setCount

public void setCount(int count)

设置可访问性事件的数量。

参数：

参数名称	参数描述
count	指示要设置的可访问性事件的数量。

getPresentIndex

public int getPresentIndex()

获取当前事件的索引。

返回:

返回事件索引。

setPresentIndex

public void setPresentIndex(int presentIndex)

设置当前事件的索引。

参数：

参数名称	参数描述
presentIndex	指示要设置的事件索引。

getStartIndex

public int getStartIndex()

获取屏幕上列出的项目的开始索引。

返回:

返回起始索引。

setStartIndex

public void setStartIndex(int startIndex)

设置屏幕上列出的项目的开始索引。

参数：

参数名称	参数描述
startIndex	指示要设置的开始索引。

getEndIndex

public int getEndIndex()

获取屏幕上列出的项目的结束索引。

返回:

返回结束索引。

setEndIndex

public void setEndIndex(int endIndex)

设置屏幕上列出项目的结束索引。

参数：

参数名称	参数描述
endIndex	指示要设置的结束索引。

getLastContent

public CharSequence getLastContent()

获取组件的最后一个内容。

返回:

返回组件的最后一个内容。

setLastContent

public void setLastContent(CharSequence lastContent)

设置组件的最后一个内容。

参数：

参数名称	参数描述
lastContent	指示要为组件设置的最后一个内容。

getContentList

public ArrayListCharSequence getContentList()

获取事件中的内容列表。

返回:

返回事件中的内容列表。

addContent

public void addContent(CharSequence in)

将元素添加到内容列表。

参数：

参数名称	参数描述
in	表示要添加的元素。