added in version 22.1.0
belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1

AccessibilityNodeInfoCompat

public class AccessibilityNodeInfoCompat
extends Object

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


Helper for accessing AccessibilityNodeInfo in a backwards compatible fashion.

Summary

Nested classes

class AccessibilityNodeInfoCompat.AccessibilityActionCompat

 

class AccessibilityNodeInfoCompat.CollectionInfoCompat

Class with information if a node is a collection. 

class AccessibilityNodeInfoCompat.CollectionItemInfoCompat

Class with information if a node is a collection item. 

class AccessibilityNodeInfoCompat.RangeInfoCompat

Class with information if a node is a range. 

Constants

int ACTION_ACCESSIBILITY_FOCUS

Action that gives accessibility focus to the node.

String ACTION_ARGUMENT_COLUMN_INT

Argument for specifying the collection column to make visible on screen.

String ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN

Argument for whether when moving at granularity to extend the selection or to move it otherwise.

String ACTION_ARGUMENT_HTML_ELEMENT_STRING

Argument for which HTML element to get moving to the next/previous HTML element.

String ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT

Argument for which movement granularity to be used when traversing the node text.

String ACTION_ARGUMENT_MOVE_WINDOW_X

Argument for specifying the x coordinate to which to move a window.

String ACTION_ARGUMENT_MOVE_WINDOW_Y

Argument for specifying the y coordinate to which to move a window.

String ACTION_ARGUMENT_PROGRESS_VALUE

Argument for specifying the progress value to set.

String ACTION_ARGUMENT_ROW_INT

Argument for specifying the collection row to make visible on screen.

String ACTION_ARGUMENT_SELECTION_END_INT

Argument for specifying the selection end.

String ACTION_ARGUMENT_SELECTION_START_INT

Argument for specifying the selection start.

String ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE

Argument for specifying the text content to set

Type: CharSequence
Actions: ACTION_SET_TEXT

int ACTION_CLEAR_ACCESSIBILITY_FOCUS

Action that clears accessibility focus of the node.

int ACTION_CLEAR_FOCUS

Action that unfocuses the node.

int ACTION_CLEAR_SELECTION

Action that unselects the node.

int ACTION_CLICK

Action that clicks on the node info.

int ACTION_COLLAPSE

Action to collapse an expandable node.

int ACTION_COPY

Action to copy the current selection to the clipboard.

int ACTION_CUT

Action to cut the current selection and place it to the clipboard.

int ACTION_DISMISS

Action to dismiss a dismissable node.

int ACTION_EXPAND

Action to expand an expandable node.

int ACTION_FOCUS

Action that focuses the node.

int ACTION_LONG_CLICK

Action that long clicks on the node.

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.

int ACTION_NEXT_HTML_ELEMENT

Action to move to the next HTML element of a given type.

int ACTION_PASTE

Action to paste the current clipboard content.

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.

int ACTION_PREVIOUS_HTML_ELEMENT

Action to move to the previous HTML element of a given type.

int ACTION_SCROLL_BACKWARD

Action to scroll the node content backward.

int ACTION_SCROLL_FORWARD

Action to scroll the node content forward.

int ACTION_SELECT

Action that selects the node.

int ACTION_SET_SELECTION

Action to set the selection.

int ACTION_SET_TEXT

Action that sets the text of the node.

int FOCUS_ACCESSIBILITY

The accessibility focus.

int FOCUS_INPUT

The input focus.

int MOVEMENT_GRANULARITY_CHARACTER

Movement granularity bit for traversing the text of a node by character.

int MOVEMENT_GRANULARITY_LINE

Movement granularity bit for traversing the text of a node by line.

int MOVEMENT_GRANULARITY_PAGE

Movement granularity bit for traversing the text of a node by page.

int MOVEMENT_GRANULARITY_PARAGRAPH

Movement granularity bit for traversing the text of a node by paragraph.

int MOVEMENT_GRANULARITY_WORD

Movement granularity bit for traversing the text of a node by word.

Public constructors

AccessibilityNodeInfoCompat(Object info)

This constructor was deprecated in API level 26.1.0. Use wrap(AccessibilityNodeInfo) instead.

Public methods

void addAction(int action)

Adds an action that can be performed on the node.

void addAction(AccessibilityNodeInfoCompat.AccessibilityActionCompat action)

Adds an action that can be performed on the node.

void addChild(View root, int virtualDescendantId)

Adds a virtual child which is a descendant of the given root.

void addChild(View child)

Adds a child.

