IT. Expert System.

Android Reference

AccessibilityNodeInfo

android.view.accessibility

Class AccessibilityNodeInfo

java.lang.Object
- android.view.accessibility.AccessibilityNodeInfo

All Implemented Interfaces:

Parcelable
```
public class AccessibilityNodeInfo
extends Object
implements Parcelable
```
This class represents a node of the window content as well as actions that can be requested from its source. From the point of view of an AccessibilityService a window content is presented as tree of accessibility node info which may or may not map one-to-one to the view hierarchy. In other words, a custom view is free to report itself as a tree of accessibility node info.

Once an accessibility node info is delivered to an accessibility service it is made immutable and calling a state mutation method generates an error.

Please refer to AccessibilityService for details about how to obtain a handle to window content as a tree of accessibility node info as well as familiarizing with the security model.

Developer Guides

For more information about making applications accessible, read the Accessibility developer guide.

See Also:
AccessibilityService, AccessibilityEvent, AccessibilityManager

Nested Class Summary
- Nested classes/interfaces inherited from interface android.os.Parcelable
  Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACTION_ACCESSIBILITY_FOCUS` Action that gives accessibility focus to the node.
`static String`	`ACTION_ARGUMENT_HTML_ELEMENT_STRING` Argument for which HTML element to get moving to the next/previous HTML element.
`static String`	`ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT` Argument for which movement granularity to be used when traversing the node text.
`static int`	`ACTION_CLEAR_ACCESSIBILITY_FOCUS` Action that clears accessibility focus of the node.
`static int`	`ACTION_CLEAR_FOCUS` Action that clears input focus of the node.
`static int`	`ACTION_CLEAR_SELECTION` Action that unselects the node.
`static int`	`ACTION_CLICK` Action that clicks on the node info.
`static int`	`ACTION_FOCUS` Action that gives input focus to the node.
`static int`	`ACTION_LONG_CLICK` Action that long clicks on the node.
`static int`	`ACTION_NEXT_AT_MOVEMENT_GRANULARITY` Action that requests to go to the next entity in this node's text at a given movement granularity.
`static int`	`ACTION_NEXT_HTML_ELEMENT` Action to move to the next HTML element of a given type.
`static int`	`ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY` Action that requests to go to the previous entity in this node's text at a given movement granularity.
`static int`	`ACTION_PREVIOUS_HTML_ELEMENT` Action to move to the previous HTML element of a given type.
`static int`	`ACTION_SCROLL_BACKWARD` Action to scroll the node content backward.
`static int`	`ACTION_SCROLL_FORWARD` Action to scroll the node content forward.
`static int`	`ACTION_SELECT` Action that selects the node.
`static int`	`ACTIVE_WINDOW_ID`
`static Parcelable.Creator<AccessibilityNodeInfo>`	`CREATOR`
`static int`	`FLAG_PREFETCH_DESCENDANTS`
`static int`	`FLAG_PREFETCH_PREDECESSORS`
`static int`	`FLAG_PREFETCH_SIBLINGS`
`static int`	`FOCUS_ACCESSIBILITY` The accessibility focus.
`static int`	`FOCUS_INPUT` The input focus.
`static int`	`INCLUDE_NOT_IMPORTANT_VIEWS`
`static int`	`MOVEMENT_GRANULARITY_CHARACTER` Movement granularity bit for traversing the text of a node by character.
`static int`	`MOVEMENT_GRANULARITY_LINE` Movement granularity bit for traversing the text of a node by line.
`static int`	`MOVEMENT_GRANULARITY_PAGE` Movement granularity bit for traversing the text of a node by page.
`static int`	`MOVEMENT_GRANULARITY_PARAGRAPH` Movement granularity bit for traversing the text of a node by paragraph.
`static int`	`MOVEMENT_GRANULARITY_WORD` Movement granularity bit for traversing the text of a node by word.
`static long`	`ROOT_NODE_ID`
`static int`	`UNDEFINED`

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAction(int action)` Adds an action that can be performed on the node.
`void`	`addChild(View child)` Adds a child.
`void`	`addChild(View root, int virtualDescendantId)` Adds a virtual child which is a descendant of the given `root`.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable's marshalled representation.
`protected void`	`enforceNotSealed()` Enforces that this instance is not sealed.
`protected void`	`enforceSealed()` Enforces that this instance is sealed.
`boolean`	`equals(Object object)` Compares this instance with the specified object and indicates if they are equal.
`List<AccessibilityNodeInfo>`	`findAccessibilityNodeInfosByText(String text)` Finds `AccessibilityNodeInfo`s by text.
`AccessibilityNodeInfo`	`findFocus(int focus)` Find the view that has the specified focus type.
`AccessibilityNodeInfo`	`focusSearch(int direction)` Searches for the nearest view in the specified direction that can take the input focus.
`static int`	`getAccessibilityViewId(long accessibilityNodeId)` Gets the accessibility view id which identifies a View in the view three.
`int`	`getActions()` Gets the actions that can be performed on the node.
`void`	`getBoundsInParent(Rect outBounds)` Gets the node bounds in parent coordinates.
`void`	`getBoundsInScreen(Rect outBounds)` Gets the node bounds in screen coordinates.
`AccessibilityNodeInfo`	`getChild(int index)` Get the child at given index.
`int`	`getChildCount()` Gets the number of children.
`SparseLongArray`	`getChildNodeIds()`
`CharSequence`	`getClassName()` Gets the class this node comes from.
`CharSequence`	`getContentDescription()` Gets the content description of this node.
`AccessibilityNodeInfo`	`getLabeledBy()` Gets the node info which serves as the label of the view represented by this info for accessibility purposes.
`AccessibilityNodeInfo`	`getLabelFor()` Gets the node info for which the view represented by this info serves as a label for accessibility purposes.
`int`	`getMovementGranularities()` Gets the movement granularities for traversing the text of this node.
`CharSequence`	`getPackageName()` Gets the package this node comes from.
`AccessibilityNodeInfo`	`getParent()` Gets the parent.
`long`	`getParentNodeId()`
`long`	`getSourceNodeId()` Gets the id of the source node.
`CharSequence`	`getText()` Gets the text of this node.
`static int`	`getVirtualDescendantId(long accessibilityNodeId)` Gets the virtual descendant id which identifies an imaginary view in a containing View.
`int`	`getWindowId()` Gets the id of the window from which the info comes from.
`int`	`hashCode()` Returns an integer hash code for this object.
`boolean`	`isAccessibilityFocused()` Gets whether this node is accessibility focused.
`boolean`	`isCheckable()` Gets whether this node is checkable.
`boolean`	`isChecked()` Gets whether this node is checked.
`boolean`	`isClickable()` Gets whether this node is clickable.
`boolean`	`isEnabled()` Gets whether this node is enabled.
`boolean`	`isFocusable()` Gets whether this node is focusable.
`boolean`	`isFocused()` Gets whether this node is focused.
`boolean`	`isLongClickable()` Gets whether this node is long clickable.
`boolean`	`isPassword()` Gets whether this node is a password.
`boolean`	`isScrollable()` Gets if the node is scrollable.
`boolean`	`isSealed()` Gets if this instance is sealed.
`boolean`	`isSelected()` Gets whether this node is selected.
`boolean`	`isVisibleToUser()` Sets whether this node is visible to the user.
`static long`	`makeNodeId(int accessibilityViewId, int virtualDescendantId)` Makes a node id by shifting the `virtualDescendantId` by `VIRTUAL_DESCENDANT_ID_SHIFT` and taking the bitwise or with the `accessibilityViewId`.
`static AccessibilityNodeInfo`	`obtain()` Returns a cached instance if such is available otherwise a new one.
`static AccessibilityNodeInfo`	`obtain(AccessibilityNodeInfo info)` Returns a cached instance if such is available or a new one is create.
`static AccessibilityNodeInfo`	`obtain(View source)` Returns a cached instance if such is available otherwise a new one and sets the source.
`static AccessibilityNodeInfo`	`obtain(View root, int virtualDescendantId)` Returns a cached instance if such is available otherwise a new one and sets the source.
`boolean`	`performAction(int action)` Performs an action on the node.
`boolean`	`performAction(int action, Bundle arguments)` Performs an action on the node.
`void`	`recycle()` Return an instance back to be reused.
`void`	`setAccessibilityFocused(boolean focused)` Sets whether this node is accessibility focused.
`void`	`setBoundsInParent(Rect bounds)` Sets the node bounds in parent coordinates.
`void`	`setBoundsInScreen(Rect bounds)` Sets the node bounds in screen coordinates.
`void`	`setCheckable(boolean checkable)` Sets whether this node is checkable.
`void`	`setChecked(boolean checked)` Sets whether this node is checked.
`void`	`setClassName(CharSequence className)` Sets the class this node comes from.
`void`	`setClickable(boolean clickable)` Sets whether this node is clickable.
`void`	`setConnectionId(int connectionId)` Sets the unique id of the IAccessibilityServiceConnection over which this instance can send requests to the system.
`void`	`setContentDescription(CharSequence contentDescription)` Sets the content description of this node.
`void`	`setEnabled(boolean enabled)` Sets whether this node is enabled.
`void`	`setFocusable(boolean focusable)` Sets whether this node is focusable.
`void`	`setFocused(boolean focused)` Sets whether this node is focused.
`void`	`setLabeledBy(View label)` Sets the view which serves as the label of the view represented by this info for accessibility purposes.
`void`	`setLabeledBy(View root, int virtualDescendantId)` Sets the view which serves as the label of the view represented by this info for accessibility purposes.
`void`	`setLabelFor(View labeled)` Sets the view for which the view represented by this info serves as a label for accessibility purposes.
`void`	`setLabelFor(View root, int virtualDescendantId)` Sets the view for which the view represented by this info serves as a label for accessibility purposes.
`void`	`setLongClickable(boolean longClickable)` Sets whether this node is long clickable.
`void`	`setMovementGranularities(int granularities)` Sets the movement granularities for traversing the text of this node.
`void`	`setPackageName(CharSequence packageName)` Sets the package this node comes from.
`void`	`setParent(View parent)` Sets the parent.
`void`	`setParent(View root, int virtualDescendantId)` Sets the parent to be a virtual descendant of the given `root`.
`void`	`setPassword(boolean password)` Sets whether this node is a password.
`void`	`setScrollable(boolean scrollable)` Sets if the node is scrollable.
`void`	`setSealed(boolean sealed)` Sets if this instance is sealed.
`void`	`setSelected(boolean selected)` Sets whether this node is selected.
`void`	`setSource(View source)` Sets the source.
`void`	`setSource(View root, int virtualDescendantId)` Sets the source to be a virtual descendant of the given `root`.
`void`	`setText(CharSequence text)` Sets the text of this node.
`void`	`setVisibleToUser(boolean visibleToUser)` Sets whether this node is visible to the user.
`String`	`toString()` Returns a string containing a concise, human-readable description of this object.
`void`	`writeToParcel(Parcel parcel, int flags)` Flatten this object in to a Parcel.

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

