Most visited

Recently visited

Results for

Summary: Nested Classes | Constants | Methods | Inherited Methods

AccessibilityManager

public final class AccessibilityManager
extends Object

java.lang.Object
↳	android.view.accessibility.AccessibilityManager

System level service that serves as an event dispatch for AccessibilityEvents, and provides facilities for querying the accessibility state of the system. Accessibility events are generated when something notable happens in the user interface, for example an Activity starts, the focus or selection of a View changes etc. Parties interested in handling accessibility events implement and register an accessibility service which extends AccessibilityService.

See also:

Summary

Nested classes
`interface`	`AccessibilityManager.AccessibilityStateChangeListener` Listener for the system accessibility state.
`interface`	`AccessibilityManager.TouchExplorationStateChangeListener` Listener for the system touch exploration state.

Constants
`int`	`FLAG_CONTENT_CONTROLS` Use this flag to indicate the content of a UI that times out contains interactive controls.
`int`	`FLAG_CONTENT_ICONS` Use this flag to indicate the content of a UI that times out contains icons.
`int`	`FLAG_CONTENT_TEXT` Use this flag to indicate the content of a UI that times out contains text.

Public methods
`void`	`addAccessibilityRequestPreparer(AccessibilityRequestPreparer preparer)` Registers a `AccessibilityRequestPreparer`.
`boolean`	`addAccessibilityStateChangeListener(AccessibilityManager.AccessibilityStateChangeListener listener)` Registers an `AccessibilityStateChangeListener` for changes in the global accessibility state of the system.
`void`	`addAccessibilityStateChangeListener(AccessibilityManager.AccessibilityStateChangeListener listener, Handler handler)` Registers an `AccessibilityStateChangeListener` for changes in the global accessibility state of the system.
`void`	`addTouchExplorationStateChangeListener(AccessibilityManager.TouchExplorationStateChangeListener listener, Handler handler)` Registers an `TouchExplorationStateChangeListener` for changes in the global touch exploration state of the system.
`boolean`	`addTouchExplorationStateChangeListener(AccessibilityManager.TouchExplorationStateChangeListener listener)` Registers a `TouchExplorationStateChangeListener` for changes in the global touch exploration state of the system.
`int`	`getAccessibilityFocusColor()` Gets the color of the focus rectangle.
`int`	`getAccessibilityFocusStrokeWidth()` Gets the strokeWidth of the focus rectangle.
`List<ServiceInfo>`	`getAccessibilityServiceList()` This method is deprecated. Use `getInstalledAccessibilityServiceList()`
`List<AccessibilityServiceInfo>`	`getEnabledAccessibilityServiceList(int feedbackTypeFlags)` Returns the `AccessibilityServiceInfo`s of the enabled accessibility services for a given feedback type.
`List<AccessibilityServiceInfo>`	`getInstalledAccessibilityServiceList()` Returns the `AccessibilityServiceInfo`s of the installed accessibility services.
`int`	`getRecommendedTimeoutMillis(int originalTimeout, int uiContentFlags)` Get the recommended timeout for changes to the UI needed by this user.
`void`	`interrupt()` Requests feedback interruption from all accessibility services.
`static boolean`	`isAccessibilityButtonSupported()` Determines if the accessibility button within the system navigation area is supported.
`boolean`	`isEnabled()` Returns if the accessibility in the system is enabled.
`boolean`	`isTouchExplorationEnabled()` Returns if the touch exploration in the system is enabled.
`void`	`removeAccessibilityRequestPreparer(AccessibilityRequestPreparer preparer)` Unregisters a `AccessibilityRequestPreparer`.
`boolean`	`removeAccessibilityStateChangeListener(AccessibilityManager.AccessibilityStateChangeListener listener)` Unregisters an `AccessibilityStateChangeListener`.
`boolean`	`removeTouchExplorationStateChangeListener(AccessibilityManager.TouchExplorationStateChangeListener listener)` Unregisters a `TouchExplorationStateChangeListener`.
`void`	`sendAccessibilityEvent(AccessibilityEvent event)` Sends an `AccessibilityEvent`.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

FLAG_CONTENT_CONTROLS

public static final int FLAG_CONTENT_CONTROLS

Use this flag to indicate the content of a UI that times out contains interactive controls.

See also:

getRecommendedTimeoutMillis(int, int)

Constant Value: 4 (0x00000004)

FLAG_CONTENT_ICONS

public static final int FLAG_CONTENT_ICONS

Use this flag to indicate the content of a UI that times out contains icons.

See also:

getRecommendedTimeoutMillis(int, int)

Constant Value: 1 (0x00000001)

FLAG_CONTENT_TEXT

public static final int FLAG_CONTENT_TEXT

Use this flag to indicate the content of a UI that times out contains text.

See also:

getRecommendedTimeoutMillis(int, int)

Constant Value: 2 (0x00000002)

Public methods

addAccessibilityRequestPreparer

public void addAccessibilityRequestPreparer (AccessibilityRequestPreparer preparer)

Registers a AccessibilityRequestPreparer.

Parameters
`preparer`	`AccessibilityRequestPreparer`

addAccessibilityStateChangeListener

public boolean addAccessibilityStateChangeListener (AccessibilityManager.AccessibilityStateChangeListener listener)

Registers an AccessibilityStateChangeListener for changes in the global accessibility state of the system. Equivalent to calling addAccessibilityStateChangeListener(android.view.accessibility.AccessibilityManager.AccessibilityStateChangeListener, android.os.Handler) with a null handler.

Parameters
`listener`	`AccessibilityManager.AccessibilityStateChangeListener`: The listener. This value cannot be `null`.

Returns
`boolean`	Always returns `true`.

addAccessibilityStateChangeListener

public void addAccessibilityStateChangeListener (AccessibilityManager.AccessibilityStateChangeListener listener, 
                Handler handler)

Registers an AccessibilityStateChangeListener for changes in the global accessibility state of the system. If the listener has already been registered, the handler used to call it back is updated.

Parameters
`listener`	`AccessibilityManager.AccessibilityStateChangeListener`: The listener. This value cannot be `null`.
`handler`	`Handler`: The handler on which the listener should be called back, or `null` for a callback on the process's main handler. This value may be `null`.

addTouchExplorationStateChangeListener

public void addTouchExplorationStateChangeListener (AccessibilityManager.TouchExplorationStateChangeListener listener, 
                Handler handler)

Registers an TouchExplorationStateChangeListener for changes in the global touch exploration state of the system. If the listener has already been registered, the handler used to call it back is updated.

Parameters
`listener`	`AccessibilityManager.TouchExplorationStateChangeListener`: The listener. This value cannot be `null`.
`handler`	`Handler`: The handler on which the listener should be called back, or `null` for a callback on the process's main handler. This value may be `null`.

addTouchExplorationStateChangeListener

public boolean addTouchExplorationStateChangeListener (AccessibilityManager.TouchExplorationStateChangeListener listener)

Registers a TouchExplorationStateChangeListener for changes in the global touch exploration state of the system. Equivalent to calling addTouchExplorationStateChangeListener(android.view.accessibility.AccessibilityManager.TouchExplorationStateChangeListener, android.os.Handler) with a null handler.

Parameters
`listener`	`AccessibilityManager.TouchExplorationStateChangeListener`: The listener. This value cannot be `null`.

Returns
`boolean`	Always returns `true`.

getAccessibilityFocusColor

public int getAccessibilityFocusColor ()

Gets the color of the focus rectangle. This value can be set by AccessibilityService.

Returns
`int`	The color of the focus rectangle.

getAccessibilityFocusStrokeWidth

public int getAccessibilityFocusStrokeWidth ()

Gets the strokeWidth of the focus rectangle. This value can be set by AccessibilityService.

Returns
`int`	The strokeWidth of the focus rectangle in pixels.

getAccessibilityServiceList

public List<ServiceInfo> getAccessibilityServiceList ()

This method is deprecated.
Use getInstalledAccessibilityServiceList()

Returns the ServiceInfos of the installed accessibility services.

Returns
`List<ServiceInfo>`	An unmodifiable list with `ServiceInfo`s.

getEnabledAccessibilityServiceList

public List<AccessibilityServiceInfo> getEnabledAccessibilityServiceList (int feedbackTypeFlags)

Returns the AccessibilityServiceInfos of the enabled accessibility services for a given feedback type.

Parameters
`feedbackTypeFlags`	`int`: The feedback type flags.

Returns
`List<AccessibilityServiceInfo>`	An unmodifiable list with `AccessibilityServiceInfo`s.

See also:

getInstalledAccessibilityServiceList

public List<AccessibilityServiceInfo> getInstalledAccessibilityServiceList ()

Returns the AccessibilityServiceInfos of the installed accessibility services.

Returns
`List<AccessibilityServiceInfo>`	An unmodifiable list with `AccessibilityServiceInfo`s.

getRecommendedTimeoutMillis

public int getRecommendedTimeoutMillis (int originalTimeout, 
                int uiContentFlags)

Get the recommended timeout for changes to the UI needed by this user. Controls should remain on the screen for at least this long to give users time to react. Some users may need extra time to review the controls, or to reach them, or to activate assistive technology to activate the controls automatically.

Use the combination of content flags to indicate contents of UI. For example, use FLAG_CONTENT_ICONS | FLAG_CONTENT_TEXT for message notification which contains icons and text, or use FLAG_CONTENT_TEXT | FLAG_CONTENT_CONTROLS for button dialog which contains text and button controls.

Parameters
`originalTimeout`	`int`: The timeout appropriate for users with no accessibility needs.
`uiContentFlags`	`int`: The combination of flags `FLAG_CONTENT_ICONS`, `FLAG_CONTENT_TEXT` or `FLAG_CONTENT_CONTROLS` to indicate the contents of UI. Value is either `0` or a combination of `FLAG_CONTENT_ICONS`, `FLAG_CONTENT_TEXT`, and `FLAG_CONTENT_CONTROLS`

Returns
`int`	The recommended UI timeout for the current user in milliseconds.

interrupt

public void interrupt ()

Requests feedback interruption from all accessibility services.

isAccessibilityButtonSupported

public static boolean isAccessibilityButtonSupported ()

Determines if the accessibility button within the system navigation area is supported.

Returns
`boolean`	`true` if the accessibility button is supported on this device, `false` otherwise

isEnabled

public boolean isEnabled ()

Returns if the accessibility in the system is enabled.

Returns
`boolean`	True if accessibility is enabled, false otherwise.

isTouchExplorationEnabled

public boolean isTouchExplorationEnabled ()

Returns if the touch exploration in the system is enabled.

Returns
`boolean`	True if touch exploration is enabled, false otherwise.

removeAccessibilityRequestPreparer

public void removeAccessibilityRequestPreparer (AccessibilityRequestPreparer preparer)

Unregisters a AccessibilityRequestPreparer.

Parameters
`preparer`	`AccessibilityRequestPreparer`

removeAccessibilityStateChangeListener

public boolean removeAccessibilityStateChangeListener (AccessibilityManager.AccessibilityStateChangeListener listener)

Unregisters an AccessibilityStateChangeListener.

Parameters
`listener`	`AccessibilityManager.AccessibilityStateChangeListener`: The listener. This value cannot be `null`.

Returns
`boolean`	True if the listener was previously registered.

removeTouchExplorationStateChangeListener

public boolean removeTouchExplorationStateChangeListener (AccessibilityManager.TouchExplorationStateChangeListener listener)

Unregisters a TouchExplorationStateChangeListener.

Parameters
`listener`	`AccessibilityManager.TouchExplorationStateChangeListener`: The listener. This value cannot be `null`.

Returns
`boolean`	True if listener was previously registered.

sendAccessibilityEvent

public void sendAccessibilityEvent (AccessibilityEvent event)

Sends an AccessibilityEvent.

Parameters
`event`	`AccessibilityEvent`: The event to send.

Throws
`IllegalStateException`	if accessibility is not enabled. Note: The preferred mechanism for sending custom accessibility events is through calling `ViewParent.requestSendAccessibilityEvent(View, AccessibilityEvent)` instead of this method to allow predecessors to augment/filter events sent by their descendants.

Most visited

Recently visited

Results for

AccessibilityManager

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

FLAG_CONTENT_CONTROLS

FLAG_CONTENT_ICONS

FLAG_CONTENT_TEXT

Public methods

addAccessibilityRequestPreparer

addAccessibilityStateChangeListener

addAccessibilityStateChangeListener

addTouchExplorationStateChangeListener

addTouchExplorationStateChangeListener

getAccessibilityFocusColor

getAccessibilityFocusStrokeWidth

getAccessibilityServiceList

getEnabledAccessibilityServiceList

getInstalledAccessibilityServiceList

getRecommendedTimeoutMillis

interrupt

isAccessibilityButtonSupported

isEnabled

isTouchExplorationEnabled

removeAccessibilityRequestPreparer

removeAccessibilityStateChangeListener

removeTouchExplorationStateChangeListener

sendAccessibilityEvent