AccessibilityNodeInfo

See also:

• AccessibilityService
• AccessibilityEvent
• AccessibilityManager

See also:

• ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT
• ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN
• setMovementGranularities(int)
• getMovementGranularities()
• MOVEMENT_GRANULARITY_CHARACTER
• MOVEMENT_GRANULARITY_WORD
• MOVEMENT_GRANULARITY_LINE
• MOVEMENT_GRANULARITY_PARAGRAPH
• MOVEMENT_GRANULARITY_PAGE

ACTION_PASTE

public static final int ACTION_PASTE

Action to paste the current clipboard content.

Constant Value: 32768 (0x00008000)

See also:

• ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT
• ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN
• setMovementGranularities(int)
• getMovementGranularities()
• MOVEMENT_GRANULARITY_CHARACTER
• MOVEMENT_GRANULARITY_WORD
• MOVEMENT_GRANULARITY_LINE
• MOVEMENT_GRANULARITY_PARAGRAPH
• MOVEMENT_GRANULARITY_PAGE

ACTION_SCROLL_BACKWARD

public static final int ACTION_SCROLL_BACKWARD

Action to scroll the node content backward.

Constant Value: 8192 (0x00002000)

ACTION_SCROLL_FORWARD

public static final int ACTION_SCROLL_FORWARD

Action to scroll the node content forward.

Constant Value: 4096 (0x00001000)

ACTION_SELECT

public static final int ACTION_SELECT

Action that selects the node.

Constant Value: 4 (0x00000004)

ACTION_SET_SELECTION

public static final int ACTION_SET_SELECTION

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

Constant Value: 131072 (0x00020000)

ACTION_SET_TEXT

public static final 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.

Constant Value: 2097152 (0x00200000)

CHECKED_STATE_FALSE

public static final int CHECKED_STATE_FALSE

This node is not checked.

Constant Value: 0 (0x00000000)

CHECKED_STATE_PARTIAL

public static final int CHECKED_STATE_PARTIAL

This node is partially checked. For example, when a checkbox owns a number of sub-options and they have different states, then the main checkbox is in a partially-checked state.

Constant Value: 2 (0x00000002)

CHECKED_STATE_TRUE

public static final int CHECKED_STATE_TRUE

This node is checked.

Constant Value: 1 (0x00000001)

EXPANDED_STATE_COLLAPSED

public static final int EXPANDED_STATE_COLLAPSED

Expanded state for a collapsed expandable element.

Constant Value: 1 (0x00000001)

EXPANDED_STATE_FULL

public static final int EXPANDED_STATE_FULL

Expanded state for a expanded expandable element that cannot be expanded further.

Constant Value: 3 (0x00000003)

EXPANDED_STATE_PARTIAL

public static final int EXPANDED_STATE_PARTIAL

Expanded state for an expanded expandable element that can still be expanded further.

Constant Value: 2 (0x00000002)

EXPANDED_STATE_UNDEFINED

public static final int EXPANDED_STATE_UNDEFINED

Expanded state for a non-expandable element

Constant Value: 0 (0x00000000)

EXTRA_DATA_RENDERING_INFO_KEY

public static final String EXTRA_DATA_RENDERING_INFO_KEY

Key used to request extra data for the rendering information. The key requests that a AccessibilityNodeInfo.ExtraRenderingInfo be added to this info. This request is made with refreshWithExtraData(String,Bundle) without argument.

The data can be retrieved from the ExtraRenderingInfo returned by getExtraRenderingInfo() using ExtraRenderingInfo.getLayoutSize, ExtraRenderingInfo.getTextSizeInPx() and ExtraRenderingInfo.getTextSizeUnit(). For layout params, it is supported by both TextView and ViewGroup. For text size and unit, it is only supported by TextView.

Constant Value: "android.view.accessibility.extra.DATA_RENDERING_INFO_KEY"

EXTRA_DATA_REQUEST_LAYOUT_BASED_ACTIONS_KEY

public static final String EXTRA_DATA_REQUEST_LAYOUT_BASED_ACTIONS_KEY

Key used to request that the node source re-evaluate and update this node's layout-dependent actions. This request is made with refreshWithExtraData(String,Bundle) and takes no arguments.

Some actions may depend on the on-screen layout of a node. In complex or dynamic UIs, it may be difficult for a source to determine if a node is truly actionable without more intensive inspection. For example, a node may be misreported as clickable despite being occluded, requiring a hit-test to confirm the availability of the action.

