A11yNodeInfo

java.lang.Object
- com.deque.worldspace.A11yNodeInfo

All Implemented Interfaces:

java.lang.Iterable<A11yNodeInfo>, java.util.Comparator<A11yNodeInfo>
```
public class A11yNodeInfo
extends java.lang.Object
implements java.lang.Iterable<A11yNodeInfo>, java.util.Comparator<A11yNodeInfo>
```
A wrapper for AccessibilityNodeInfo or AccessiblityNodeInfoCompat objects. Extract properties reliably for various versions of the Android and Android compatability library, as well as adding support for many calculated properties.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`A11yNodeInfo.Actions`
`static class`	`A11yNodeInfo.Matcher` A class that supports matching to an accessibility node.
`static interface`	`A11yNodeInfo.OnVisitListener` Callbacks for iterating over the A11yNodeInfo heirarchy.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`A11yNodeInfo()`
`protected`	`A11yNodeInfo(android.view.accessibility.AccessibilityNodeInfo nodeInfo)`
`protected`	`A11yNodeInfo(android.support.v4.view.accessibility.AccessibilityNodeInfoCompat nodeInfoCompat)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compare(A11yNodeInfo lhs, A11yNodeInfo rhs)`
`android.support.v4.view.accessibility.AccessibilityNodeInfoCompat`	`getAccessibilityNodeInfoCompat()`
`java.util.List<android.support.v4.view.accessibility.AccessibilityNodeInfoCompat.AccessibilityActionCompat>`	`getActionList()`
`int`	`getActions()`
`android.graphics.Rect`	`getBoundsInScreen()`
`A11yNodeInfo`	`getChild(int i)`
`int`	`getChildCount()`
`java.lang.String`	`getClassName()`
`java.lang.String`	`getContDesc()` I hate how long the properly named method is, and it's used so frequently, so here's a shorthand one!
`java.lang.CharSequence`	`getContentDescription()`
`java.lang.String`	`getContentDescriptionAsString()` I don't often use CharSequence's, and prefer strings.
`int`	`getDepthInTree()` Gets the depth of the child in the node info heirarchy.
`A11yNodeInfo`	`getFirstNodeThatMatches(A11yNodeInfo.Matcher matcher)` Get the first `node` that matches the given `matcher`
`A11yNodeInfo`	`getLabeledBy()`
`A11yNodeInfo`	`getParent()`
`java.lang.String`	`getSpeakableText()` Attempts to calculate the string that will be read off by TalkBack for a given accessibility node.
`java.lang.CharSequence`	`getText()`
`java.lang.String`	`getTextAsString()` Don't like CharSequences, and random null string checks.
`java.lang.String`	`getViewIdResourceName()`
`boolean`	`isActiveElement()`
`boolean`	`isClassType(java.lang.Class<?> clazz)`
`boolean`	`isInVisibleScrollableField()`
`boolean`	`isScrollable()`
`boolean`	`isVisibleToUser()`
`java.util.Iterator<A11yNodeInfo>`	`iterator()` Implenting the iterable interface to more easily navigate the node infos children.
`boolean`	`performAction(A11yNodeInfo.Actions action)`
`java.lang.String`	`toString()`
`java.lang.String`	`toViewHeirarchy()` Get the entire node heirarchy as a string.
`A11yNodeInfo`	`visitNodes(A11yNodeInfo.OnVisitListener onVisitListener)` Loop over children in the node heirarchy, until one of them returns true.
`static A11yNodeInfo`	`wrap(android.view.accessibility.AccessibilityNodeInfo node)`
`static A11yNodeInfo`	`wrap(android.support.v4.view.accessibility.AccessibilityNodeInfoCompat node)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface java.util.Comparator
comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

- Constructor Detail
  - A11yNodeInfo
```
protected A11yNodeInfo()
```
  - A11yNodeInfo
```
protected A11yNodeInfo(android.view.accessibility.AccessibilityNodeInfo nodeInfo)
```
  - A11yNodeInfo
```
protected A11yNodeInfo(android.support.v4.view.accessibility.AccessibilityNodeInfoCompat nodeInfoCompat)
```
- Method Detail
  - wrap
```
public static A11yNodeInfo wrap(android.view.accessibility.AccessibilityNodeInfo node)
```
  - wrap
```
public static A11yNodeInfo wrap(android.support.v4.view.accessibility.AccessibilityNodeInfoCompat node)
```
  - compare
```
public int compare(A11yNodeInfo lhs,
                   A11yNodeInfo rhs)