boolean canOpenPopup()

Gets if this node opens a popup or a dialog.

boolean equals(Object obj)
List<AccessibilityNodeInfoCompat> findAccessibilityNodeInfosByText(String text)

Finds AccessibilityNodeInfos by text.

List<AccessibilityNodeInfoCompat> findAccessibilityNodeInfosByViewId(String viewId)

Finds AccessibilityNodeInfoCompats by the fully qualified view id's resource name where a fully qualified id is of the from "package:id/id_resource_name".

AccessibilityNodeInfoCompat findFocus(int focus)

Find the view that has the specified focus type.

AccessibilityNodeInfoCompat focusSearch(int direction)

Searches for the nearest view in the specified direction that can take input focus.

List<AccessibilityNodeInfoCompat.AccessibilityActionCompat> getActionList()

Gets the actions that can be performed on the node.

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.

AccessibilityNodeInfoCompat getChild(int index)

Get the child at given index.

int getChildCount()

Gets the number of children.

CharSequence getClassName()

Gets the class this node comes from.

AccessibilityNodeInfoCompat.CollectionInfoCompat getCollectionInfo()

Gets the collection info if the node is a collection.

AccessibilityNodeInfoCompat.CollectionItemInfoCompat getCollectionItemInfo()

Gets the collection item info if the node is a collection item.

CharSequence getContentDescription()

Gets the content description of this node.

int getDrawingOrder()

Get the drawing order of the view corresponding it this node.

CharSequence getError()

Gets the error text of this node.

Bundle getExtras()

Gets an optional bundle with extra data.

CharSequence getHintText()

Gets the hint text of this node.

Object getInfo()

This method was deprecated in API level 26.1.0. Use unwrap() instead.

int getInputType()

Gets the input type of the source as defined by InputType.

AccessibilityNodeInfoCompat getLabelFor()

Gets the node info for which the view represented by this info serves as a label for accessibility purposes.

AccessibilityNodeInfoCompat getLabeledBy()

Gets the node info which serves as the label of the view represented by this info for accessibility purposes.

int getLiveRegion()

Gets the node's live region mode.

int getMaxTextLength()

Returns the maximum text length for this node.

int getMovementGranularities()

Gets the movement granularities for traversing the text of this node.

CharSequence getPackageName()

Gets the package this node comes from.

CharSequence getPaneTitle()

Get the title of the pane represented by this node.

AccessibilityNodeInfoCompat getParent()

Gets the parent.

AccessibilityNodeInfoCompat.RangeInfoCompat getRangeInfo()

Gets the range info if this node is a range.

CharSequence getRoleDescription()

Gets the custom role description.

CharSequence getText()

Gets the text of this node.

int getTextSelectionEnd()

Gets the text selection end.

int getTextSelectionStart()

Gets the text selection start.

CharSequence getTooltipText()

Gets the tooltip text of this node.

AccessibilityNodeInfoCompat getTraversalAfter()

Gets the node after which this one is visited in accessibility traversal.

AccessibilityNodeInfoCompat getTraversalBefore()

Gets the node before which this one is visited during traversal.

String getViewIdResourceName()

Gets the fully qualified resource name of the source view's id.

AccessibilityWindowInfoCompat getWindow()

Gets the window to which this node belongs.

int getWindowId()

Gets the id of the window from which the info comes from.

int hashCode()
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 isContentInvalid()

Gets if the content of this node is invalid.

boolean isContextClickable()

Gets whether this node is context clickable.

boolean isDismissable()

Gets if the node can be dismissed.

boolean isEditable()

Gets if the node is editable.

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

Returns whether node represents a heading.

boolean isImportantForAccessibility()

Returns whether the node originates from a view considered important for accessibility.

boolean isLongClickable()

Gets whether this node is long clickable.

boolean isMultiLine()

Gets if the node is a multi line editable text.

boolean isPassword()

Gets whether this node is a password.

boolean isScreenReaderFocusable()

Returns whether the node is explicitly marked as a focusable unit by a screen reader.

boolean isScrollable()

Gets if the node is scrollable.

boolean isSelected()

Gets whether this node is selected.

boolean isShowingHintText()

Returns whether the node's text represents a hint for the user to enter text.

boolean isVisibleToUser()

Gets whether this node is visible to the user.

static AccessibilityNodeInfoCompat obtain(View root, int virtualDescendantId)

Returns a cached instance if such is available otherwise a new one and sets the source.

static AccessibilityNodeInfoCompat obtain(AccessibilityNodeInfoCompat info)

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

