# AccessibilityDelegateCompat # AccessibilityDelegateCompat Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/AccessibilityDelegateCompat.java+class:androidx.core.view.AccessibilityDelegateCompat) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0) *** ** * ** *** Kotlin \|[Java](https://developer.android.com/reference/androidx/core/view/AccessibilityDelegateCompat "View this page in Java") ``` class AccessibilityDelegateCompat ```
Known direct subclasses [ExploreByTouchHelper](https://developer.android.com/reference/kotlin/androidx/customview/widget/ExploreByTouchHelper), [RecyclerViewAccessibilityDelegate.ItemDelegate](https://developer.android.com/reference/kotlin/androidx/recyclerview/widget/RecyclerViewAccessibilityDelegate.ItemDelegate), [RecyclerViewAccessibilityDelegate](https://developer.android.com/reference/kotlin/androidx/recyclerview/widget/RecyclerViewAccessibilityDelegate) |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [ExploreByTouchHelper](https://developer.android.com/reference/kotlin/androidx/customview/widget/ExploreByTouchHelper) | ExploreByTouchHelper is a utility class for implementing accessibility support in custom [View](https://developer.android.com/reference/android/view/View.html)s that represent a collection of View-like logical items. | | [RecyclerViewAccessibilityDelegate.ItemDelegate](https://developer.android.com/reference/kotlin/androidx/recyclerview/widget/RecyclerViewAccessibilityDelegate.ItemDelegate) | The default implementation of accessibility delegate for the individual items of the RecyclerView. | | [RecyclerViewAccessibilityDelegate](https://developer.android.com/reference/kotlin/androidx/recyclerview/widget/RecyclerViewAccessibilityDelegate) | The AccessibilityDelegate used by RecyclerView. | *** ** * ** *** Helper for accessing [AccessibilityDelegate](https://developer.android.com/reference/android/view/View.AccessibilityDelegate.html). **Note:** On platform versions prior to [API 23](https://developer.android.com/reference/android/os/Build.VERSION_CODES.html#M()), delegate methods on views in the `android.widget.*` package are called *before* host methods. This prevents certain properties such as class name from being modified by overriding [onInitializeAccessibilityNodeInfo](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#onInitializeAccessibilityNodeInfo(android.view.View,androidx.core.view.accessibility.AccessibilityNodeInfoCompat)), as any changes will be overwritten by the host class. Starting in [API 23](https://developer.android.com/reference/android/os/Build.VERSION_CODES.html#M()), delegate methods are called *after* host methods, which all properties to be modified without being overwritten by the host class. ## Summary | ### Public constructors | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [AccessibilityDelegateCompat](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#AccessibilityDelegateCompat())`()` Creates a new instance. | | ### Public functions | |-------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [dispatchPopulateAccessibilityEvent](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#dispatchPopulateAccessibilityEvent(android.view.View,android.view.accessibility.AccessibilityEvent))`(host: `[View](https://developer.android.com/reference/android/view/View.html)`, event: `[AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html)`)` Dispatches an [AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) to the host [View](https://developer.android.com/reference/android/view/View.html) first and then to its children for adding their text content to the event. | | [AccessibilityNodeProviderCompat](https://developer.android.com/reference/kotlin/androidx/core/view/accessibility/AccessibilityNodeProviderCompat)`?` | [getAccessibilityNodeProvider](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#getAccessibilityNodeProvider(android.view.View))`(host: `[View](https://developer.android.com/reference/android/view/View.html)`)` Gets the provider for managing a virtual view hierarchy rooted at this View and reported to [AccessibilityService](https://developer.android.com/reference/android/accessibilityservice/AccessibilityService.html)s that explore the window content. | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [onInitializeAccessibilityEvent](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#onInitializeAccessibilityEvent(android.view.View,android.view.accessibility.AccessibilityEvent))`(host: `[View](https://developer.android.com/reference/android/view/View.html)`, event: `[AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html)`)` Initializes an [AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) with information about the the host View which is the event source. | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [onInitializeAccessibilityNodeInfo](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#onInitializeAccessibilityNodeInfo(android.view.View,androidx.core.view.accessibility.AccessibilityNodeInfoCompat))`(` ` host: `[View](https://developer.android.com/reference/android/view/View.html)`,` ` info: `[AccessibilityNodeInfoCompat](https://developer.android.com/reference/kotlin/androidx/core/view/accessibility/AccessibilityNodeInfoCompat) `)` Initializes an [AccessibilityNodeInfoCompat](https://developer.android.com/reference/kotlin/androidx/core/view/accessibility/AccessibilityNodeInfoCompat) with information about the host view. | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [onPopulateAccessibilityEvent](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#onPopulateAccessibilityEvent(android.view.View,android.view.accessibility.AccessibilityEvent))`(host: `[View](https://developer.android.com/reference/android/view/View.html)`, event: `[AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html)`)` Gives a chance to the host View to populate the accessibility event with its text content. | | [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [onRequestSendAccessibilityEvent](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#onRequestSendAccessibilityEvent(android.view.ViewGroup,android.view.View,android.view.accessibility.AccessibilityEvent))`(` ` host: `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)`,` ` child: `[View](https://developer.android.com/reference/android/view/View.html)`,` ` event: `[AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) `)` Called when a child of the host View has requested sending an [AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) and gives an opportunity to the parent (the host) to augment the event. | | [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [performAccessibilityAction](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#performAccessibilityAction(android.view.View,int,android.os.Bundle))`(host: `[View](https://developer.android.com/reference/android/view/View.html)`, action: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`, args: `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)`?)` Performs the specified accessibility action on the view. | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [sendAccessibilityEvent](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#sendAccessibilityEvent(android.view.View,int))`(host: `[View](https://developer.android.com/reference/android/view/View.html)`, eventType: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`)` Sends an accessibility event of the given type. | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [sendAccessibilityEventUnchecked](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#sendAccessibilityEventUnchecked(android.view.View,android.view.accessibility.AccessibilityEvent))`(host: `[View](https://developer.android.com/reference/android/view/View.html)`, event: `[AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html)`)` Sends an accessibility event. | ## Public constructors ### AccessibilityDelegateCompat Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0) ``` AccessibilityDelegateCompat() ``` Creates a new instance. ## Public functions ### dispatchPopulateAccessibilityEvent Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0) ``` fun dispatchPopulateAccessibilityEvent(host: View, event: AccessibilityEvent): Boolean ``` Dispatches an [AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) to the host [View](https://developer.android.com/reference/android/view/View.html) first and then to its children for adding their text content to the event. The default implementation behaves as [View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)](https://developer.android.com/reference/android/view/View.html#dispatchPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent)) for the case of no accessibility delegate been set. | Parameters | |---------------------------------------------------------------------------------------------------------------------------|--------------------------------| | `host: `[View](https://developer.android.com/reference/android/view/View.html) | The View hosting the delegate. | | `event: `[AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) | The event. | | Returns | |-------------------------------------------------------------------------------------|---------------------------------------------| | [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True if the event population was completed. | | See also | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------| | [dispatchPopulateAccessibilityEvent](https://developer.android.com/reference/android/view/View.html#dispatchPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent)) | View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) | ### getAccessibilityNodeProvider Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0) ``` fun getAccessibilityNodeProvider(host: View): AccessibilityNodeProviderCompat? ``` Gets the provider for managing a virtual view hierarchy rooted at this View and reported to [AccessibilityService](https://developer.android.com/reference/android/accessibilityservice/AccessibilityService.html)s that explore the window content. The default implementation behaves as [ViewCompat#getAccessibilityNodeProvider(View)](https://developer.android.com/reference/kotlin/androidx/core/view/ViewCompat#getAccessibilityNodeProvider(android.view.View)) for the case of no accessibility delegate been set. | Returns | |-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| | [AccessibilityNodeProviderCompat](https://developer.android.com/reference/kotlin/androidx/core/view/accessibility/AccessibilityNodeProviderCompat)`?` | The provider. | | See also | |----------------------------------------------------------------------------------------------------------------------------------------------------|---| | [AccessibilityNodeProviderCompat](https://developer.android.com/reference/kotlin/androidx/core/view/accessibility/AccessibilityNodeProviderCompat) | | ### onInitializeAccessibilityEvent Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0) ``` fun onInitializeAccessibilityEvent(host: View, event: AccessibilityEvent): Unit ``` Initializes an [AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) with information about the the host View which is the event source. The default implementation behaves as [ViewCompat#onInitalizeAccessibilityEvent(View v, AccessibilityEvent event)](https://developer.android.com/reference/kotlin/androidx/core/view/ViewCompat#onInitializeAccessibilityEvent(android.view.View,android.view.accessibility.AccessibilityEvent)) for the case of no accessibility delegate been set. | Parameters | |---------------------------------------------------------------------------------------------------------------------------|--------------------------------| | `host: `[View](https://developer.android.com/reference/android/view/View.html) | The View hosting the delegate. | | `event: `[AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) | The event to initialize. | | See also | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| | [onInitializeAccessibilityEvent](https://developer.android.com/reference/kotlin/androidx/core/view/ViewCompat#onInitializeAccessibilityEvent(android.view.View,android.view.accessibility.AccessibilityEvent)) | ViewCompat#onInitializeAccessibilityEvent(View, AccessibilityEvent) | ### onInitializeAccessibilityNodeInfo Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0) ``` fun onInitializeAccessibilityNodeInfo(     host: View,     info: AccessibilityNodeInfoCompat ): Unit ``` Initializes an [AccessibilityNodeInfoCompat](https://developer.android.com/reference/kotlin/androidx/core/view/accessibility/AccessibilityNodeInfoCompat) with information about the host view. The default implementation behaves as [ViewCompat#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfoCompat)](https://developer.android.com/reference/kotlin/androidx/core/view/ViewCompat#onInitializeAccessibilityNodeInfo(android.view.View,androidx.core.view.accessibility.AccessibilityNodeInfoCompat)) for the case of no accessibility delegate been set. | Parameters | |----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| | `host: `[View](https://developer.android.com/reference/android/view/View.html) | The View hosting the delegate. | | `info: `[AccessibilityNodeInfoCompat](https://developer.android.com/reference/kotlin/androidx/core/view/accessibility/AccessibilityNodeInfoCompat) | The instance to initialize. | | See also | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| | [onInitializeAccessibilityNodeInfo](https://developer.android.com/reference/kotlin/androidx/core/view/ViewCompat#onInitializeAccessibilityNodeInfo(android.view.View,androidx.core.view.accessibility.AccessibilityNodeInfoCompat)) | ViewCompat#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfoCompat) | ### onPopulateAccessibilityEvent Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0) ``` fun onPopulateAccessibilityEvent(host: View, event: AccessibilityEvent): Unit ``` Gives a chance to the host View to populate the accessibility event with its text content. The default implementation behaves as [ViewCompat#onPopulateAccessibilityEvent(AccessibilityEvent)](https://developer.android.com/reference/kotlin/androidx/core/view/ViewCompat#onPopulateAccessibilityEvent(android.view.View,android.view.accessibility.AccessibilityEvent)) for the case of no accessibility delegate been set. | Parameters | |---------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| | `host: `[View](https://developer.android.com/reference/android/view/View.html) | The View hosting the delegate. | | `event: `[AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) | The accessibility event which to populate. | | See also | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| | [onPopulateAccessibilityEvent](https://developer.android.com/reference/kotlin/androidx/core/view/ViewCompat#onPopulateAccessibilityEvent(android.view.View,android.view.accessibility.AccessibilityEvent)) | ViewCompat#onPopulateAccessibilityEvent(View, AccessibilityEvent) | ### onRequestSendAccessibilityEvent Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0) ``` fun onRequestSendAccessibilityEvent(     host: ViewGroup,     child: View,     event: AccessibilityEvent ): Boolean ``` Called when a child of the host View has requested sending an [AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) and gives an opportunity to the parent (the host) to augment the event. The default implementation behaves as [ViewGroupCompat#onRequestSendAccessibilityEvent(ViewGroup, View, AccessibilityEvent)](https://developer.android.com/reference/kotlin/androidx/core/view/ViewGroupCompat#onRequestSendAccessibilityEvent(android.view.ViewGroup,android.view.View,android.view.accessibility.AccessibilityEvent)) for the case of no accessibility delegate been set. | Parameters | |---------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| | `host: `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html) | The View hosting the delegate. | | `child: `[View](https://developer.android.com/reference/android/view/View.html) | The child which requests sending the event. | | `event: `[AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) | The event to be sent. | | Returns | |-------------------------------------------------------------------------------------|----------------------------------| | [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True if the event should be sent | | See also | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| | [onRequestSendAccessibilityEvent](https://developer.android.com/reference/kotlin/androidx/core/view/ViewGroupCompat#onRequestSendAccessibilityEvent(android.view.ViewGroup,android.view.View,android.view.accessibility.AccessibilityEvent)) | ViewGroupCompat#onRequestSendAccessibilityEvent(ViewGroup, View, AccessibilityEvent) | ### performAccessibilityAction Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0) ``` fun performAccessibilityAction(host: View, action: Int, args: Bundle?): Boolean ``` Performs the specified accessibility action on the view. For possible accessibility actions look at [AccessibilityNodeInfoCompat](https://developer.android.com/reference/kotlin/androidx/core/view/accessibility/AccessibilityNodeInfoCompat). The default implementation behaves as [View#performAccessibilityAction(int, Bundle)](https://developer.android.com/reference/android/view/View.html#performAccessibilityAction(int, android.os.Bundle)) for the case of no accessibility delegate been set. | Parameters | |---------------------------------------------------------------------------------------|--------------------------------------| | `host: `[View](https://developer.android.com/reference/android/view/View.html) | View on which to perform the action. | | `action: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | The action to perform. | | `args: `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)`?` | Optional action arguments. | | Returns | |-------------------------------------------------------------------------------------|-----------------------------------| | [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | Whether the action was performed. | | See also | |-------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| | [performAccessibilityAction](https://developer.android.com/reference/android/view/View.html#performAccessibilityAction(int, android.os.Bundle)) | View#performAccessibilityAction(int, Bundle) | ### sendAccessibilityEvent Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0) ``` fun sendAccessibilityEvent(host: View, eventType: Int): Unit ``` Sends an accessibility event of the given type. If accessibility is not enabled this method has no effect. The default implementation behaves as [View#sendAccessibilityEvent(int)](https://developer.android.com/reference/android/view/View.html#sendAccessibilityEvent(int)) for the case of no accessibility delegate been set. | Parameters | |------------------------------------------------------------------------------------------|--------------------------------| | `host: `[View](https://developer.android.com/reference/android/view/View.html) | The View hosting the delegate. | | `eventType: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | The type of the event to send. | | See also | |----------------------------------------------------------------------------------------------------------------------|----------------------------------| | [sendAccessibilityEvent](https://developer.android.com/reference/android/view/View.html#sendAccessibilityEvent(int)) | View#sendAccessibilityEvent(int) | ### sendAccessibilityEventUnchecked Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0) ``` fun sendAccessibilityEventUnchecked(host: View, event: AccessibilityEvent): Unit ``` Sends an accessibility event. This method behaves exactly as [sendAccessibilityEvent](https://developer.android.com/reference/kotlin/androidx/core/view/AccessibilityDelegateCompat#sendAccessibilityEvent(android.view.View,int)) but takes as an argument an empty [AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) and does not perform a check whether accessibility is enabled. The default implementation behaves as [View#sendAccessibilityEventUnchecked(AccessibilityEvent)](https://developer.android.com/reference/android/view/View.html#sendAccessibilityEventUnchecked(android.view.accessibility.AccessibilityEvent)) for the case of no accessibility delegate been set. | Parameters | |---------------------------------------------------------------------------------------------------------------------------|--------------------------------| | `host: `[View](https://developer.android.com/reference/android/view/View.html) | The View hosting the delegate. | | `event: `[AccessibilityEvent](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) | The event to send. | | See also | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| | [sendAccessibilityEventUnchecked](https://developer.android.com/reference/android/view/View.html#sendAccessibilityEventUnchecked(android.view.accessibility.AccessibilityEvent)) | View#sendAccessibilityEventUnchecked(AccessibilityEvent) |