```
    Specified by:
    
    compare in interface java.util.Comparator<A11yNodeInfo>
  - getActionList
```
public java.util.List<android.support.v4.view.accessibility.AccessibilityNodeInfoCompat.AccessibilityActionCompat> getActionList()
```
  - getActions
```
public int getActions()
```
  - isActiveElement
```
public boolean isActiveElement()
```
  - performAction
```
public boolean performAction(A11yNodeInfo.Actions action)
```
  - getAccessibilityNodeInfoCompat
```
public android.support.v4.view.accessibility.AccessibilityNodeInfoCompat getAccessibilityNodeInfoCompat()
```
  - getBoundsInScreen
```
public android.graphics.Rect getBoundsInScreen()
```
  - getChild
```
public A11yNodeInfo getChild(int i)
```
  - getChildCount
```
public int getChildCount()
```
  - getClassName
```
public java.lang.String getClassName()
```
  - getContentDescription
```
public java.lang.CharSequence getContentDescription()
```
  - getContentDescriptionAsString
```
public java.lang.String getContentDescriptionAsString()
```
    I don't often use CharSequence's, and prefer strings. Note: null strings will return as empty strings!
    
    Returns:
    
    The content descriptiong as a NotNull String.
  - getContDesc
```
public java.lang.String getContDesc()
```
    I hate how long the properly named method is, and it's used so frequently, so here's a shorthand one!
    
    Returns:
    
    getContentDescriptionAsString()
  - getDepthInTree
```
public int getDepthInTree()
```
    Gets the depth of the child in the node info heirarchy.
    
    Returns:
    
    The depth of the node.
  - getLabeledBy
```
public A11yNodeInfo getLabeledBy()
```
  - getParent
```
public A11yNodeInfo getParent()
```
  - getSpeakableText
```
public java.lang.String getSpeakableText()
```
    Attempts to calculate the string that will be read off by TalkBack for a given accessibility node. Eventually including role, trait, and value information. If null, returns an empty string instead.
    
    Returns:
    
    The string representing the spoken text.
  - getText
```
public java.lang.CharSequence getText()
```
  - getTextAsString
```
public java.lang.String getTextAsString()
```
    Don't like CharSequences, and random null string checks. This will get the Text as a NotNull String.
    
    Returns:
    
    The text as a NotNull String.
  - getViewIdResourceName
```
public java.lang.String getViewIdResourceName()
```
  - iterator
```
public java.util.Iterator<A11yNodeInfo> iterator()
```
    Implenting the iterable interface to more easily navigate the node infos children.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<A11yNodeInfo>
    
    Returns:
    
    An itarator over the children of this A11yNodeInfo.
  - toViewHeirarchy
```
public java.lang.String toViewHeirarchy()
```
    Get the entire node heirarchy as a string.
    
    Returns:
    
    The node heirarchy.
  - getFirstNodeThatMatches
```
public A11yNodeInfo getFirstNodeThatMatches(A11yNodeInfo.Matcher matcher)
```
    Get the first node that matches the given matcher
    
    Parameters:
    
    matcher - The matcher with props to match.
    
    Returns:
    
    The first node that matches.
  - isClassType
```
public boolean isClassType(java.lang.Class<?> clazz)
```
  - isScrollable
```
public boolean isScrollable()
```
  - isVisibleToUser
```
public boolean isVisibleToUser()
```
  - isInVisibleScrollableField
```
public boolean isInVisibleScrollableField()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - visitNodes
```
public A11yNodeInfo visitNodes(A11yNodeInfo.OnVisitListener onVisitListener)
```
    Loop over children in the node heirarchy, until one of them returns true. Return the first element where "onVisit" returns true. This can be used to create a very simple "find first" type of method. Though most of the time, you likely want to travel all, in which case, just return "false" from your onVisit method, and you will visit every node.
    
    Parameters:
    
    onVisitListener - onVisit will be alled for every node, until onVisit returns true.
    
    Returns:
    
    The first node for which onVisit returns true.

Class A11yNodeInfo

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.Comparator

Constructor Detail

A11yNodeInfo

A11yNodeInfo

A11yNodeInfo

Method Detail

wrap

wrap

compare

getActionList

getActions

isActiveElement

performAction

getAccessibilityNodeInfoCompat

getBoundsInScreen

getChild

getChildCount

getClassName

getContentDescription

getContentDescriptionAsString

getContDesc

getDepthInTree

getLabeledBy

getParent

getSpeakableText

getText

getTextAsString

getViewIdResourceName

iterator

toViewHeirarchy

getFirstNodeThatMatches

isClassType

isScrollable

isVisibleToUser

isInVisibleScrollableField

toString

visitNodes