Using this key requests that the source perform a more intensive, layout-based analysis to determine which actions are available to the user. After this request, the source will update the actions and related properties of this node. For example, for clickability, this may result in changes to the value returned by isClickable() and the presence of AccessibilityAction.ACTION_CLICK in the node's getActionList().

This analysis can be computationally expensive and should only be requested when needed to resolve ambiguous or inaccurate actions.

Providers may advertise that they support this request using setAvailableExtraData(List). Services may check for support with getAvailableExtraData().

Constant Value: "android.view.accessibility.extra.DATA_REQUEST_LAYOUT_BASED_ACTIONS_KEY"

EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_LENGTH

public static final String EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_LENGTH

Integer argument specifying the end index of the requested text location data. Must be positive and no larger than EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_MAX_LENGTH.

Constant Value: "android.view.accessibility.extra.DATA_TEXT_CHARACTER_LOCATION_ARG_LENGTH"

EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_MAX_LENGTH

public static final int EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_MAX_LENGTH

The maximum allowed length of the requested text location data.

Constant Value: 20000 (0x00004e20)

EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_START_INDEX

public static final String EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_START_INDEX

Integer argument specifying the start index of the requested text location data. Must be valid inside the CharSequence returned by getText().

Constant Value: "android.view.accessibility.extra.DATA_TEXT_CHARACTER_LOCATION_ARG_START_INDEX"

EXTRA_DATA_TEXT_CHARACTER_LOCATION_IN_WINDOW_KEY

public static final String EXTRA_DATA_TEXT_CHARACTER_LOCATION_IN_WINDOW_KEY

Key used to request and locate extra data for text character location in window coordinates. This key requests that an array of RectFs be added to the extras. This request is made with refreshWithExtraData(String,Bundle). The arguments taken by this request are two integers: EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_START_INDEX and EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_LENGTH. The starting index must be valid inside the CharSequence returned by getText(), and the length must be positive.

Providers may advertise that they support text characters in window coordinates using setAvailableExtraData(List). Services may check if an implementation supports text characters in window coordinates with getAvailableExtraData().

The data can be retrieved from the Bundle returned by getExtras() using this string as a key for Bundle.getParcelableArray(String,Class). The RectF will be null for characters that either do not exist or are outside of the window bounds.

Note that character locations in window bounds are not modified by changes in display magnification.

Constant Value: "android.view.accessibility.extra.DATA_TEXT_CHARACTER_LOCATION_IN_WINDOW_KEY"

EXTRA_DATA_TEXT_CHARACTER_LOCATION_KEY

public static final String EXTRA_DATA_TEXT_CHARACTER_LOCATION_KEY

Key used to request and locate extra data for text character location. This key requests that an array of RectFs be added to the extras. This request is made with refreshWithExtraData(String,Bundle). The arguments taken by this request are two integers: EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_START_INDEX and EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_LENGTH. The starting index must be valid inside the CharSequence returned by getText(), and the length must be positive.

The data can be retrieved from the Bundle returned by getExtras() using this string as a key for Bundle.getParcelableArray(String,Class). The RectF will be null for characters that either do not exist or are off the screen.

Note that character locations returned are modified by changes in display magnification.

Constant Value: "android.view.accessibility.extra.DATA_TEXT_CHARACTER_LOCATION_KEY"

FLAG_PREFETCH_ANCESTORS

public static final int FLAG_PREFETCH_ANCESTORS

Prefetching strategy that prefetches the ancestors of the requested node.

Ancestors will be prefetched before siblings and descendants.

Constant Value: 1 (0x00000001)

FLAG_PREFETCH_DESCENDANTS_BREADTH_FIRST

public static final int FLAG_PREFETCH_DESCENDANTS_BREADTH_FIRST

Prefetching strategy that prefetches the descendants of the requested node breadth-first.

This must not be combined with FLAG_PREFETCH_DESCENDANTS_HYBRID or FLAG_PREFETCH_DESCENDANTS_DEPTH_FIRST or this will trigger an IllegalArgumentException.

See FLAG_PREFETCH_ANCESTORS for information on where these flags can be used.

Constant Value: 16 (0x00000010)

FLAG_PREFETCH_DESCENDANTS_DEPTH_FIRST

public static final int FLAG_PREFETCH_DESCENDANTS_DEPTH_FIRST

Prefetching strategy that prefetches the descendants of the requested node depth-first.

This must not be combined with FLAG_PREFETCH_DESCENDANTS_HYBRID or FLAG_PREFETCH_DESCENDANTS_BREADTH_FIRST or this will trigger an IllegalArgumentException.

See FLAG_PREFETCH_ANCESTORS for information on where these flags can be used.

Constant Value: 8 (0x00000008)

FLAG_PREFETCH_DESCENDANTS_HYBRID

public static final int FLAG_PREFETCH_DESCENDANTS_HYBRID

Prefetching strategy that prefetches the descendants in a hybrid depth first and breadth first approach.

The children of the root node is prefetched before recursing on the children. This must not be combined with FLAG_PREFETCH_DESCENDANTS_DEPTH_FIRST or FLAG_PREFETCH_DESCENDANTS_BREADTH_FIRST or this will trigger an IllegalArgumentException.

See FLAG_PREFETCH_ANCESTORS for information on where these flags can be used.

Constant Value: 4 (0x00000004)

FLAG_PREFETCH_SIBLINGS

public static final int FLAG_PREFETCH_SIBLINGS

Prefetching strategy that prefetches the siblings of the requested node.

To avoid disconnected trees, this flag will also prefetch the parent. Siblings will be prefetched before descendants.

See FLAG_PREFETCH_ANCESTORS for information on where these flags can be used.

Constant Value: 2 (0x00000002)

FLAG_PREFETCH_UNINTERRUPTIBLE

public static final int FLAG_PREFETCH_UNINTERRUPTIBLE

Prefetching flag that specifies prefetching should not be interrupted by a request to retrieve a node or perform an action on a node.

See FLAG_PREFETCH_ANCESTORS for information on where these flags can be used.

Constant Value: 32 (0x00000020)

FOCUS_ACCESSIBILITY

public static final int FOCUS_ACCESSIBILITY

The accessibility focus.

Constant Value: 2 (0x00000002)

FOCUS_INPUT

public static final int FOCUS_INPUT

The input focus.

Constant Value: 1 (0x00000001)

MAX_NUMBER_OF_PREFETCHED_NODES

public static final int MAX_NUMBER_OF_PREFETCHED_NODES

Maximum batch size of prefetched nodes for a request.

Constant Value: 50 (0x00000032)

MOVEMENT_GRANULARITY_CHARACTER

public static final int MOVEMENT_GRANULARITY_CHARACTER

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

Constant Value: 1 (0x00000001)

MOVEMENT_GRANULARITY_LINE

public static final int MOVEMENT_GRANULARITY_LINE

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

Constant Value: 4 (0x00000004)

MOVEMENT_GRANULARITY_PAGE

public static final int MOVEMENT_GRANULARITY_PAGE

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

Constant Value: 16 (0x00000010)

MOVEMENT_GRANULARITY_PARAGRAPH

public static final int MOVEMENT_GRANULARITY_PARAGRAPH

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

Constant Value: 8 (0x00000008)

MOVEMENT_GRANULARITY_WORD

public static final int MOVEMENT_GRANULARITY_WORD

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

Constant Value: 2 (0x00000002)

CREATOR

public static final Creator<AccessibilityNodeInfo> CREATOR

AccessibilityNodeInfo

public AccessibilityNodeInfo ()

Creates a new AccessibilityNodeInfo.

AccessibilityNodeInfo

public AccessibilityNodeInfo (AccessibilityNodeInfo info)

Copy constructor. Creates a new AccessibilityNodeInfo, and this new instance is initialized from the given info.

AccessibilityNodeInfo

public AccessibilityNodeInfo (View source)

Creates a new AccessibilityNodeInfo with the given source.

AccessibilityNodeInfo

public AccessibilityNodeInfo (View root, 
                int virtualDescendantId)

Creates a new AccessibilityNodeInfo with the given source.

addAction

public void addAction (int action)

This method was deprecated in API level 21.
This has been deprecated for addAction(AccessibilityAction)

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.

addAction

public void addAction (AccessibilityNodeInfo.AccessibilityAction action)

Adds an action that can be performed on the node.

To add a standard action use the static constants on AccessibilityAction. To add a custom action create a new AccessibilityAction by passing in a resource id from your application as the action id and an optional label that describes the action. To override one of the standard actions use as the action id of a standard action id such as ACTION_CLICK and an optional label that describes the action.

