lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

belongs to Maven artifact androidx.core:core:1.0.0-alpha3

AccessibilityWindowInfoCompat

public class AccessibilityWindowInfoCompat
extends Object

java.lang.Object
   ↳ androidx.core.view.accessibility.AccessibilityWindowInfoCompat


Helper for accessing AccessibilityWindowInfo.

Summary

Constants

int TYPE_ACCESSIBILITY_OVERLAY

Window type: Windows that are overlaid only by an AccessibilityService for interception of user interactions without changing the windows an accessibility service can introspect.

int TYPE_APPLICATION

Window type: This is an application window.

int TYPE_INPUT_METHOD

Window type: This is an input method window.

int TYPE_SPLIT_SCREEN_DIVIDER

Window type: A system window used to divide the screen in split-screen mode.

int TYPE_SYSTEM

Window type: This is an system window.

Public methods

boolean equals(Object obj)
AccessibilityNodeInfoCompat getAnchor()

Gets the node that anchors this window to another.

void getBoundsInScreen(Rect outBounds)

Gets the bounds of this window in the screen.

AccessibilityWindowInfoCompat getChild(int index)

Gets the child window at a given index.

int getChildCount()

Gets the number of child windows.

int getId()

Gets the unique window id.

int getLayer()

Gets the layer which determines the Z-order of the window.

AccessibilityWindowInfoCompat getParent()

Gets the parent window if such.

AccessibilityNodeInfoCompat getRoot()

Gets the root node in the window's hierarchy.

CharSequence getTitle()

Gets the title of the window.

int getType()

Gets the type of the window.

int hashCode()
boolean isAccessibilityFocused()

Gets if this window has accessibility focus.

boolean isActive()

Gets if this window is active.

boolean isFocused()

Gets if this window has input focus.

static AccessibilityWindowInfoCompat obtain(AccessibilityWindowInfoCompat info)

Returns a cached instance if such is available or a new one is created.

static AccessibilityWindowInfoCompat obtain()

Returns a cached instance if such is available or a new one is created.

void recycle()

Return an instance back to be reused.

String toString()

Inherited methods

Constants

TYPE_ACCESSIBILITY_OVERLAY

public static final int TYPE_ACCESSIBILITY_OVERLAY

Window type: Windows that are overlaid only by an AccessibilityService for interception of user interactions without changing the windows an accessibility service can introspect. In particular, an accessibility service can introspect only windows that a sighted user can interact with which they can touch these windows or can type into these windows. For example, if there is a full screen accessibility overlay that is touchable, the windows below it will be introspectable by an accessibility service regardless they are covered by a touchable window.

Constant Value: 4 (0x00000004)

TYPE_APPLICATION

public static final int TYPE_APPLICATION

Window type: This is an application window. Such a window shows UI for interacting with an application.

Constant Value: 1 (0x00000001)

TYPE_INPUT_METHOD

public static final int TYPE_INPUT_METHOD

Window type: This is an input method window. Such a window shows UI for inputting text such as keyboard, suggestions, etc.

Constant Value: 2 (0x00000002)

TYPE_SPLIT_SCREEN_DIVIDER

public static final int TYPE_SPLIT_SCREEN_DIVIDER

Window type: A system window used to divide the screen in split-screen mode. This type of window is present only in split-screen mode.

Constant Value: 5 (0x00000005)

TYPE_SYSTEM

public static final int TYPE_SYSTEM

Window type: This is an system window. Such a window shows UI for interacting with the system.

Constant Value: 3 (0x00000003)

Public methods

equals

public boolean equals (Object obj)

Parameters
obj Object

Returns
boolean

getAnchor

public AccessibilityNodeInfoCompat getAnchor ()

Gets the node that anchors this window to another.

Returns
AccessibilityNodeInfoCompat The anchor node, or null if none exists.

getBoundsInScreen

public void getBoundsInScreen (Rect outBounds)

Gets the bounds of this window in the screen.

Parameters
outBounds Rect: The out window bounds.

getChild

public AccessibilityWindowInfoCompat getChild (int index)

Gets the child window at a given index.

Parameters
index int: The index.

Returns
AccessibilityWindowInfoCompat The child.

getChildCount

public int getChildCount ()

Gets the number of child windows.

Returns
int The child count.

getId

public int getId ()

Gets the unique window id.

Returns
int windowId The window id.

getLayer

public int getLayer ()

Gets the layer which determines the Z-order of the window. Windows with greater layer appear on top of windows with lesser layer.

Returns
int The window layer.

getParent

public AccessibilityWindowInfoCompat getParent ()

Gets the parent window if such.

Returns
AccessibilityWindowInfoCompat The parent window.

getRoot

public AccessibilityNodeInfoCompat getRoot ()

Gets the root node in the window's hierarchy.

Returns
AccessibilityNodeInfoCompat The root node.

getTitle

public CharSequence getTitle ()

Gets the title of the window.

Returns
CharSequence The title of the window, or the application label for the window if no title was explicitly set, or null if neither is available.

getType

public int getType ()

Gets the type of the window.

Returns
int The type.

hashCode

public int hashCode ()

Returns
int

isAccessibilityFocused

public boolean isAccessibilityFocused ()

Gets if this window has accessibility focus.

Returns
boolean Whether has accessibility focus.

isActive

public boolean isActive ()

Gets if this window is active. An active window is the one the user is currently touching or the window has input focus and the user is not touching any window.

Returns
boolean Whether this is the active window.

isFocused

public boolean isFocused ()

Gets if this window has input focus.

Returns
boolean Whether has input focus.

obtain

public static AccessibilityWindowInfoCompat obtain (AccessibilityWindowInfoCompat info)

Returns a cached instance if such is available or a new one is created. The returned instance is initialized from the given info.

Parameters
info AccessibilityWindowInfoCompat: The other info.

Returns
AccessibilityWindowInfoCompat An instance.

obtain

public static AccessibilityWindowInfoCompat obtain ()

Returns a cached instance if such is available or a new one is created.

Returns
AccessibilityWindowInfoCompat An instance.

recycle

public void recycle ()

Return an instance back to be reused.

Note: You must not touch the object after calling this function.

Throws
IllegalStateException If the info is already recycled.

toString

public String toString ()

Returns
String