FileDocCategorySizeDatePackage
AccessibilityServiceInfoCompat.javaAPI DocAndroid 5.1 API17971Thu Mar 12 22:22:56 GMT 2015android.support.v4.accessibilityservice

AccessibilityServiceInfoCompat

public class AccessibilityServiceInfoCompat extends Object
Helper for accessing features in {@link android.accessibilityservice.AccessibilityService} introduced after API level 4 in a backwards compatible fashion.

(Omit source code)

Fields Summary
private static final AccessibilityServiceInfoVersionImpl
IMPL
public static final int
CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT
Capability: This accessibility service can retrieve the active window content.
public static final int
CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION
Capability: This accessibility service can request touch exploration mode in which touched items are spoken aloud and the UI can be explored via gestures.
public static final int
CAPABILITY_CAN_REQUEST_ENHANCED_WEB_ACCESSIBILITY
Capability: This accessibility service can request enhanced web accessibility enhancements. For example, installing scripts to make app content more accessible.
public static final int
CAPABILITY_CAN_FILTER_KEY_EVENTS
Capability: This accessibility service can filter the key event stream.
public static final int
FEEDBACK_BRAILLE
Denotes braille feedback.
public static final int
FEEDBACK_ALL_MASK
Mask for all feedback types.
public static final int
DEFAULT
If an {@link AccessibilityService} is the default for a given type. Default service is invoked only if no package specific one exists. In case of more than one package specific service only the earlier registered is notified.
public static final int
FLAG_INCLUDE_NOT_IMPORTANT_VIEWS
If this flag is set the system will regard views that are not important for accessibility in addition to the ones that are important for accessibility. That is, views that are marked as not important for accessibility via {@link View#IMPORTANT_FOR_ACCESSIBILITY_NO} or {@link View#IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS} and views that are marked as potentially important for accessibility via {@link View#IMPORTANT_FOR_ACCESSIBILITY_AUTO} for which the system has determined that are not important for accessibility, are both reported while querying the window content and also the accessibility service will receive accessibility events from them.

Note: For accessibility services targeting API version {@link Build.VERSION_CODES#JELLY_BEAN} or higher this flag has to be explicitly set for the system to regard views that are not important for accessibility. For accessibility services targeting API version lower than {@link Build.VERSION_CODES#JELLY_BEAN} this flag is ignored and all views are regarded for accessibility purposes.

Usually views not important for accessibility are layout managers that do not react to user actions, do not draw any content, and do not have any special semantics in the context of the screen content. For example, a three by three grid can be implemented as three horizontal linear layouts and one vertical, or three vertical linear layouts and one horizontal, or one grid layout, etc. In this context the actual layout mangers used to achieve the grid configuration are not important, rather it is important that there are nine evenly distributed elements.

public static final int
FLAG_REQUEST_TOUCH_EXPLORATION_MODE
This flag requests that the system gets into touch exploration mode. In this mode a single finger moving on the screen behaves as a mouse pointer hovering over the user interface. The system will also detect certain gestures performed on the touch screen and notify this service. The system will enable touch exploration mode if there is at least one accessibility service that has this flag set. Hence, clearing this flag does not guarantee that the device will not be in touch exploration mode since there may be another enabled service that requested it.

For accessibility services targeting API version higher than {@link Build.VERSION_CODES#JELLY_BEAN_MR1} that want to set this flag have to declare this capability in their meta-data by setting the attribute canRequestTouchExplorationMode to true, otherwise this flag will be ignored. For how to declare the meta-data of a service refer to {@value AccessibilityService#SERVICE_META_DATA}.

Services targeting API version equal to or lower than {@link Build.VERSION_CODES#JELLY_BEAN_MR1} will work normally, i.e. the first time they are run, if this flag is specified, a dialog is shown to the user to confirm enabling explore by touch.

public static final int
FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY
This flag requests from the system to enable web accessibility enhancing extensions. Such extensions aim to provide improved accessibility support for content presented in a {@link android.webkit.WebView}. An example of such an extension is injecting JavaScript from a secure source. The system will enable enhanced web accessibility if there is at least one accessibility service that has this flag set. Hence, clearing this flag does not guarantee that the device will not have enhanced web accessibility enabled since there may be another enabled service that requested it.

Services that want to set this flag have to declare this capability in their meta-data by setting the attribute canRequestEnhancedWebAccessibility to true, otherwise this flag will be ignored. For how to declare the meta-data of a service refer to {@value AccessibilityService#SERVICE_META_DATA}.

public static final int
FLAG_REPORT_VIEW_IDS
This flag requests that the AccessibilityNodeInfos obtained by an {@link AccessibilityService} contain the id of the source view. The source view id will be a fully qualified resource name of the form "package:id/name", for example "foo.bar:id/my_list", and it is useful for UI test automation. This flag is not set by default.
public static final int
FLAG_REQUEST_FILTER_KEY_EVENTS
This flag requests from the system to filter key events. If this flag is set the accessibility service will receive the key events before applications allowing it implement global shortcuts. Setting this flag does not guarantee that this service will filter key events since only one service can do so at any given time. This avoids user confusion due to behavior change in case different key filtering services are enabled. If there is already another key filtering service enabled, this one will not receive key events.

Services that want to set this flag have to declare this capability in their meta-data by setting the attribute canRequestFilterKeyEvents to true, otherwise this flag will be ignored. For how to declare the meta -data of a service refer to {@value AccessibilityService#SERVICE_META_DATA}.

Constructors Summary
private AccessibilityServiceInfoCompat()


    /*
     * Hide constructor
     */
Methods Summary
public static java.lang.StringcapabilityToString(int capability)
Returns the string representation of a capability. For example, {@link #CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT} is represented by the string CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT.

param
capability The capability.
return
The string representation.

        switch (capability) {
            case CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT:
                return "CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT";
            case CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION:
                return "CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION";
            case CAPABILITY_CAN_REQUEST_ENHANCED_WEB_ACCESSIBILITY:
                return "CAPABILITY_CAN_REQUEST_ENHANCED_WEB_ACCESSIBILITY";
            case CAPABILITY_CAN_FILTER_KEY_EVENTS:
                return "CAPABILITY_CAN_FILTER_KEY_EVENTS";
            default:
                return "UNKNOWN";
        }
public static java.lang.StringfeedbackTypeToString(int feedbackType)
Returns the string representation of a feedback type. For example, {@link AccessibilityServiceInfo#FEEDBACK_SPOKEN} is represented by the string FEEDBACK_SPOKEN.

param
feedbackType The feedback type.
return
The string representation.

        StringBuilder builder = new StringBuilder();
        builder.append("[");
        while (feedbackType > 0) {
            final int feedbackTypeFlag = 1 << Integer.numberOfTrailingZeros(feedbackType);
            feedbackType &= ~feedbackTypeFlag;
            if (builder.length() > 1) {
                builder.append(", ");
            }
            switch (feedbackTypeFlag) {
                case AccessibilityServiceInfo.FEEDBACK_AUDIBLE:
                    builder.append("FEEDBACK_AUDIBLE");
                    break;
                case AccessibilityServiceInfo.FEEDBACK_HAPTIC:
                    builder.append("FEEDBACK_HAPTIC");
                    break;
                case AccessibilityServiceInfo.FEEDBACK_GENERIC:
                    builder.append("FEEDBACK_GENERIC");
                    break;
                case AccessibilityServiceInfo.FEEDBACK_SPOKEN:
                    builder.append("FEEDBACK_SPOKEN");
                    break;
                case AccessibilityServiceInfo.FEEDBACK_VISUAL:
                    builder.append("FEEDBACK_VISUAL");
                    break;
            }
        }
        builder.append("]");
        return builder.toString();
public static java.lang.StringflagToString(int flag)
Returns the string representation of a flag. For example, {@link AccessibilityServiceInfo#DEFAULT} is represented by the string DEFAULT.

param
flag The flag.
return
The string representation.

        switch (flag) {
            case DEFAULT:
                return "DEFAULT";
            case FLAG_INCLUDE_NOT_IMPORTANT_VIEWS:
                return "FLAG_INCLUDE_NOT_IMPORTANT_VIEWS";
            case FLAG_REQUEST_TOUCH_EXPLORATION_MODE:
                return "FLAG_REQUEST_TOUCH_EXPLORATION_MODE";
            case FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY:
                return "FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY";
            case FLAG_REPORT_VIEW_IDS:
                return "FLAG_REPORT_VIEW_IDS";
            case FLAG_REQUEST_FILTER_KEY_EVENTS:
                return "FLAG_REQUEST_FILTER_KEY_EVENTS";
            default:
                return null;
        }
public static booleangetCanRetrieveWindowContent(android.accessibilityservice.AccessibilityServiceInfo info)
Whether this service can retrieve the current window's content.

Statically set from {@link AccessibilityService#SERVICE_META_DATA meta-data}.

return
True window content can be retrieved.

        return IMPL.getCanRetrieveWindowContent(info);
public static intgetCapabilities(android.accessibilityservice.AccessibilityServiceInfo info)
Returns the bit mask of capabilities this accessibility service has such as being able to retrieve the active window content, etc.

param
info The service info whose capabilities to get.
return
The capability bit mask.
see
#CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT
see
#CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION
see
#CAPABILITY_CAN_REQUEST_ENHANCED_WEB_ACCESSIBILITY
see
#CAPABILITY_CAN_FILTER_KEY_EVENTS

        return IMPL.getCapabilities(info);
public static java.lang.StringgetDescription(android.accessibilityservice.AccessibilityServiceInfo info)
Description of the accessibility service.

Statically set from {@link AccessibilityService#SERVICE_META_DATA meta-data}.

return
The description.

        return IMPL.getDescription(info);
public static java.lang.StringgetId(android.accessibilityservice.AccessibilityServiceInfo info)
The accessibility service id.

Generated by the system.

return
The id.

        return IMPL.getId(info);
public static android.content.pm.ResolveInfogetResolveInfo(android.accessibilityservice.AccessibilityServiceInfo info)
The service {@link ResolveInfo}.

Generated by the system.

return
The info.

        return IMPL.getResolveInfo(info);
public static java.lang.StringgetSettingsActivityName(android.accessibilityservice.AccessibilityServiceInfo info)
The settings activity name.

Statically set from {@link AccessibilityService#SERVICE_META_DATA meta-data}.

return
The settings activity name.

        return IMPL.getSettingsActivityName(info);