static AccessibilityNodeInfoCompat obtain()

Returns a cached instance if such is available otherwise a new one.

static AccessibilityNodeInfoCompat obtain(View source)

Returns a cached instance if such is available otherwise a new one and sets the source.

boolean performAction(int action, Bundle arguments)

Performs an action on the node.

boolean performAction(int action)

Performs an action on the node.

void recycle()

Return an instance back to be reused.

boolean refresh()

Refreshes this info with the latest state of the view it represents.

boolean removeAction(AccessibilityNodeInfoCompat.AccessibilityActionCompat action)

Removes an action that can be performed on the node.

boolean removeChild(View root, int virtualDescendantId)

Removes a virtual child which is a descendant of the given root.

boolean removeChild(View child)

Removes a child.

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 setCanOpenPopup(boolean opensPopup)

Sets if this node opens a popup or a dialog.

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 setCollectionInfo(Object collectionInfo)
void setCollectionItemInfo(Object collectionItemInfo)
void setContentDescription(CharSequence contentDescription)

Sets the content description of this node.

void setContentInvalid(boolean contentInvalid)

Sets if the content of this node is invalid.

void setContextClickable(boolean contextClickable)

Sets whether this node is context clickable.

void setDismissable(boolean dismissable)

Sets if the node can be dismissed.

void setDrawingOrder(int drawingOrderInParent)

Set the drawing order of the view corresponding it this node.

void setEditable(boolean editable)

Sets whether this node is editable.

void setEnabled(boolean enabled)

Sets whether this node is enabled.

void setError(CharSequence error)

Sets the error text of this node.

void setFocusable(boolean focusable)

Sets whether this node is focusable.

void setFocused(boolean focused)

Sets whether this node is focused.

void setHeading(boolean isHeading)

Sets whether the node represents a heading.

void setHintText(CharSequence hintText)

Sets the hint text of this node.

void setImportantForAccessibility(boolean important)

Sets whether the node is considered important for accessibility.

void setInputType(int inputType)

Sets the input type of the source as defined by InputType.

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 setLabelFor(View labeled)

Sets the view for which the view represented by this info serves as a label for accessibility purposes.

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 setLiveRegion(int mode)

Sets the node's live region mode.

void setLongClickable(boolean longClickable)

Sets whether this node is long clickable.

void setMaxTextLength(int max)

Sets the maximum text length, or -1 for no limit.

void setMovementGranularities(int granularities)

Sets the movement granularities for traversing the text of this node.

void setMultiLine(boolean multiLine)

Sets if the node is a multi line editable text.

void setPackageName(CharSequence packageName)

Sets the package this node comes from.

void setPaneTitle(CharSequence paneTitle)

If this node represents a visually distinct region of the screen that may update separately from the rest of the window, it is considered a pane.

void setParent(View root, int virtualDescendantId)

Sets the parent to be a virtual descendant of the given root.

void setParent(View parent)

Sets the parent.

void setPassword(boolean password)

Sets whether this node is a password.

void setRangeInfo(AccessibilityNodeInfoCompat.RangeInfoCompat rangeInfo)

Sets the range info if this node is a range.

void setRoleDescription(CharSequence roleDescription)

Sets the custom role description.

void setScreenReaderFocusable(boolean screenReaderFocusable)

Sets whether the node should be considered a focusable unit by a screen reader.

void setScrollable(boolean scrollable)

Sets if the node is scrollable.

void setSelected(boolean selected)

Sets whether this node is selected.

void setShowingHintText(boolean showingHintText)

Sets whether the node's text represents a hint for the user to enter text.

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 setTextSelection(int start, int end)

Sets the text selection start and end.

void setTooltipText(CharSequence tooltipText)

Sets the tooltip text of this node.

void setTraversalAfter(View view)

Sets the view whose node is visited after this one in accessibility traversal.

void setTraversalAfter(View root, int virtualDescendantId)

Sets the node after which this one is visited in accessibility traversal.

void setTraversalBefore(View view)

Sets the view before whose node this one should be visited during traversal.

void setTraversalBefore(View root, int virtualDescendantId)

Sets the node before which this one is visited during traversal.

void setViewIdResourceName(String viewId)

Sets the fully qualified resource name of the source view's id.

void setVisibleToUser(boolean visibleToUser)

Sets whether this node is visible to the user.

String toString()
AccessibilityNodeInfo unwrap()
static AccessibilityNodeInfoCompat wrap(AccessibilityNodeInfo info)