- Field Detail
  - UNDEFINED
```
public static final int UNDEFINED
```
    See Also:
    Constant Field Values
  - ROOT_NODE_ID
```
public static final long ROOT_NODE_ID
```
  - ACTIVE_WINDOW_ID
```
public static final int ACTIVE_WINDOW_ID
```
    See Also:
    Constant Field Values
  - FLAG_PREFETCH_PREDECESSORS
```
public static final int FLAG_PREFETCH_PREDECESSORS
```
    See Also:
    Constant Field Values
  - FLAG_PREFETCH_SIBLINGS
```
public static final int FLAG_PREFETCH_SIBLINGS
```
    See Also:
    Constant Field Values
  - FLAG_PREFETCH_DESCENDANTS
```
public static final int FLAG_PREFETCH_DESCENDANTS
```
    See Also:
    Constant Field Values
  - INCLUDE_NOT_IMPORTANT_VIEWS
```
public static final int INCLUDE_NOT_IMPORTANT_VIEWS
```
    See Also:
    Constant Field Values
  - ACTION_FOCUS
```
public static final int ACTION_FOCUS
```
    Action that gives input focus to the node.
    
    See Also:
    Constant Field Values
  - ACTION_CLEAR_FOCUS
```
public static final int ACTION_CLEAR_FOCUS
```
    Action that clears input focus of the node.
    
    See Also:
    Constant Field Values
  - ACTION_SELECT
