Android APIs
public class

AccessibilityRecord

extends Object
java.lang.Object
   ↳ android.view.accessibility.AccessibilityRecord
Known Direct Subclasses

Class Overview

Represents a record in an AccessibilityEvent and contains information about state change of its source View. When a view fires an accessibility event it requests from its parent to dispatch the constructed event. The parent may optionally append a record for itself for providing more context to AccessibilityServices. Hence, accessibility services can facilitate additional accessibility records to enhance feedback.

Once the accessibility event containing a record is dispatched the record is made immutable and calling a state mutation method generates an error.

Note: Not all properties are applicable to all accessibility event types. For detailed information please refer to AccessibilityEvent.

Developer Guides

For more information about creating and processing AccessibilityRecords, read the Accessibility developer guide.

Summary

Public Methods
int getAddedCount()
Gets the number of added characters.
CharSequence getBeforeText()
Sets the text before a change.
CharSequence getClassName()
Gets the class name of the source.
CharSequence getContentDescription()
Gets the description of the source.
int getCurrentItemIndex()
Gets the index of the source in the list of items the can be visited.
int getFromIndex()
Gets the index of the first character of the changed sequence, or the beginning of a text selection or the index of the first visible item when scrolling.
int getItemCount()
Gets the number of items that can be visited.
int getMaxScrollX()
Gets the max scroll offset of the source left edge in pixels.
int getMaxScrollY()
Gets the max scroll offset of the source top edge in pixels.
Parcelable getParcelableData()
Gets the Parcelable data.
int getRemovedCount()
Gets the number of removed characters.
int getScrollX()
Gets the scroll offset of the source left edge in pixels.
int getScrollY()
Gets the scroll offset of the source top edge in pixels.
AccessibilityNodeInfo getSource()
Gets the AccessibilityNodeInfo of the event source.
List<CharSequence> getText()
Gets the text of the event.
int getToIndex()
Gets the index of text selection end or the index of the last visible item when scrolling.
int getWindowId()
Gets the id of the window from which the event comes from.
boolean isChecked()
Gets if the source is checked.
boolean isEnabled()
Gets if the source is enabled.
boolean isFullScreen()
Gets if the source is taking the entire screen.
boolean isPassword()
Gets if the source is a password field.
boolean isScrollable()
Gets if the source is scrollable.
static AccessibilityRecord obtain(AccessibilityRecord record)
Returns a cached instance if such is available or a new one is instantiated.
static AccessibilityRecord obtain()
Returns a cached instance if such is available or a new one is instantiated.
void recycle()
Return an instance back to be reused.
void setAddedCount(int addedCount)
Sets the number of added characters.
void setBeforeText(CharSequence beforeText)
Sets the text before a change.
void setChecked(boolean isChecked)
Sets if the source is checked.
void setClassName(CharSequence className)
Sets the class name of the source.
void setContentDescription(CharSequence contentDescription)
Sets the description of the source.
void setCurrentItemIndex(int currentItemIndex)
Sets the index of the source in the list of items that can be visited.
void setEnabled(boolean isEnabled)
Sets if the source is enabled.
void setFromIndex(int fromIndex)
Sets the index of the first character of the changed sequence or the beginning of a text selection or the index of the first visible item when scrolling.
void setFullScreen(boolean isFullScreen)
Sets if the source is taking the entire screen.
void setItemCount(int itemCount)
Sets the number of items that can be visited.
void setMaxScrollX(int maxScrollX)
Sets the max scroll offset of the source left edge in pixels.
void setMaxScrollY(int maxScrollY)
Sets the max scroll offset of the source top edge in pixels.
void setParcelableData(Parcelable parcelableData)
Sets the Parcelable data of the event.
void setPassword(boolean isPassword)
Sets if the source is a password field.
void setRemovedCount(int removedCount)
Sets the number of removed characters.
void setScrollX(int scrollX)
Sets the scroll offset of the source left edge in pixels.
void setScrollY(int scrollY)
Sets the scroll offset of the source top edge in pixels.
void setScrollable(boolean scrollable)
Sets if the source is scrollable.
void setSource(View root, int virtualDescendantId)
Sets the source to be a virtual descendant of the given root.
void setSource(View source)
Sets the event source.
void setToIndex(int toIndex)
Sets the index of text selection end or the index of the last visible item when scrolling.
String toString()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public int getAddedCount ()

