java.lang.Object | |
↳ | android.support.v4.accessibilityservice.AccessibilityServiceInfoCompat |
Helper for accessing features in AccessibilityService
introduced after API level 4 in a backwards compatible fashion.
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 | DEFAULT | If an AccessibilityService is the default for a given type. |
|||||||||
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 AccessibilityService contain the id of the source view. |
|||||||||
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the string representation of a capability.
| |||||||||||
Returns the string representation of a feedback type.
| |||||||||||
Returns the string representation of a flag.
| |||||||||||
Whether this service can retrieve the current window's content.
| |||||||||||
Returns the bit mask of capabilities this accessibility service has such as
being able to retrieve the active window content, etc.
| |||||||||||
Description of the accessibility service.
| |||||||||||
The accessibility service id.
| |||||||||||
The service
ResolveInfo . | |||||||||||
The settings activity name.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Capability: This accessibility service can filter the key event stream.
Capability: This accessibility service can request enhanced web accessibility enhancements. For example, installing scripts to make app content more accessible.
Capability: This accessibility service can request touch exploration mode in which touched items are spoken aloud and the UI can be explored via gestures.
Capability: This accessibility service can retrieve the active window content.
If an 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.
Mask for all feedback types.
Denotes braille feedback.
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.
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.
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
.
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
.
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.
Returns the string representation of a capability. For example,
CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT
is represented
by the string CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT.
capability | The capability. |
---|
Returns the string representation of a feedback type. For example,
FEEDBACK_SPOKEN
is represented by the
string FEEDBACK_SPOKEN.
feedbackType | The feedback type. |
---|
Returns the string representation of a flag. For example,
DEFAULT
is represented by the
string DEFAULT.
flag | The flag. |
---|
Whether this service can retrieve the current window's content.
Statically set from meta-data
.
Returns the bit mask of capabilities this accessibility service has such as being able to retrieve the active window content, etc.
info | The service info whose capabilities to get. |
---|
Description of the accessibility service.
Statically set from meta-data
.
The accessibility service id.
Generated by the system.
The service ResolveInfo
.
Generated by the system.
The settings activity name.
Statically set from meta-data
.