AccessibilityRecord

Kotlin |Java

open class AccessibilityRecord

kotlin.Any
↳	android.view.accessibility.AccessibilityRecord

Known Direct Subclasses

AccessibilityEvent

This class represents accessibility events that are sent by the system when something notable happens in the user interface.

Represents a record in an AccessibilityEvent and contains information about state change of its source android.view.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 android.accessibilityservice.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.

Summary

Public constructors
`AccessibilityRecord()` Creates a new `AccessibilityRecord`.
`AccessibilityRecord(record: AccessibilityRecord)` Copy constructor.

Public methods
open Int	`getAddedCount()` Gets the number of added characters.
open CharSequence?	`getBeforeText()` Gets the text before a change.
open CharSequence?	`getClassName()` Gets the class name of the source.
open CharSequence?	`getContentDescription()` Gets the description of the source.
open Int	`getCurrentItemIndex()` Gets the index of the source in the list of items the can be visited.
open Int	`getDisplayId()` Gets the id of the display from which the event comes from.
open 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.
open Int	`getItemCount()` Gets the number of items that can be visited.
open Int	`getMaxScrollX()` Gets the max scroll offset of the source left edge in pixels.
open Int	`getMaxScrollY()` Gets the max scroll offset of the source top edge in pixels.
open Parcelable?	`getParcelableData()` Gets the `Parcelable` data.
open Int	`getRemovedCount()` Gets the number of removed characters.
open Int	`getScrollDeltaX()` Gets the difference in pixels between the horizontal position before the scroll and the current horizontal position
open Int	`getScrollDeltaY()` Gets the difference in pixels between the vertical position before the scroll and the current vertical position
open Int	`getScrollX()` Gets the scroll offset of the source left edge in pixels.
open Int	`getScrollY()` Gets the scroll offset of the source top edge in pixels.
open AccessibilityNodeInfo?	`getSource()` Gets the `AccessibilityNodeInfo` of the event source.
open AccessibilityNodeInfo?	`getSource(prefetchingStrategy: Int)` Gets the `AccessibilityNodeInfo` of the event source.
open MutableList<CharSequence!>	`getText()` Gets the text of the event.
open Int	`getToIndex()` Gets the index of text selection end or the index of the last visible item when scrolling.
open Int	`getWindowId()` Gets the id of the window from which the event comes from.
open Boolean	`isChecked()` Gets if the source is checked.
open Boolean	`isEnabled()` Gets if the source is enabled.
open Boolean	`isFullScreen()` Gets if the source is taking the entire screen.
open Boolean	`isPassword()` Gets if the source is a password field.
open Boolean	`isScrollable()` Gets if the source is scrollable.
open static AccessibilityRecord	`obtain(record: AccessibilityRecord)` Instantiates a new record initialized with data from the given record.
open static AccessibilityRecord	`obtain()` Instantiates a new record.
open Unit	`recycle()` Would previously return an instance back to be reused.
open Unit	`setAddedCount(addedCount: Int)` Sets the number of added characters.
open Unit	`setBeforeText(beforeText: CharSequence?)` Sets the text before a change.
open Unit	`setChecked(isChecked: Boolean)` Sets if the source is checked.
open Unit	`setClassName(className: CharSequence?)` Sets the class name of the source.
open Unit	`setContentDescription(contentDescription: CharSequence?)` Sets the description of the source.
open Unit	`setCurrentItemIndex(currentItemIndex: Int)` Sets the index of the source in the list of items that can be visited.
open Unit	`setEnabled(isEnabled: Boolean)` Sets if the source is enabled.
open Unit	`setFromIndex(fromIndex: Int)` 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.
open Unit	`setFullScreen(isFullScreen: Boolean)` Sets if the source is taking the entire screen.
open Unit	`setItemCount(itemCount: Int)` Sets the number of items that can be visited.
open Unit	`setMaxScrollX(maxScrollX: Int)` Sets the max scroll offset of the source left edge in pixels.
open Unit	`setMaxScrollY(maxScrollY: Int)` Sets the max scroll offset of the source top edge in pixels.
open Unit	`setParcelableData(parcelableData: Parcelable?)` Sets the `Parcelable` data of the event.
open Unit	`setPassword(isPassword: Boolean)` Sets if the source is a password field.
open Unit	`setRemovedCount(removedCount: Int)` Sets the number of removed characters.
open Unit	`setScrollDeltaX(scrollDeltaX: Int)` Sets the difference in pixels between the horizontal position before the scroll and the current horizontal position
open Unit	`setScrollDeltaY(scrollDeltaY: Int)` Sets the difference in pixels between the vertical position before the scroll and the current vertical position
open Unit	`setScrollX(scrollX: Int)` Sets the scroll offset of the source left edge in pixels.
open Unit	`setScrollY(scrollY: Int)` Sets the scroll offset of the source top edge in pixels.
open Unit	`setScrollable(scrollable: Boolean)` Sets if the source is scrollable.
open Unit	`setSource(source: View?)` Sets the event source.
open Unit	`setSource(root: View?, virtualDescendantId: Int)` Sets the source to be a virtual descendant of the given `root`.
open Unit	`setToIndex(toIndex: Int)` Sets the index of text selection end or the index of the last visible item when scrolling.
open String	`toString()`

Public constructors