Added in API level 4

Gets the number of added characters.

Returns
int The number of added characters.

public CharSequence getBeforeText ()

Added in API level 4

Sets the text before a change.

Returns
CharSequence The text before the change.

public CharSequence getClassName ()

Added in API level 4

Gets the class name of the source.

Returns
CharSequence The class name.

public CharSequence getContentDescription ()

Added in API level 4

Gets the description of the source.

Returns
CharSequence The description.

public int getCurrentItemIndex ()

Added in API level 4

Gets the index of the source in the list of items the can be visited.

Returns
int The current item index.

public int getFromIndex ()

Added in API level 4

Gets the index of the first character of the changed sequence, or the beginning of a text selection or the index of the first visible item when scrolling.

Returns
int The index of the first character or selection start or the first visible item.

public int getItemCount ()

Added in API level 4

Gets the number of items that can be visited.

Returns
int The number of items.

public int getMaxScrollX ()

Added in API level 15

Gets the max scroll offset of the source left edge in pixels.

Returns
int The max scroll.

public int getMaxScrollY ()

Added in API level 15

Gets the max scroll offset of the source top edge in pixels.

Returns
int The max scroll.

public Parcelable getParcelableData ()

Added in API level 4

Gets the Parcelable data.

Returns
Parcelable The parcelable data.

public int getRemovedCount ()

Added in API level 4

Gets the number of removed characters.

Returns
int The number of removed characters.

public int getScrollX ()

Added in API level 14

Gets the scroll offset of the source left edge in pixels.

Returns
int The scroll.

public int getScrollY ()

Added in API level 14

Gets the scroll offset of the source top edge in pixels.

Returns
int The scroll.

public AccessibilityNodeInfo getSource ()

Added in API level 14

Gets the AccessibilityNodeInfo of the event source.

Note: It is a client responsibility to recycle the received info by calling AccessibilityNodeInfo#recycle() to avoid creating of multiple instances.

Returns
AccessibilityNodeInfo The info of the source.

public List<CharSequence> getText ()

Added in API level 4

Gets the text of the event. The index in the list represents the priority of the text. Specifically, the lower the index the higher the priority.

Returns
List<CharSequence> The text.

public int getToIndex ()

Added in API level 14

Gets the index of text selection end or the index of the last visible item when scrolling.

Returns
int The index of selection end or last item index.

public int getWindowId ()

Added in API level 14

Gets the id of the window from which the event comes from.

Returns
int The window id.

public boolean isChecked ()

Added in API level 4

Gets if the source is checked.

Returns
boolean True if the view is checked, false otherwise.

public boolean isEnabled ()

Added in API level 4

Gets if the source is enabled.

Returns
boolean True if the view is enabled, false otherwise.

public boolean isFullScreen ()

Added in API level 4

Gets if the source is taking the entire screen.

Returns
boolean True if the source is full screen, false otherwise.

public boolean isPassword ()

Added in API level 4

Gets if the source is a password field.

Returns
boolean True if the view is a password field, false otherwise.

public boolean isScrollable ()

Added in API level 14

Gets if the source is scrollable.

Returns
boolean True if the source is scrollable, false otherwise.

public static AccessibilityRecord obtain (AccessibilityRecord record)

Added in API level 14

Returns a cached instance if such is available or a new one is instantiated. The instance is initialized with data from the given record.

Parameters
record AccessibilityRecord
Returns
AccessibilityRecord An instance.

public static AccessibilityRecord obtain ()

Added in API level 14

Returns a cached instance if such is available or a new one is instantiated.

Returns
AccessibilityRecord An instance.

public void recycle ()

Added in API level 14

Return an instance back to be reused.

Note: You must not touch the object after calling this function.

Throws
IllegalStateException If the record is already recycled.

public void setAddedCount (int addedCount)

Added in API level 4

Sets the number of added characters.

Parameters
addedCount int: The number of added characters.
Throws
IllegalStateException If called from an AccessibilityService.

public void setBeforeText (CharSequence beforeText)

Added in API level 4

Sets the text before a change.

Parameters
beforeText CharSequence: The text before the change.
Throws
IllegalStateException If called from an AccessibilityService.