Creates a new instance wrapping an AccessibilityNodeInfo.

Inherited methods

From class java.lang.Object

Constants

ACTION_ACCESSIBILITY_FOCUS

added in version 22.1.0
int ACTION_ACCESSIBILITY_FOCUS

Action that gives accessibility focus to the node.

Constant Value: 64 (0x00000040)

ACTION_ARGUMENT_COLUMN_INT

added in version 25.1.0
String ACTION_ARGUMENT_COLUMN_INT

Argument for specifying the collection column to make visible on screen.

Type: int
Actions:

Constant Value: "android.view.accessibility.action.ARGUMENT_COLUMN_INT"

ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN

added in version 22.1.0
String ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN

Argument for whether when moving at granularity to extend the selection or to move it otherwise.

Type: boolean
Actions: ACTION_NEXT_AT_MOVEMENT_GRANULARITY, ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY

Constant Value: "ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN"

ACTION_ARGUMENT_HTML_ELEMENT_STRING

added in version 22.1.0
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

Constant Value: "ACTION_ARGUMENT_HTML_ELEMENT_STRING"

ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT

added in version 22.1.0
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

Constant Value: "ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT"

ACTION_ARGUMENT_MOVE_WINDOW_X

String ACTION_ARGUMENT_MOVE_WINDOW_X

Argument for specifying the x coordinate to which to move a window.

Type: int
Actions:

See also:

Constant Value: "ACTION_ARGUMENT_MOVE_WINDOW_X"

ACTION_ARGUMENT_MOVE_WINDOW_Y

String ACTION_ARGUMENT_MOVE_WINDOW_Y

Argument for specifying the y coordinate to which to move a window.

Type: int
Actions:

See also:

Constant Value: "ACTION_ARGUMENT_MOVE_WINDOW_Y"

ACTION_ARGUMENT_PROGRESS_VALUE

added in version 25.1.0
String ACTION_ARGUMENT_PROGRESS_VALUE

Argument for specifying the progress value to set.

Type: float
Actions:

Constant Value: "android.view.accessibility.action.ARGUMENT_PROGRESS_VALUE"

ACTION_ARGUMENT_ROW_INT

added in version 25.1.0
String ACTION_ARGUMENT_ROW_INT

Argument for specifying the collection row to make visible on screen.

Type: int
Actions:

Constant Value: "android.view.accessibility.action.ARGUMENT_ROW_INT"

ACTION_ARGUMENT_SELECTION_END_INT

added in version 22.1.0
String ACTION_ARGUMENT_SELECTION_END_INT

Argument for specifying the selection end.

Type: int
Actions: ACTION_SET_SELECTION

Constant Value: "ACTION_ARGUMENT_SELECTION_END_INT"

ACTION_ARGUMENT_SELECTION_START_INT

added in version 22.1.0
String ACTION_ARGUMENT_SELECTION_START_INT

Argument for specifying the selection start.

Type: int
Actions: ACTION_SET_SELECTION

Constant Value: "ACTION_ARGUMENT_SELECTION_START_INT"

ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE

added in version 22.1.0
String ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE

Argument for specifying the text content to set

Type: CharSequence
Actions: ACTION_SET_TEXT

See also:

Constant Value: "ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE"

ACTION_CLEAR_ACCESSIBILITY_FOCUS

added in version 22.1.0
int ACTION_CLEAR_ACCESSIBILITY_FOCUS

Action that clears accessibility focus of the node.

Constant Value: 128 (0x00000080)

ACTION_CLEAR_FOCUS

added in version 22.1.0
int ACTION_CLEAR_FOCUS

Action that unfocuses the node.

Constant Value: 2 (0x00000002)

ACTION_CLEAR_SELECTION

added in version 22.1.0
int ACTION_CLEAR_SELECTION

Action that unselects the node.

Constant Value: 8 (0x00000008)

ACTION_CLICK

added in version 22.1.0
int ACTION_CLICK

Action that clicks on the node info.

Constant Value: 16 (0x00000010)

ACTION_COLLAPSE

added in version 24.1.0
int ACTION_COLLAPSE

Action to collapse an expandable node.

Constant Value: 524288 (0x00080000)

ACTION_COPY

added in version 22.1.0
int ACTION_COPY

Action to copy the current selection to the clipboard.

Constant Value: 16384 (0x00004000)

ACTION_CUT

added in version 22.1.0
int ACTION_CUT

Action to cut the current selection and place it to the clipboard.

Constant Value: 65536 (0x00010000)

ACTION_DISMISS

