android.support.v4.view.accessibility
Class AccessibilityRecordCompat

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

public class AccessibilityRecordCompat
extends Object

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

Constructor Summary

AccessibilityRecordCompat(Object record)

Method Summary

boolean	equals(Object obj)
int	getAddedCount() Gets the number of added characters.
CharSequence	getBeforeText() Sets the text before a change.
CharSequence	getClassName() Gets the class name of the source.
CharSequence	getContentDescription() Gets the description of the source.
int	getCurrentItemIndex() Gets the index of the source in the list of items the can be visited.
int	getFromIndex() Gets the index of the first character of the changed sequence, or the beginning of a text selection or the index of the first visible item when scrolling.
Object	getImpl()
int	getItemCount() Gets the number of items that can be visited.
android.os.Parcelable	getParcelableData() Gets the Parcelable data.
int	getRemovedCount() Gets the number of removed characters.
int	getScrollX() Gets the scroll offset of the source left edge in pixels.
int	getScrollY() Gets the scroll offset of the source top edge in pixels.
AccessibilityNodeInfoCompat	getSource() Gets the AccessibilityNodeInfo of the event source.
List<CharSequence>	getText() Gets the text of the event.
int	getToIndex() Gets the index of text selection end or the index of the last visible item when scrolling.
int	getWindowId() Gets the id of the window from which the event comes from.
int	hashCode()
boolean	isChecked() Gets if the source is checked.
boolean	isEnabled() Gets if the source is enabled.
boolean	isFullScreen() Gets if the source is taking the entire screen.
boolean	isPassword() Gets if the source is a password field.
boolean	isScrollable() Gets if the source is scrollable.
static AccessibilityRecordCompat	obtain() Returns a cached instance if such is available or a new one is instantiated.
static AccessibilityRecordCompat	obtain(AccessibilityRecordCompat record) Returns a cached instance if such is available or a new one is instantiated.
void	recycle() Return an instance back to be reused.
void	setAddedCount(int addedCount) Sets the number of added characters.
void	setBeforeText(CharSequence beforeText) Sets the text before a change.
void	setChecked(boolean isChecked) Sets if the source is checked.
void	setClassName(CharSequence className) Sets the class name of the source.
void	setContentDescription(CharSequence contentDescription) Sets the description of the source.
void	setCurrentItemIndex(int currentItemIndex) Sets the index of the source in the list of items that can be visited.
void	setEnabled(boolean isEnabled) Sets if the source is enabled.
void	setFromIndex(int fromIndex) Sets the index of the first character of the changed sequence or the beginning of a text selection or the index of the first visible item when scrolling.
void	setFullScreen(boolean isFullScreen) Sets if the source is taking the entire screen.
void	setItemCount(int itemCount) Sets the number of items that can be visited.
void	setParcelableData(android.os.Parcelable parcelableData) Sets the Parcelable data of the event.
void	setPassword(boolean isPassword) Sets if the source is a password field.
void	setRemovedCount(int removedCount) Sets the number of removed characters.
void	setScrollable(boolean scrollable) Sets if the source is scrollable.
void	setScrollX(int scrollX) Sets the scroll offset of the source left edge in pixels.
void	setScrollY(int scrollY) Sets the scroll offset of the source top edge in pixels.
void	setSource(android.view.View source) Sets the event source.
void	setToIndex(int toIndex) Sets the index of text selection end or the index of the last visible item when scrolling.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessibilityRecordCompat

public AccessibilityRecordCompat(Object record)

Method Detail

getImpl

public Object getImpl()

Returns:

The wrapped implementation.

obtain

public static AccessibilityRecordCompat obtain(AccessibilityRecordCompat record)

Returns a cached instance if such is available or a new one is instantiated. The instance is initialized with data from the given record.

Returns:

An instance.

obtain

public static AccessibilityRecordCompat obtain()

Returns a cached instance if such is available or a new one is instantiated.

Returns:

An instance.

setSource

public void setSource(android.view.View source)

Sets the event source.

Parameters:

source - The source.

Throws:

IllegalStateException - If called from an AccessibilityService.

getSource

public AccessibilityNodeInfoCompat getSource()

Gets the AccessibilityNodeInfo of the event source.

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

Returns:

The info of the source.

getWindowId

public int getWindowId()

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

Returns:

The window id.

isChecked

public boolean isChecked()

Gets if the source is checked.

Returns:

True if the view is checked, false otherwise.

setChecked

public void setChecked(boolean isChecked)

Sets if the source is checked.

Parameters:

isChecked - True if the view is checked, false otherwise.

Throws:

IllegalStateException - If called from an AccessibilityService.

isEnabled

public boolean isEnabled()

Gets if the source is enabled.

Returns:

True if the view is enabled, false otherwise.

setEnabled

public void setEnabled(boolean isEnabled)

Sets if the source is enabled.

Parameters:

isEnabled - True if the view is enabled, false otherwise.

Throws:

IllegalStateException - If called from an AccessibilityService.

isPassword

public boolean isPassword()

Gets if the source is a password field.

