Android AccessibilityEvent api文档

老是要穿墙去看着官方文档真是麻烦死了,存在这里吧。顺便说一句,这blog做得太烂了,垃圾功能太多,老出问题、慢得要命、烦得要死,真是受不了


https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent
 |Java

public final class AccessibilityEvent
extends AccessibilityRecord implements Parcelable

java.lang.Object
   ↳android.view.accessibility.AccessibilityRecord
   ↳android.view.accessibility.AccessibilityEvent


This class represents accessibility events that are sent by the system when something notable happens in the user interface. For example, when a Button is clicked, a View is focused, etc.

An accessibility event is fired by an individual view which populates the event with data for its state and requests from its parent to send the event to interested parties. The parent can optionally modify or even block the event based on its broader understanding of the user interface's context.

The main purpose of an accessibility event is to communicate changes in the UI to an AccessibilityService. The service may then inspect, if needed the user interface by examining the View hierarchy, as represented by a tree of AccessibilityNodeInfos (snapshot of a View state) which can be used for exploring the window content. Note that the privilege for accessing an event's source, thus the window content, has to be explicitly requested. For more details refer to AccessibilityService. If an accessibility service has not requested to retrieve the window content the event will not contain reference to its source. Also for events of type TYPE_NOTIFICATION_STATE_CHANGED the source is never available.

This class represents various semantically different accessibility event types. Each event type has an associated set of related properties. In other words, each event type is characterized via a subset of the properties exposed by this class. For each event type there is a corresponding constant defined in this class. Follows a specification of the event types and their associated properties:

Developer Guides

For more information about creating and processing AccessibilityEvents, read the Accessibility developer guide.

VIEW TYPES

View clicked - represents the event of clicking on a View like ButtonCompoundButton, etc.
Type:TYPE_VIEW_CLICKED
Properties:

View long clicked - represents the event of long clicking on a View like ButtonCompoundButton, etc
Type:TYPE_VIEW_LONG_CLICKED
Properties:

View selected - represents the event of selecting an item usually in the context of an AdapterView.
Type: TYPE_VIEW_SELECTED
Properties:

View focused - represents the event of focusing a View.
Type: TYPE_VIEW_FOCUSED
Properties:

View text changed - represents the event of changing the text of an EditText.
Type: TYPE_VIEW_TEXT_CHANGED
Properties:

View text selection changed - represents the event of changing the text selection of an EditText.
Type: TYPE_VIEW_TEXT_SELECTION_CHANGED
Properties:

View text traversed at movement granularity - represents the event of traversing the text of a view at a given granularity. For example, moving to the next word.
Type: TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY
Properties:

View scrolled - represents the event of scrolling a view.
Type: TYPE_VIEW_SCROLLED
Properties:

TRANSITION TYPES

Window state changed - represents the event of a change to a section of the user interface that is visually distinct. Should be sent from either the root view of a window or from a view that is marked as a pane View.setAccessibilityPaneTitle(CharSequence). Note that changes to true windows are represented by TYPE_WINDOWS_CHANGED.
Type: TYPE_WINDOW_STATE_CHANGED
Properties:

Window content changed - represents the event of change in the content of a window. This change can be adding/removing view, changing a view size, etc.

Type: TYPE_WINDOW_CONTENT_CHANGED
Properties:

Windows changed - represents a change in the windows shown on the screen such as a window appeared, a window disappeared, a window size changed, a window layer changed, etc. These events should only come from the system, which is responsible for managing windows. The list of windows is available from AccessibilityService.getWindows(). For regions of the user interface that are presented as windows but are controlled by an app's process, use TYPE_WINDOW_STATE_CHANGED.
Type: TYPE_WINDOWS_CHANGED
Properties:

Note: You can retrieve the AccessibilityWindowInfo for the window source of the event by looking through the list returned by AccessibilityService.getWindows() for the window whose ID matches AccessibilityRecord.getWindowId().

NOTIFICATION TYPES

Notification state changed - represents the event showing a transient piece of information to the user. This information may be a Notification or Toast.
Type: TYPE_NOTIFICATION_STATE_CHANGED
Properties:

EXPLORATION TYPES

View hover enter - represents the event of beginning to hover over a View. The hover may be generated via exploring the screen by touch or via a pointing device.
Type: TYPE_VIEW_HOVER_ENTER
Properties:

View hover exit - represents the event of stopping to hover over a View. The hover may be generated via exploring the screen by touch or via a pointing device.
Type: TYPE_VIEW_HOVER_EXIT
Properties:

Touch interaction start - represents the event of starting a touch interaction, which is the user starts touching the screen.
Type: TYPE_TOUCH_INTERACTION_START
Properties:

Note: This event is fired only by the system and is not passed to the view tree to be populated.

Touch interaction end - represents the event of ending a touch interaction, which is the user stops touching the screen.
Type: TYPE_TOUCH_INTERACTION_END
Properties:

Note: This event is fired only by the system and is not passed to the view tree to be populated.

Touch exploration gesture start - represents the event of starting a touch exploring gesture.
Type: TYPE_TOUCH_EXPLORATION_GESTURE_START
Properties:

Note: This event is fired only by the system and is not passed to the view tree to be populated.

Touch exploration gesture end - represents the event of ending a touch exploring gesture.
Type: TYPE_TOUCH_EXPLORATION_GESTURE_END
Properties:

Note: This event is fired only by the system and is not passed to the view tree to be populated.

Touch gesture detection start - represents the event of starting a user gesture detection.
Type: TYPE_GESTURE_DETECTION_START
Properties:

Note: This event is fired only by the system and is not passed to the view tree to be populated.

Touch gesture detection end - represents the event of ending a user gesture detection.
Type: TYPE_GESTURE_DETECTION_END
Properties:

Note: This event is fired only by the system and is not passed to the view tree to be populated.

MISCELLANEOUS TYPES

Announcement - represents the event of an application requesting a screen reader to make an announcement. Because the event carries no semantic meaning, this event is appropriate only in exceptional situations where additional screen reader output is needed but other types of accessibility services do not need to be aware of the change.
Type: TYPE_ANNOUNCEMENT
Properties:

See also:

Summary

Constants

intCONTENT_CHANGE_TYPE_CONTENT_DESCRIPTION

Change type for TYPE_WINDOW_CONTENT_CHANGED event: The node's content description changed.

intCONTENT_CHANGE_TYPE_DRAG_CANCELLED

Change type for TYPE_WINDOW_CONTENT_CHANGED event: A drag in with accessibility enabled has ended.

intCONTENT_CHANGE_TYPE_DRAG_DROPPED

Change type for TYPE_WINDOW_CONTENT_CHANGED event: A drag in with accessibility enabled has ended.

intCONTENT_CHANGE_TYPE_DRAG_STARTED

Change type for TYPE_WINDOW_CONTENT_CHANGED event: A drag has started while accessibility is enabled.

intCONTENT_CHANGE_TYPE_PANE_APPEARED

Change type for TYPE_WINDOW_STATE_CHANGED event: The node has a pane title, and either just appeared or just was assigned a title when it had none before.

intCONTENT_CHANGE_TYPE_PANE_DISAPPEARED

Change type for TYPE_WINDOW_STATE_CHANGED event: Can mean one of two slightly different things.

intCONTENT_CHANGE_TYPE_PANE_TITLE

Change type for TYPE_WINDOW_STATE_CHANGED event: The node's pane title changed.

intCONTENT_CHANGE_TYPE_STATE_DESCRIPTION

Change type for TYPE_WINDOW_CONTENT_CHANGED event: state description of the node as returned by AccessibilityNodeInfo#getStateDescription changed.

intCONTENT_CHANGE_TYPE_SUBTREE

Change type for TYPE_WINDOW_CONTENT_CHANGED event: One or more content changes occurred in the the subtree rooted at the source node, or the subtree's structure changed when a node was added or removed.

intCONTENT_CHANGE_TYPE_TEXT

Change type for TYPE_WINDOW_CONTENT_CHANGED event: The node's text changed.

intCONTENT_CHANGE_TYPE_UNDEFINED

Change type for TYPE_WINDOW_CONTENT_CHANGED event: The type of change is not defined.

intINVALID_POSITION

Invalid selection/focus position.

intMAX_TEXT_LENGTH

Maximum length of the text fields.

intSPEECH_STATE_LISTENING_END

Change type for TYPE_SPEECH_STATE_CHANGE event: another service is no longer listening to the microphone.

intSPEECH_STATE_LISTENING_START

Change type for TYPE_SPEECH_STATE_CHANGE event: another service is listening to the microphone.

intSPEECH_STATE_SPEAKING_END

Change type for TYPE_SPEECH_STATE_CHANGE event: another service is no longer speaking.

intSPEECH_STATE_SPEAKING_START

Change type for TYPE_SPEECH_STATE_CHANGE event: another service is speaking.

intTYPES_ALL_MASK

Mask for AccessibilityEvent all types.

intTYPE_ANNOUNCEMENT

Represents the event of an application making an announcement.

intTYPE_ASSIST_READING_CONTEXT

Represents the event of the assistant currently reading the users screen context.

intTYPE_GESTURE_DETECTION_END

Represents the event of ending gesture detection.

intTYPE_GESTURE_DETECTION_START

Represents the event of beginning gesture detection.

intTYPE_NOTIFICATION_STATE_CHANGED

Represents the event showing a Notification.

intTYPE_SPEECH_STATE_CHANGE

Represents a change in the speech state defined by the content-change types.

intTYPE_TOUCH_EXPLORATION_GESTURE_END

Represents the event of ending a touch exploration gesture.

intTYPE_TOUCH_EXPLORATION_GESTURE_START

Represents the event of starting a touch exploration gesture.

intTYPE_TOUCH_INTERACTION_END

Represents the event of the user ending to touch the screen.

intTYPE_TOUCH_INTERACTION_START

Represents the event of the user starting to touch the screen.

intTYPE_VIEW_ACCESSIBILITY_FOCUSED

Represents the event of gaining accessibility focus.

intTYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED

Represents the event of clearing accessibility focus.

intTYPE_VIEW_CLICKED

Represents the event of clicking on a View like ButtonCompoundButton, etc.

intTYPE_VIEW_CONTEXT_CLICKED

Represents the event of a context click on a View.

intTYPE_VIEW_FOCUSED

Represents the event of setting input focus of a View.

intTYPE_VIEW_HOVER_ENTER

Represents the event of a hover enter over a View.

intTYPE_VIEW_HOVER_EXIT

Represents the event of a hover exit over a View.

intTYPE_VIEW_LONG_CLICKED

Represents the event of long clicking on a View like ButtonCompoundButton, etc.

intTYPE_VIEW_SCROLLED

Represents the event of scrolling a view.

intTYPE_VIEW_SELECTED

Represents the event of selecting an item usually in the context of an AdapterView.

intTYPE_VIEW_TEXT_CHANGED

Represents the event of changing the text of an EditText.

intTYPE_VIEW_TEXT_SELECTION_CHANGED

Represents the event of changing the selection in an EditText.

intTYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY

Represents the event of traversing the text of a view at a given movement granularity.

intTYPE_WINDOWS_CHANGED

Represents the event change in the system windows shown on the screen.

intTYPE_WINDOW_CONTENT_CHANGED

Represents the event of changing the content of a window and more specifically the sub-tree rooted at the event's source.

intTYPE_WINDOW_STATE_CHANGED

Represents the event of a change to a visually distinct section of the user interface.

intWINDOWS_CHANGE_ACCESSIBILITY_FOCUSED

Change type for TYPE_WINDOWS_CHANGED event: The window's AccessibilityWindowInfo#isAccessibilityFocused() changed.

intWINDOWS_CHANGE_ACTIVE

Change type for TYPE_WINDOWS_CHANGED event: The window's AccessibilityWindowInfo#isActive() changed.

intWINDOWS_CHANGE_ADDED

Change type for TYPE_WINDOWS_CHANGED event: The window was added.

intWINDOWS_CHANGE_BOUNDS

Change type for TYPE_WINDOWS_CHANGED event: The window's bounds changed.

intWINDOWS_CHANGE_CHILDREN

Change type for TYPE_WINDOWS_CHANGED event: The window's children changed.

intWINDOWS_CHANGE_FOCUSED

Change type for TYPE_WINDOWS_CHANGED event: The window's AccessibilityWindowInfo#isFocused() changed.

intWINDOWS_CHANGE_LAYER

Change type for TYPE_WINDOWS_CHANGED event: The window's layer changed.

intWINDOWS_CHANGE_PARENT

Change type for TYPE_WINDOWS_CHANGED event: The window's parent changed.

intWINDOWS_CHANGE_PIP

Change type for TYPE_WINDOWS_CHANGED event: The window either entered or exited picture-in-picture mode.

intWINDOWS_CHANGE_REMOVED

Change type for TYPE_WINDOWS_CHANGED event: A window was removed.

intWINDOWS_CHANGE_TITLE

Change type for TYPE_WINDOWS_CHANGED event: The window's title changed.

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<AccessibilityEvent>CREATOR

Public constructors

AccessibilityEvent()

Creates a new AccessibilityEvent.

AccessibilityEvent(int eventType)

Creates a new AccessibilityEvent with the given eventType.

AccessibilityEvent(AccessibilityEvent event)

Copy constructor.

Public methods

voidappendRecord(AccessibilityRecord record)

Appends an AccessibilityRecord to the end of event records.

intdescribeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

static StringeventTypeToString(int eventType)

Returns the string representation of an event type.

intgetAction()

Gets the performed action that triggered this event.

intgetContentChangeTypes()

Gets the bit mask of change types signaled by a TYPE_WINDOW_CONTENT_CHANGED event or TYPE_WINDOW_STATE_CHANGED.

longgetEventTime()

Gets the time in which this event was sent.

intgetEventType()

Gets the event type.

intgetMovementGranularity()

Gets the movement granularity that was traversed.

CharSequencegetPackageName()

Gets the package name of the source.

AccessibilityRecordgetRecord(int index)

Gets the record at a given index.

intgetRecordCount()

Gets the number of records contained in the event.

intgetSpeechStateChangeTypes()

Gets the speech state signaled by a TYPE_SPEECH_STATE_CHANGE event

intgetWindowChanges()

Get the bit mask of change types signaled by a TYPE_WINDOWS_CHANGED event.

voidinitFromParcel(Parcel parcel)

Creates a new instance from a Parcel.

static AccessibilityEventobtain(AccessibilityEvent event)

This method was deprecated in API level Tiramisu. Object pooling has been discontinued. Create a new instance using the constructor AccessibilityEvent() instead.

static AccessibilityEventobtain()

This method was deprecated in API level Tiramisu. Object pooling has been discontinued. Create a new instance using the constructor AccessibilityEvent() instead.

static AccessibilityEventobtain(int eventType)

This method was deprecated in API level Tiramisu. Object pooling has been discontinued. Create a new instance using the constructor AccessibilityEvent() instead.

voidrecycle()

This method was deprecated in API level Tiramisu. Object pooling has been discontinued. Calling this function now will have no effect.

voidsetAction(int action)

Sets the performed action that triggered this event.

voidsetContentChangeTypes(int changeTypes)

Sets the bit mask of node tree changes signaled by an TYPE_WINDOW_CONTENT_CHANGED event.

voidsetEventTime(long eventTime)

Sets the time in which this event was sent.

voidsetEventType(int eventType)

Sets the event type.

voidsetMovementGranularity(int granularity)

Sets the movement granularity that was traversed.

voidsetPackageName(CharSequence packageName)

Sets the package name of the source.

voidsetSpeechStateChangeTypes(int state)

Sets the speech state type signaled by a TYPE_SPEECH_STATE_CHANGE event

StringtoString()

Returns a string representation of the object.

voidwriteToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class android.view.accessibility.AccessibilityRecord
From class java.lang.Object
From interface android.os.Parcelable

Constants

CONTENT_CHANGE_TYPE_CONTENT_DESCRIPTION

Added in API level 19

public static final int CONTENT_CHANGE_TYPE_CONTENT_DESCRIPTION

Change type for TYPE_WINDOW_CONTENT_CHANGED event: The node's content description changed.

Constant Value: 4 (0x00000004)

CONTENT_CHANGE_TYPE_DRAG_CANCELLED

Added in API level 32

public static final int CONTENT_CHANGE_TYPE_DRAG_CANCELLED

Change type for TYPE_WINDOW_CONTENT_CHANGED event: A drag in with accessibility enabled has ended. This means the content has been unsuccessfully dropped, the user has canceled the action via an AccessibilityAction, or no drop has been detected within a timeout and the drag was automatically cancelled. This is sent from the source that initiated the drag.

See also:

Constant Value: 512 (0x00000200)

CONTENT_CHANGE_TYPE_DRAG_DROPPED

Added in API level 32

public static final int CONTENT_CHANGE_TYPE_DRAG_DROPPED

Change type for TYPE_WINDOW_CONTENT_CHANGED event: A drag in with accessibility enabled has ended. This means the content has been successfully dropped. This is sent from the target that accepted the dragged content.

See also:

Constant Value: 256 (0x00000100)

CONTENT_CHANGE_TYPE_DRAG_STARTED

Added in API level 32

public static final int CONTENT_CHANGE_TYPE_DRAG_STARTED

Change type for TYPE_WINDOW_CONTENT_CHANGED event: A drag has started while accessibility is enabled. This is either via an AccessibilityAction, or via touch events. This is sent from the source that initiated the drag.

See also:

Constant Value: 128 (0x00000080)

CONTENT_CHANGE_TYPE_PANE_APPEARED

Added in API level 28

public static final int CONTENT_CHANGE_TYPE_PANE_APPEARED

Change type for TYPE_WINDOW_STATE_CHANGED event: The node has a pane title, and either just appeared or just was assigned a title when it had none before.

Constant Value: 16 (0x00000010)

CONTENT_CHANGE_TYPE_PANE_DISAPPEARED

Added in API level 28

public static final int CONTENT_CHANGE_TYPE_PANE_DISAPPEARED

Change type for TYPE_WINDOW_STATE_CHANGED event: Can mean one of two slightly different things. The primary meaning is that the node has a pane title, and was removed from the node hierarchy. It will also be sent if the pane title is set to null after it contained a title. No source will be returned if the node is no longer on the screen. To make the change more clear for the user, the first entry in AccessibilityRecord.getText() will return the value that would have been returned by getSource().getPaneTitle().

Constant Value: 32 (0x00000020)

CONTENT_CHANGE_TYPE_PANE_TITLE

Added in API level 28

public static final int CONTENT_CHANGE_TYPE_PANE_TITLE

Change type for TYPE_WINDOW_STATE_CHANGED event: The node's pane title changed.

Constant Value: 8 (0x00000008)

CONTENT_CHANGE_TYPE_STATE_DESCRIPTION

Added in API level 30

public static final int CONTENT_CHANGE_TYPE_STATE_DESCRIPTION

Change type for TYPE_WINDOW_CONTENT_CHANGED event: state description of the node as returned by AccessibilityNodeInfo#getStateDescription changed. If part of the state description changes, the changed part can be put into event text. For example, if state description changed from "on, wifi signal full" to "on, wifi three bars", "wifi three bars" can be put into the event text.

Constant Value: 64 (0x00000040)

CONTENT_CHANGE_TYPE_SUBTREE

Added in API level 19

public static final int CONTENT_CHANGE_TYPE_SUBTREE

Change type for TYPE_WINDOW_CONTENT_CHANGED event: One or more content changes occurred in the the subtree rooted at the source node, or the subtree's structure changed when a node was added or removed.

Constant Value: 1 (0x00000001)

CONTENT_CHANGE_TYPE_TEXT

Added in API level 19

public static final int CONTENT_CHANGE_TYPE_TEXT

Change type for TYPE_WINDOW_CONTENT_CHANGED event: The node's text changed.

Constant Value: 2 (0x00000002)

CONTENT_CHANGE_TYPE_UNDEFINED

Added in API level 19

public static final int CONTENT_CHANGE_TYPE_UNDEFINED

Change type for TYPE_WINDOW_CONTENT_CHANGED event: The type of change is not defined.

Constant Value: 0 (0x00000000)

INVALID_POSITION

Added in API level 4

public static final int INVALID_POSITION

Invalid selection/focus position.

See also:

Constant Value: -1 (0xffffffff)

MAX_TEXT_LENGTH

Added in API level 4
Deprecated in API level 15

public static final int MAX_TEXT_LENGTH

Maximum length of the text fields.

See also:

Constant Value: 500 (0x000001f4)

SPEECH_STATE_LISTENING_END

Added in Android Tiramisu

public static final int SPEECH_STATE_LISTENING_END

Change type for TYPE_SPEECH_STATE_CHANGE event: another service is no longer listening to the microphone.

Constant Value: 8 (0x00000008)

SPEECH_STATE_LISTENING_START

Added in Android Tiramisu

public static final int SPEECH_STATE_LISTENING_START

Change type for TYPE_SPEECH_STATE_CHANGE event: another service is listening to the microphone.