added in version 24.1.0
int ACTION_DISMISS

Action to dismiss a dismissable node.

Constant Value: 1048576 (0x00100000)

ACTION_EXPAND

added in version 24.1.0
int ACTION_EXPAND

Action to expand an expandable node.

Constant Value: 262144 (0x00040000)

ACTION_FOCUS

added in version 22.1.0
int ACTION_FOCUS

Action that focuses the node.

Constant Value: 1 (0x00000001)

ACTION_LONG_CLICK

added in version 22.1.0
int ACTION_LONG_CLICK

Action that long clicks on the node.

Constant Value: 32 (0x00000020)

ACTION_NEXT_AT_MOVEMENT_GRANULARITY

added in version 22.1.0
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<, ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN
Example: Move to the previous character and do not extend selection.

Bundle arguments = new Bundle(); arguments.putInt(AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT, AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER); arguments.putBoolean(AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN, false); info.performAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY, arguments);

Constant Value: 256 (0x00000100)

ACTION_NEXT_HTML_ELEMENT

added in version 22.1.0
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);

Constant Value: 1024 (0x00000400)

ACTION_PASTE

added in version 22.1.0
int ACTION_PASTE

Action to paste the current clipboard content.

Constant Value: 32768 (0x00008000)

ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY

added in version 22.1.0
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<, ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN
Example: Move to the next character and do not extend selection.

Bundle arguments = new Bundle(); arguments.putInt(AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT, AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER); arguments.putBoolean(AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN, false); info.performAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY, arguments);

Constant Value: 512 (0x00000200)

ACTION_PREVIOUS_HTML_ELEMENT

added in version 22.1.0
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);

Constant Value: 2048 (0x00000800)

ACTION_SCROLL_BACKWARD

added in version 22.1.0
int ACTION_SCROLL_BACKWARD

Action to scroll the node content backward.

Constant Value: 8192 (0x00002000)

ACTION_SCROLL_FORWARD

added in version 22.1.0
int ACTION_SCROLL_FORWARD

Action to scroll the node content forward.

Constant Value: 4096 (0x00001000)

ACTION_SELECT

added in version 22.1.0
int ACTION_SELECT

Action that selects the node.

Constant Value: 4 (0x00000004)

ACTION_SET_SELECTION

added in version 22.1.0
int ACTION_SET_SELECTION

Action to set the selection. Performing this action with no arguments clears the selection.

Arguments: ACTION_ARGUMENT_SELECTION_START_INT, ACTION_ARGUMENT_SELECTION_END_INT
Example:

Bundle arguments = new Bundle(); arguments.putInt(AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_START_INT, 1); arguments.putInt(AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_END_INT, 2); info.performAction(AccessibilityNodeInfo.ACTION_SET_SELECTION, arguments);

Constant Value: 131072 (0x00020000)

ACTION_SET_TEXT

added in version 22.1.0
int ACTION_SET_TEXT

Action that sets the text of the node. Performing the action without argument, using null or empty CharSequence will clear the text. This action will also put the cursor at the end of text.

Arguments: ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE
Example:

Bundle arguments = new Bundle(); arguments.putCharSequence(AccessibilityNodeInfo.ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE, "android"); info.performAction(AccessibilityNodeInfo.ACTION_SET_TEXT, arguments);

Constant Value: 2097152 (0x00200000)

FOCUS_ACCESSIBILITY

added in version 22.1.0
int FOCUS_ACCESSIBILITY

The accessibility focus.

Constant Value: 2 (0x00000002)

FOCUS_INPUT

added in version 22.1.0
int FOCUS_INPUT

The input focus.

Constant Value: 1 (0x00000001)

MOVEMENT_GRANULARITY_CHARACTER

added in version 22.1.0
int MOVEMENT_GRANULARITY_CHARACTER

Movement granularity bit for traversing the text of a node by character.

Constant Value: 1 (0x00000001)

MOVEMENT_GRANULARITY_LINE

added in version 22.1.0
int MOVEMENT_GRANULARITY_LINE

Movement granularity bit for traversing the text of a node by line.

Constant Value: 4 (0x00000004)

MOVEMENT_GRANULARITY_PAGE

added in version 22.1.0
int MOVEMENT_GRANULARITY_PAGE

Movement granularity bit for traversing the text of a node by page.

Constant Value: 16 (0x00000010)

MOVEMENT_GRANULARITY_PARAGRAPH

added in version 22.1.0
int MOVEMENT_GRANULARITY_PARAGRAPH

Movement granularity bit for traversing the text of a node by paragraph.

Constant Value: 8 (0x00000008)

MOVEMENT_GRANULARITY_WORD

added in version 22.1.0
int MOVEMENT_GRANULARITY_WORD

Movement granularity bit for traversing the text of a node by word.

Constant Value: 2 (0x00000002)

Public constructors

AccessibilityNodeInfoCompat

added in version 22.1.0
AccessibilityNodeInfoCompat (Object info)

This constructor was deprecated in API level 26.1.0.
Use wrap(AccessibilityNodeInfo) instead.

Creates a new instance wrapping an AccessibilityNodeInfo.

Parameters
info Object: The info.

Public methods

addAction

added in version 22.1.0
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 int: The action.

Throws
IllegalStateException If called from an AccessibilityService.

addAction

added in version 22.1.0
void addAction (AccessibilityNodeInfoCompat.AccessibilityActionCompat 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 AccessibilityNodeInfoCompat.AccessibilityActionCompat: The action.

Throws
IllegalStateException If called from an AccessibilityService.

addChild

added in version 22.1.0
void addChild (View root, 
                int virtualDescendantId)

Adds a virtual child which is a descendant of the given root. If virtualDescendantId is 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 View: The root of the virtual subtree.

virtualDescendantId int: The id of the virtual child.

addChild

added in version 22.1.0
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 View: The child.

Throws
IllegalStateException If called from an AccessibilityService.

canOpenPopup

added in version 24.1.0
boolean canOpenPopup ()

Gets if this node opens a popup or a dialog.

Returns
boolean If the the node opens a popup.

equals

boolean equals (Object obj)

Parameters
obj Object

Returns
boolean

findAccessibilityNodeInfosByText

added in version 22.1.0
List<AccessibilityNodeInfoCompat> 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 String: The searched text.

Returns
List<AccessibilityNodeInfoCompat> A list of node info.

findAccessibilityNodeInfosByViewId

added in version 24.1.0
List<AccessibilityNodeInfoCompat> findAccessibilityNodeInfosByViewId (String viewId)

Finds AccessibilityNodeInfoCompats by the fully qualified view id's resource name where a fully qualified id is of the from "package:id/id_resource_name". For example, if the target application's package is "foo.bar" and the id resource name is "baz", the fully qualified resource id is "foo.bar:id/baz".

Note: It is a client responsibility to recycle the received info by calling recycle() to avoid creating of multiple instances.

Note: The primary usage of this API is for UI test automation and in order to report the fully qualified view id if an AccessibilityNodeInfoCompat the client has to set the FLAG_REPORT_VIEW_IDS flag when configuring the AccessibilityService.

Parameters
viewId String: The fully qualified resource name of the view id to find.

Returns
List<AccessibilityNodeInfoCompat> A list of node info.

findFocus

added in version 22.1.0
AccessibilityNodeInfoCompat 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 int: The focus to find. One of FOCUS_INPUT or FOCUS_ACCESSIBILITY.

Returns
AccessibilityNodeInfoCompat The node info of the focused view or null.

focusSearch

added in version 22.1.0
AccessibilityNodeInfoCompat focusSearch (int direction)

Searches for the nearest view in the specified direction that can take input focus.

Parameters
direction int: The direction. Can be one of: FOCUS_DOWN, FOCUS_UP, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD, FOCUS_BACKWARD.

Returns
AccessibilityNodeInfoCompat The node info for the view that can take accessibility focus.

getActionList

added in version 22.1.0
List<AccessibilityNodeInfoCompat.AccessibilityActionCompat> getActionList ()

Gets the actions that can be performed on the node.

Returns
List<AccessibilityNodeInfoCompat.AccessibilityActionCompat> A list of AccessibilityActions.

getActions

added in version 22.1.0
int getActions ()

Gets the actions that can be performed on the node.

Returns
int The bit mask of with actions.

getBoundsInParent

added in version 22.1.0
void getBoundsInParent (Rect outBounds)

Gets the node bounds in parent coordinates.

Parameters
outBounds Rect: The output node bounds.

getBoundsInScreen

added in version 22.1.0
void getBoundsInScreen (Rect outBounds)

Gets the node bounds in screen coordinates.

Parameters
outBounds Rect: The output node bounds.

getChild

added in version 22.1.0
AccessibilityNodeInfoCompat 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 int: The child index.

Returns
AccessibilityNodeInfoCompat The child node.

Throws
IllegalStateException If called outside of an AccessibilityService.