public class AccessibilityRecord
extends Object
| java.lang.Object | |
| ↳ | android.view.accessibility.AccessibilityRecord |
 Known Direct Subclasses
|
代表AccessibilityEvent的记录，并包含有关其源View状态更改的信息。 当视图触发可访问性事件时，它会请求其父级派发构造的事件。 父母可以有选择地为自己添加一条记录，以便为AccessibilityService提供更多的上下文。 因此，无障碍服务可以促进额外的无障碍记录以加强反馈。
一旦包含记录的可访问性事件被调度，记录就会不可变，并且调用状态变异方法会产生错误。
注意：并非所有属性都适用于所有辅助功能事件类型。 有关详细信息，请参阅AccessibilityEvent 。
有关创建和处理AccessibilityRecords的更多信息，请阅读 Accessibility开发人员指南。
Public methods |
|
|---|---|
int |
getAddedCount() 获取添加的字符数。 |
CharSequence |
getBeforeText() 设置更改前的文本。 |
CharSequence |
getClassName() 获取源的类名称。 |
CharSequence |
getContentDescription() 获取源的描述。 |
int |
getCurrentItemIndex() 获取可以访问的项目列表中源的索引。 |
int |
getFromIndex() 获取已更改序列的第一个字符的索引，或滚动时文本选择的开始或第一个可见项目的索引。 |
int |
getItemCount() 获取可以访问的项目数。 |
int |
getMaxScrollX() 获取源左边缘的最大滚动偏移量（以像素为单位）。 |
int |
getMaxScrollY() 以像素为单位获取源顶部边缘的最大滚动偏移量。 |
Parcelable |
getParcelableData() 获取 |
int |
getRemovedCount() 获取已删除字符的数量。 |
int |
getScrollX() 获取源左边缘的滚动偏移量，以像素为单位。 |
int |
getScrollY() 获取以像素为单位的源顶部边缘的滚动偏移量。 |
AccessibilityNodeInfo |
getSource() 获取事件源的 |
List<CharSequence> |
getText() 获取事件的文本。 |
int |
getToIndex() 滚动时获取文本选择结束的索引或最后一个可见项目的索引。 |
int |
getWindowId() 获取事件来自的窗口的ID。 |
boolean |
isChecked() 获取源是否被选中。 |
boolean |
isEnabled() 获取源是否已启用。 |
boolean |
isFullScreen() 获取源是否正在拍摄整个屏幕。 |
boolean |
isPassword() 获取源是否是密码字段。 |
boolean |
isScrollable() 获取源是否可滚动。 |
static AccessibilityRecord |
obtain() 如果可用或返回实例，则返回缓存的实例。 |
static AccessibilityRecord |
obtain(AccessibilityRecord record) 如果可用或返回实例，则返回缓存的实例。 |
void |
recycle() 返回一个实例以重用。 |
void |
setAddedCount(int addedCount) 设置添加的字符数。 |
void |
setBeforeText(CharSequence beforeText) 设置更改前的文本。 |
void |
setChecked(boolean isChecked) 设置是否检查源。 |
void |
setClassName(CharSequence className) 设置源的类名称。 |
void |
setContentDescription(CharSequence contentDescription) 设置源的描述。 |
void |
setCurrentItemIndex(int currentItemIndex) 设置可以访问的项目列表中源的索引。 |
void |
setEnabled(boolean isEnabled) 设置源是否已启用。 |
void |
setFromIndex(int fromIndex) 滚动时，设置已更改序列的第一个字符的索引或文本选择的开头或第一个可见项目的索引。 |
void |
setFullScreen(boolean isFullScreen) 设置信号源是否拍摄整个屏幕。 |
void |
setItemCount(int itemCount) 设置可以访问的项目数量。 |
void |
setMaxScrollX(int maxScrollX) 设置源左边缘的最大滚动偏移量（以像素为单位）。 |
void |
setMaxScrollY(int maxScrollY) 设置源顶部边缘的最大滚动偏移量（以像素为单位）。 |
void |
setParcelableData(Parcelable parcelableData) 设置事件的 |
void |
setPassword(boolean isPassword) 设置源是否是密码字段。 |
void |
setRemovedCount(int removedCount) 设置已删除字符的数量。 |
void |
setScrollX(int scrollX) 设置源左边缘的滚动偏移量（以像素为单位）。 |
void |
setScrollY(int scrollY) 以像素为单位设置源顶部边缘的滚动偏移量。 |
void |
setScrollable(boolean scrollable) 设置源是否可滚动。 |
void |
setSource(View root, int virtualDescendantId) 将源设置为给定 |
void |
setSource(View source) 设置事件源。 |
void |
setToIndex(int toIndex) 滚动时设置文本选择结束的索引或最后一个可见项目的索引。 |
String |
toString() 返回对象的字符串表示形式。 |
Inherited methods |
|
|---|---|
From class java.lang.Object
|
|
int getAddedCount ()
获取添加的字符数。
| Returns | |
|---|---|
int |
The number of added characters. |
CharSequence getBeforeText ()
设置更改前的文本。
| Returns | |
|---|---|
CharSequence |
The text before the change. |
CharSequence getClassName ()
获取源的类名称。
| Returns | |
|---|---|
CharSequence |
The class name. |
CharSequence getContentDescription ()
获取源的描述。
| Returns | |
|---|---|
CharSequence |
The description. |
int getCurrentItemIndex ()
获取可以访问的项目列表中源的索引。
| Returns | |
|---|---|
int |
The current item index. |
int getFromIndex ()
获取已更改序列的第一个字符的索引，或滚动时文本选择的开始或第一个可见项目的索引。
| Returns | |
|---|---|
int |
The index of the first character or selection start or the first visible item. |
int getMaxScrollX ()
获取源左边缘的最大滚动偏移量（以像素为单位）。
| Returns | |
|---|---|
int |
The max scroll. |
int getMaxScrollY ()
以像素为单位获取源顶部边缘的最大滚动偏移量。
| Returns | |
|---|---|
int |
The max scroll. |
Parcelable getParcelableData ()
获取 Parcelable数据。
| Returns | |
|---|---|
Parcelable |
The parcelable data. |
int getRemovedCount ()
获取已删除字符的数量。
| Returns | |
|---|---|
int |
The number of removed characters. |
AccessibilityNodeInfo getSource ()
获取事件源的 AccessibilityNodeInfo 。
注意：通过调用 AccessibilityNodeInfo#recycle()来回收接收到的信息是客户的责任，以避免创建多个实例。
| Returns | |
|---|---|
AccessibilityNodeInfo |
The info of the source. |
List<CharSequence> getText ()
获取事件的文本。 列表中的索引代表文本的优先级。 具体而言，指数越低，优先级越高。
| Returns | |
|---|---|
List<CharSequence> |
The text. |
int getToIndex ()
滚动时获取文本选择结束的索引或最后一个可见项目的索引。
| Returns | |
|---|---|
int |
The index of selection end or last item index. |
boolean isChecked ()
获取源是否被选中。
| Returns | |
|---|---|
boolean |
True if the view is checked, false otherwise. |
boolean isEnabled ()
获取源是否已启用。
| Returns | |
|---|---|
boolean |
True if the view is enabled, false otherwise. |
boolean isFullScreen ()
获取源是否正在拍摄整个屏幕。
| Returns | |
|---|---|
boolean |
True if the source is full screen, false otherwise. |
boolean isPassword ()
获取源是否是密码字段。
| Returns | |
|---|---|
boolean |
True if the view is a password field, false otherwise. |
boolean isScrollable ()
获取源是否可滚动。
| Returns | |
|---|---|
boolean |
True if the source is scrollable, false otherwise. |
AccessibilityRecord obtain ()
如果可用或返回实例，则返回缓存的实例。
| Returns | |
|---|---|
AccessibilityRecord |
An instance. |
AccessibilityRecord obtain (AccessibilityRecord record)
如果可用或返回实例，则返回缓存的实例。 该实例使用给定记录的数据进行初始化。
| Parameters | |
|---|---|
record |
AccessibilityRecord
|
| Returns | |
|---|---|
AccessibilityRecord |
An instance. |
void recycle ()
返回一个实例以重用。
注意：调用此函数后，请勿触摸对象。
| Throws | |
|---|---|
IllegalStateException |
If the record is already recycled. |
void setAddedCount (int addedCount)
设置添加的字符数。
| Parameters | |
|---|---|
addedCount |
int: The number of added characters. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setBeforeText (CharSequence beforeText)
设置更改前的文本。
| Parameters | |
|---|---|
beforeText |
CharSequence: The text before the change. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setChecked (boolean isChecked)
设置是否检查源。
| Parameters | |
|---|---|
isChecked |
boolean: True if the view is checked, false otherwise. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setClassName (CharSequence className)
设置源的类名称。
| Parameters | |
|---|---|
className |
CharSequence: The lass name. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setContentDescription (CharSequence contentDescription)
设置源的描述。
| Parameters | |
|---|---|
contentDescription |
CharSequence: The description. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setCurrentItemIndex (int currentItemIndex)
设置可以访问的项目列表中源的索引。
| Parameters | |
|---|---|
currentItemIndex |
int: The current item index. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setEnabled (boolean isEnabled)
设置源是否已启用。
| Parameters | |
|---|---|
isEnabled |
boolean: True if the view is enabled, false otherwise. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setFromIndex (int fromIndex)
滚动时，设置已更改序列的第一个字符的索引或文本选择的开头或第一个可见项目的索引。
| Parameters | |
|---|---|
fromIndex |
int: The index of the first character or selection start or the first visible item. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setFullScreen (boolean isFullScreen)
设置信号源是否拍摄整个屏幕。
| Parameters | |
|---|---|
isFullScreen |
boolean: True if the source is full screen, false otherwise. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setItemCount (int itemCount)
设置可以访问的项目数量。
| Parameters | |
|---|---|
itemCount |
int: The number of items. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setMaxScrollX (int maxScrollX)
设置源左边缘的最大滚动偏移量（以像素为单位）。
| Parameters | |
|---|---|
maxScrollX |
int: The max scroll. |
void setMaxScrollY (int maxScrollY)
设置源顶部边缘的最大滚动偏移量（以像素为单位）。
| Parameters | |
|---|---|
maxScrollY |
int: The max scroll. |
void setParcelableData (Parcelable parcelableData)
设置事件的 Parcelable数据。
| Parameters | |
|---|---|
parcelableData |
Parcelable: The parcelable data. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setPassword (boolean isPassword)
设置源是否是密码字段。
| Parameters | |
|---|---|
isPassword |
boolean: True if the view is a password field, false otherwise. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setRemovedCount (int removedCount)
设置已删除字符的数量。
| Parameters | |
|---|---|
removedCount |
int: The number of removed characters. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setScrollX (int scrollX)
设置源左边缘的滚动偏移量（以像素为单位）。
| Parameters | |
|---|---|
scrollX |
int: The scroll. |
void setScrollY (int scrollY)
以像素为单位设置源顶部边缘的滚动偏移量。
| Parameters | |
|---|---|
scrollY |
int: The scroll. |
void setScrollable (boolean scrollable)
设置源是否可滚动。
| Parameters | |
|---|---|
scrollable |
boolean: True if the source is scrollable, false otherwise. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setSource (View root, int virtualDescendantId)
将源设置为给定的root的虚拟后代。 如果virtualDescendantId等于NO_ID则将根设置为源。
虚拟后代是一个假想的视图，作为可见性层次结构的一部分进行报告，以实现可访问性。 这使得绘制复杂内容的自定义视图能够将它们自己报告为虚拟视图树，从而传达其逻辑结构。
| Parameters | |
|---|---|
root |
View: The root of the virtual subtree. |
virtualDescendantId |
int: The id of the virtual descendant. |
void setSource (View source)
设置事件源。
| Parameters | |
|---|---|
source |
View: The source. |
| Throws | |
|---|---|
IllegalStateException |
If called from an AccessibilityService. |
void setToIndex (int toIndex)
滚动时设置文本选择结束的索引或最后一个可见项目的索引。
| Parameters | |
|---|---|
toIndex |
int: The index of selection end or last item index. |
String toString ()
返回对象的字符串表示形式。 通常， toString方法将返回一个“文本表示”此对象的字符串。 结果应该是一个简洁但内容丰富的表述，对于一个人来说很容易阅读。 建议所有子类重写此方法。
类Object的toString方法返回一个字符串，其中包含对象为实例的类的名称，符号字符“ @ ”以及对象的哈希代码的无符号十六进制表示形式。 换句话说，这个方法返回一个字符串，其值等于：
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
Android开发手册