public void setChecked (boolean isChecked)

Added in API level 4

Sets if the source is checked.

Parameters
isChecked boolean: True if the view is checked, false otherwise.
Throws
IllegalStateException If called from an AccessibilityService.

public void setClassName (CharSequence className)

Added in API level 4

Sets the class name of the source.

Parameters
className CharSequence: The lass name.
Throws
IllegalStateException If called from an AccessibilityService.

public void setContentDescription (CharSequence contentDescription)

Added in API level 4

Sets the description of the source.

Parameters
contentDescription CharSequence: The description.
Throws
IllegalStateException If called from an AccessibilityService.

public void setCurrentItemIndex (int currentItemIndex)

Added in API level 4

Sets the index of the source in the list of items that can be visited.

Parameters
currentItemIndex int: The current item index.
Throws
IllegalStateException If called from an AccessibilityService.

public void setEnabled (boolean isEnabled)

Added in API level 4

Sets if the source is enabled.

Parameters
isEnabled boolean: True if the view is enabled, false otherwise.
Throws
IllegalStateException If called from an AccessibilityService.

public void setFromIndex (int fromIndex)

Added in API level 4

Sets the index of the first character of the changed sequence or the beginning of a text selection or the index of the first visible item when scrolling.

Parameters
fromIndex int: The index of the first character or selection start or the first visible item.
Throws
IllegalStateException If called from an AccessibilityService.

public void setFullScreen (boolean isFullScreen)

Added in API level 4

Sets if the source is taking the entire screen.

Parameters
isFullScreen boolean: True if the source is full screen, false otherwise.
Throws
IllegalStateException If called from an AccessibilityService.

public void setItemCount (int itemCount)

Added in API level 4

Sets the number of items that can be visited.

Parameters
itemCount int: The number of items.
Throws
IllegalStateException If called from an AccessibilityService.

public void setMaxScrollX (int maxScrollX)

Added in API level 15

Sets the max scroll offset of the source left edge in pixels.

Parameters
maxScrollX int: The max scroll.

public void setMaxScrollY (int maxScrollY)

Added in API level 15

Sets the max scroll offset of the source top edge in pixels.

Parameters
maxScrollY int: The max scroll.

public void setParcelableData (Parcelable parcelableData)

Added in API level 4

Sets the Parcelable data of the event.

Parameters
parcelableData Parcelable: The parcelable data.
Throws
IllegalStateException If called from an AccessibilityService.

public void setPassword (boolean isPassword)

Added in API level 4

Sets if the source is a password field.

Parameters
isPassword boolean: True if the view is a password field, false otherwise.
Throws
IllegalStateException If called from an AccessibilityService.

public void setRemovedCount (int removedCount)

Added in API level 4

Sets the number of removed characters.

Parameters
removedCount int: The number of removed characters.
Throws
IllegalStateException If called from an AccessibilityService.

public void setScrollX (int scrollX)

Added in API level 14

Sets the scroll offset of the source left edge in pixels.

Parameters
scrollX int: The scroll.

public void setScrollY (int scrollY)

Added in API level 14

Sets the scroll offset of the source top edge in pixels.

Parameters
scrollY int: The scroll.

public void setScrollable (boolean scrollable)

Added in API level 14

Sets if the source is scrollable.

Parameters
scrollable boolean: True if the source is scrollable, false otherwise.
Throws
IllegalStateException If called from an AccessibilityService.

public void setSource (View root, int virtualDescendantId)

Added in API level 16

Sets the source to be a virtual descendant of the given root. If virtualDescendantId equals to NO_ID the root is set as the source.

A virtual descendant is an imaginary View that is reported as a part of the view hierarchy for accessibility purposes. This enables custom views that draw complex content to report them selves as a tree of virtual views, thus conveying their logical structure.

Parameters
root View: The root of the virtual subtree.
virtualDescendantId int: The id of the virtual descendant.

public void setSource (View source)

Added in API level 14

Sets the event source.

Parameters
source View: The source.
Throws
IllegalStateException If called from an AccessibilityService.

public void setToIndex (int toIndex)

Added in API level 14

Sets the index of text selection end or the index of the last visible item when scrolling.

Parameters
toIndex int: The index of selection end or last item index.

public String toString ()

Added in API level 14

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.