to top
Android APIs
public class

AccessibilityDelegateCompat

extends Object
java.lang.Object
   ↳ android.support.v4.view.AccessibilityDelegateCompat

Class Overview

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

Summary

Public Constructors
AccessibilityDelegateCompat()
Creates a new instance.
Public Methods
boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event)
Dispatches an AccessibilityEvent to the host View first and then to its children for adding their text content to the event.
AccessibilityNodeProviderCompat getAccessibilityNodeProvider(View host)
Gets the provider for managing a virtual view hierarchy rooted at this View and reported to AccessibilityServices that explore the window content.
void onInitializeAccessibilityEvent(View host, AccessibilityEvent event)
Initializes an AccessibilityEvent with information about the the host View which is the event source.
void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfoCompat info)
Initializes an AccessibilityNodeInfoCompat with information about the host view.
void onPopulateAccessibilityEvent(View host, AccessibilityEvent event)
Gives a chance to the host View to populate the accessibility event with its text content.
boolean onRequestSendAccessibilityEvent(ViewGroup host, View child, AccessibilityEvent event)
Called when a child of the host View has requested sending an AccessibilityEvent and gives an opportunity to the parent (the host) to augment the event.
boolean performAccessibilityAction(View host, int action, Bundle args)
Performs the specified accessibility action on the view.
void sendAccessibilityEvent(View host, int eventType)
Sends an accessibility event of the given type.
void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event)
Sends an accessibility event.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public AccessibilityDelegateCompat ()

Creates a new instance.

Public Methods

public boolean dispatchPopulateAccessibilityEvent (View host, AccessibilityEvent event)

Dispatches an AccessibilityEvent to the host View first and then to its children for adding their text content to the event.

The default implementation behaves as View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) for the case of no accessibility delegate been set.

Parameters
host The View hosting the delegate.
event The event.
Returns
  • True if the event population was completed.
See Also

public AccessibilityNodeProviderCompat getAccessibilityNodeProvider (View host)

Gets the provider for managing a virtual view hierarchy rooted at this View and reported to AccessibilityServices that explore the window content.

The default implementation behaves as ViewCompat#getAccessibilityNodeProvider(View) for the case of no accessibility delegate been set.

Returns
  • The provider.
See Also

public void onInitializeAccessibilityEvent (View host, AccessibilityEvent event)

Initializes an AccessibilityEvent with information about the the host View which is the event source.

The default implementation behaves as ViewCompat#onInitalizeAccessibilityEvent(View v, AccessibilityEvent event) for the case of no accessibility delegate been set.

Parameters
host The View hosting the delegate.
event The event to initialize.
See Also

public void onInitializeAccessibilityNodeInfo (View host, AccessibilityNodeInfoCompat info)

Initializes an AccessibilityNodeInfoCompat with information about the host view.

The default implementation behaves as ViewCompat#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfoCompat) for the case of no accessibility delegate been set.

Parameters
host The View hosting the delegate.
info The instance to initialize.
See Also

public void onPopulateAccessibilityEvent (View host, AccessibilityEvent event)

Gives a chance to the host View to populate the accessibility event with its text content.

The default implementation behaves as ViewCompat#onPopulateAccessibilityEvent(AccessibilityEvent) for the case of no accessibility delegate been set.

Parameters
host The View hosting the delegate.
event The accessibility event which to populate.
See Also

public boolean onRequestSendAccessibilityEvent (ViewGroup host, View child, AccessibilityEvent event)

Called when a child of the host View has requested sending an AccessibilityEvent and gives an opportunity to the parent (the host) to augment the event.

The default implementation behaves as ViewGroupCompat#onRequestSendAccessibilityEvent(ViewGroup, View, AccessibilityEvent) for the case of no accessibility delegate been set.

Parameters
host The View hosting the delegate.
child The child which requests sending the event.
event The event to be sent.
Returns
  • True if the event should be sent
See Also

public boolean performAccessibilityAction (View host, int action, Bundle args)

Performs the specified accessibility action on the view. For possible accessibility actions look at AccessibilityNodeInfoCompat.

The default implementation behaves as View#performAccessibilityAction(int, Bundle) for the case of no accessibility delegate been set.

Parameters
action The action to perform.
Returns
  • Whether the action was performed.
See Also

public void sendAccessibilityEvent (View host, int eventType)

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) for the case of no accessibility delegate been set.

Parameters
host The View hosting the delegate.
eventType The type of the event to send.
See Also

public void sendAccessibilityEventUnchecked (View host, AccessibilityEvent event)

Sends an accessibility event. This method behaves exactly as sendAccessibilityEvent(View, int) but takes as an argument an empty AccessibilityEvent and does not perform a check whether accessibility is enabled.

The default implementation behaves as View#sendAccessibilityEventUnchecked(AccessibilityEvent) for the case of no accessibility delegate been set.

Parameters
host The View hosting the delegate.
event The event to send.
See Also