Constant Value: 4 (0x00000004)

SPEECH_STATE_SPEAKING_END

Added in Android Tiramisu

public static final int SPEECH_STATE_SPEAKING_END

Change type for TYPE_SPEECH_STATE_CHANGE event: another service is no longer speaking.

Constant Value: 2 (0x00000002)

SPEECH_STATE_SPEAKING_START

Added in Android Tiramisu

public static final int SPEECH_STATE_SPEAKING_START

Change type for TYPE_SPEECH_STATE_CHANGE event: another service is speaking.

Constant Value: 1 (0x00000001)

TYPES_ALL_MASK

Added in API level 4

public static final int TYPES_ALL_MASK

Mask for AccessibilityEvent all types.

See also:

Constant Value: -1 (0xffffffff)

TYPE_ANNOUNCEMENT

Added in API level 16

public static final int TYPE_ANNOUNCEMENT

Represents the event of an application making an announcement.

Constant Value: 16384 (0x00004000)

TYPE_ASSIST_READING_CONTEXT

Added in API level 23

public static final int TYPE_ASSIST_READING_CONTEXT

Represents the event of the assistant currently reading the users screen context.

Constant Value: 16777216 (0x01000000)

TYPE_GESTURE_DETECTION_END

Added in API level 17

public static final int TYPE_GESTURE_DETECTION_END

Represents the event of ending gesture detection.

Constant Value: 524288 (0x00080000)

TYPE_GESTURE_DETECTION_START

Added in API level 17

public static final int TYPE_GESTURE_DETECTION_START

Represents the event of beginning gesture detection.

Constant Value: 262144 (0x00040000)

TYPE_NOTIFICATION_STATE_CHANGED

Added in API level 4

public static final int TYPE_NOTIFICATION_STATE_CHANGED

Represents the event showing a Notification.

Constant Value: 64 (0x00000040)

TYPE_SPEECH_STATE_CHANGE

Added in Android Tiramisu

public static final int TYPE_SPEECH_STATE_CHANGE

Represents a change in the speech state defined by the content-change types. A change in the speech state occurs when another service is either speaking or listening for human speech. This event helps avoid conflicts where two services want to speak or one listens when another speaks.

See also:

Constant Value: 33554432 (0x02000000)

TYPE_TOUCH_EXPLORATION_GESTURE_END

Added in API level 14

public static final int TYPE_TOUCH_EXPLORATION_GESTURE_END

Represents the event of ending a touch exploration gesture.

Constant Value: 1024 (0x00000400)

TYPE_TOUCH_EXPLORATION_GESTURE_START

Added in API level 14

public static final int TYPE_TOUCH_EXPLORATION_GESTURE_START

Represents the event of starting a touch exploration gesture.

Constant Value: 512 (0x00000200)

TYPE_TOUCH_INTERACTION_END

Added in API level 17

public static final int TYPE_TOUCH_INTERACTION_END

Represents the event of the user ending to touch the screen.

Constant Value: 2097152 (0x00200000)

TYPE_TOUCH_INTERACTION_START

Added in API level 17

public static final int TYPE_TOUCH_INTERACTION_START

Represents the event of the user starting to touch the screen.

Constant Value: 1048576 (0x00100000)

TYPE_VIEW_ACCESSIBILITY_FOCUSED

Added in API level 16

public static final int TYPE_VIEW_ACCESSIBILITY_FOCUSED

Represents the event of gaining accessibility focus.

Constant Value: 32768 (0x00008000)

TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED

Added in API level 16

public static final int TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED

Represents the event of clearing accessibility focus.

Constant Value: 65536 (0x00010000)

TYPE_VIEW_CLICKED

Added in API level 4

public static final int TYPE_VIEW_CLICKED

Represents the event of clicking on a View like ButtonCompoundButton, etc.

Constant Value: 1 (0x00000001)

TYPE_VIEW_CONTEXT_CLICKED

Added in API level 23

public static final int TYPE_VIEW_CONTEXT_CLICKED

Represents the event of a context click on a View.

Constant Value: 8388608 (0x00800000)

TYPE_VIEW_FOCUSED

Added in API level 4

public static final int TYPE_VIEW_FOCUSED

Represents the event of setting input focus of a View.

Constant Value: 8 (0x00000008)

TYPE_VIEW_HOVER_ENTER

Added in API level 14

public static final int TYPE_VIEW_HOVER_ENTER

Represents the event of a hover enter over a View.

Constant Value: 128 (0x00000080)

TYPE_VIEW_HOVER_EXIT

Added in API level 14

public static final int TYPE_VIEW_HOVER_EXIT

Represents the event of a hover exit over a View.

Constant Value: 256 (0x00000100)

TYPE_VIEW_LONG_CLICKED

Added in API level 4

public static final int TYPE_VIEW_LONG_CLICKED

Represents the event of long clicking on a View like ButtonCompoundButton, etc.

Constant Value: 2 (0x00000002)

TYPE_VIEW_SCROLLED

Added in API level 14

public static final int TYPE_VIEW_SCROLLED

Represents the event of scrolling a view. This event type is generally not sent directly.

See also:

Constant Value: 4096 (0x00001000)

TYPE_VIEW_SELECTED

Added in API level 4

public static final int TYPE_VIEW_SELECTED

Represents the event of selecting an item usually in the context of an AdapterView.

Constant Value: 4 (0x00000004)

