鴻蒙OS AccessibilityEventInfo

AccessibilityEventInfo

java.lang.Object

|---ohos.accessibility.AccessibilityEventInfo

public class AccessibilityEventInfo
extends Object

描述無障礙事件信息并為無障礙服務(wù)提供信息。

信息包括無障礙事件類型、觸發(fā)無障礙事件的操作、事件源的包名、用于閱讀文本的移動步驟、無障礙事件列表。

當對 UI 進行任何更改時，例如，當視圖控件獲得焦點時，您的應(yīng)用可以向無障礙服務(wù)發(fā)送 AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT 無障礙事件以觸發(fā)無障礙功能。

字段摘要

修飾符和類型	字段	描述
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	描述窗口變?yōu)榛顒踊虿换顒拥拇翱诟氖录?/td>
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	描述窗口標題已更改的窗口更改事件。

構(gòu)造函數(shù)摘要

構(gòu)造函數(shù)	描述
AccessibilityEventInfo()	用于創(chuàng)建 AccessibilityEventInfo 實例的構(gòu)造函數(shù)。
AccessibilityEventInfo(int eventType)	用于創(chuàng)建具有指定事件類型的 AccessibilityEventInfo 實例的構(gòu)造函數(shù)，例如 TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED_EVENT、TYPE_VIEW_CLICKED_EVENT 和 TYPE_VIEW_ACCESSIBILITY_FOCUSED_EVENT。
AccessibilityEventInfo(AccessibilityEventInfo eventInfo)	用于通過復(fù)制指定的可訪問性事件信息來創(chuàng)建 AccessibilityEventInfo 實例的構(gòu)造函數(shù)。

方法總結(jié)

修飾符和類型	方法	描述
void	addContent(CharSequence in)	將元素添加到內(nèi)容列表。
void	addRecord(AccessibilityEventInfo eventInfo)	將可訪問性事件添加到事件列表。
int	getAccessibilityEventType()	獲取可訪問性事件的類型。
CharSequence	getBundleName()	獲取事件源的bundle名，即目標應(yīng)用的bundle名。
CharSequence	getClassName()	獲取類名。
ArrayListCharSequence	getContentList()	獲取事件中的內(nèi)容列表。
int	getCount()	獲取可訪問性事件的數(shù)量。
CharSequence	getDescription()	獲取可訪問性事件描述。
int	getEndIndex()	獲取屏幕上列出的項目的結(jié)束索引。
CharSequence	getLastContent()	獲取組件的最后一個內(nèi)容。
int	getPresentIndex()	獲取當前事件的索引。
ArrayListAccessibilityEventInfo	getRecords()	獲取可訪問性事件列表。
int	getStartIndex()	獲取屏幕上列出的項目的開始索引。
int	getTextMoveStep()	獲取用于閱讀文本的移動步長。
int	getTriggerAction()	獲取觸發(fā)無障礙事件的動作，例如點擊或聚焦視圖。
int	getViewId()	獲取與可訪問性事件關(guān)聯(lián)的視圖 ID。
int	getWindowChangeTypes()	獲取窗口變化事件的類型，可以是內(nèi)容變化，也可以是狀態(tài)變化。
void	setAccessibilityEventType(int accessibilityEventType)	設(shè)置可訪問性事件的類型。
void	setBundleName(CharSequence bundleName)	設(shè)置事件源的包名稱。
void	setClassName(CharSequence className)	設(shè)置類名。
void	setCount(int count)	設(shè)置可訪問性事件的數(shù)量。
void	setDescription(CharSequence description)	設(shè)置可訪問性事件描述。
void	setEndIndex(int endIndex)	設(shè)置屏幕上列出項目的結(jié)束索引。
void	setLastContent(CharSequence lastContent)	設(shè)置組件的最后一個內(nèi)容。
void	setPresentIndex(int presentIndex)	設(shè)置當前事件的索引。
void	setStartIndex(int startIndex)	設(shè)置屏幕上列出的項目的開始索引。
void	setTextMoveStep(int moveStep)	設(shè)置用于閱讀文本的移動步長。
void	setTriggerAction(int action)	設(shè)置觸發(fā)可訪問性事件的操作。
void	setViewId(int viewId)	設(shè)置與可訪問性事件關(guān)聯(lián)的視圖 ID。
void	setWindowChangeTypes(int changeTypes)	設(shè)置窗口改變事件的類型，可以是內(nèi)容改變或狀態(tài)改變。

從類 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

描述窗口變?yōu)榛顒踊虿换顒拥拇翱诟氖录?/p>

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

描述窗口標題已更改的窗口更改事件。

構(gòu)造函數(shù)詳細信息

AccessibilityEventInfo

public AccessibilityEventInfo()

用于創(chuàng)建 AccessibilityEventInfo 實例的構(gòu)造函數(shù)。

AccessibilityEventInfo

public AccessibilityEventInfo(int eventType)

用于創(chuàng)建具有指定事件類型的 AccessibilityEventInfo 實例的構(gòu)造函數(shù)，例如 TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED_EVENT、TYPE_VIEW_CLICKED_EVENT 和 TYPE_VIEW_ACCESSIBILITY_FOCUSED_EVENT。

參數(shù)：

參數(shù)名稱	參數(shù)描述
eventType	指示可訪問性事件的類型。

AccessibilityEventInfo

public AccessibilityEventInfo(AccessibilityEventInfo eventInfo)

用于通過復(fù)制指定的可訪問性事件信息來創(chuàng)建 AccessibilityEventInfo 實例的構(gòu)造函數(shù)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
eventInfo	表示可訪問性事件信息。

方法詳情

getTriggerAction

