Package org.robolectric.shadows

Class ShadowAccessibilityNodeInfo

java.lang.Object

org.robolectric.shadows.ShadowAccessibilityNodeInfo

@Implements(android.view.accessibility.AccessibilityNodeInfo.class)
public class ShadowAccessibilityNodeInfo
extends Object

Properties of AccessibilityNodeInfo that are normally locked may be changed using test APIs.

Calls to obtain() and recycle() are tracked to help spot bugs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShadowAccessibilityNodeInfo.OnPerformActionListener
static class	ShadowAccessibilityNodeInfo.ShadowSelectionPosition	Shadow class for android.view.accessibility.AccessibilityNodeInfo$SelectionPosition.

Constructor Summary

Constructors

Constructor	Description
ShadowAccessibilityNodeInfo()

Method Summary

Modifier and Type	Method	Description
void	addChild(AccessibilityNodeInfo child)	Add a child node to this one.
protected void	addChild(View child)
protected void	addChild(View root, int virtualDescendantId)
protected void	addLabeledBy(View label)	Adds a node that labels this node.
boolean	equals(Object object)	Equality check based on reference equality of the Views from which these instances were created, or the equality of their assigned IDs.
protected AccessibilityNodeInfo	getChild(int index)
protected int	getChildCount()
protected AccessibilityNodeInfo	getLabeledBy()
protected List<AccessibilityNodeInfo>	getLabeledByList()	Returns the list of nodes that label this node.
protected AccessibilityNodeInfo	getLabelFor()
protected AccessibilityNodeInfo	getParent()
List<Integer>	getPerformedActions()
List<Pair<Integer,Bundle>>	getPerformedActionsWithArgs()
protected Object	getSelection()
protected CharSequence	getText()
protected int	getTextSelectionEnd()
protected int	getTextSelectionStart()
protected AccessibilityNodeInfo	getTraversalAfter()
protected AccessibilityNodeInfo	getTraversalBefore()
protected AccessibilityWindowInfo	getWindow()
protected int	getWindowId()	Returns the id of the window from which the info comes.
protected static AccessibilityNodeInfo	obtain()
protected static AccessibilityNodeInfo	obtain(AccessibilityNodeInfo info)
protected static AccessibilityNodeInfo	obtain(View view)
protected static AccessibilityNodeInfo	obtain(View root, int virtualDescendantId)
protected boolean	performAction(int action)
protected boolean	performAction(int action, Bundle arguments)
protected void	recycle()
protected boolean	refresh()
static void	resetObtainedInstances()
void	setAccessibilityWindowInfo(AccessibilityWindowInfo info)
void	setLabeledBy(AccessibilityNodeInfo info)
void	setLabelFor(AccessibilityNodeInfo info)
void	setOnPerformActionListener(ShadowAccessibilityNodeInfo.OnPerformActionListener listener)	Configure the return result of an action if it is performed
protected void	setQueryFromAppProcessEnabled(View view, boolean enabled)	After AccessibilityNodeInfo.setQueryFromAppProcessEnabled(View, boolean) is called, we will have direct access to the real AccessibilityNodeInfo hierarchy, so we want all future interactions with ANI to use the real object.
void	setRefreshReturnValue(boolean refreshReturnValue)
protected void	setSelection(Object selection)
protected void	setSource(View source)
protected void	setSource(View root, int virtualDescendantId)
protected void	setText(CharSequence t)
protected void	setTextSelection(int start, int end)
void	setTraversalAfter(AccessibilityNodeInfo info)	Sets the view whose node is visited after this one in accessibility traversal.
protected void	setTraversalAfter(View view, int virtualDescendantId)
void	setTraversalBefore(AccessibilityNodeInfo info)	Sets the view before whose node this one should be visited during traversal.
protected void	setTraversalBefore(View info, int virtualDescendantId)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShadowAccessibilityNodeInfo

public ShadowAccessibilityNodeInfo()

Method Details

obtain

@Implementation
protected static AccessibilityNodeInfo obtain(AccessibilityNodeInfo info)

obtain

@Implementation
protected static AccessibilityNodeInfo obtain(View view)

obtain

@Implementation
protected static AccessibilityNodeInfo obtain(View root,
 int virtualDescendantId)

obtain

@Implementation
protected static AccessibilityNodeInfo obtain()

resetObtainedInstances

@Resetter
public static void resetObtainedInstances()

recycle

@Implementation
protected void recycle()

getChildCount

@Implementation
protected int getChildCount()

getChild

@Implementation
protected AccessibilityNodeInfo getChild(int index)

getParent

@Implementation
protected AccessibilityNodeInfo getParent()

refresh

@Implementation
protected boolean refresh()

setRefreshReturnValue

public void setRefreshReturnValue(boolean refreshReturnValue)

setText

@Filter(order=AFTER)
protected void setText(CharSequence t)

getText

@Implementation
protected CharSequence getText()

getTextSelectionStart

@Implementation(minSdk=37)
protected int getTextSelectionStart()

getTextSelectionEnd

@Implementation(minSdk=37)
protected int getTextSelectionEnd()

setTextSelection

