belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1
AccessibilityNodeProviderCompat
public
class
AccessibilityNodeProviderCompat
extends Object
java.lang.Object | |
↳ | android.support.v4.view.accessibility.AccessibilityNodeProviderCompat |
Helper for accessing AccessibilityNodeProvider
.
Summary
Constants | |
---|---|
int |
HOST_VIEW_ID
The virtual id for the hosting View. |
Public constructors | |
---|---|
AccessibilityNodeProviderCompat()
Creates a new instance. |
|
AccessibilityNodeProviderCompat(Object provider)
Creates a new instance wrapping an
|
Public methods | |
---|---|
AccessibilityNodeInfoCompat
|
createAccessibilityNodeInfo(int virtualViewId)
Returns an |
List<AccessibilityNodeInfoCompat>
|
findAccessibilityNodeInfosByText(String text, int virtualViewId)
Finds |
AccessibilityNodeInfoCompat
|
findFocus(int focus)
Find the virtual view, i.e. |
Object
|
getProvider()
|
boolean
|
performAction(int virtualViewId, int action, Bundle arguments)
Performs an accessibility action on a virtual view, i.e. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
Constants
HOST_VIEW_ID
int HOST_VIEW_ID
The virtual id for the hosting View.
Constant Value: -1 (0xffffffff)
Public constructors
AccessibilityNodeProviderCompat
AccessibilityNodeProviderCompat ()
Creates a new instance.
AccessibilityNodeProviderCompat
AccessibilityNodeProviderCompat (Object provider)
Creates a new instance wrapping an
AccessibilityNodeProvider
.
Parameters | |
---|---|
provider |
Object : The provider.
|
Public methods
createAccessibilityNodeInfo
AccessibilityNodeInfoCompat createAccessibilityNodeInfo (int virtualViewId)
Returns an AccessibilityNodeInfoCompat
representing a virtual view,
i.e. a descendant of the host View, with the given virtualViewId
or the host View itself if virtualViewId
equals to HOST_VIEW_ID
.
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.
The implementer is responsible for obtaining an accessibility node info from the pool of reusable instances and setting the desired properties of the node info before returning it.
Parameters | |
---|---|
virtualViewId |
int : A client defined virtual view id. |
Returns | |
---|---|
AccessibilityNodeInfoCompat |
A populated AccessibilityNodeInfoCompat for a virtual descendant
or the host View. |
See also:
findAccessibilityNodeInfosByText
List<AccessibilityNodeInfoCompat> findAccessibilityNodeInfosByText (String text, int virtualViewId)
Finds AccessibilityNodeInfoCompat
s by text. The match is case insensitive
containment. The search is relative to the virtual view, i.e. a descendant of the
host View, with the given virtualViewId
or the host View itself
virtualViewId
equals to HOST_VIEW_ID
.
Parameters | |
---|---|
text |
String : The searched text. |
virtualViewId |
int : A client defined virtual view id which defined
the root of the tree in which to perform the search. |
Returns | |
---|---|
List<AccessibilityNodeInfoCompat> |
A list of node info. |
findFocus
AccessibilityNodeInfoCompat findFocus (int focus)
Find the virtual view, i.e. a descendant of the host View, that has the specified focus type.
Parameters | |
---|---|
focus |
int : The focus to find. One of
FOCUS_INPUT or
FOCUS_ACCESSIBILITY . |
Returns | |
---|---|
AccessibilityNodeInfoCompat |
The node info of the focused view or null. |
See also:
getProvider
Object getProvider ()
Returns | |
---|---|
Object |
The wrapped AccessibilityNodeProvider .
|
performAction
boolean performAction (int virtualViewId, int action, Bundle arguments)
Performs an accessibility action on a virtual view, i.e. a descendant of the
host View, with the given virtualViewId
or the host View itself
if virtualViewId
equals to HOST_VIEW_ID
.
Parameters | |
---|---|
virtualViewId |
int : A client defined virtual view id. |
action |
int : The action to perform. |
arguments |
Bundle : Optional arguments. |
Returns | |
---|---|
boolean |
True if the action was performed. |
Interfaces
Classes
- AccessibilityEventCompat
- AccessibilityManagerCompat
- AccessibilityManagerCompat.AccessibilityStateChangeListenerCompat
- AccessibilityNodeInfoCompat
- AccessibilityNodeInfoCompat.AccessibilityActionCompat
- AccessibilityNodeInfoCompat.CollectionInfoCompat
- AccessibilityNodeInfoCompat.CollectionItemInfoCompat
- AccessibilityNodeInfoCompat.RangeInfoCompat
- AccessibilityNodeProviderCompat
- AccessibilityRecordCompat
- AccessibilityWindowInfoCompat