android.support.v4.view.accessibility
Class AccessibilityNodeInfoCompat

java.lang.Object
  android.support.v4.view.accessibility.AccessibilityNodeInfoCompat

public class AccessibilityNodeInfoCompat
extends Object

Helper for accessing AccessibilityNodeInfo introduced after API level 4 in a backwards compatible fashion.

Field Summary

static int	ACTION_CLEAR_FOCUS Action that unfocuses the node.
static int	ACTION_CLEAR_SELECTION Action that unselects the node.
static int	ACTION_FOCUS Action that focuses the node.
static int	ACTION_SELECT Action that selects the node.

Constructor Summary

AccessibilityNodeInfoCompat(Object info)

Method Summary

void	addAction(int action) Adds an action that can be performed on the node.
void	addChild(android.view.View child) Adds a child.
boolean	equals(Object obj)
List<AccessibilityNodeInfoCompat>	findAccessibilityNodeInfosByText(String text) Finds AccessibilityNodeInfos by text.
int	getActions() Gets the actions that can be performed on the node.
void	getBoundsInParent(android.graphics.Rect outBounds) Gets the node bounds in parent coordinates.
void	getBoundsInScreen(android.graphics.Rect outBounds) Gets the node bounds in screen coordinates.
AccessibilityNodeInfoCompat	getChild(int index) Get the child at given index.
int	getChildCount() Gets the number of children.
CharSequence	getClassName() Gets the class this node comes from.
CharSequence	getContentDescription() Gets the content description of this node.
Object	getImpl()
CharSequence	getPackageName() Gets the package this node comes from.
AccessibilityNodeInfoCompat	getParent() Gets the parent.
CharSequence	getText() Gets the text of this node.
int	getWindowId() Gets the id of the window from which the info comes from.
int	hashCode()
boolean	isCheckable() Gets whether this node is checkable.
boolean	isChecked() Gets whether this node is checked.
boolean	isClickable() Gets whether this node is clickable.
boolean	isEnabled() Gets whether this node is enabled.
boolean	isFocusable() Gets whether this node is focusable.
boolean	isFocused() Gets whether this node is focused.
boolean	isLongClickable() Gets whether this node is long clickable.
boolean	isPassword() Gets whether this node is a password.
boolean	isScrollable() Gets if the node is scrollable.
boolean	isSelected() Gets whether this node is selected.
static AccessibilityNodeInfoCompat	obtain() Returns a cached instance if such is available otherwise a new one.
static AccessibilityNodeInfoCompat	obtain(AccessibilityNodeInfoCompat info) Returns a cached instance if such is available or a new one is create.
static AccessibilityNodeInfoCompat	obtain(android.view.View source) Returns a cached instance if such is available otherwise a new one and sets the source.
boolean	performAction(int action) Performs an action on the node.
void	recycle() Return an instance back to be reused.
void	setBoundsInParent(android.graphics.Rect bounds) Sets the node bounds in parent coordinates.
void	setBoundsInScreen(android.graphics.Rect bounds) Sets the node bounds in screen coordinates.
void	setCheckable(boolean checkable) Sets whether this node is checkable.
void	setChecked(boolean checked) Sets whether this node is checked.
void	setClassName(CharSequence className) Sets the class this node comes from.
void	setClickable(boolean clickable) Sets whether this node is clickable.
void	setContentDescription(CharSequence contentDescription) Sets the content description of this node.
void	setEnabled(boolean enabled) Sets whether this node is enabled.
void	setFocusable(boolean focusable) Sets whether this node is focusable.
void	setFocused(boolean focused) Sets whether this node is focused.
void	setLongClickable(boolean longClickable) Sets whether this node is long clickable.
void	setPackageName(CharSequence packageName) Sets the package this node comes from.
void	setParent(android.view.View parent) Sets the parent.
void	setPassword(boolean password) Sets whether this node is a password.
void	setScrollable(boolean scrollable) Sets if the node is scrollable.
void	setSelected(boolean selected) Sets whether this node is selected.
void	setSource(android.view.View source) Sets the source.
void	setText(CharSequence text) Sets the text of this node.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_FOCUS

public static final int ACTION_FOCUS

Action that focuses the node.

See Also:

Constant Field Values

ACTION_CLEAR_FOCUS

public static final int ACTION_CLEAR_FOCUS