@Implementation(minSdk=37)
protected void setTextSelection(int start,
 int end)

setSelection

@Implementation(minSdk=37)
protected void setSelection(Object selection)

getSelection

@Implementation(minSdk=37)
protected Object getSelection()

getLabelFor

@Implementation
protected AccessibilityNodeInfo getLabelFor()

setLabelFor

public void setLabelFor(AccessibilityNodeInfo info)

getLabeledBy

@Implementation
protected AccessibilityNodeInfo getLabeledBy()

setLabeledBy

public void setLabeledBy(AccessibilityNodeInfo info)

addLabeledBy

@Implementation(minSdk=36)
protected void addLabeledBy(View label)

Adds a node that labels this node.

If useRealAni() returns true, this method adds the given view that labels this node to the real AccessibilityNodeInfo. Otherwise, it adds the ANI node of the given view to `labeledByList`.

If one wishes to use a real ANI node in a test, which is a recommended practice, below is a test snippet:

 Activity activity = Robolectric.buildActivity(Activity.class).setup().get();
 LinearLayout layout = new LinearLayout(activity);
 layout.setOrientation(LinearLayout.VERTICAL);
 TextView label1 = new TextView(activity);
 label1.setText("Label 1");
 layout.addView(label1);
 TextView label2 = new TextView(activity);
 label2.setText("Label 2");
 layout.addView(label2);
 activity.setContentView(layout);
 View view = activity.getWindow().getDecorView();
 AccessibilityNodeInfo node = new AccessibilityNodeInfo();
 node.setQueryFromAppProcessEnabled(view, true);
 node.addLabeledBy(label1);
 node.addLabeledBy(label2);
 List<AccessibilityNodeInfo> labeledByList = node.getLabeledByList();
 

See Also:

• getLabeledByList()

getLabeledByList

@Implementation(minSdk=36)
protected List<AccessibilityNodeInfo> getLabeledByList()

Returns the list of nodes that label this node.

If useRealAni() returns true, this method returns the list of nodes that label this node from the real AccessibilityNodeInfo. Otherwise, returns `labeledByList`.

See Also:

• addLabeledBy(View)

getTraversalAfter

@Implementation
protected AccessibilityNodeInfo getTraversalAfter()

setTraversalAfter

@Implementation
protected void setTraversalAfter(View view,
 int virtualDescendantId)

setTraversalAfter

public void setTraversalAfter(AccessibilityNodeInfo info)

Sets the view whose node is visited after this one in accessibility traversal.

This may be useful for configuring traversal order in tests before the corresponding views have been inflated.

Parameters:

info - The previous node.

See Also:

• getTraversalAfter()

getTraversalBefore

@Implementation
protected AccessibilityNodeInfo getTraversalBefore()

setTraversalBefore

@Implementation
protected void setTraversalBefore(View info,
 int virtualDescendantId)

setTraversalBefore

public void setTraversalBefore(AccessibilityNodeInfo info)

Sets the view before whose node this one should be visited during traversal.

This may be useful for configuring traversal order in tests before the corresponding views have been inflated.

Parameters:

info - The view providing the preceding node.

See Also:

• getTraversalBefore()

setSource

@Filter(order=AFTER)
protected void setSource(View source)

setSource

@Filter(order=AFTER)
protected void setSource(View root,
 int virtualDescendantId)

getWindow

@Implementation
protected AccessibilityWindowInfo getWindow()

getWindowId

@Implementation
protected int getWindowId()

Returns the id of the window from which the info comes.

setAccessibilityWindowInfo

public void setAccessibilityWindowInfo(AccessibilityWindowInfo info)

performAction

@Implementation
protected boolean performAction(int action)

performAction

@Implementation
protected boolean performAction(int action,
 Bundle arguments)

equals

@Implementation
public boolean equals(Object object)

Equality check based on reference equality of the Views from which these instances were created, or the equality of their assigned IDs.

Overrides:

equals in class Object

addChild

public void addChild(AccessibilityNodeInfo child)

Add a child node to this one. Also initializes the parent field of the child.

Parameters:

child - The node to be added as a child.

addChild

@Filter(order=AFTER)
protected void addChild(View child)

addChild

@Filter(order=AFTER)
protected void addChild(View root,
 int virtualDescendantId)

getPerformedActions

public List<Integer> getPerformedActions()

Returns:

The list of arguments for the various calls to performAction. Unmodifiable.

getPerformedActionsWithArgs

public List<Pair<Integer,Bundle>> getPerformedActionsWithArgs()

Returns:

The list of arguments for the various calls to performAction. Unmodifiable.

setQueryFromAppProcessEnabled

@Filter(minSdk=34,
        order=AFTER)
protected void setQueryFromAppProcessEnabled(View view,
 boolean enabled)

After AccessibilityNodeInfo.setQueryFromAppProcessEnabled(View, boolean) is called, we will have direct access to the real AccessibilityNodeInfo hierarchy, so we want all future interactions with ANI to use the real object.

setOnPerformActionListener

public void setOnPerformActionListener(ShadowAccessibilityNodeInfo.OnPerformActionListener listener)

Configure the return result of an action if it is performed

Parameters:

listener - The listener.