View.AccessibilityDelegate Class

Definition

[Android.Runtime.Register("android/view/View$AccessibilityDelegate", DoNotGenerateAcw=true)]
public class View.AccessibilityDelegate : Java.Lang.Object

[<Android.Runtime.Register("android/view/View$AccessibilityDelegate", DoNotGenerateAcw=true)>]
type View.AccessibilityDelegate = class
    inherit Object

Inheritance

Object

Object

View.AccessibilityDelegate

Attributes

RegisterAttribute

Remarks

This class represents a delegate that can be registered in a View to enhance accessibility support via composition rather via inheritance. It is specifically targeted to widget developers that extend basic View classes i.e. classes in package android.view, that would like their applications to be backwards compatible.

<div class="special reference"> <h3>Developer Guides</h3>

For more information about making applications accessible, read the Accessibility developer guide.

</div>

A scenario in which a developer would like to use an accessibility delegate is overriding a method introduced in a later API version than the minimal API version supported by the application. For example, the method View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) is not available in API version 4 when the accessibility APIs were first introduced. If a developer would like their application to run on API version 4 devices (assuming all other APIs used by the application are version 4 or lower) and take advantage of this method, instead of overriding the method which would break the application's backwards compatibility, they can override the corresponding method in this delegate and register the delegate in the target View if the API version of the system is high enough, i.e. the API version is the same as or higher than the API version that introduced View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo).

Here is an example implementation:

<pre><p> if (Build.VERSION.SDK_INT >= 14) { // If the API version is equal of higher than the version in // which onInitializeAccessibilityNodeInfo was introduced we // register a delegate with a customized implementation. View view = findViewById(R.id.view_id); view.setAccessibilityDelegate(new AccessibilityDelegate() { public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) { // Let the default implementation populate the info. super.onInitializeAccessibilityNodeInfo(host, info); // Set some other information. info.setEnabled(host.isEnabled()); } }); } </pre></p>

This delegate contains methods that correspond to the accessibility methods in View. If a delegate has been specified the implementation in View hands off handling to the corresponding method in this delegate. The default implementation the delegate methods behaves exactly as the corresponding method in View for the case of no accessibility delegate been set. Hence, to customize the behavior of a View method, clients can override only the corresponding delegate method without altering the behavior of the rest accessibility related methods of the host view.

<strong>Note:</strong> On platform versions prior to android.os.Build.VERSION_CODES#M API 23, 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 AccessibilityDelegate#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo), as any changes will be overwritten by the host class.

Starting in android.os.Build.VERSION_CODES#M API 23, delegate methods are called after host methods, which all properties to be modified without being overwritten by the host class. "note"> <b>Note:</b> Use a <c>androidx.core.view.AccessibilityDelegateCompat</c> wrapper instead of this class for backwards-compatibility. </aside>

Java documentation for android.view.View.AccessibilityDelegate.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.