```
public static final int ACTION_SELECT
```
    Action that selects the node.
    
    See Also:
    Constant Field Values
  - ACTION_CLEAR_SELECTION
```
public static final int ACTION_CLEAR_SELECTION
```
    Action that unselects the node.
    
    See Also:
    Constant Field Values
  - ACTION_CLICK
```
public static final int ACTION_CLICK
```
    Action that clicks on the node info.
    
    See Also:
    Constant Field Values
  - ACTION_LONG_CLICK
```
public static final int ACTION_LONG_CLICK
```
    Action that long clicks on the node.
    
    See Also:
    Constant Field Values
  - ACTION_ACCESSIBILITY_FOCUS
```
public static final int ACTION_ACCESSIBILITY_FOCUS
```
    Action that gives accessibility focus to the node.
    
    See Also:
    Constant Field Values
  - ACTION_CLEAR_ACCESSIBILITY_FOCUS
```
public static final int ACTION_CLEAR_ACCESSIBILITY_FOCUS
```
    Action that clears accessibility focus of the node.
    
    See Also:
    Constant Field Values
  - ACTION_NEXT_AT_MOVEMENT_GRANULARITY
```
public static final int ACTION_NEXT_AT_MOVEMENT_GRANULARITY
```
    Action that requests to go to the next entity in this node's text at a given movement granularity. For example, move to the next character, word, etc.
    Arguments: ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT
    Example:
```
   Bundle arguments = new Bundle();
   arguments.putInt(AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT,
           AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER);
   info.performAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY, arguments);
 
```
    See Also:
    setMovementGranularities(int), getMovementGranularities(), MOVEMENT_GRANULARITY_CHARACTER, MOVEMENT_GRANULARITY_WORD, MOVEMENT_GRANULARITY_LINE, MOVEMENT_GRANULARITY_PARAGRAPH, MOVEMENT_GRANULARITY_PAGE, Constant Field Values
  - ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY
```
public static final int ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY
```
    Action that requests to go to the previous entity in this node's text at a given movement granularity. For example, move to the next character, word, etc.
    Arguments: ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT
    Example:
```
   Bundle arguments = new Bundle();
   arguments.putInt(AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT,
           AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER);
   info.performAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY,
           arguments);
 
```
    See Also:
    setMovementGranularities(int), getMovementGranularities(), MOVEMENT_GRANULARITY_CHARACTER, MOVEMENT_GRANULARITY_WORD, MOVEMENT_GRANULARITY_LINE, MOVEMENT_GRANULARITY_PARAGRAPH, MOVEMENT_GRANULARITY_PAGE, Constant Field Values
  - ACTION_NEXT_HTML_ELEMENT
```
public static final int ACTION_NEXT_HTML_ELEMENT
```
    Action to move to the next HTML element of a given type. For example, move to the BUTTON, INPUT, TABLE, etc.
    Arguments: ACTION_ARGUMENT_HTML_ELEMENT_STRING
    Example:
```
   Bundle arguments = new Bundle();
   arguments.putString(AccessibilityNodeInfo.ACTION_ARGUMENT_HTML_ELEMENT_STRING, "BUTTON");
   info.performAction(AccessibilityNodeInfo.ACTION_NEXT_HTML_ELEMENT, arguments);
 
```
    See Also:
    Constant Field Values
  - ACTION_PREVIOUS_HTML_ELEMENT
```
public static final int ACTION_PREVIOUS_HTML_ELEMENT
```
    Action to move to the previous HTML element of a given type. For example, move to the BUTTON, INPUT, TABLE, etc.
    Arguments: ACTION_ARGUMENT_HTML_ELEMENT_STRING
    Example:
```
   Bundle arguments = new Bundle();
   arguments.putString(AccessibilityNodeInfo.ACTION_ARGUMENT_HTML_ELEMENT_STRING, "BUTTON");
   info.performAction(AccessibilityNodeInfo.ACTION_PREVIOUS_HTML_ELEMENT, arguments);
 
```
    See Also:
    Constant Field Values
  - ACTION_SCROLL_FORWARD
```
public static final int ACTION_SCROLL_FORWARD
```
    Action to scroll the node content forward.
    
    See Also:
    Constant Field Values
  - ACTION_SCROLL_BACKWARD
```
public static final int ACTION_SCROLL_BACKWARD
```
    Action to scroll the node content backward.
    
    See Also:
    Constant Field Values
  - ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT
```
public static final String ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT
```
    Argument for which movement granularity to be used when traversing the node text.
    Type: int
    Actions: ACTION_NEXT_AT_MOVEMENT_GRANULARITY, ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY
    
    See Also:
    Constant Field Values
  - ACTION_ARGUMENT_HTML_ELEMENT_STRING
```
public static final String ACTION_ARGUMENT_HTML_ELEMENT_STRING
```
    Argument for which HTML element to get moving to the next/previous HTML element.
    Type: String
    Actions: ACTION_NEXT_HTML_ELEMENT, ACTION_PREVIOUS_HTML_ELEMENT
    
    See Also:
    Constant Field Values
  - FOCUS_INPUT
```
public static final int FOCUS_INPUT
```
    The input focus.
    
    See Also:
    Constant Field Values
  - FOCUS_ACCESSIBILITY
```
public static final int FOCUS_ACCESSIBILITY
```
    The accessibility focus.
    
    See Also:
    Constant Field Values
  - MOVEMENT_GRANULARITY_CHARACTER
```
public static final int MOVEMENT_GRANULARITY_CHARACTER
```
    Movement granularity bit for traversing the text of a node by character.
    
    See Also:
    Constant Field Values
  - MOVEMENT_GRANULARITY_WORD
```
public static final int MOVEMENT_GRANULARITY_WORD
```
    Movement granularity bit for traversing the text of a node by word.
    
    See Also:
    Constant Field Values
  - MOVEMENT_GRANULARITY_LINE
```
public static final int MOVEMENT_GRANULARITY_LINE
```
    Movement granularity bit for traversing the text of a node by line.
    
    See Also:
    Constant Field Values
  - MOVEMENT_GRANULARITY_PARAGRAPH
```
public static final int MOVEMENT_GRANULARITY_PARAGRAPH
```
    Movement granularity bit for traversing the text of a node by paragraph.
    
    See Also:
    Constant Field Values
  - MOVEMENT_GRANULARITY_PAGE
```
public static final int MOVEMENT_GRANULARITY_PAGE
```
    Movement granularity bit for traversing the text of a node by page.
    
    See Also:
    Constant Field Values
  - CREATOR
```
public static final Parcelable.Creator<AccessibilityNodeInfo> CREATOR
```
    See Also:
    Parcelable.Creator
- Method Detail
  - getAccessibilityViewId
```
public static int getAccessibilityViewId(long accessibilityNodeId)
```
    Gets the accessibility view id which identifies a View in the view three.
    
    Parameters:
    accessibilityNodeId - The id of an AccessibilityNodeInfo.
    
    Returns:
    The accessibility view id part of the node id.
  - getVirtualDescendantId
