AccessibilityNodeProvider

Class Overview

This class is the contract a client should implement to enable support of a virtual view hierarchy rooted at a given view for accessibility purposes. A virtual view hierarchy is a tree of imaginary Views that is reported as a part of the view hierarchy when an AccessibilityService explores the window content. Since the virtual View tree does not exist this class is responsible for managing the AccessibilityNodeInfo s describing that tree to accessibility services.

The main use case of these APIs is to enable a custom view that draws complex content, for example a monthly calendar grid, to be presented as a tree of logical nodes, for example month days each containing events, thus conveying its logical structure.

A typical use case is to override getAccessibilityNodeProvider() of the View that is a root of a virtual View hierarchy to return an instance of this class. In such a case this instance is responsible for managing AccessibilityNodeInfo s describing the virtual sub-tree rooted at the View including the one representing the View itself. Similarly the returned instance is responsible for performing accessibility actions on any virtual view or the root view itself. For example:

       getAccessibilityNodeProvider(
         if (mAccessibilityNodeProvider == null) {
             mAccessibilityNodeProvider = new AccessibilityNodeProvider() {
                 public boolean performAction(int action, int virtualDescendantId) {
                     // Implementation.
                     return false;
                 }

                 public List
       
        findAccessibilityNodeInfosByText(String text,
                         int virtualDescendantId) {
                     // Implementation.
                     return null;
                 }

                 public AccessibilityNodeInfo createAccessibilityNodeInfo(int virtualDescendantId) {
                     // Implementation.
                     return null;
                 }
             });
     return mAccessibilityNodeProvider;
       
      

Summary

[Expand] Inherited Methods

From class java.lang.Object Object clone () Creates and returns a copy of this Object . boolean equals ( Object o) Compares this instance with the specified object and indicates if they are equal. void finalize () Invoked when the garbage collector has detected that this instance is no longer reachable. final Class <?> getClass () Returns the unique instance of Class that represents this object's class. int hashCode () Returns an integer hash code for this object. final void notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. final void notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. String toString () Returns a string containing a concise, human-readable description of this object. final void wait () Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object. final void wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires. final void wait (long millis) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.