Skip to content

Most visited

Recently visited

navigation
Added in API level 14

AccessibilityRecord

public class AccessibilityRecord
extends Object

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


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.

See also:

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()

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

static AccessibilityRecord obtain(AccessibilityRecord record)

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 representation of the object.

Inherited methods

From class java.lang.Object

Public methods

getAddedCount

Added in API level 4
int getAddedCount ()

Gets the number of added characters.

Returns
int The number of added characters.

getBeforeText

Added in API level 4
CharSequence getBeforeText ()

Sets the text before a change.

Returns
CharSequence The text before the change.

getClassName

Added in API level 4
CharSequence getClassName ()

Gets the class name of the source.

Returns
CharSequence The class name.

getContentDescription

Added in API level 4
CharSequence getContentDescription ()

Gets the description of the source.

Returns
CharSequence The description.

getCurrentItemIndex

Added in API level 4
int getCurrentItemIndex ()

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

Returns
int The current item index.

getFromIndex

Added in API level 4
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.

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

getItemCount

Added in API level 4
int getItemCount ()

Gets the number of items that can be visited.

Returns
int The number of items.

getMaxScrollX

Added in API level 15
int getMaxScrollX ()

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

Returns
int The max scroll.

getMaxScrollY

Added in API level 15
int getMaxScrollY ()

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

Returns
int The max scroll.

getParcelableData

Added in API level 4
Parcelable getParcelableData ()

Gets the Parcelable data.

Returns
Parcelable The parcelable data.

getRemovedCount

Added in API level 4
int getRemovedCount ()

Gets the number of removed characters.

Returns
int The number of removed characters.

getScrollX

Added in API level 14
int getScrollX ()

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

Returns
int The scroll.

getScrollY

Added in API level 14
int getScrollY ()

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

Returns
int The scroll.

getSource

Added in API level 14
AccessibilityNodeInfo getSource ()

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.

getText

Added in API level 4
List<CharSequence> getText ()

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.

getToIndex

Added in API level 14
int getToIndex ()

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.

getWindowId

Added in API level 14
int getWindowId ()

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

Returns
int The window id.

isChecked

Added in API level 4
boolean isChecked ()

Gets if the source is checked.

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

isEnabled

Added in API level 4
boolean isEnabled ()

Gets if the source is enabled.

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

isFullScreen

Added in API level 4
boolean isFullScreen ()

Gets if the source is taking the entire screen.

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

isPassword

Added in API level 4
boolean isPassword ()

Gets if the source is a password field.

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

isScrollable

Added in API level 14
boolean isScrollable ()

Gets if the source is scrollable.

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

obtain

Added in API level 14
AccessibilityRecord obtain ()

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

Returns
AccessibilityRecord An instance.

obtain

Added in API level 14
AccessibilityRecord obtain (AccessibilityRecord record)

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.

recycle

Added in API level 14
void recycle ()

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.

setAddedCount

Added in API level 4
void setAddedCount (int addedCount)

Sets the number of added characters.

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

setBeforeText

Added in API level 4
void setBeforeText (CharSequence beforeText)

Sets the text before a change.

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

setChecked

Added in API level 4
void setChecked (boolean isChecked)

Sets if the source is checked.

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

setClassName

Added in API level 4
void setClassName (CharSequence className)

Sets the class name of the source.

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

setContentDescription

Added in API level 4
void setContentDescription (CharSequence contentDescription)

Sets the description of the source.

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

setCurrentItemIndex

Added in API level 4
void setCurrentItemIndex (int currentItemIndex)

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.

setEnabled

Added in API level 4
void setEnabled (boolean isEnabled)

Sets if the source is enabled.

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

setFromIndex

Added in API level 4
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.

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

setFullScreen

Added in API level 4
void setFullScreen (boolean isFullScreen)

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.

setItemCount

Added in API level 4
void setItemCount (int itemCount)

Sets the number of items that can be visited.

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

setMaxScrollX

Added in API level 15
void setMaxScrollX (int maxScrollX)

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

Parameters
maxScrollX int: The max scroll.

setMaxScrollY

Added in API level 15
void setMaxScrollY (int maxScrollY)

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

Parameters
maxScrollY int: The max scroll.

setParcelableData

Added in API level 4
void setParcelableData (Parcelable parcelableData)

Sets the Parcelable data of the event.

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

setPassword

Added in API level 4
void setPassword (boolean isPassword)

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.

setRemovedCount

Added in API level 4
void setRemovedCount (int removedCount)

Sets the number of removed characters.

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

setScrollX

Added in API level 14
void setScrollX (int scrollX)

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

Parameters
scrollX int: The scroll.

setScrollY

Added in API level 14
void setScrollY (int scrollY)

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

Parameters
scrollY int: The scroll.

setScrollable

Added in API level 14
void setScrollable (boolean scrollable)

Sets if the source is scrollable.

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

setSource

Added in API level 16
void setSource (View root, 
                int virtualDescendantId)

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.

setSource

Added in API level 14
void setSource (View source)

Sets the event source.

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

setToIndex

Added in API level 14
void setToIndex (int toIndex)

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.

toString

Added in API level 14
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

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

Returns
String a string representation of the object.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.