```
public static int getVirtualDescendantId(long accessibilityNodeId)
```
    Gets the virtual descendant id which identifies an imaginary view in a containing View.
    
    Parameters:
    accessibilityNodeId - The id of an AccessibilityNodeInfo.
    
    Returns:
    The virtual view id part of the node id.
  - makeNodeId
```
public static long makeNodeId(int accessibilityViewId,
              int virtualDescendantId)
```
    Makes a node id by shifting the virtualDescendantId by VIRTUAL_DESCENDANT_ID_SHIFT and taking the bitwise or with the accessibilityViewId.
    
    Parameters:
    accessibilityViewId - A View accessibility id.
    virtualDescendantId - A virtual descendant id.
    
    Returns:
    The node id.
  - setSource
```
public void setSource(View source)
```
    Sets the source.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    source - The info source.
  - setSource
```
public void setSource(View root,
             int virtualDescendantId)
```
    Sets the source to be a virtual descendant of the given root. If virtualDescendantId is View.NO_ID the root is set as the source.
    A virtual descendant is an imaginary View that is reported as a part of the view hierarchy for accessibility purposes. This enables custom views that draw complex content to report themselves as a tree of virtual views, thus conveying their logical structure.
    
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    root - The root of the virtual subtree.
    virtualDescendantId - The id of the virtual descendant.
  - findFocus
```
public AccessibilityNodeInfo findFocus(int focus)
```
    Find the view that has the specified focus type. The search starts from the view represented by this node info.
    
    Parameters:
    focus - The focus to find. One of FOCUS_INPUT or FOCUS_ACCESSIBILITY.
    
    Returns:
    The node info of the focused view or null.
    See Also:
    FOCUS_INPUT, FOCUS_ACCESSIBILITY
  - focusSearch
```
public AccessibilityNodeInfo focusSearch(int direction)
```
    Searches for the nearest view in the specified direction that can take the input focus.
    
    Parameters:
    direction - The direction. Can be one of: View.FOCUS_DOWN, View.FOCUS_UP, View.FOCUS_LEFT, View.FOCUS_RIGHT, View.FOCUS_FORWARD, View.FOCUS_BACKWARD.
    
    Returns:
    The node info for the view that can take accessibility focus.
  - getWindowId
```
public int getWindowId()
```
    Gets the id of the window from which the info comes from.
    
    Returns:
    The window id.
  - getChildNodeIds
```
public SparseLongArray getChildNodeIds()
```
    Returns:
    The ids of the children.
  - getChildCount
```
public int getChildCount()
```
    Gets the number of children.
    
    Returns:
    The child count.
  - getChild
```
public AccessibilityNodeInfo getChild(int index)
```
    Get the child at given index.
    Note: It is a client responsibility to recycle the received info by calling recycle() to avoid creating of multiple instances.
    
    Parameters:
    index - The child index.
    
    Returns:
    The child node.
    
    Throws:
    
    IllegalStateException - If called outside of an AccessibilityService.
  - addChild
```
public void addChild(View child)
```
    Adds a child.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    child - The child.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - addChild
```
public void addChild(View root,
            int virtualDescendantId)
```
    Adds a virtual child which is a descendant of the given root. If virtualDescendantId is View.NO_ID the root is added as a child.
    A virtual descendant is an imaginary View that is reported as a part of the view hierarchy for accessibility purposes. This enables custom views that draw complex content to report them selves as a tree of virtual views, thus conveying their logical structure.
    
    Parameters:
    root - The root of the virtual subtree.
    virtualDescendantId - The id of the virtual child.
  - getActions
```
public int getActions()
```
    Gets the actions that can be performed on the node.
    
    Returns:
    The bit mask of with actions.
    See Also:
    ACTION_FOCUS, ACTION_CLEAR_FOCUS, ACTION_SELECT, ACTION_CLEAR_SELECTION, ACTION_ACCESSIBILITY_FOCUS, ACTION_CLEAR_ACCESSIBILITY_FOCUS, ACTION_CLICK, ACTION_LONG_CLICK, ACTION_NEXT_AT_MOVEMENT_GRANULARITY, ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY, ACTION_NEXT_HTML_ELEMENT, ACTION_PREVIOUS_HTML_ELEMENT, ACTION_SCROLL_FORWARD, ACTION_SCROLL_BACKWARD
  - addAction
```
public void addAction(int action)
```
    Adds an action that can be performed on the node.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    action - The action.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - setMovementGranularities
```
public void setMovementGranularities(int granularities)
```
    Sets the movement granularities for traversing the text of this node.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    granularities - The bit mask with granularities.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - getMovementGranularities
```
public int getMovementGranularities()
```
    Gets the movement granularities for traversing the text of this node.
    
    Returns:
    The bit mask with granularities.
  - performAction
```
public boolean performAction(int action)
```
    Performs an action on the node.
    Note: An action can be performed only if the request is made from an AccessibilityService.
    
    Parameters:
    action - The action to perform.
    
    Returns:
    True if the action was performed.
    
    Throws:
    
    IllegalStateException - If called outside of an AccessibilityService.
  - performAction
```
public boolean performAction(int action,
                    Bundle arguments)
```
    Performs an action on the node.
    Note: An action can be performed only if the request is made from an AccessibilityService.
    
    Parameters:
    action - The action to perform.
    arguments - A bundle with additional arguments.
    
    Returns:
    True if the action was performed.
    
    Throws:
    
    IllegalStateException - If called outside of an AccessibilityService.
  - findAccessibilityNodeInfosByText
```
public List<AccessibilityNodeInfo> findAccessibilityNodeInfosByText(String text)
```
    Finds AccessibilityNodeInfos by text. The match is case insensitive containment. The search is relative to this info i.e. this info is the root of the traversed tree.
    Note: It is a client responsibility to recycle the received info by calling recycle() to avoid creating of multiple instances.
    
    Parameters:
    text - The searched text.
    
    Returns:
    A list of node info.
  - getParent
```
public AccessibilityNodeInfo getParent()
```
    Gets the parent.
    Note: It is a client responsibility to recycle the received info by calling recycle() to avoid creating of multiple instances.
    
    Returns:
    The parent.
  - getParentNodeId
```
public long getParentNodeId()
```
    Returns:
    The parent node id.
  - setParent
```
public void setParent(View parent)
```
    Sets the parent.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    parent - The parent.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - setParent
```
public void setParent(View root,
             int virtualDescendantId)
```
    Sets the parent to be a virtual descendant of the given root. If virtualDescendantId equals to View.NO_ID the root is set as the parent.
    A virtual descendant is an imaginary View that is reported as a part of the view hierarchy for accessibility purposes. This enables custom views that draw complex content to report them selves as a tree of virtual views, thus conveying their logical structure.
    
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    root - The root of the virtual subtree.
    virtualDescendantId - The id of the virtual descendant.
  - getBoundsInParent
```
public void getBoundsInParent(Rect outBounds)
```
    Gets the node bounds in parent coordinates.
    
    Parameters:
    outBounds - The output node bounds.
  - setBoundsInParent
```
public void setBoundsInParent(Rect bounds)
```
    Sets the node bounds in parent coordinates.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    bounds - The node bounds.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - getBoundsInScreen
```
public void getBoundsInScreen(Rect outBounds)
```
    Gets the node bounds in screen coordinates.
    
    Parameters:
    outBounds - The output node bounds.
  - setBoundsInScreen
```
public void setBoundsInScreen(Rect bounds)
```
    Sets the node bounds in screen coordinates.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    bounds - The node bounds.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isCheckable
```
public boolean isCheckable()
```
    Gets whether this node is checkable.
    
    Returns:
    True if the node is checkable.
  - setCheckable
```
public void setCheckable(boolean checkable)
```
    Sets whether this node is checkable.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    checkable - True if the node is checkable.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isChecked
```
public boolean isChecked()
```
    Gets whether this node is checked.
    
    Returns:
    True if the node is checked.
  - setChecked
```
public void setChecked(boolean checked)
```
    Sets whether this node is checked.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    checked - True if the node is checked.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isFocusable
```
public boolean isFocusable()
```
    Gets whether this node is focusable.
    
    Returns:
    True if the node is focusable.
  - setFocusable
```
public void setFocusable(boolean focusable)
```
    Sets whether this node is focusable.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    focusable - True if the node is focusable.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isFocused
```
public boolean isFocused()
```
    Gets whether this node is focused.
    
    Returns:
    True if the node is focused.
  - setFocused
```
public void setFocused(boolean focused)
```
    Sets whether this node is focused.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    focused - True if the node is focused.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isVisibleToUser
```
public boolean isVisibleToUser()
```
    Sets whether this node is visible to the user.
    
    Returns:
    Whether the node is visible to the user.
  - setVisibleToUser
```
public void setVisibleToUser(boolean visibleToUser)
```
    Sets whether this node is visible to the user.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    visibleToUser - Whether the node is visible to the user.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isAccessibilityFocused
```
public boolean isAccessibilityFocused()
```
    Gets whether this node is accessibility focused.
    
    Returns:
    True if the node is accessibility focused.
  - setAccessibilityFocused
```
public void setAccessibilityFocused(boolean focused)
```
    Sets whether this node is accessibility focused.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    focused - True if the node is accessibility focused.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isSelected
```
public boolean isSelected()
```
    Gets whether this node is selected.
    
    Returns:
    True if the node is selected.
  - setSelected
```
public void setSelected(boolean selected)
```
    Sets whether this node is selected.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    selected - True if the node is selected.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isClickable
```
public boolean isClickable()
```
    Gets whether this node is clickable.
    
    Returns:
    True if the node is clickable.
  - setClickable
```
public void setClickable(boolean clickable)
```
    Sets whether this node is clickable.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    clickable - True if the node is clickable.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isLongClickable
```
public boolean isLongClickable()
```
    Gets whether this node is long clickable.
    
    Returns:
    True if the node is long clickable.
  - setLongClickable
```
public void setLongClickable(boolean longClickable)
```
    Sets whether this node is long clickable.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    longClickable - True if the node is long clickable.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isEnabled
```
public boolean isEnabled()
```
    Gets whether this node is enabled.
    
    Returns:
    True if the node is enabled.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets whether this node is enabled.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    enabled - True if the node is enabled.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isPassword
```
public boolean isPassword()
```
    Gets whether this node is a password.
    
    Returns:
    True if the node is a password.
  - setPassword
```
public void setPassword(boolean password)
```
    Sets whether this node is a password.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    password - True if the node is a password.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - isScrollable
```
public boolean isScrollable()
```
    Gets if the node is scrollable.
    
    Returns:
    True if the node is scrollable, false otherwise.
  - setScrollable
```
public void setScrollable(boolean scrollable)
```
    Sets if the node is scrollable.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    scrollable - True if the node is scrollable, false otherwise.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - getPackageName
```
public CharSequence getPackageName()
```
    Gets the package this node comes from.
    
    Returns:
    The package name.
  - setPackageName
```
public void setPackageName(CharSequence packageName)
```
    Sets the package this node comes from.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    packageName - The package name.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - getClassName
```
public CharSequence getClassName()
```
    Gets the class this node comes from.
    
    Returns:
    The class name.
  - setClassName
```
public void setClassName(CharSequence className)
```
    Sets the class this node comes from.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    className - The class name.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - getText
```
public CharSequence getText()
```
    Gets the text of this node.
    
    Returns:
    The text.
  - setText
```
public void setText(CharSequence text)
```
    Sets the text of this node.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    text - The text.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - getContentDescription
```
public CharSequence getContentDescription()
```
    Gets the content description of this node.
    
    Returns:
    The content description.
  - setContentDescription
```
public void setContentDescription(CharSequence contentDescription)
```
    Sets the content description of this node.
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    contentDescription - The content description.
    
    Throws:
    
    IllegalStateException - If called from an AccessibilityService.
  - setLabelFor
```
public void setLabelFor(View labeled)
```
    Sets the view for which the view represented by this info serves as a label for accessibility purposes.
    
    Parameters:
    labeled - The view for which this info serves as a label.
  - setLabelFor
```
public void setLabelFor(View root,
               int virtualDescendantId)
```
    Sets the view for which the view represented by this info serves as a label for accessibility purposes. If virtualDescendantId is View.NO_ID the root is set as the labeled.
    A virtual descendant is an imaginary View that is reported as a part of the view hierarchy for accessibility purposes. This enables custom views that draw complex content to report themselves as a tree of virtual views, thus conveying their logical structure.
    
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    root - The root whose virtual descendant serves as a label.
    virtualDescendantId - The id of the virtual descendant.
  - getLabelFor
```
public AccessibilityNodeInfo getLabelFor()
```
    Gets the node info for which the view represented by this info serves as a label for accessibility purposes.
    Note: It is a client responsibility to recycle the received info by calling recycle() to avoid creating of multiple instances.
    
    Returns:
    The labeled info.
  - setLabeledBy
```
public void setLabeledBy(View label)
```
    Sets the view which serves as the label of the view represented by this info for accessibility purposes.
    
    Parameters:
    label - The view that labels this node's source.
  - setLabeledBy
```
public void setLabeledBy(View root,
                int virtualDescendantId)
```
    Sets the view which serves as the label of the view represented by this info for accessibility purposes. If virtualDescendantId is View.NO_ID the root is set as the label.
    A virtual descendant is an imaginary View that is reported as a part of the view hierarchy for accessibility purposes. This enables custom views that draw complex content to report themselves as a tree of virtual views, thus conveying their logical structure.
    
    Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.
    
    Parameters:
    root - The root whose virtual descendant labels this node's source.
    virtualDescendantId - The id of the virtual descendant.
  - getLabeledBy
```
public AccessibilityNodeInfo getLabeledBy()
```
    Gets the node info which serves as the label of the view represented by this info for accessibility purposes.
    Note: It is a client responsibility to recycle the received info by calling recycle() to avoid creating of multiple instances.
    
    Returns:
    The label.
  - setConnectionId
```
public void setConnectionId(int connectionId)
```
    Sets the unique id of the IAccessibilityServiceConnection over which this instance can send requests to the system.
    
    Parameters:
    connectionId - The connection id.
  - describeContents
```
public int describeContents()
```
    Describe the kinds of special objects contained in this Parcelable's marshalled representation.
    
    Specified by:
    
    describeContents in interface Parcelable
    
    Returns:
    a bitmask indicating the set of special object types marshalled by the Parcelable.
  - getSourceNodeId
```
public long getSourceNodeId()
```
    Gets the id of the source node.
    
    Returns:
    The id.
  - setSealed
```
public void setSealed(boolean sealed)
```
    Sets if this instance is sealed.
    
    Parameters:
    sealed - Whether is sealed.
  - isSealed