Returns:

True if the view is a password field, false otherwise.

setPassword

public void setPassword(boolean isPassword)

Sets if the source is a password field.

Parameters:

isPassword - True if the view is a password field, false otherwise.

Throws:

IllegalStateException - If called from an AccessibilityService.

isFullScreen

public boolean isFullScreen()

Gets if the source is taking the entire screen.

Returns:

True if the source is full screen, false otherwise.

setFullScreen

public void setFullScreen(boolean isFullScreen)

Sets if the source is taking the entire screen.

Parameters:

isFullScreen - True if the source is full screen, false otherwise.

Throws:

IllegalStateException - If called from an AccessibilityService.

isScrollable

public boolean isScrollable()

Gets if the source is scrollable.

Returns:

True if the source is scrollable, false otherwise.

setScrollable

public void setScrollable(boolean scrollable)

Sets if the source is scrollable.

Parameters:

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

Throws:

IllegalStateException - If called from an AccessibilityService.

getItemCount

public int getItemCount()

Gets the number of items that can be visited.

Returns:

The number of items.

setItemCount

public void setItemCount(int itemCount)

Sets the number of items that can be visited.

Parameters:

itemCount - The number of items.

Throws:

IllegalStateException - If called from an AccessibilityService.

getCurrentItemIndex

public int getCurrentItemIndex()

Gets the index of the source in the list of items the can be visited.

Returns:

The current item index.

setCurrentItemIndex

public void setCurrentItemIndex(int currentItemIndex)

Sets the index of the source in the list of items that can be visited.

Parameters:

currentItemIndex - The current item index.

Throws:

IllegalStateException - If called from an AccessibilityService.

getFromIndex

public int getFromIndex()

Gets the index of the first character of the changed sequence, or the beginning of a text selection or the index of the first visible item when scrolling.

Returns:

The index of the first character or selection start or the first visible item.

setFromIndex

public void setFromIndex(int fromIndex)

Sets the index of the first character of the changed sequence or the beginning of a text selection or the index of the first visible item when scrolling.

Parameters:

fromIndex - The index of the first character or selection start or the first visible item.

Throws:

IllegalStateException - If called from an AccessibilityService.

getToIndex

public int getToIndex()

Gets the index of text selection end or the index of the last visible item when scrolling.

Returns:

The index of selection end or last item index.

setToIndex

public void setToIndex(int toIndex)

Sets the index of text selection end or the index of the last visible item when scrolling.

Parameters:

toIndex - The index of selection end or last item index.

getScrollX

public int getScrollX()

Gets the scroll offset of the source left edge in pixels.

Returns:

The scroll.

setScrollX

public void setScrollX(int scrollX)

Sets the scroll offset of the source left edge in pixels.

Parameters:

scrollX - The scroll.

getScrollY

public int getScrollY()

Gets the scroll offset of the source top edge in pixels.

Returns:

The scroll.

setScrollY

public void setScrollY(int scrollY)

Sets the scroll offset of the source top edge in pixels.

Parameters:

scrollY - The scroll.

getAddedCount

public int getAddedCount()

Gets the number of added characters.

Returns:

The number of added characters.

setAddedCount

public void setAddedCount(int addedCount)

Sets the number of added characters.

Parameters:

addedCount - The number of added characters.

Throws:

IllegalStateException - If called from an AccessibilityService.

getRemovedCount

public int getRemovedCount()

Gets the number of removed characters.

Returns:

The number of removed characters.

setRemovedCount

public void setRemovedCount(int removedCount)

Sets the number of removed characters.

Parameters:

removedCount - The number of removed characters.

Throws:

IllegalStateException - If called from an AccessibilityService.

getClassName

public CharSequence getClassName()

Gets the class name of the source.

Returns:

The class name.

setClassName

public void setClassName(CharSequence className)

Sets the class name of the source.

Parameters:

className - The lass name.

Throws:

IllegalStateException - If called from an AccessibilityService.

getText

public List<CharSequence> getText()

Gets the text of the event. The index in the list represents the priority of the text. Specifically, the lower the index the higher the priority.

Returns:

The text.

getBeforeText

public CharSequence getBeforeText()

Sets the text before a change.

Returns:

The text before the change.

setBeforeText

public void setBeforeText(CharSequence beforeText)

Sets the text before a change.

Parameters:

beforeText - The text before the change.

Throws:

IllegalStateException - If called from an AccessibilityService.

getContentDescription

public CharSequence getContentDescription()

Gets the description of the source.

Returns:

The description.

setContentDescription

public void setContentDescription(CharSequence contentDescription)

Sets the description of the source.

Parameters:

contentDescription - The description.

Throws:

IllegalStateException - If called from an AccessibilityService.

getParcelableData

public android.os.Parcelable getParcelableData()

Gets the Parcelable data.

Returns:

The parcelable data.

setParcelableData

public void setParcelableData(android.os.Parcelable parcelableData)

Sets the Parcelable data of the event.

Parameters:

parcelableData - The parcelable data.

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 record is already recycled.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object