TYPE_VIEW_TEXT_CHANGED

Added in API level 4

public static final int TYPE_VIEW_TEXT_CHANGED

Represents the event of changing the text of an EditText.

Constant Value: 16 (0x00000010)

TYPE_VIEW_TEXT_SELECTION_CHANGED

Added in API level 14

public static final int TYPE_VIEW_TEXT_SELECTION_CHANGED

Represents the event of changing the selection in an EditText.

Constant Value: 8192 (0x00002000)

TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY

Added in API level 16

public static final int TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY

Represents the event of traversing the text of a view at a given movement granularity.

Constant Value: 131072 (0x00020000)

TYPE_WINDOWS_CHANGED

Added in API level 21

public static final int TYPE_WINDOWS_CHANGED

Represents the event change in the system windows shown on the screen. This event type should only be dispatched by the system.

Constant Value: 4194304 (0x00400000)

TYPE_WINDOW_CONTENT_CHANGED

Added in API level 14

public static final int TYPE_WINDOW_CONTENT_CHANGED

Represents the event of changing the content of a window and more specifically the sub-tree rooted at the event's source.

Constant Value: 2048 (0x00000800)

TYPE_WINDOW_STATE_CHANGED

Added in API level 4

public static final int TYPE_WINDOW_STATE_CHANGED

Represents the event of a change to a visually distinct section of the user interface. These events should only be dispatched from Views that have accessibility pane titles, and replaces TYPE_WINDOW_CONTENT_CHANGED for those sources. Details about the change are available from getContentChangeTypes().

Constant Value: 32 (0x00000020)

WINDOWS_CHANGE_ACCESSIBILITY_FOCUSED

Added in API level 28

public static final int WINDOWS_CHANGE_ACCESSIBILITY_FOCUSED

Change type for TYPE_WINDOWS_CHANGED event: The window's AccessibilityWindowInfo#isAccessibilityFocused() changed.

Constant Value: 128 (0x00000080)

WINDOWS_CHANGE_ACTIVE

Added in API level 28

public static final int WINDOWS_CHANGE_ACTIVE

Change type for TYPE_WINDOWS_CHANGED event: The window's AccessibilityWindowInfo#isActive() changed.

Constant Value: 32 (0x00000020)

WINDOWS_CHANGE_ADDED

Added in API level 28

public static final int WINDOWS_CHANGE_ADDED

Change type for TYPE_WINDOWS_CHANGED event: The window was added.

Constant Value: 1 (0x00000001)

WINDOWS_CHANGE_BOUNDS

Added in API level 28

public static final int WINDOWS_CHANGE_BOUNDS

Change type for TYPE_WINDOWS_CHANGED event: The window's bounds changed.

Starting in R, this event implies the window's region changed. It's also possible that region changed but bounds doesn't.

Constant Value: 8 (0x00000008)

WINDOWS_CHANGE_CHILDREN

Added in API level 28

public static final int WINDOWS_CHANGE_CHILDREN

Change type for TYPE_WINDOWS_CHANGED event: The window's children changed.

Constant Value: 512 (0x00000200)

WINDOWS_CHANGE_FOCUSED

Added in API level 28

public static final int WINDOWS_CHANGE_FOCUSED

Change type for TYPE_WINDOWS_CHANGED event: The window's AccessibilityWindowInfo#isFocused() changed.

Constant Value: 64 (0x00000040)

WINDOWS_CHANGE_LAYER

Added in API level 28

public static final int WINDOWS_CHANGE_LAYER

Change type for TYPE_WINDOWS_CHANGED event: The window's layer changed.

Constant Value: 16 (0x00000010)

WINDOWS_CHANGE_PARENT

Added in API level 28

public static final int WINDOWS_CHANGE_PARENT

Change type for TYPE_WINDOWS_CHANGED event: The window's parent changed.

Constant Value: 256 (0x00000100)

WINDOWS_CHANGE_PIP

Added in API level 28

public static final int WINDOWS_CHANGE_PIP

Change type for TYPE_WINDOWS_CHANGED event: The window either entered or exited picture-in-picture mode.

Constant Value: 1024 (0x00000400)

WINDOWS_CHANGE_REMOVED

Added in API level 28

public static final int WINDOWS_CHANGE_REMOVED

Change type for TYPE_WINDOWS_CHANGED event: A window was removed.

Constant Value: 2 (0x00000002)

WINDOWS_CHANGE_TITLE

Added in API level 28

public static final int WINDOWS_CHANGE_TITLE

Change type for TYPE_WINDOWS_CHANGED event: The window's title changed.

Constant Value: 4 (0x00000004)

Fields

CREATOR

Added in API level 4

public static final Creator<AccessibilityEvent> CREATOR

See also:

Public constructors

AccessibilityEvent

Added in API level 30

public AccessibilityEvent ()

Creates a new AccessibilityEvent.

AccessibilityEvent

Added in API level 30

public AccessibilityEvent (int eventType)

Creates a new AccessibilityEvent with the given eventType.

Parameters
eventTypeint: The event type.

AccessibilityEvent

Added in API level 30

public AccessibilityEvent (AccessibilityEvent event)

Copy constructor. Creates a new AccessibilityEvent, and this instance is initialized from the given event.

Parameters
eventAccessibilityEvent: The other event. This value cannot be null.

Public methods

appendRecord

Added in API level 14

public void appendRecord (AccessibilityRecord record)

Appends an AccessibilityRecord to the end of event records.

Parameters
recordAccessibilityRecord: The record to append.

Throws
IllegalStateExceptionIf called from an AccessibilityService.

describeContents

Added in API level 4

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
inta bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

eventTypeToString

Added in API level 14

public static String eventTypeToString (int eventType)

Returns the string representation of an event type. For example, TYPE_VIEW_CLICKED is represented by the string TYPE_VIEW_CLICKED.

Parameters
eventTypeint: The event type

Returns
StringThe string representation.

getAction

Added in API level 16

public int getAction ()

Gets the performed action that triggered this event.

Returns
intThe action.

getContentChangeTypes

Added in API level 19

public int getContentChangeTypes ()

Gets the bit mask of change types signaled by a TYPE_WINDOW_CONTENT_CHANGED event or TYPE_WINDOW_STATE_CHANGED. A single event may represent multiple change types.

Returns
intThe bit mask of change types. One or more of: Value is either 0 or a combination of CONTENT_CHANGE_TYPE_UNDEFINEDCONTENT_CHANGE_TYPE_SUBTREECONTENT_CHANGE_TYPE_TEXTCONTENT_CHANGE_TYPE_CONTENT_DESCRIPTIONCONTENT_CHANGE_TYPE_STATE_DESCRIPTIONCONTENT_CHANGE_TYPE_PANE_TITLECONTENT_CHANGE_TYPE_PANE_APPEAREDCONTENT_CHANGE_TYPE_PANE_DISAPPEAREDCONTENT_CHANGE_TYPE_DRAG_STARTEDCONTENT_CHANGE_TYPE_DRAG_DROPPED, and CONTENT_CHANGE_TYPE_DRAG_CANCELLED

getEventTime

Added in API level 4

public long getEventTime ()

Gets the time in which this event was sent.

Returns
longThe event time.

getEventType

Added in API level 4

public int getEventType ()

Gets the event type.

Returns
intThe event type. Value is either 0 or a combination of TYPE_VIEW_CLICKEDTYPE_VIEW_LONG_CLICKEDTYPE_VIEW_SELECTEDTYPE_VIEW_FOCUSEDTYPE_VIEW_TEXT_CHANGEDTYPE_WINDOW_STATE_CHANGEDTYPE_NOTIFICATION_STATE_CHANGEDTYPE_VIEW_HOVER_ENTERTYPE_VIEW_HOVER_EXITTYPE_TOUCH_EXPLORATION_GESTURE_STARTTYPE_TOUCH_EXPLORATION_GESTURE_ENDTYPE_WINDOW_CONTENT_CHANGEDTYPE_VIEW_SCROLLEDTYPE_VIEW_TEXT_SELECTION_CHANGEDTYPE_ANNOUNCEMENTTYPE_VIEW_ACCESSIBILITY_FOCUSEDTYPE_VIEW_ACCESSIBILITY_FOCUS_CLEAREDTYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITYTYPE_GESTURE_DETECTION_STARTTYPE_GESTURE_DETECTION_ENDTYPE_TOUCH_INTERACTION_STARTTYPE_TOUCH_INTERACTION_ENDTYPE_WINDOWS_CHANGEDTYPE_VIEW_CONTEXT_CLICKEDTYPE_ASSIST_READING_CONTEXT, and TYPE_SPEECH_STATE_CHANGE

getMovementGranularity

Added in API level 16

public int getMovementGranularity ()

Gets the movement granularity that was traversed.

Returns
intThe granularity.

getPackageName

Added in API level 4

public CharSequence getPackageName ()

Gets the package name of the source.

Returns
CharSequenceThe package name.

getRecord

Added in API level 14

public AccessibilityRecord getRecord (int index)

Gets the record at a given index.

Parameters
indexint: The index.

Returns
AccessibilityRecordThe record at the specified index.

getRecordCount

Added in API level 14

public int getRecordCount ()

Gets the number of records contained in the event.

Returns
intThe number of records.

getSpeechStateChangeTypes

Added in Android Tiramisu

public int getSpeechStateChangeTypes ()

Gets the speech state signaled by a TYPE_SPEECH_STATE_CHANGE event

Returns
int

See also:

getWindowChanges

Added in API level 28

public int getWindowChanges ()

Get the bit mask of change types signaled by a TYPE_WINDOWS_CHANGED event. A single event may represent multiple change types.

Returns
intThe bit mask of change types. Value is either 0 or a combination of WINDOWS_CHANGE_ADDEDWINDOWS_CHANGE_REMOVEDWINDOWS_CHANGE_TITLEWINDOWS_CHANGE_BOUNDSWINDOWS_CHANGE_LAYERWINDOWS_CHANGE_ACTIVEWINDOWS_CHANGE_FOCUSEDWINDOWS_CHANGE_ACCESSIBILITY_FOCUSEDWINDOWS_CHANGE_PARENTWINDOWS_CHANGE_CHILDREN, and WINDOWS_CHANGE_PIP

initFromParcel

Added in API level 4

public void initFromParcel (Parcel parcel)

Creates a new instance from a Parcel.

Parameters
parcelParcel: A parcel containing the state of a AccessibilityEvent.

obtain

Added in API level 14
Deprecated in API level Tiramisu

public static AccessibilityEvent obtain (AccessibilityEvent event)

This method was deprecated in API level Tiramisu.
Object pooling has been discontinued. Create a new instance using the constructor AccessibilityEvent() instead.

Instantiates a new AccessibilityEvent instance. The returned instance is initialized from the given event.

Parameters
eventAccessibilityEvent: The other event.

Returns
AccessibilityEventAn instance.

obtain

Added in API level 4
Deprecated in API level Tiramisu

public static AccessibilityEvent obtain ()

This method was deprecated in API level Tiramisu.
Object pooling has been discontinued. Create a new instance using the constructor AccessibilityEvent() instead.

Instantiates a new AccessibilityEvent instance.

Returns
AccessibilityEventAn instance.

obtain

Added in API level 4
Deprecated in API level Tiramisu

public static AccessibilityEvent obtain (int eventType)

This method was deprecated in API level Tiramisu.
Object pooling has been discontinued. Create a new instance using the constructor AccessibilityEvent() instead.

Instantiates a new AccessibilityEvent instance with its type property set.

Parameters
eventTypeint: The event type.

Returns
AccessibilityEventAn instance.

recycle

Added in API level 4
Deprecated in API level Tiramisu

public void recycle ()

This method was deprecated in API level Tiramisu.
Object pooling has been discontinued. Calling this function now will have no effect.

Previously would recycle an instance back to be reused.

setAction

Added in API level 16

public void setAction (int action)

Sets the performed action that triggered this event.

Valid actions are defined in AccessibilityNodeInfo:

Parameters
actionint: The action.

Throws
IllegalStateExceptionIf called from an AccessibilityService.

See also:

setContentChangeTypes

Added in API level 19

public void setContentChangeTypes (int changeTypes)

Sets the bit mask of node tree changes signaled by an TYPE_WINDOW_CONTENT_CHANGED event.

Parameters
changeTypesint: The bit mask of change types. Value is either 0 or a combination of CONTENT_CHANGE_TYPE_UNDEFINEDCONTENT_CHANGE_TYPE_SUBTREECONTENT_CHANGE_TYPE_TEXTCONTENT_CHANGE_TYPE_CONTENT_DESCRIPTIONCONTENT_CHANGE_TYPE_STATE_DESCRIPTIONCONTENT_CHANGE_TYPE_PANE_TITLECONTENT_CHANGE_TYPE_PANE_APPEAREDCONTENT_CHANGE_TYPE_PANE_DISAPPEAREDCONTENT_CHANGE_TYPE_DRAG_STARTEDCONTENT_CHANGE_TYPE_DRAG_DROPPED, and CONTENT_CHANGE_TYPE_DRAG_CANCELLED

Throws
IllegalStateExceptionIf called from an AccessibilityService.

See also:

setEventTime

Added in API level 4

public void setEventTime (long eventTime)

Sets the time in which this event was sent.

Parameters
eventTimelong: The event time.

Throws
IllegalStateExceptionIf called from an AccessibilityService.

setEventType

Added in API level 4

public void setEventType (int eventType)

Sets the event type. Note: An event must represent a single event type.

Parameters
eventTypeint: The event type. Value is either 0 or a combination of TYPE_VIEW_CLICKEDTYPE_VIEW_LONG_CLICKEDTYPE_VIEW_SELECTEDTYPE_VIEW_FOCUSEDTYPE_VIEW_TEXT_CHANGEDTYPE_WINDOW_STATE_CHANGEDTYPE_NOTIFICATION_STATE_CHANGEDTYPE_VIEW_HOVER_ENTERTYPE_VIEW_HOVER_EXITTYPE_TOUCH_EXPLORATION_GESTURE_STARTTYPE_TOUCH_EXPLORATION_GESTURE_ENDTYPE_WINDOW_CONTENT_CHANGEDTYPE_VIEW_SCROLLEDTYPE_VIEW_TEXT_SELECTION_CHANGEDTYPE_ANNOUNCEMENTTYPE_VIEW_ACCESSIBILITY_FOCUSEDTYPE_VIEW_ACCESSIBILITY_FOCUS_CLEAREDTYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITYTYPE_GESTURE_DETECTION_STARTTYPE_GESTURE_DETECTION_ENDTYPE_TOUCH_INTERACTION_STARTTYPE_TOUCH_INTERACTION_ENDTYPE_WINDOWS_CHANGEDTYPE_VIEW_CONTEXT_CLICKEDTYPE_ASSIST_READING_CONTEXT, and TYPE_SPEECH_STATE_CHANGE

Throws
IllegalStateExceptionIf called from an AccessibilityService.

setMovementGranularity

Added in API level 16

public void setMovementGranularity (int granularity)

Sets the movement granularity that was traversed.

Parameters
granularityint: The granularity.

Throws
IllegalStateExceptionIf called from an AccessibilityService.

setPackageName

Added in API level 4

public void setPackageName (CharSequence packageName)

Sets the package name of the source.

Parameters
packageNameCharSequence: The package name.

Throws
IllegalStateExceptionIf called from an AccessibilityService.

setSpeechStateChangeTypes

Added in Android Tiramisu

public void setSpeechStateChangeTypes (int state)

Sets the speech state type signaled by a TYPE_SPEECH_STATE_CHANGE event

Parameters
stateint

See also:

toString

Added in API level 4

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
Stringa string representation of the object.

writeToParcel

Added in API level 4

public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcelParcel: The Parcel in which the object should be written. This value cannot be null.

flagsint: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值