Most visited

Recently visited

AccessibilityWindowInfoCompat

public class AccessibilityWindowInfoCompat
extends Object

java.lang.Object
   ↳ android.support.v4.view.accessibility.AccessibilityWindowInfoCompat


Helper for accessing AccessibilityWindowInfo introduced after API level 4 in a backwards compatible fashion.

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_SYSTEM

Window type: This is an system window.

Public methods

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

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()

Returns a hash code value for the object.

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()

Returns a string representation of the object.

Inherited methods

From class java.lang.Object

Constants

TYPE_ACCESSIBILITY_OVERLAY

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

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

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_SYSTEM

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

boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getAnchor

AccessibilityNodeInfoCompat getAnchor ()

Gets the node that anchors this window to another.

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

getBoundsInScreen

void getBoundsInScreen (Rect outBounds)

Gets the bounds of this window in the screen.

Parameters
outBounds Rect: The out window bounds.

getChild

AccessibilityWindowInfoCompat getChild (int index)

Gets the child window at a given index.

Parameters
index int: The index.
Returns
AccessibilityWindowInfoCompat The child.

getChildCount

int getChildCount ()

Gets the number of child windows.

Returns
int The child count.

getId

int getId ()

Gets the unique window id.

Returns
int windowId The window id.

getLayer

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

AccessibilityWindowInfoCompat getParent ()

Gets the parent window if such.

Returns
AccessibilityWindowInfoCompat The parent window.

getRoot

AccessibilityNodeInfoCompat getRoot ()

Gets the root node in the window's hierarchy.

Returns
AccessibilityNodeInfoCompat The root node.

getTitle

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

int getType ()

Gets the type of the window.

Returns
int The type.

See also:

hashCode

int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
int a hash code value for this object.

isAccessibilityFocused

boolean isAccessibilityFocused ()

Gets if this window has accessibility focus.

Returns
boolean Whether has accessibility focus.

isActive

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

boolean isFocused ()

Gets if this window has input focus.

Returns
boolean Whether has input focus.

obtain

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

AccessibilityWindowInfoCompat obtain ()

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

Returns
AccessibilityWindowInfoCompat An instance.

recycle

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

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
String a string representation of the object.

Hooray!