InlineSuggestion
public
final
class
InlineSuggestion
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.view.inputmethod.InlineSuggestion |
This class represents an inline suggestion which is made by one app and can be embedded into the UI of another. Suggestions may contain sensitive information not known to the host app which needs to be protected from spoofing. To address that the suggestion view inflated on demand for embedding is created in such a way that the hosting app cannot introspect its content and cannot interact with it.
Summary
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<InlineSuggestion> |
CREATOR
|
Public methods | |
|---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
InlineSuggestionInfo
|
getInfo()
|
int
|
hashCode()
Returns a hash code value for the object. |
void
|
inflate(Context context, Size size, Executor callbackExecutor, Consumer<InlineContentView> callback)
Inflates a view with the content of this suggestion at a specific size. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Fields
Public methods
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(android.os.Parcel, int),
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR bit.
| Returns | |
|---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
equals
public boolean equals (Object o)
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation
on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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.
| Parameters | |
|---|---|
o |
Object: This value may be null. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getInfo
public InlineSuggestionInfo getInfo ()
| Returns | |
|---|---|
InlineSuggestionInfo |
This value cannot be null. |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)method, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
equals(java.lang.Object)method, then calling thehashCodemethod 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
Java™ programming language.)
| Returns | |
|---|---|
int |
a hash code value for this object. |
inflate
public void inflate (Context context, Size size, Executor callbackExecutor, Consumer<InlineContentView> callback)
Inflates a view with the content of this suggestion at a specific size.
Each dimension of the size must satisfy one of the following conditions:
- between
InlinePresentationSpec.getMinSize()andInlinePresentationSpec.getMaxSize()of the presentation spec frommInfo ViewGroup.LayoutParams#WRAP_CONTENT
ViewGroup.LayoutParams#WRAP_CONTENT, then the size of the inflated view will be just large
enough to fit the content, while still conforming to the min / max size specified by the
InlinePresentationSpec.
The caller can attach an View.OnClickListener and/or an
View.OnLongClickListener to the view in the callback to receive
click and long click events on the view.
| Parameters | |
|---|---|
context |
Context: Context in which to inflate the view.
This value cannot be null. |
size |
Size: The size at which to inflate the suggestion. For each dimension, it maybe an
exact value or ViewGroup.LayoutParams#WRAP_CONTENT.
This value cannot be null. |
callbackExecutor |
Executor: This value cannot be null.
Callback and listener events are dispatched through this
Executor, providing an easy way to control which thread is
used. To dispatch events through the main thread of your
application, you can use
Context.getMainExecutor().
To dispatch events through a shared thread pool, you can use
AsyncTask#THREAD_POOL_EXECUTOR. |
callback |
Consumer: Callback for receiving the inflated view, where the ViewGroup.LayoutParams of the view is set as the actual size of the
underlying remote view.
This value cannot be null. |
| Throws | |
|---|---|
IllegalArgumentException |
If an invalid argument is passed. |
IllegalStateException |
If this method is already called. |
toString
public String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel: This value cannot be null. |
flags |
int: Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |