public
static
final
class
AccessibilityNodeInfo.AccessibilityAction
extends Object
java.lang.Object | |
↳ | android.view.accessibility.AccessibilityNodeInfo.AccessibilityAction |
A class defining an action that can be performed on an AccessibilityNodeInfo
.
Each action has a unique id that is mandatory and optional data.
There are three categories of actions:
ACTION_FOCUS
.
ACTION_CLICK
action to announce that this action clears browsing history.
Actions are typically added to an AccessibilityNodeInfo
by using
addAction(AccessibilityAction)
within
onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
and are performed
within performAccessibilityAction(int, Bundle)
.
Note: Views which support these actions should invoke
setImportantForAccessibility(int)
with
IMPORTANT_FOR_ACCESSIBILITY_YES
to ensure an AccessibilityService
can discover the set of supported actions.
Fields | |
---|---|
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_ACCESSIBILITY_FOCUS
Action that gives accessibility focus to the node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_CLEAR_ACCESSIBILITY_FOCUS
Action that clears accessibility focus of the node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_CLEAR_FOCUS
Action that clears input focus of the node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_CLEAR_SELECTION
Action that deselects the node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_CLICK
Action that clicks on the node info. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_COLLAPSE
Action to collapse an expandable node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_CONTEXT_CLICK
Action that context clicks the node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_COPY
Action to copy the current selection to the clipboard. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_CUT
Action to cut the current selection and place it to the clipboard. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_DISMISS
Action to dismiss a dismissable node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_EXPAND
Action to expand an expandable node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_FOCUS
Action that gives input focus to the node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_LONG_CLICK
Action that long clicks on the node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
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
AccessibilityNodeInfo.AccessibilityAction |
ACTION_NEXT_HTML_ELEMENT
Action to move to the next HTML element of a given type. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_PASTE
Action to paste the current clipboard content. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
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
AccessibilityNodeInfo.AccessibilityAction |
ACTION_PREVIOUS_HTML_ELEMENT
Action to move to the previous HTML element of a given type. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SCROLL_BACKWARD
Action to scroll the node content backward. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SCROLL_DOWN
Action to scroll the node content down. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SCROLL_FORWARD
Action to scroll the node content forward. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SCROLL_LEFT
Action to scroll the node content left. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SCROLL_RIGHT
Action to scroll the node content right. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SCROLL_TO_POSITION
Action that scrolls the node to make the specified collection position visible on screen. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SCROLL_UP
Action to scroll the node content up. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SELECT
Action that selects the node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SET_PROGRESS
Action that sets progress between |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SET_SELECTION
Action to set the selection. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SET_TEXT
Action that sets the text of the node. |
public
static
final
AccessibilityNodeInfo.AccessibilityAction |
ACTION_SHOW_ON_SCREEN
Action that requests the node make its bounding rectangle visible on the screen, scrolling if necessary just enough. |
Public constructors | |
---|---|
AccessibilityNodeInfo.AccessibilityAction(int actionId, CharSequence label)
Creates a new AccessibilityAction. |
Public methods | |
---|---|
boolean
|
equals(Object other)
Indicates whether some other object is "equal to" this one. |
int
|
getId()
Gets the id for this action. |
CharSequence
|
getLabel()
Gets the label for this action. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
AccessibilityNodeInfo.AccessibilityAction ACTION_ACCESSIBILITY_FOCUS
Action that gives accessibility focus to the node.
AccessibilityNodeInfo.AccessibilityAction ACTION_CLEAR_ACCESSIBILITY_FOCUS
Action that clears accessibility focus of the node.
AccessibilityNodeInfo.AccessibilityAction ACTION_CLEAR_FOCUS
Action that clears input focus of the node.
AccessibilityNodeInfo.AccessibilityAction ACTION_CLEAR_SELECTION
Action that deselects the node.
AccessibilityNodeInfo.AccessibilityAction ACTION_CLICK
Action that clicks on the node info.
AccessibilityNodeInfo.AccessibilityAction ACTION_COLLAPSE
Action to collapse an expandable node.
AccessibilityNodeInfo.AccessibilityAction ACTION_CONTEXT_CLICK
Action that context clicks the node.
AccessibilityNodeInfo.AccessibilityAction ACTION_COPY
Action to copy the current selection to the clipboard.
AccessibilityNodeInfo.AccessibilityAction ACTION_CUT
Action to cut the current selection and place it to the clipboard.
AccessibilityNodeInfo.AccessibilityAction ACTION_DISMISS
Action to dismiss a dismissable node.
AccessibilityNodeInfo.AccessibilityAction ACTION_EXPAND
Action to expand an expandable node.
AccessibilityNodeInfo.AccessibilityAction ACTION_FOCUS
Action that gives input focus to the node.
AccessibilityNodeInfo.AccessibilityAction ACTION_LONG_CLICK
Action that long clicks on the node.
AccessibilityNodeInfo.AccessibilityAction 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:
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(AccessibilityAction.ACTION_NEXT_AT_MOVEMENT_GRANULARITY.getId(),
arguments);
AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT
,
AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN
Example: Move to the previous character and do not extend selection.
See also:
AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT
AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN
AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN
AccessibilityNodeInfo.getMovementGranularities()
AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER
AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD
AccessibilityNodeInfo.MOVEMENT_GRANULARITY_LINE
AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH
AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PAGE
AccessibilityNodeInfo.AccessibilityAction 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:
Bundle arguments = new Bundle();
arguments.putString(AccessibilityNodeInfo.ACTION_ARGUMENT_HTML_ELEMENT_STRING, "BUTTON");
info.performAction(AccessibilityAction.ACTION_NEXT_HTML_ELEMENT.getId(), arguments);
AccessibilityNodeInfo.ACTION_ARGUMENT_HTML_ELEMENT_STRING
Example:
AccessibilityNodeInfo.AccessibilityAction ACTION_PASTE
Action to paste the current clipboard content.
AccessibilityNodeInfo.AccessibilityAction 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:
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(AccessibilityAction.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY.getId(),
arguments);
AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT
,
AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN
Example: Move to the next character and do not extend selection.
See also:
AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT
AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN
AccessibilityNodeInfo.setMovementGranularities(int)
AccessibilityNodeInfo.getMovementGranularities()
AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER
AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD
AccessibilityNodeInfo.MOVEMENT_GRANULARITY_LINE
AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH
AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PAGE
AccessibilityNodeInfo.AccessibilityAction 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:
Bundle arguments = new Bundle();
arguments.putString(AccessibilityNodeInfo.ACTION_ARGUMENT_HTML_ELEMENT_STRING, "BUTTON");
info.performAction(AccessibilityAction.ACTION_PREVIOUS_HTML_ELEMENT.getId(), arguments);
AccessibilityNodeInfo.ACTION_ARGUMENT_HTML_ELEMENT_STRING
Example:
AccessibilityNodeInfo.AccessibilityAction ACTION_SCROLL_BACKWARD
Action to scroll the node content backward.
AccessibilityNodeInfo.AccessibilityAction ACTION_SCROLL_DOWN
Action to scroll the node content down.
AccessibilityNodeInfo.AccessibilityAction ACTION_SCROLL_FORWARD
Action to scroll the node content forward.
AccessibilityNodeInfo.AccessibilityAction ACTION_SCROLL_LEFT
Action to scroll the node content left.
AccessibilityNodeInfo.AccessibilityAction ACTION_SCROLL_RIGHT
Action to scroll the node content right.
AccessibilityNodeInfo.AccessibilityAction ACTION_SCROLL_TO_POSITION
Action that scrolls the node to make the specified collection position visible on screen.
Arguments:
AccessibilityNodeInfo.AccessibilityAction ACTION_SCROLL_UP
Action to scroll the node content up.
AccessibilityNodeInfo.AccessibilityAction ACTION_SELECT
Action that selects the node.
AccessibilityNodeInfo.AccessibilityAction ACTION_SET_PROGRESS
Action that sets progress between RangeInfo.getMin()
and
RangeInfo.getMax()
. It should use the same value type as
RangeInfo.getType()
Arguments:
ACTION_ARGUMENT_PROGRESS_VALUE
See also:
AccessibilityNodeInfo.AccessibilityAction ACTION_SET_SELECTION
Action to set the selection. Performing this action with no arguments clears the selection.
Arguments:
Bundle arguments = new Bundle();
arguments.putInt(AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_START_INT, 1);
arguments.putInt(AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_END_INT, 2);
info.performAction(AccessibilityAction.ACTION_SET_SELECTION.getId(), arguments);
AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_START_INT
,
AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_END_INT
Example:
AccessibilityNodeInfo.AccessibilityAction 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:
Bundle arguments = new Bundle();
arguments.putCharSequence(AccessibilityNodeInfo.ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE,
"android");
info.performAction(AccessibilityAction.ACTION_SET_TEXT.getId(), arguments);
AccessibilityNodeInfo.ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE
Example:
AccessibilityNodeInfo.AccessibilityAction ACTION_SHOW_ON_SCREEN
Action that requests the node make its bounding rectangle visible on the screen, scrolling if necessary just enough.
See also:
AccessibilityNodeInfo.AccessibilityAction (int actionId, CharSequence label)
Creates a new AccessibilityAction. For adding a standard action without a specific label, use the static constants. You can also override the description for one the standard actions. Below is an example how to override the standard click action by adding a custom label:
AccessibilityAction action = new AccessibilityAction( AccessibilityAction.ACTION_ACTION_CLICK, getLocalizedLabel()); node.addAction(action);
Parameters | |
---|---|
actionId |
int :
The id for this action. This should either be one of the
standard actions or a specific action for your app. In that case it is
required to use a resource identifier. |
label |
CharSequence :
The label for the new AccessibilityAction.
|
boolean equals (Object other)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
Parameters | |
---|---|
other |
Object :
the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
CharSequence getLabel ()
Gets the label for this action. Its purpose is to describe the action to user.
Returns | |
---|---|
CharSequence |
The label. |
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:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
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.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
JavaTM programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
String toString ()
Returns a string representation of the object. In general, the
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |