AccessibilityNodeInfoCompat

Kotlin |Java

open class AccessibilityNodeInfoCompat

kotlin.Any
↳	androidx.core.view.accessibility.AccessibilityNodeInfoCompat

Helper for accessing android.view.accessibility.AccessibilityNodeInfo in a backwards compatible fashion.

Summary

Nested classes
open	`AccessibilityActionCompat` A class defining an action that can be performed on an `AccessibilityNodeInfo`.
open	`CollectionInfoCompat` Class with information if a node is a collection.
open	`CollectionItemInfoCompat` Class with information if a node is a collection item.
open	`RangeInfoCompat` Class with information if a node is a range.
	`TouchDelegateInfoCompat` Class with information of touch delegated views and regions.

Constants
static Int	`ACTION_ACCESSIBILITY_FOCUS` Action that gives accessibility focus to the node.
static String	`ACTION_ARGUMENT_COLUMN_INT` Argument for specifying the collection column to make visible on screen.
static String	`ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN` Argument for whether when moving at granularity to extend the selection or to move it otherwise.
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 String	`ACTION_ARGUMENT_MOVE_WINDOW_X` Argument for specifying the x coordinate to which to move a window.
static String	`ACTION_ARGUMENT_MOVE_WINDOW_Y` Argument for specifying the y coordinate to which to move a window.
static String	`ACTION_ARGUMENT_PRESS_AND_HOLD_DURATION_MILLIS_INT` Argument to represent the duration in milliseconds to press and hold a node.
static String	`ACTION_ARGUMENT_PROGRESS_VALUE` Argument for specifying the progress value to set.
static String	`ACTION_ARGUMENT_ROW_INT` Argument for specifying the collection row to make visible on screen.
static String	`ACTION_ARGUMENT_SELECTION_END_INT` Argument for specifying the selection end.
static String	`ACTION_ARGUMENT_SELECTION_START_INT` Argument for specifying the selection start.
static String	`ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE` Argument for specifying the text content to set
static Int	`ACTION_CLEAR_ACCESSIBILITY_FOCUS` Action that clears accessibility focus of the node.
static Int	`ACTION_CLEAR_FOCUS` Action that unfocuses 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_COLLAPSE` Action to collapse an expandable node.
static Int	`ACTION_COPY` Action to copy the current selection to the clipboard.
static Int	`ACTION_CUT` Action to cut the current selection and place it to the clipboard.
static Int	`ACTION_DISMISS` Action to dismiss a dismissable node.
static Int	`ACTION_EXPAND` Action to expand an expandable node.
static Int	`ACTION_FOCUS` Action that focuses 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_PASTE` Action to paste the current clipboard content.
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	`ACTION_SET_SELECTION` Action to set the selection.
static Int	`ACTION_SET_TEXT` Action that sets the text of the node.
static Int	`FOCUS_ACCESSIBILITY` The accessibility focus.
static Int	`FOCUS_INPUT` The input focus.
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.

Public constructors
`<init>(info: Any!)` Creates a new instance wrapping an `android.view.accessibility.AccessibilityNodeInfo`.