public int getTriggerAction()

獲取觸發(fā)無障礙事件的動作，例如點擊或聚焦視圖。

返回:

返回觸發(fā)可訪問性事件的操作。

getWindowChangeTypes

public int getWindowChangeTypes()

獲取窗口變化事件的類型，可以是內(nèi)容變化，也可以是狀態(tài)變化。

返回:

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

getAccessibilityEventType

public int getAccessibilityEventType()

獲取可訪問性事件的類型。

返回:

返回可訪問性事件的類型。

getTextMoveStep

public int getTextMoveStep()

獲取用于閱讀文本的移動步長。

返回:

返回移動步驟，例如，移動到下一個字符、單詞或行。

getBundleName

public CharSequence getBundleName()

獲取事件源的bundle名，即目標應(yīng)用的bundle名。

返回:

返回事件源的包名稱。

getViewId

public int getViewId()

獲取與可訪問性事件關(guān)聯(lián)的視圖 ID。

返回:

返回視圖 ID。

addRecord

public void addRecord(AccessibilityEventInfo eventInfo)

將可訪問性事件添加到事件列表。

參數(shù)：

參數(shù)名稱	參數(shù)描述
eventInfo	指示要添加的可訪問性事件。

getRecords

public ArrayListAccessibilityEventInfo getRecords()

獲取可訪問性事件列表。

返回:

返回可訪問性事件列表。

setTriggerAction

public void setTriggerAction(int action)

設(shè)置觸發(fā)可訪問性事件的操作。

參數(shù)：

參數(shù)名稱	參數(shù)描述
action	指示觸發(fā)可訪問性事件的操作。

setTextMoveStep

public void setTextMoveStep(int moveStep)

設(shè)置用于閱讀文本的移動步長。

參數(shù)：

參數(shù)名稱	參數(shù)描述
moveStep	表示移動步驟，例如移動到下一個字符、單詞或行。

setBundleName

public void setBundleName(CharSequence bundleName)

設(shè)置事件源的包名稱。

參數(shù)：

參數(shù)名稱	參數(shù)描述
bundleName	指示事件源的包名稱。

setAccessibilityEventType

public void setAccessibilityEventType(int accessibilityEventType)

設(shè)置可訪問性事件的類型。

參數(shù)：

參數(shù)名稱	參數(shù)描述
accessibilityEventType	指示可訪問性事件的類型。

setWindowChangeTypes

public void setWindowChangeTypes(int changeTypes)

設(shè)置窗口改變事件的類型，可以是內(nèi)容改變或狀態(tài)改變。

參數(shù)：

參數(shù)名稱	參數(shù)描述
changeTypes	指示窗口更改事件的類型。

setViewId

public void setViewId(int viewId)

設(shè)置與可訪問性事件關(guān)聯(lián)的視圖 ID。

參數(shù)：

參數(shù)名稱	參數(shù)描述
viewId	表示視圖 ID。

getClassName

public CharSequence getClassName()

獲取類名。

返回:

返回類名。

setClassName

public void setClassName(CharSequence className)

設(shè)置類名。

參數(shù)：

參數(shù)名稱	參數(shù)描述
className	表示要設(shè)置的類名。

getDescription

public CharSequence getDescription()

獲取可訪問性事件描述。

返回:

返回描述。

setDescription

public void setDescription(CharSequence description)

設(shè)置可訪問性事件描述。

參數(shù)：

參數(shù)名稱	參數(shù)描述
description	表示要設(shè)置的描述。

getCount

public int getCount()

獲取可訪問性事件的數(shù)量。

返回:

返回可訪問性事件的數(shù)量。

setCount

public void setCount(int count)

設(shè)置可訪問性事件的數(shù)量。

參數(shù)：

參數(shù)名稱	參數(shù)描述
count	指示要設(shè)置的可訪問性事件的數(shù)量。

getPresentIndex

public int getPresentIndex()

獲取當前事件的索引。

返回:

返回事件索引。

setPresentIndex

public void setPresentIndex(int presentIndex)

設(shè)置當前事件的索引。

參數(shù)：

參數(shù)名稱	參數(shù)描述
presentIndex	指示要設(shè)置的事件索引。

getStartIndex

public int getStartIndex()

獲取屏幕上列出的項目的開始索引。

返回:

返回起始索引。

setStartIndex

public void setStartIndex(int startIndex)

設(shè)置屏幕上列出的項目的開始索引。

參數(shù)：

參數(shù)名稱	參數(shù)描述
startIndex	指示要設(shè)置的開始索引。

getEndIndex

public int getEndIndex()

獲取屏幕上列出的項目的結(jié)束索引。

返回:

返回結(jié)束索引。

setEndIndex

public void setEndIndex(int endIndex)

設(shè)置屏幕上列出項目的結(jié)束索引。

參數(shù)：

參數(shù)名稱	參數(shù)描述
endIndex	指示要設(shè)置的結(jié)束索引。

getLastContent

public CharSequence getLastContent()

獲取組件的最后一個內(nèi)容。

返回:

返回組件的最后一個內(nèi)容。

setLastContent

public void setLastContent(CharSequence lastContent)

設(shè)置組件的最后一個內(nèi)容。

參數(shù)：

參數(shù)名稱	參數(shù)描述
lastContent	指示要為組件設(shè)置的最后一個內(nèi)容。

getContentList

public ArrayListCharSequence getContentList()

獲取事件中的內(nèi)容列表。

返回:

返回事件中的內(nèi)容列表。

addContent

public void addContent(CharSequence in)

將元素添加到內(nèi)容列表。

參數(shù)：

參數(shù)名稱	參數(shù)描述
in	表示要添加的元素。