Use androidx.core.view.ViewCompat.addAccessibilityAction(View,CharSequence,AccessibilityViewCommand) to register an action directly on the view.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to 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. Note that a view cannot be made its own child.

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. Note that a view cannot be made its own child.

addLabeledBy

public void addLabeledBy (View label)

Adds the view which serves as the label of the view represented by this info for accessibility purposes. When multiple labels are added, the content from each label is combined in the order that they are added.

If visible text can be used to describe or give meaning to this UI, this method is preferred. For example, a TextView before an EditText in the UI usually specifies what information is contained in the EditText. Hence, the EditText is labeled by the TextView.

addLabeledBy

public void addLabeledBy (View root, 
                int virtualDescendantId)

Adds 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. When multiple labels are added, the content from each label is combined in the order that they are added.

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.

If visible text can be used to describe or give meaning to this UI, this method is preferred. For example, a TextView before an EditText in the UI usually specifies what information is contained in the EditText. Hence, the EditText is labeled by the TextView.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

canOpenPopup

public boolean canOpenPopup ()

Gets if this node opens a popup or a dialog.

equals

public boolean equals (Object object)

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

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

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

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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: If this view hierarchy has a SurfaceView embedding another view hierarchy via SurfaceView.setChildSurfacePackage, there is a limitation that this API won't be able to find the node for the view on the embedded view hierarchy. It's because views don't know about the embedded hierarchies. Instead, you could traverse all the children to find the node.

findAccessibilityNodeInfosByViewId

public List<AccessibilityNodeInfo> findAccessibilityNodeInfosByViewId (String viewId)

Finds AccessibilityNodeInfos 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: The primary usage of this API is for UI test automation and in order to report the fully qualified view id if an AccessibilityNodeInfo the client has to set the AccessibilityServiceInfo.FLAG_REPORT_VIEW_IDS flag when configuring the AccessibilityService.

Note: If this view hierarchy has a SurfaceView embedding another view hierarchy via SurfaceView.setChildSurfacePackage, there is a limitation that this API won't be able to find the node for the view on the embedded view hierarchy. It's because views don't know about the embedded hierarchies. Instead, you could traverse all the children to find the node.

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.

Note: If this view hierarchy has a SurfaceView embedding another view hierarchy via SurfaceView.setChildSurfacePackage, there is a limitation that this API won't be able to find the node for the view on the embedded view hierarchy. It's because views don't know about the embedded hierarchies. Instead, you could traverse all the children to find the node. Or, use AccessibilityService.findFocus(int) for FOCUS_ACCESSIBILITY only since it has no such limitation.

focusSearch

public AccessibilityNodeInfo focusSearch (int direction)

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

Note: If this view hierarchy has a SurfaceView embedding another view hierarchy via SurfaceView.setChildSurfacePackage, there is a limitation that this API won't be able to find the node for the view in the specified direction on the embedded view hierarchy. It's because views don't know about the embedded hierarchies. Instead, you could traverse all the children to find the node.

getActionList

public List<AccessibilityNodeInfo.AccessibilityAction> getActionList ()

Gets the actions that can be performed on the node.

getActions

public int getActions ()

This method was deprecated in API level 21.
Use getActionList().

Gets the actions that can be performed on the node.

getAvailableExtraData

public List<String> getAvailableExtraData ()

Get the extra data available for this node.

Some data that is useful for some accessibility services is expensive to compute, and would place undue overhead on apps to compute all the time. That data can be requested with refreshWithExtraData(String,Bundle).

getBoundsInParent

public void getBoundsInParent (Rect outBounds)

This method was deprecated in API level 29.
Use getBoundsInScreen(Rect) instead.

Gets the node bounds in the viewParent's coordinates. getParent() does not represent the source's viewParent. Instead it represents the result of View.getParentForAccessibility(), which returns the closest ancestor where View.isImportantForAccessibility() is true. So this method is not reliable.

When magnification is enabled, the bounds in parent are also scaled up by magnification scale. For example, it returns Rect(20, 20, 200, 200) for original bounds Rect(10, 10, 100, 100), when the magnification scale is 2.

getBoundsInScreen

public void getBoundsInScreen (Rect outBounds)

Gets the node bounds in screen coordinates.

When magnification is enabled, the bounds in screen are scaled up by magnification scale and the positions are also adjusted according to the offset of magnification viewport. For example, it returns Rect(-180, -180, 0, 0) for original bounds Rect(10, 10, 100, 100), when the magnification scale is 2 and offsets for X and Y are both 200.