Public methods
open Unit	`addAction(action: Int)` Adds an action that can be performed on the node.
open Unit	`addAction(action: AccessibilityNodeInfoCompat.AccessibilityActionCompat!)` Adds an action that can be performed on the node.
open Unit	`addChild(child: View!)` Adds a child.
open Unit	`addChild(root: View!, virtualDescendantId: Int)` Adds a virtual child which is a descendant of the given `root`.
open Boolean	`canOpenPopup()` Gets if this node opens a popup or a dialog.
open Boolean	`equals(other: Any?)`
open MutableList<AccessibilityNodeInfoCompat!>!	`findAccessibilityNodeInfosByText(text: String!)` Finds `android.view.accessibility.AccessibilityNodeInfo`s by text.
open MutableList<AccessibilityNodeInfoCompat!>!	`findAccessibilityNodeInfosByViewId(viewId: String!)` Finds `AccessibilityNodeInfoCompat`s by the fully qualified view id's resource name where a fully qualified id is of the from "package:id/id_resource_name".
open AccessibilityNodeInfoCompat!	`findFocus(focus: Int)` Find the view that has the specified focus type.
open AccessibilityNodeInfoCompat!	`focusSearch(direction: Int)` Searches for the nearest view in the specified direction that can take input focus.
open MutableList<AccessibilityNodeInfoCompat.AccessibilityActionCompat!>!	`getActionList()` Gets the actions that can be performed on the node.
open Int	`getActions()` Gets the actions that can be performed on the node.
open Unit	`getBoundsInParent(outBounds: Rect!)` Gets the node bounds in the viewParent's coordinates.
open Unit	`getBoundsInScreen(outBounds: Rect!)` Gets the node bounds in screen coordinates.
open AccessibilityNodeInfoCompat!	`getChild(index: Int)` Get the child at given index.
open Int	`getChildCount()` Gets the number of children.
open CharSequence!	`getClassName()` Gets the class this node comes from.
open AccessibilityNodeInfoCompat.CollectionInfoCompat!	`getCollectionInfo()` Gets the collection info if the node is a collection.
open AccessibilityNodeInfoCompat.CollectionItemInfoCompat!	`getCollectionItemInfo()` Gets the collection item info if the node is a collection item.
open CharSequence!	`getContentDescription()` Gets the content description of this node.
open Int	`getDrawingOrder()` Get the drawing order of the view corresponding it this node.
open CharSequence!	`getError()` Gets the error text of this node.
open Bundle!	`getExtras()` Gets an optional bundle with extra data.
open CharSequence?	`getHintText()` Gets the hint text of this node.
open Any!	`getInfo()`
open Int	`getInputType()` Gets the input type of the source as defined by `InputType`.
open AccessibilityNodeInfoCompat!	`getLabelFor()` Gets the node info for which the view represented by this info serves as a label for accessibility purposes.
open AccessibilityNodeInfoCompat!	`getLabeledBy()` Gets the node info which serves as the label of the view represented by this info for accessibility purposes.
open Int	`getLiveRegion()` Gets the node's live region mode.
open Int	`getMaxTextLength()` Returns the maximum text length for this node.
open Int	`getMovementGranularities()` Gets the movement granularities for traversing the text of this node.
open CharSequence!	`getPackageName()` Gets the package this node comes from.
open CharSequence?	`getPaneTitle()` Get the title of the pane represented by this node.
open AccessibilityNodeInfoCompat!	`getParent()` Gets the parent.
open AccessibilityNodeInfoCompat.RangeInfoCompat!	`getRangeInfo()` Gets the range info if this node is a range.
open CharSequence?	`getRoleDescription()` Gets the custom role description.
open CharSequence?	`getStateDescription()` Gets the state description of this node.
open CharSequence!	`getText()` Gets the text of this node.
open Int	`getTextSelectionEnd()` Gets the text selection end.
open Int	`getTextSelectionStart()` Gets the text selection start.
open CharSequence?	`getTooltipText()` Gets the tooltip text of this node.
open AccessibilityNodeInfoCompat.TouchDelegateInfoCompat?	`getTouchDelegateInfo()` Get the `TouchDelegateInfoCompat` for touch delegate behavior with the represented view.
open AccessibilityNodeInfoCompat!	`getTraversalAfter()` Gets the node after which this one is visited in accessibility traversal.
open AccessibilityNodeInfoCompat!	`getTraversalBefore()` Gets the node before which this one is visited during traversal.
open String!	`getViewIdResourceName()` Gets the fully qualified resource name of the source view's id.
open AccessibilityWindowInfoCompat!	`getWindow()` Gets the window to which this node belongs.
open Int	`getWindowId()` Gets the id of the window from which the info comes from.
open Int	`hashCode()`
open Boolean	`isAccessibilityFocused()` Gets whether this node is accessibility focused.
open Boolean	`isCheckable()` Gets whether this node is checkable.
open Boolean	`isChecked()` Gets whether this node is checked.
open Boolean	`isClickable()` Gets whether this node is clickable.
open Boolean	`isContentInvalid()` Gets if the content of this node is invalid.
open Boolean	`isContextClickable()` Gets whether this node is context clickable.
open Boolean	`isDismissable()` Gets if the node can be dismissed.
open Boolean	`isEditable()` Gets if the node is editable.
open Boolean	`isEnabled()` Gets whether this node is enabled.
open Boolean	`isFocusable()` Gets whether this node is focusable.
open Boolean	`isFocused()` Gets whether this node is focused.
open Boolean	`isHeading()` Returns whether node represents a heading.
open Boolean	`isImportantForAccessibility()` Returns whether the node originates from a view considered important for accessibility.
open Boolean	`isLongClickable()` Gets whether this node is long clickable.
open Boolean	`isMultiLine()` Gets if the node is a multi line editable text.
open Boolean	`isPassword()` Gets whether this node is a password.
open Boolean	`isScreenReaderFocusable()` Returns whether the node is explicitly marked as a focusable unit by a screen reader.
open Boolean	`isScrollable()` Gets if the node is scrollable.
open Boolean	`isSelected()` Gets whether this node is selected.
open Boolean	`isShowingHintText()` Returns whether the node's text represents a hint for the user to enter text.
open Boolean	`isTextEntryKey()` Returns whether node represents a text entry key that is part of a keyboard or keypad.
open Boolean	`isVisibleToUser()` Gets whether this node is visible to the user.
open static AccessibilityNodeInfoCompat!	`obtain(source: View!)` Returns a cached instance if such is available otherwise a new one and sets the source.
open static AccessibilityNodeInfoCompat!	`obtain(root: View!, virtualDescendantId: Int)` Returns a cached instance if such is available otherwise a new one and sets the source.
open static AccessibilityNodeInfoCompat!	`obtain()` Returns a cached instance if such is available otherwise a new one.
open static AccessibilityNodeInfoCompat!	`obtain(info: AccessibilityNodeInfoCompat!)` Returns a cached instance if such is available or a new one is create.
open Boolean	`performAction(action: Int)` Performs an action on the node.
open Boolean	`performAction(action: Int, arguments: Bundle!)` Performs an action on the node.
open Unit	`recycle()` Return an instance back to be reused.
open Boolean	`refresh()` Refreshes this info with the latest state of the view it represents.
open Boolean	`removeAction(action: AccessibilityNodeInfoCompat.AccessibilityActionCompat!)` Removes an action that can be performed on the node.
open Boolean	`removeChild(child: View!)` Removes a child.
open Boolean	`removeChild(root: View!, virtualDescendantId: Int)` Removes a virtual child which is a descendant of the given `root`.
open Unit	`setAccessibilityFocused(focused: Boolean)` Sets whether this node is accessibility focused.
open Unit	`setBoundsInParent(bounds: Rect!)` Sets the node bounds in the viewParent's coordinates.
open Unit	`setBoundsInScreen(bounds: Rect!)` Sets the node bounds in screen coordinates.
open Unit	`setCanOpenPopup(opensPopup: Boolean)` Sets if this node opens a popup or a dialog.
open Unit	`setCheckable(checkable: Boolean)` Sets whether this node is checkable.
open Unit	`setChecked(checked: Boolean)` Sets whether this node is checked.
open Unit	`setClassName(className: CharSequence!)` Sets the class this node comes from.
open Unit	`setClickable(clickable: Boolean)` Sets whether this node is clickable.
open Unit	`setCollectionInfo(collectionInfo: Any!)`
open Unit	`setCollectionItemInfo(collectionItemInfo: Any!)`
open Unit	`setContentDescription(contentDescription: CharSequence!)` Sets the content description of this node.
open Unit	`setContentInvalid(contentInvalid: Boolean)` Sets if the content of this node is invalid.
open Unit	`setContextClickable(contextClickable: Boolean)` Sets whether this node is context clickable.
open Unit	`setDismissable(dismissable: Boolean)` Sets if the node can be dismissed.
open Unit	`setDrawingOrder(drawingOrderInParent: Int)` Set the drawing order of the view corresponding it this node.
open Unit	`setEditable(editable: Boolean)` Sets whether this node is editable.
open Unit	`setEnabled(enabled: Boolean)` Sets whether this node is enabled.
open Unit	`setError(error: CharSequence!)` Sets the error text of this node.
open Unit	`setFocusable(focusable: Boolean)` Sets whether this node is focusable.
open Unit	`setFocused(focused: Boolean)` Sets whether this node is focused.
open Unit	`setHeading(isHeading: Boolean)` Sets whether the node represents a heading.
open Unit	`setHintText(@Nullable hintText: CharSequence?)` Sets the hint text of this node.
open Unit	`setImportantForAccessibility(important: Boolean)` Sets whether the node is considered important for accessibility.
open Unit	`setInputType(inputType: Int)` Sets the input type of the source as defined by `InputType`.
open Unit	`setLabelFor(labeled: View!)` Sets the view for which the view represented by this info serves as a label for accessibility purposes.
open Unit	`setLabelFor(root: View!, virtualDescendantId: Int)` Sets the view for which the view represented by this info serves as a label for accessibility purposes.
open Unit	`setLabeledBy(label: View!)` Sets the view which serves as the label of the view represented by this info for accessibility purposes.
open Unit	`setLabeledBy(root: View!, virtualDescendantId: Int)` Sets the view which serves as the label of the view represented by this info for accessibility purposes.
open Unit	`setLiveRegion(mode: Int)` Sets the node's live region mode.
open Unit	`setLongClickable(longClickable: Boolean)` Sets whether this node is long clickable.
open Unit	`setMaxTextLength(max: Int)` Sets the maximum text length, or -1 for no limit.
open Unit	`setMovementGranularities(granularities: Int)` Sets the movement granularities for traversing the text of this node.
open Unit	`setMultiLine(multiLine: Boolean)` Sets if the node is a multi line editable text.
open Unit	`setPackageName(packageName: CharSequence!)` Sets the package this node comes from.
open Unit	`setPaneTitle(@Nullable paneTitle: CharSequence?)` 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.
open Unit	`setParent(parent: View!)` Sets the parent.
open Unit	`setParent(root: View!, virtualDescendantId: Int)` Sets the parent to be a virtual descendant of the given `root`.
open Unit	`setPassword(password: Boolean)` Sets whether this node is a password.
open Unit	`setRangeInfo(rangeInfo: AccessibilityNodeInfoCompat.RangeInfoCompat!)` Sets the range info if this node is a range.
open Unit	`setRoleDescription(@Nullable roleDescription: CharSequence?)` Sets the custom role description.
open Unit	`setScreenReaderFocusable(screenReaderFocusable: Boolean)` Sets whether the node should be considered a focusable unit by a screen reader.
open Unit	`setScrollable(scrollable: Boolean)` Sets if the node is scrollable.
open Unit	`setSelected(selected: Boolean)` Sets whether this node is selected.
open Unit	`setShowingHintText(showingHintText: Boolean)` Sets whether the node's text represents a hint for the user to enter text.
open Unit	`setSource(source: View!)` Sets the source.
open Unit	`setSource(root:`