AccessibilityNodeInfoCompat

public class AccessibilityNodeInfoCompat
extends Object

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


Helper for accessing AccessibilityNodeInfo in a backwards compatible fashion.

Summary

Nested classes

class AccessibilityNodeInfoCompat.AccessibilityActionCompat

A class defining an action that can be performed on an AccessibilityNodeInfo

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. 

class AccessibilityNodeInfoCompat.TouchDelegateInfoCompat

Class with information of touch delegated views and regions. 

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_PRESS_AND_HOLD_DURATION_MILLIS_INT

Argument to represent the duration in milliseconds to press and hold a node.

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 is deprecated. 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)

This method is deprecated. Use getBoundsInScreen(Rect) instead.

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 is deprecated. 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 getStateDescription()

Gets the state description of this node.

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.TouchDelegateInfoCompat getTouchDelegateInfo()

Get the AccessibilityNodeInfoCompat.TouchDelegateInfoCompat for touch delegate behavior with the represented view.

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