getBoundsInWindow

public void getBoundsInWindow (Rect outBounds)

Gets the node bounds in window coordinates.

The node bounds returned are not scaled by magnification.

See also:

• setCheckable(boolean)
• isCheckable()
• setChecked(int)

getChild

public AccessibilityNodeInfo getChild (int index)

Get the child at given index.

getChildCount

public int getChildCount ()

Gets the number of children.

getClassName

public CharSequence getClassName ()

Gets the class this node comes from.

getCollectionInfo

public AccessibilityNodeInfo.CollectionInfo getCollectionInfo ()

Gets the collection info if the node is a collection. A collection child is always a collection item.

getCollectionItemInfo

public AccessibilityNodeInfo.CollectionItemInfo getCollectionItemInfo ()

Gets the collection item info if the node is a collection item. A collection item is always a child of a collection.

getContainerTitle

public CharSequence getContainerTitle ()

Returns the container title.

getContentDescription

public CharSequence getContentDescription ()

Gets the content description of this node.

getDrawingOrder

public int getDrawingOrder ()

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

Drawing order is determined only within the node's parent, so this index is only relative to its siblings.

In some cases, the drawing order is essentially simultaneous, so it is possible for two siblings to return the same value. It is also possible that values will be skipped.

getError

public CharSequence getError ()

Gets the error text of this node.

getExtraRenderingInfo

public AccessibilityNodeInfo.ExtraRenderingInfo getExtraRenderingInfo ()

Gets the extra rendering info if the node is meant to be refreshed with extra data to examine rendering related accessibility issues.

getExtras

public Bundle getExtras ()

Gets an optional bundle with extra data. The bundle is lazily created and never null.

Note: It is recommended to use the package name of your application as a prefix for the keys to avoid collisions which may confuse an accessibility service if the same key has different meaning when emitted from different applications.

getHintText

public CharSequence getHintText ()

Gets the hint text of this node. Only applies to nodes where text can be entered.

getInputType

public int getInputType ()

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

getLabelFor

public AccessibilityNodeInfo getLabelFor ()

This method was deprecated in API level 36.
Use getLabeledByList() on the labeled node instead, since calling addLabeledBy(View) or addLabeledBy(View,int) on the labeled node do not automatically provide that node from this method.

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

getLabeledBy

public AccessibilityNodeInfo getLabeledBy ()

This method was deprecated in API level 36.
Use getLabeledByList() instead.

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

getLabeledByList

public List<AccessibilityNodeInfo> getLabeledByList ()

Gets the list of node infos which serve as the labels of the view represented by this info for accessibility purposes.

getLiveRegion

public int getLiveRegion ()

Gets the node's live region mode.

A live region is a node that contains information that is important for the user and when it changes the user should be notified. For example, a Snackbar that displays a confirmation notification should be marked as a live region with mode View.ACCESSIBILITY_LIVE_REGION_POLITE.

It is the responsibility of the accessibility service to monitor AccessibilityEvent.TYPE_WINDOW_CONTENT_CHANGED events indicating changes to live region nodes and their children.

getMaxTextLength

public int getMaxTextLength ()

Returns the maximum text length for this node.

getMinDurationBetweenContentChanges

public Duration getMinDurationBetweenContentChanges ()

Gets the minimum time duration between two content change events.

getMovementGranularities

public int getMovementGranularities ()

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

getPackageName

public CharSequence getPackageName ()

Gets the package this node comes from.

getPaneTitle

public CharSequence getPaneTitle ()

Get the title of the pane represented by this node.

getParent

public AccessibilityNodeInfo getParent ()

Gets the parent.

See also:

• FLAG_PREFETCH_ANCESTORS
• FLAG_PREFETCH_DESCENDANTS_BREADTH_FIRST
• FLAG_PREFETCH_DESCENDANTS_DEPTH_FIRST
• FLAG_PREFETCH_DESCENDANTS_HYBRID
• FLAG_PREFETCH_SIBLINGS
• FLAG_PREFETCH_UNINTERRUPTIBLE

getRangeInfo

public AccessibilityNodeInfo.RangeInfo getRangeInfo ()

Gets the range info if this node is a range.

getSelection

public AccessibilityNodeInfo.Selection getSelection ()

Gets the extended selection, which is a representation of selection that spans multiple nodes that exist within the subtree of the node defining selection.

Note: Nodes that are candidates to contain a selection should return true from isFocusable() and isFocused(). The start and end SelectionPositions of this Selection should exist within this node or its descendants.

getStateDescription

public CharSequence getStateDescription ()

Get the state description of this node.

getStructuredDataInfo

public AccessibilityNodeInfo.StructuredDataInfo getStructuredDataInfo ()

Gets additional structured data properties of this node. This is only populated for nodes that offer additional structured data, like a mathematical expression.

getSupplementalDescription

public CharSequence getSupplementalDescription ()

Gets the supplemental description of this node. A supplemental description provides brief supplemental information for this node, such as the purpose of the node when that purpose is not conveyed within its textual representation. For example, if a dropdown select has a purpose of setting font family, the supplemental description could be "font family". If this node has children, its supplemental description serves as additional information and is not intended to replace any existing information in the subtree. This is different from the getContentDescription() in that this description is purely supplemental while a content description may be used to replace a description for a node or its subtree that an assistive technology would otherwise compute based on other properties of the node and its descendants.

getText

public CharSequence getText ()

Gets the text of this node.

Note: If the text contains ClickableSpans or URLSpans, these spans will have been replaced with ones whose ClickableSpan.onClick(View) can be called from an AccessibilityService. When called from a service, the View argument is ignored and the corresponding span will be found on the view that this AccessibilityNodeInfo represents and called with that view as its argument.

This treatment of ClickableSpans means that the text returned from this method may different slightly one passed to setText(CharSequence), although they will be equivalent according to TextUtils.equals(CharSequence,CharSequence). The ClickableSpan.onClick(View) of any spans, however, will generally not work outside of an accessibility service.

getTextSelectionEnd

public int getTextSelectionEnd ()

Gets the text selection end if text is selected.

If no text is selected, both this method and AccessibilityNodeInfo.getTextSelectionStart() return the same value: the current location of the cursor.

getTextSelectionStart

public int getTextSelectionStart ()

Gets the text selection start or the cursor position.

If no text is selected, both this method and AccessibilityNodeInfo.getTextSelectionEnd() return the same value: the current location of the cursor.

getTooltipText

public CharSequence getTooltipText ()

Gets the tooltip text of this node.

getTouchDelegateInfo

public AccessibilityNodeInfo.TouchDelegateInfo getTouchDelegateInfo ()

Get the TouchDelegateInfo for touch delegate behavior with the represented view. It is possible for the same node to be pointed to by several regions. Use TouchDelegateInfo.getRegionAt(int) to get touch delegate target Region, and TouchDelegateInfo.getTargetForRegion(Region) for AccessibilityNodeInfo from the given region.

getTraversalAfter

public AccessibilityNodeInfo getTraversalAfter ()

Gets the node after which this one is visited in accessibility traversal. A screen-reader must visit the content of the other node before the content of this one.

getTraversalBefore

public AccessibilityNodeInfo getTraversalBefore ()

Gets the node before which this one is visited during traversal. A screen-reader must visit the content of this node before the content of the one it precedes.

getUniqueId

public String getUniqueId ()

Gets the unique id of the node.

getViewIdResourceName

public String getViewIdResourceName ()

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

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

getWindow

public AccessibilityWindowInfo getWindow ()

Gets the window to which this node belongs.

getWindowId

public int getWindowId ()

Returns the id of the window that created this node.

Note: If this node comes from a window that is embedded in another window using SurfaceView then the return value is the id of the window that embeds this node's window.

hasRequestInitialAccessibilityFocus

public boolean hasRequestInitialAccessibilityFocus ()

Gets whether the node has setRequestInitialAccessibilityFocus(boolean).

hashCode

public int hashCode ()

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

The general contract of hashCode is:

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

isAccessibilityDataSensitive

public boolean isAccessibilityDataSensitive ()

Gets if the node's accessibility data is considered sensitive.

isAccessibilityFocused

public boolean isAccessibilityFocused ()

Gets whether this node is accessibility focused.

This is distinct from isFocused(), which is used to track system focus. See ACTION_ACCESSIBILITY_FOCUS for details.

isCheckable

public boolean isCheckable ()

Gets whether this node is checkable.

isChecked

public boolean isChecked ()

This method was deprecated in API level 36.
Use getChecked() instead.

Gets whether this node is checked. This is only meaningful when isCheckable() returns true.

isClickable

