AccessibilityNodeInfoCompat.AccessibilityActionCompat

public static class AccessibilityNodeInfoCompat.AccessibilityActionCompat
extends Object

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


A class defining an action that can be performed on an AccessibilityNodeInfo. Each action has a unique id and a label.

There are three categories of actions:

  • Standard actions - These are actions that are reported and handled by the standard UI widgets in the platform. For each standard action there is a static constant defined in this class, e.g. ACTION_FOCUS. These actions will have null labels.
  • Custom actions action - These are actions that are reported and handled by custom widgets. i.e. ones that are not part of the UI toolkit. For example, an application may define a custom action for clearing the user history.
  • Overriden standard actions - These are actions that override standard actions to customize them. For example, an app may add a label to the standard ACTION_CLICK action to indicate to the user that this action clears browsing history.

Note: Views which support these actions should invoke View.setImportantForAccessibility(int) with View.IMPORTANT_FOR_ACCESSIBILITY_YES to ensure an AccessibilityService can discover the set of supported actions.

Summary

Fields

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_ACCESSIBILITY_FOCUS

Action that gives accessibility focus to the node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CLEAR_ACCESSIBILITY_FOCUS

Action that clears accessibility focus of the node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CLEAR_FOCUS

Action that clears input focus of the node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CLEAR_SELECTION

Action that deselects the node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CLICK

Action that clicks on the node info.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_COLLAPSE

Action to collapse an expandable node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CONTEXT_CLICK

Action that context clicks the node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_COPY

Action to copy the current selection to the clipboard.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CUT

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

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_DISMISS

Action to dismiss a dismissable node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_EXPAND

Action to expand an expandable node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_FOCUS

Action that gives input focus to the node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_HIDE_TOOLTIP

Action to hide a tooltip.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_IME_ENTER

Action to send an ime actionId which is from EditorInfo.actionId.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_LONG_CLICK

Action that long clicks on the node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_MOVE_WINDOW

Action to move a window to a new location.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_NEXT_AT_MOVEMENT_GRANULARITY

Action that requests to go to the next entity in this node's text at a given movement granularity.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_NEXT_HTML_ELEMENT

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

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_PAGE_DOWN

Action to move to the page below.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_PAGE_LEFT

Action to move to the page left.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_PAGE_RIGHT

Action to move to the page right.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_PAGE_UP

Action to move to the page above.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_PASTE

Action to paste the current clipboard content.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_PRESS_AND_HOLD

Action that presses and holds a node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY

Action that requests to go to the previous entity in this node's text at a given movement granularity.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_PREVIOUS_HTML_ELEMENT

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

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SCROLL_BACKWARD

Action to scroll the node content backward.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SCROLL_DOWN

Action to scroll the node content down.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SCROLL_FORWARD

Action to scroll the node content forward.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SCROLL_LEFT

Action to scroll the node content left.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SCROLL_RIGHT

Action to scroll the node content right.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SCROLL_TO_POSITION

Action that scrolls the node to make the specified collection position visible on screen.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SCROLL_UP

Action to scroll the node content up.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SELECT

Action that selects the node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SET_PROGRESS

Action that sets progress between RangeInfo.getMin() and RangeInfo.getMax().

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SET_SELECTION

Action to set the selection.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SET_TEXT

Action that sets the text of the node.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SHOW_ON_SCREEN

Action that requests the node make its bounding rectangle visible on the screen, scrolling if necessary just enough.

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_SHOW_TOOLTIP

Action to show a tooltip.

Public constructors

AccessibilityActionCompat(int actionId, CharSequence label)

Creates a new instance.

Public methods

boolean equals(Object obj)
int getId()

Gets the id for this action.

CharSequence getLabel()

Gets the label for this action.

int hashCode()

Inherited methods

Fields

ACTION_ACCESSIBILITY_FOCUS

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_ACCESSIBILITY_FOCUS

Action that gives accessibility focus to the node.

ACTION_CLEAR_ACCESSIBILITY_FOCUS

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CLEAR_ACCESSIBILITY_FOCUS

Action that clears accessibility focus of the node.

ACTION_CLEAR_FOCUS

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CLEAR_FOCUS

Action that clears input focus of the node.

ACTION_CLEAR_SELECTION

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CLEAR_SELECTION

Action that deselects the node.

ACTION_CLICK

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CLICK

Action that clicks on the node info.

ACTION_COLLAPSE

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_COLLAPSE

Action to collapse an expandable node.

ACTION_CONTEXT_CLICK

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CONTEXT_CLICK

Action that context clicks the node.

ACTION_COPY

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_COPY

Action to copy the current selection to the clipboard.

ACTION_CUT

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_CUT

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

ACTION_DISMISS

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_DISMISS

Action to dismiss a dismissable node.

ACTION_EXPAND

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_EXPAND

Action to expand an expandable node.

ACTION_FOCUS

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_FOCUS

Action that gives input focus to the node.

ACTION_HIDE_TOOLTIP

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_HIDE_TOOLTIP

Action to hide a tooltip. A node should expose this action only for views that are currently showing a tooltip.

ACTION_IME_ENTER

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_IME_ENTER

Action to send an ime actionId which is from EditorInfo.actionId. This ime actionId sets by TextView.setImeActionLabel(CharSequence, int), or it would be EditorInfo.IME_ACTION_UNSPECIFIED if no specific actionId has set. A node should expose this action only for views that are currently with input focus and editable.

ACTION_LONG_CLICK

public static final AccessibilityNodeInfoCompat.AccessibilityActionCompat ACTION_LONG_CLICK

Action that long clicks on the node.

ACTION_MOVE_WINDOW