```
public boolean isSealed()
```
    Gets if this instance is sealed.
    
    Returns:
    Whether is sealed.
  - enforceSealed
```
protected void enforceSealed()
```
    Enforces that this instance is sealed.
    
    Throws:
    
    IllegalStateException - If this instance is not sealed.
  - enforceNotSealed
```
protected void enforceNotSealed()
```
    Enforces that this instance is not sealed.
    
    Throws:
    
    IllegalStateException - If this instance is sealed.
  - obtain
```
public static AccessibilityNodeInfo obtain(View source)
```
    Returns a cached instance if such is available otherwise a new one and sets the source.
    
    Parameters:
    source - The source view.
    
    Returns:
    An instance.
    See Also:
    setSource(View)
  - obtain
```
public static AccessibilityNodeInfo obtain(View root,
                           int virtualDescendantId)
```
    Returns a cached instance if such is available otherwise a new one and sets the source.
    
    Parameters:
    root - The root of the virtual subtree.
    virtualDescendantId - The id of the virtual descendant.
    
    Returns:
    An instance.
    See Also:
    setSource(View, int)
  - obtain
```
public static AccessibilityNodeInfo obtain()
```
    Returns a cached instance if such is available otherwise a new one.
    
    Returns:
    An instance.
  - obtain
```
public static AccessibilityNodeInfo obtain(AccessibilityNodeInfo info)
```
    Returns a cached instance if such is available or a new one is create. The returned instance is initialized from the given info.
    
    Parameters:
    info - The other info.
    
    Returns:
    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.
  - writeToParcel
```
public void writeToParcel(Parcel parcel,
                 int flags)
```
    Flatten this object in to a Parcel.
    Note: After the instance is written to a parcel it is recycled. You must not touch the object after calling this function.
    
    Specified by:
    
    writeToParcel in interface Parcelable
    
    Parameters:
    parcel - The Parcel in which the object should be written.
    flags - Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
  - equals
```
public boolean equals(Object object)
```
    Description copied from class: Object
    
    Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.
    The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.
    The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    object - the object to compare this instance with.
    
    Returns:
    true if the specified object is equal to this Object; false otherwise.
    See Also:
    Object.hashCode()
  - hashCode
```
public int hashCode()
```
    Description copied from class: Object
    
    Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.
    Note that hash values must not change over time unless information used in equals comparisons also changes.
    See Writing a correct hashCode method if you intend implementing your own hashCode method.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    this object's hash code.
    See Also:
    Object.equals(java.lang.Object)
  - toString
```
public String toString()
```
    Description copied from class: Object
    Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
```
   getClass().getName() + '@' + Integer.toHexString(hashCode())
```
    See Writing a useful toString method if you intend implementing your own toString method.
    Overrides:
    
    toString in class Object
    
    Returns:
    a printable representation of this object.

Content

Android Reference

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.

All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.

IT. Expert System.

Android Reference

AccessibilityNodeInfo

Class AccessibilityNodeInfo

Developer Guides

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNDEFINED

ROOT_NODE_ID

ACTIVE_WINDOW_ID

FLAG_PREFETCH_PREDECESSORS

FLAG_PREFETCH_SIBLINGS

FLAG_PREFETCH_DESCENDANTS

INCLUDE_NOT_IMPORTANT_VIEWS

ACTION_FOCUS

ACTION_CLEAR_FOCUS

ACTION_SELECT

ACTION_CLEAR_SELECTION

ACTION_CLICK

ACTION_LONG_CLICK

ACTION_ACCESSIBILITY_FOCUS

ACTION_CLEAR_ACCESSIBILITY_FOCUS

ACTION_NEXT_AT_MOVEMENT_GRANULARITY

ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY

ACTION_NEXT_HTML_ELEMENT

ACTION_PREVIOUS_HTML_ELEMENT

ACTION_SCROLL_FORWARD

ACTION_SCROLL_BACKWARD

ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT

ACTION_ARGUMENT_HTML_ELEMENT_STRING

FOCUS_INPUT

FOCUS_ACCESSIBILITY

MOVEMENT_GRANULARITY_CHARACTER

MOVEMENT_GRANULARITY_WORD

MOVEMENT_GRANULARITY_LINE

MOVEMENT_GRANULARITY_PARAGRAPH

MOVEMENT_GRANULARITY_PAGE

CREATOR

Method Detail

getAccessibilityViewId

getVirtualDescendantId

makeNodeId

setSource

setSource

findFocus

focusSearch

getWindowId

getChildNodeIds

getChildCount

getChild

addChild

addChild

getActions

addAction

setMovementGranularities

getMovementGranularities

performAction

performAction

findAccessibilityNodeInfosByText

getParent

getParentNodeId

setParent

setParent

getBoundsInParent

setBoundsInParent

getBoundsInScreen

setBoundsInScreen

isCheckable

setCheckable

isChecked

setChecked

isFocusable

setFocusable

isFocused

setFocused