public boolean isClickable ()

Gets whether this node is clickable.

isContentInvalid

public boolean isContentInvalid ()

Gets if the content of this node is invalid. For example, a date is not well-formed.

isContextClickable

public boolean isContextClickable ()

Gets whether this node is context clickable.

isDismissable

public boolean isDismissable ()

Gets if the node can be dismissed.

isEditable

public boolean isEditable ()

Gets if the node is editable.

isEnabled

public boolean isEnabled ()

Gets whether this node is enabled.

isFieldRequired

public boolean isFieldRequired ()

Gets whether a node representing a form field requires input or selection.

isFocusable

public boolean isFocusable ()

Gets whether this node is focusable.

In the View system, this typically maps to View.isFocusable().

isFocused

public boolean isFocused ()

Gets whether this node is focused.

This is distinct from isAccessibilityFocused(), which is used by screen readers. See AccessibilityAction.ACTION_ACCESSIBILITY_FOCUS for details.

isGranularScrollingSupported

public boolean isGranularScrollingSupported ()

Gets if the node supports granular scrolling.

isHeading

public boolean isHeading ()

Returns whether node represents a heading.

Note: Returns true if either setHeading(boolean) marks this node as a heading or if the node has a CollectionItemInfo that marks it as such, to accomodate apps that use the now-deprecated API.

isImportantForAccessibility

public boolean isImportantForAccessibility ()

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

isLongClickable

public boolean isLongClickable ()

Gets whether this node is long clickable.

isMultiLine

public boolean isMultiLine ()

Gets if the node is a multi line editable text.

isPassword

public boolean isPassword ()

Gets whether this node is a password.

isScreenReaderFocusable

public boolean isScreenReaderFocusable ()

Returns whether the node is explicitly marked as a focusable unit by a screen reader. Note that false indicates that it is not explicitly marked, not that the node is not a focusable unit. Screen readers should generally use other signals, such as isFocusable(), or the presence of text in a node, to determine what should receive focus.

isScrollable

public boolean isScrollable ()

Gets if the node is scrollable.

isSelected

public boolean isSelected ()

Gets whether this node is selected.

isShowingHintText

public boolean isShowingHintText ()

Returns whether the node's text represents a hint for the user to enter text. It should only be true if the node has editable text.

isTextEntryKey

public boolean isTextEntryKey ()

Returns whether node represents a text entry key that is part of a keyboard or keypad.

isTextSelectable

public boolean isTextSelectable ()

Gets if the node has selectable text.

Services should use ACTION_SET_SELECTION for selection. Editable text nodes must also be selectable. But not all UIs will populate this field, so services should consider 'isTextSelectable | isEditable' to ensure they don't miss nodes with selectable text.

isVisibleToUser

public boolean isVisibleToUser ()

Gets whether this node is visible to the user.

Between API 16 and API 29, this method may incorrectly return false when magnification is enabled. On other versions, a node is considered visible even if it is not on the screen because magnification is active.

obtain

public static AccessibilityNodeInfo obtain (View root, 
                int virtualDescendantId)

This method was deprecated in API level 33.
Object pooling has been discontinued. Create a new instance using the constructor AccessibilityNodeInfo(View,int) instead.

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

obtain

public static AccessibilityNodeInfo obtain (AccessibilityNodeInfo info)

This method was deprecated in API level 33.
Object pooling has been discontinued. Create a new instance using the constructor AccessibilityNodeInfo(AccessibilityNodeInfo) instead.

Instantiates a new AccessibilityNodeInfo initialized from the given info.

obtain

public static AccessibilityNodeInfo obtain ()

This method was deprecated in API level 33.
Object pooling has been discontinued. Create a new instance using the constructor AccessibilityNodeInfo() instead.

Instantiates a new AccessibilityNodeInfo.

obtain

public static AccessibilityNodeInfo obtain (View source)

This method was deprecated in API level 33.
Object pooling has been discontinued. Create a new instance using the constructor AccessibilityNodeInfo(View) instead.

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

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.

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.

recycle

public void recycle ()

This method was deprecated in API level 33.
Object pooling has been discontinued. Calling this function now will have no effect.

Would previously return an instance back to be reused.

refresh

public boolean refresh ()

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

refreshWithExtraData

public boolean refreshWithExtraData (String extraDataKey, 
                Bundle args)

Refreshes this info with the latest state of the view it represents, and request new data be added by the View.

removeAction

public boolean removeAction (AccessibilityNodeInfo.AccessibilityAction action)

Removes an action that can be performed on the node. If the action was not already added to the node, calling this method has no effect.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

removeAction

public void removeAction (int action)

This method was deprecated in API level 21.
Use removeAction(AccessibilityAction)

Removes an action that can be performed on the node. If the action was not already added to the node, calling this method has no effect.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

removeChild

public boolean removeChild (View root, 
                int virtualDescendantId)

Removes a virtual child which is a descendant of the given root. If the child was not previously added to the node, calling this method has no effect.

removeChild

public boolean removeChild (View child)

Removes a child. If the child was not previously added to the node, calling this method has no effect.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

removeLabeledBy

public boolean removeLabeledBy (View root, 
                int virtualDescendantId)

Removes a label which is a virtual descendant of the given root. If virtualDescendantId is View.NO_ID the root is set as the label. If the label was not previously added to the node, calling this method has no effect.

removeLabeledBy

public boolean removeLabeledBy (View label)

Removes a label. If the label was not previously added to the node, calling this method has no effect.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

setAccessibilityDataSensitive

public void setAccessibilityDataSensitive (boolean accessibilityDataSensitive)

Sets whether this node's accessibility data is considered sensitive.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

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.

The UI element updating this property should send an event of AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED or AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED if its accessibility-focused state changes.

setAvailableExtraData

public void setAvailableExtraData (List<String> extraDataKeys)

Set the extra data available for this node.

Note: When a View passes in a non-empty list, it promises that it will populate the node's extras with corresponding pieces of information in View.addExtraDataToAccessibilityNodeInfo(AccessibilityNodeInfo,String,Bundle).

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

setBoundsInParent

public void setBoundsInParent (Rect bounds)

This method was deprecated in API level 29.
Accessibility services should not care about these bounds.

Sets the node bounds in the viewParent's coordinates. getParent() does not represent the source's viewParent. Instead it represents the result of View.getParentForAccessibility(), which returns the closest ancestor where View.isImportantForAccessibility() is true. So this method is not reliable.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

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.

setBoundsInWindow

public void setBoundsInWindow (Rect bounds)

Sets the node bounds in window coordinates.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

setCanOpenPopup

public void setCanOpenPopup (boolean opensPopup)

Sets if this node opens a popup or a dialog.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

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.

setChecked

public void setChecked (boolean checked)

This method was deprecated in API level 36.
Use setChecked(int) instead.

Sets whether this node is checked. This is only meaningful when isCheckable() returns true.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

See also:

• setCheckable(boolean)
• isCheckable()
• getChecked()

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.

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.

setCollectionInfo

public void setCollectionInfo (AccessibilityNodeInfo.CollectionInfo collectionInfo)

Sets the collection info if the node is a collection. A collection child is always a collection item.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

setCollectionItemInfo

public void setCollectionItemInfo (AccessibilityNodeInfo.CollectionItemInfo collectionItemInfo)

Sets the collection item info if the node is a collection item. A collection item is always a child of a collection.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

setContainerTitle

public void setContainerTitle (CharSequence containerTitle)

Sets the container title for app-developer-defined container which can be any type of ViewGroup or layout. Container title will be used to group together related controls, similar to HTML fieldset. Or container title may identify a large piece of the UI that is visibly grouped together, such as a toolbar or a card, etc.

Container title helps to assist in navigation across containers and other groups. For example, a screen reader may use this to determine where to put accessibility focus.

Container title is different from pane titlesetPaneTitle(CharSequence) which indicates that the node represents a window or activity.

Example: An app can set container titles on several non-modal menus, containing TextViews or ImageButtons that have content descriptions, text, etc. Screen readers can quickly switch accessibility focus among menus instead of child views. Other accessibility-services can easily find the menu.

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.

setContentInvalid

public void setContentInvalid (boolean contentInvalid)

Sets if the content of this node is invalid. For example, a date is not well-formed.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

setContextClickable

public void setContextClickable (boolean contextClickable)

Sets whether this node is context clickable.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

setDismissable

public void setDismissable (boolean dismissable)

Sets if the node can be dismissed.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

setDrawingOrder

public void setDrawingOrder (int drawingOrderInParent)

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

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

setEditable

public void setEditable (boolean editable)

Sets whether this node is editable.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

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.

setError

public void setError (CharSequence error)

Sets the error text of this node.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.