Action that unfocuses the node.

See Also:

Constant Field Values

ACTION_SELECT

public static final int ACTION_SELECT

Action that selects the node.

See Also:

Constant Field Values

ACTION_CLEAR_SELECTION

public static final int ACTION_CLEAR_SELECTION

Action that unselects the node.

See Also:

Constant Field Values

Constructor Detail

AccessibilityNodeInfoCompat

public AccessibilityNodeInfoCompat(Object info)

Method Detail

getImpl

public Object getImpl()

Returns:

The wrapped actual implementation.

obtain

public static AccessibilityNodeInfoCompat obtain(android.view.View source)

Returns a cached instance if such is available otherwise a new one and sets the source.

Returns:

An instance.

See Also:

setSource(View)

obtain

public static AccessibilityNodeInfoCompat obtain()

Returns a cached instance if such is available otherwise a new one.

Returns:

An instance.

obtain

public static AccessibilityNodeInfoCompat obtain(AccessibilityNodeInfoCompat info)

Returns a cached instance if such is available or a new one is create. The returned instance is initialized from the given info.

Parameters:

info - The other info.

Returns:

An instance.

setSource

public void setSource(android.view.View source)

Sets the source.

Parameters:

source - The info source.

getWindowId

public int getWindowId()

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

Returns:

The window id.

getChildCount

public int getChildCount()

Gets the number of children.

Returns:

The child count.

getChild

public AccessibilityNodeInfoCompat getChild(int index)

Get the child at given index.

Note: It is a client responsibility to recycle the received info by calling recycle() to avoid creating of multiple instances.

Parameters:

index - The child index.

Returns:

The child node.

Throws:

IllegalStateException - If called outside of an AccessibilityService.

addChild

public void addChild(android.view.View child)

Adds a child.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

child - The child.

Throws:

IllegalStateException - If called from an AccessibilityService.

getActions

public int getActions()

Gets the actions that can be performed on the node.

Returns:

The bit mask of with actions.

See Also:

AccessibilityNodeInfo.ACTION_FOCUS, AccessibilityNodeInfo.ACTION_CLEAR_FOCUS, AccessibilityNodeInfo.ACTION_SELECT, AccessibilityNodeInfo.ACTION_CLEAR_SELECTION

addAction

public void addAction(int action)

Adds an action that can be performed on the node.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

action - The action.

Throws:

IllegalStateException - If called from an AccessibilityService.

performAction

public boolean performAction(int action)

Performs an action on the node.

Note: An action can be performed only if the request is made from an AccessibilityService.

Parameters:

action - The action to perform.

Returns:

True if the action was performed.

Throws:

IllegalStateException - If called outside of an AccessibilityService.

findAccessibilityNodeInfosByText

public List<AccessibilityNodeInfoCompat> findAccessibilityNodeInfosByText(String text)

Finds AccessibilityNodeInfos by text. The match is case insensitive containment. The search is relative to this info i.e. this info is the root of the traversed tree.

Note: It is a client responsibility to recycle the received info by calling AccessibilityNodeInfo.recycle() to avoid creating of multiple instances.

Parameters:

text - The searched text.

Returns:

A list of node info.

getParent

public AccessibilityNodeInfoCompat getParent()

Gets the parent.

Note: It is a client responsibility to recycle the received info by calling AccessibilityNodeInfo.recycle() to avoid creating of multiple instances.

Returns:

The parent.

setParent

public void setParent(android.view.View parent)

Sets the parent.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

parent - The parent.

Throws:

IllegalStateException - If called from an AccessibilityService.

getBoundsInParent

public void getBoundsInParent(android.graphics.Rect outBounds)

Gets the node bounds in parent coordinates.

Parameters:

outBounds - The output node bounds.

setBoundsInParent

public void setBoundsInParent(android.graphics.Rect bounds)

Sets the node bounds in parent coordinates.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

bounds - The node bounds.

Throws:

IllegalStateException - If called from an AccessibilityService.

getBoundsInScreen

public void getBoundsInScreen(android.graphics.Rect outBounds)

Gets the node bounds in screen coordinates.

Parameters:

outBounds - The output node bounds.

setBoundsInScreen

public void setBoundsInScreen(android.graphics.Rect bounds)

Sets the node bounds in screen coordinates.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

bounds - The node bounds.

Throws:

IllegalStateException - If called from an AccessibilityService.

isCheckable

public boolean isCheckable()

Gets whether this node is checkable.

Returns:

True if the node is checkable.

setCheckable

public void setCheckable(boolean checkable)

Sets whether this node is checkable.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

checkable - True if the node is checkable.

Throws:

IllegalStateException - If called from an AccessibilityService.

isChecked

public boolean isChecked()

Gets whether this node is checked.

Returns:

True if the node is checked.

setChecked

public void setChecked(boolean checked)

Sets whether this node is checked.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

checked - True if the node is checked.

Throws:

IllegalStateException - If called from an AccessibilityService.

isFocusable

public boolean isFocusable()

Gets whether this node is focusable.

Returns:

True if the node is focusable.

setFocusable

public void setFocusable(boolean focusable)

Sets whether this node is focusable.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

focusable - True if the node is focusable.

Throws:

IllegalStateException - If called from an AccessibilityService.

isFocused

public boolean isFocused()

Gets whether this node is focused.

Returns:

True if the node is focused.

setFocused

public void setFocused(boolean focused)

Sets whether this node is focused.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

focused - True if the node is focused.

Throws:

IllegalStateException - If called from an AccessibilityService.

isSelected

public boolean isSelected()

Gets whether this node is selected.

Returns:

True if the node is selected.

setSelected

public void setSelected(boolean selected)

Sets whether this node is selected.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

selected - True if the node is selected.

Throws:

IllegalStateException - If called from an AccessibilityService.

isClickable

public boolean isClickable()

Gets whether this node is clickable.

Returns:

True if the node is clickable.

setClickable

public void setClickable(boolean clickable)

Sets whether this node is clickable.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

clickable - True if the node is clickable.

Throws:

IllegalStateException - If called from an AccessibilityService.

isLongClickable

public boolean isLongClickable()

Gets whether this node is long clickable.

Returns:

True if the node is long clickable.

setLongClickable

public void setLongClickable(boolean longClickable)

Sets whether this node is long clickable.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

longClickable - True if the node is long clickable.

Throws:

IllegalStateException - If called from an AccessibilityService.

isEnabled

public boolean isEnabled()

Gets whether this node is enabled.

Returns:

True if the node is enabled.

setEnabled

public void setEnabled(boolean enabled)

Sets whether this node is enabled.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

enabled - True if the node is enabled.

Throws:

IllegalStateException - If called from an AccessibilityService.

isPassword

public boolean isPassword()

Gets whether this node is a password.

Returns:

True if the node is a password.

setPassword

public void setPassword(boolean password)

Sets whether this node is a password.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

password - True if the node is a password.

Throws:

IllegalStateException - If called from an AccessibilityService.

isScrollable

public boolean isScrollable()

Gets if the node is scrollable.

Returns:

True if the node is scrollable, false otherwise.

setScrollable

public void setScrollable(boolean scrollable)

Sets if the node is scrollable.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

scrollable - True if the node is scrollable, false otherwise.

Throws:

IllegalStateException - If called from an AccessibilityService.

getPackageName

public CharSequence getPackageName()

Gets the package this node comes from.

Returns:

The package name.

setPackageName

public void setPackageName(CharSequence packageName)

Sets the package this node comes from.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

packageName - The package name.

Throws:

IllegalStateException - If called from an AccessibilityService.

getClassName

public CharSequence getClassName()

Gets the class this node comes from.

Returns:

The class name.

setClassName

public void setClassName(CharSequence className)

Sets the class this node comes from.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

className - The class name.

Throws:

IllegalStateException - If called from an AccessibilityService.

getText

public CharSequence getText()

Gets the text of this node.

Returns:

The text.

setText

public void setText(CharSequence text)

Sets the text of this node.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

text - The text.

Throws:

IllegalStateException - If called from an AccessibilityService.

getContentDescription

public CharSequence getContentDescription()

Gets the content description of this node.

Returns:

The content description.

setContentDescription

public void setContentDescription(CharSequence contentDescription)

Sets the content description of this node.

Note: Cannot be called from an AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Parameters:

contentDescription - The content description.

Throws:

IllegalStateException - If called from an AccessibilityService.

recycle

public void recycle()

Return an instance back to be reused.

Note: You must not touch the object after calling this function.

Throws:

IllegalStateException - If the info is already recycled.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object