Skip to content

Most visited

Recently visited

navigation

AccessibilityRecordCompat

public class AccessibilityRecordCompat
extends Object

java.lang.Object
   ↳ android.support.v4.view.accessibility.AccessibilityRecordCompat


Helper for accessing AccessibilityRecord introduced after API level 4 in a backwards compatible fashion.

Summary

Public constructors

AccessibilityRecordCompat(Object record)

This constructor is deprecated. This is not type safe. If you want to modify an AccessibilityEvent's properties defined in AccessibilityRecord use asRecord(AccessibilityEvent). This method will be removed in a subsequent release of the support library.

Public methods

boolean equals(Object obj)

Compares this instance with the specified object and indicates if they are equal.

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.

Object getImpl()

This method is deprecated. This method will be removed in a subsequent release of the support library.

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.

AccessibilityNodeInfoCompat 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.

int hashCode()

Returns an integer hash code for this object.

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

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

static AccessibilityRecordCompat obtain(AccessibilityRecordCompat 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.

Inherited methods

From class java.lang.Object

Public constructors

AccessibilityRecordCompat

AccessibilityRecordCompat (Object record)

This constructor is deprecated.
This is not type safe. If you want to modify an AccessibilityEvent's properties defined in AccessibilityRecord use asRecord(AccessibilityEvent). This method will be removed in a subsequent release of the support library.

Parameters
record Object

Public methods

equals

boolean equals (Object obj)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
obj Object: the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

getAddedCount

int getAddedCount ()

Gets the number of added characters.

Returns
int The number of added characters.

getBeforeText

CharSequence getBeforeText ()

Sets the text before a change.

Returns
CharSequence The text before the change.

getClassName

CharSequence getClassName ()

Gets the class name of the source.

Returns
CharSequence The class name.

getContentDescription

CharSequence getContentDescription ()

Gets the description of the source.

Returns
CharSequence The description.

getCurrentItemIndex

int getCurrentItemIndex ()

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

Returns
int The current item index.

getFromIndex

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.

getImpl

Object getImpl ()

This method is deprecated.
This method will be removed in a subsequent release of the support library.

Returns
Object The wrapped implementation.

getItemCount

int getItemCount ()

Gets the number of items that can be visited.

Returns
int The number of items.

getMaxScrollX

int getMaxScrollX ()

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

Returns
int The max scroll.

getMaxScrollY

int getMaxScrollY ()

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

Returns
int The max scroll.

getParcelableData

Parcelable getParcelableData ()

Gets the Parcelable data.

Returns
Parcelable The parcelable data.

getRemovedCount

int getRemovedCount ()

Gets the number of removed characters.

Returns
int The number of removed characters.

getScrollX

int getScrollX ()

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

Returns
int The scroll.

getScrollY

int getScrollY ()

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

Returns
int The scroll.

getSource

AccessibilityNodeInfoCompat 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
AccessibilityNodeInfoCompat The info of the source.

getText

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

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

int getWindowId ()

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

Returns
int The window id.

hashCode

int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

isChecked

boolean isChecked ()

Gets if the source is checked.

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

isEnabled

boolean isEnabled ()

Gets if the source is enabled.

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

isFullScreen

boolean isFullScreen ()

Gets if the source is taking the entire screen.

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

isPassword

boolean isPassword ()

Gets if the source is a password field.

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

isScrollable

boolean isScrollable ()

Gets if the source is scrollable.

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

obtain

AccessibilityRecordCompat obtain ()

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

Returns
AccessibilityRecordCompat An instance.

obtain

AccessibilityRecordCompat obtain (AccessibilityRecordCompat 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 AccessibilityRecordCompat
Returns
AccessibilityRecordCompat An instance.

recycle

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

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

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

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

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

void setContentDescription (CharSequence contentDescription)

Sets the description of the source.

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

setCurrentItemIndex

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

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

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

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

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

void setMaxScrollX (int maxScrollX)

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

Parameters
maxScrollX int: The max scroll.

setMaxScrollY

void setMaxScrollY (int maxScrollY)

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

Parameters
maxScrollY int: The max scroll.

setParcelableData

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

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

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

void setScrollX (int scrollX)

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

Parameters
scrollX int: The scroll.

setScrollY

void setScrollY (int scrollY)

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

Parameters
scrollY int: The scroll.

setScrollable

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

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

void setSource (View source)

Sets the event source.

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

setToIndex

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.
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.