belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1
AccessibilityServiceInfoCompat
public
final
class
AccessibilityServiceInfoCompat
extends Object
java.lang.Object | |
↳ | android.support.v4.accessibilityservice.AccessibilityServiceInfoCompat |
Helper for accessing features in AccessibilityServiceInfo
.
Summary
Constants | |
---|---|
int |
CAPABILITY_CAN_FILTER_KEY_EVENTS
Capability: This accessibility service can filter the key event stream. |
int |
CAPABILITY_CAN_REQUEST_ENHANCED_WEB_ACCESSIBILITY
Capability: This accessibility service can request enhanced web accessibility enhancements. |
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. |
int |
CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT
Capability: This accessibility service can retrieve the active window content. |
int |
FEEDBACK_ALL_MASK
Mask for all feedback types. |
int |
FEEDBACK_BRAILLE
Denotes braille feedback. |
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. |
int |
FLAG_REPORT_VIEW_IDS
This flag requests that the AccessibilityNodeInfos obtained
by an |
int |
FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY
This flag requests from the system to enable web accessibility enhancing extensions. |
int |
FLAG_REQUEST_FILTER_KEY_EVENTS
This flag requests from the system to filter key events. |
int |
FLAG_REQUEST_TOUCH_EXPLORATION_MODE
This flag requests that the system gets into touch exploration mode. |
Public methods | |
---|---|
static
String
|
capabilityToString(int capability)
Returns the string representation of a capability. |
static
String
|
feedbackTypeToString(int feedbackType)
Returns the string representation of a feedback type. |
static
String
|
flagToString(int flag)
Returns the string representation of a flag. |
static
int
|
getCapabilities(AccessibilityServiceInfo info)
Returns the bit mask of capabilities this accessibility service has such as being able to retrieve the active window content, etc. |
static
String
|
loadDescription(AccessibilityServiceInfo info, PackageManager packageManager)
The localized description of the accessibility service. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
Constants
CAPABILITY_CAN_FILTER_KEY_EVENTS
int CAPABILITY_CAN_FILTER_KEY_EVENTS
Capability: This accessibility service can filter the key event stream.
Constant Value: 8 (0x00000008)
CAPABILITY_CAN_REQUEST_ENHANCED_WEB_ACCESSIBILITY
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.
Constant Value: 4 (0x00000004)
CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION
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.
Constant Value: 2 (0x00000002)
CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT
int CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT
Capability: This accessibility service can retrieve the active window content.
Constant Value: 1 (0x00000001)
FEEDBACK_ALL_MASK
int FEEDBACK_ALL_MASK
Mask for all feedback types.
See also:
Constant Value: -1 (0xffffffff)
FEEDBACK_BRAILLE
int FEEDBACK_BRAILLE
Denotes braille feedback.
Constant Value: 32 (0x00000020)
FLAG_INCLUDE_NOT_IMPORTANT_VIEWS
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
IMPORTANT_FOR_ACCESSIBILITY_NO
or
IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS
and views that are
marked as potentially important for accessibility via
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
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
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.
Constant Value: 2 (0x00000002)
FLAG_REPORT_VIEW_IDS
int FLAG_REPORT_VIEW_IDS
This flag requests that the AccessibilityNodeInfos obtained
by an 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.
Constant Value: 16 (0x00000010)
FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY
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 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 AccessibilityService.SERVICE_META_DATA
.
Constant Value: 8 (0x00000008)
FLAG_REQUEST_FILTER_KEY_EVENTS
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 AccessibilityService.SERVICE_META_DATA
.
Constant Value: 32 (0x00000020)
FLAG_REQUEST_TOUCH_EXPLORATION_MODE
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
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
AccessibilityService.SERVICE_META_DATA
.
Services targeting API version equal to or lower than
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.
Constant Value: 4 (0x00000004)
Public methods
capabilityToString
String capabilityToString (int capability)
Returns the string representation of a capability. For example,
CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT
is represented
by the string CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT.
Parameters | |
---|---|
capability |
int : The capability. |
Returns | |
---|---|
String |
The string representation. |
feedbackTypeToString
String feedbackTypeToString (int feedbackType)
Returns the string representation of a feedback type. For example,
FEEDBACK_SPOKEN
is represented by the
string FEEDBACK_SPOKEN.
Parameters | |
---|---|
feedbackType |
int : The feedback type. |
Returns | |
---|---|
String |
The string representation. |
flagToString
String flagToString (int flag)
Returns the string representation of a flag. For example,
DEFAULT
is represented by the
string DEFAULT.
Parameters | |
---|---|
flag |
int : The flag. |
Returns | |
---|---|
String |
The string representation. |
getCapabilities
int getCapabilities (AccessibilityServiceInfo info)
Returns the bit mask of capabilities this accessibility service has such as being able to retrieve the active window content, etc.
Parameters | |
---|---|
info |
AccessibilityServiceInfo : The service info whose capabilities to get. |
Returns | |
---|---|
int |
The capability bit mask. |
loadDescription
String loadDescription (AccessibilityServiceInfo info, PackageManager packageManager)
The localized description of the accessibility service.
Statically set from
meta-data
.
Parameters | |
---|---|
info |
AccessibilityServiceInfo : The service info of interest |
packageManager |
PackageManager : The current package manager |
Returns | |
---|---|
String |
The localized description. |
Classes