public class AccessibilityRecordCompat extends Object
AccessibilityRecord
introduced after API level 4 in a backwards compatible fashion.Constructor and Description |
---|
AccessibilityRecordCompat(Object record)
Deprecated.
This is not type safe. If you want to modify an
AccessibilityEvent 's properties defined in
AccessibilityRecord use
AccessibilityEventCompat.asRecord(AccessibilityEvent) . This method will be removed
in a subsequent release of the support library. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
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()
Deprecated.
This method will be removed in a subsequent release of
the support library.
|
int |
getItemCount()
Gets the number of items that can be visited.
|
int |
getMaxScrollX()
Gets the max scroll offset of the source left edge in pixels.
|
int |
getMaxScrollY()
Gets the max scroll offset of the source top edge in pixels.
|
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()
Returns a hash code value for the object.
|
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 |
setMaxScrollX(int maxScrollX)
Sets the max scroll offset of the source left edge in pixels.
|
void |
setMaxScrollY(int maxScrollY)
Sets the max scroll offset of the source top edge in pixels.
|
void |
setParcelableData(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(View source)
Sets the event source.
|
void |
setSource(View root,
int virtualDescendantId)
Sets the source to be a virtual descendant of the given
root . |
void |
setToIndex(int toIndex)
Sets the index of text selection end or the index of the last
visible item when scrolling.
|
@Deprecated public AccessibilityRecordCompat(Object record)
AccessibilityEvent
's properties defined in
AccessibilityRecord
use
AccessibilityEventCompat.asRecord(AccessibilityEvent)
. This method will be removed
in a subsequent release of the support library.@Deprecated public Object getImpl()
public static AccessibilityRecordCompat obtain(AccessibilityRecordCompat record)
public static AccessibilityRecordCompat obtain()
public void setSource(View source)
source
- The source.IllegalStateException
- If called from an AccessibilityService.public void setSource(View root, int virtualDescendantId)
root
.
If virtualDescendantId
equals to View.NO_ID
the root
is set as the source.
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.
root
- The root of the virtual subtree.virtualDescendantId
- The id of the virtual descendant.public AccessibilityNodeInfoCompat getSource()
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.
public int getWindowId()
public boolean isChecked()
public void setChecked(boolean isChecked)
isChecked
- True if the view is checked, false otherwise.IllegalStateException
- If called from an AccessibilityService.public boolean isEnabled()
public void setEnabled(boolean isEnabled)
isEnabled
- True if the view is enabled, false otherwise.IllegalStateException
- If called from an AccessibilityService.public boolean isPassword()
public void setPassword(boolean isPassword)
isPassword
- True if the view is a password field, false otherwise.IllegalStateException
- If called from an AccessibilityService.public boolean isFullScreen()
public void setFullScreen(boolean isFullScreen)
isFullScreen
- True if the source is full screen, false otherwise.IllegalStateException
- If called from an AccessibilityService.public boolean isScrollable()
public void setScrollable(boolean scrollable)
scrollable
- True if the source is scrollable, false otherwise.IllegalStateException
- If called from an AccessibilityService.public int getItemCount()
public void setItemCount(int itemCount)
itemCount
- The number of items.IllegalStateException
- If called from an AccessibilityService.public int getCurrentItemIndex()
public void setCurrentItemIndex(int currentItemIndex)
currentItemIndex
- The current item index.IllegalStateException
- If called from an AccessibilityService.public int getFromIndex()
public void setFromIndex(int fromIndex)
fromIndex
- The index of the first character or selection
start or the first visible item.IllegalStateException
- If called from an AccessibilityService.public int getToIndex()
public void setToIndex(int toIndex)
toIndex
- The index of selection end or last item index.public int getScrollX()
public void setScrollX(int scrollX)
scrollX
- The scroll.public int getScrollY()
public void setScrollY(int scrollY)
scrollY
- The scroll.public int getMaxScrollX()
public void setMaxScrollX(int maxScrollX)
maxScrollX
- The max scroll.public int getMaxScrollY()
public void setMaxScrollY(int maxScrollY)
maxScrollY
- The max scroll.public int getAddedCount()
public void setAddedCount(int addedCount)
addedCount
- The number of added characters.IllegalStateException
- If called from an AccessibilityService.public int getRemovedCount()
public void setRemovedCount(int removedCount)
removedCount
- The number of removed characters.IllegalStateException
- If called from an AccessibilityService.public CharSequence getClassName()
public void setClassName(CharSequence className)
className
- The lass name.IllegalStateException
- If called from an AccessibilityService.public List<CharSequence> getText()
public CharSequence getBeforeText()
public void setBeforeText(CharSequence beforeText)
beforeText
- The text before the change.IllegalStateException
- If called from an AccessibilityService.public CharSequence getContentDescription()
public void setContentDescription(CharSequence contentDescription)
contentDescription
- The description.IllegalStateException
- If called from an AccessibilityService.public Parcelable getParcelableData()
Parcelable
data.public void setParcelableData(Parcelable parcelableData)
Parcelable
data of the event.parcelableData
- The parcelable data.IllegalStateException
- If called from an AccessibilityService.public void recycle()
Note: You must not touch the object after calling this function.
IllegalStateException
- If the record is already recycled.public int hashCode()
Object
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.
Object.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.)
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public boolean equals(Object obj)
Object
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.
equals
in class Object
obj
- the reference object with which to compare.true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
HashMap