# Print output for @column tags ?>
public
final
class
RemoteAction
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.app.RemoteAction |
Represents a remote action that can be called from another process. The action can have an associated visualization including metadata like an icon or title.
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<RemoteAction> |
CREATOR
|
Public constructors | |
---|---|
RemoteAction(Icon icon, CharSequence title, CharSequence contentDescription, PendingIntent intent)
|
Public methods | |
---|---|
RemoteAction
|
clone()
Creates and returns a copy of this object. |
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
void
|
dump(String prefix, PrintWriter pw)
|
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
PendingIntent
|
getActionIntent()
Return the action intent. |
CharSequence
|
getContentDescription()
Return a content description representing the action. |
Icon
|
getIcon()
Return an icon representing the action. |
CharSequence
|
getTitle()
Return an title representing the action. |
int
|
hashCode()
Returns a hash code value for the object. |
boolean
|
isEnabled()
Return whether this action is enabled. |
void
|
setEnabled(boolean enabled)
Sets whether this action is enabled. |
void
|
setShouldShowIcon(boolean shouldShowIcon)
Sets whether the icon should be shown. |
boolean
|
shouldShowIcon()
Return whether the icon should be shown. |
void
|
writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
public RemoteAction (Icon icon, CharSequence title, CharSequence contentDescription, PendingIntent intent)
Parameters | |
---|---|
icon |
Icon : This value cannot be null . |
title |
CharSequence : This value cannot be null . |
contentDescription |
CharSequence : This value cannot be null . |
intent |
PendingIntent : This value cannot be null . |
public RemoteAction clone ()
Creates and returns a copy of this object. The precise meaning
of "copy" may depend on the class of the object. The general
intent is that, for any object x
, the expression:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true
, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
true
, this is not an absolute requirement.
By convention, the returned object should be obtained by calling
super.clone
. If a class and all of its superclasses (except
Object
) obey this convention, it will be the case that
x.clone().getClass() == x.getClass()
.
By convention, the object returned by this method should be independent
of this object (which is being cloned). To achieve this independence,
it may be necessary to modify one or more fields of the object returned
by super.clone
before returning it. Typically, this means
copying any mutable objects that comprise the internal "deep structure"
of the object being cloned and replacing the references to these
objects with references to the copies. If a class contains only
primitive fields or references to immutable objects, then it is usually
the case that no fields in the object returned by super.clone
need to be modified.
The method clone
for class Object
performs a
specific cloning operation. First, if the class of this object does
not implement the interface Cloneable
, then a
CloneNotSupportedException
is thrown. Note that all arrays
are considered to implement the interface Cloneable
and that
the return type of the clone
method of an array type T[]
is T[]
where T is any reference or primitive type.
Otherwise, this method creates a new instance of the class of this
object and initializes all its fields with exactly the contents of
the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method
performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object
does not itself implement the interface
Cloneable
, so calling the clone
method on an object
whose class is Object
will result in throwing an
exception at run time.
Returns | |
---|---|
RemoteAction |
a clone of this instance. |
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 |
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:
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.
Parameters | |
---|---|
o |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
public PendingIntent getActionIntent ()
Return the action intent.
Returns | |
---|---|
PendingIntent |
This value cannot be null . |
public CharSequence getContentDescription ()
Return a content description representing the action.
Returns | |
---|---|
CharSequence |
This value cannot be null . |
public Icon getIcon ()
Return an icon representing the action.
Returns | |
---|---|
Icon |
This value cannot be null . |
public CharSequence getTitle ()
Return an title representing the action.
Returns | |
---|---|
CharSequence |
This value cannot be null . |
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:
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.
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
Java™ programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
public boolean isEnabled ()
Return whether this action is enabled.
Returns | |
---|---|
boolean |
public void setEnabled (boolean enabled)
Sets whether this action is enabled.
Parameters | |
---|---|
enabled |
boolean |
public void setShouldShowIcon (boolean shouldShowIcon)
Sets whether the icon should be shown.
Parameters | |
---|---|
shouldShowIcon |
boolean |
public boolean shouldShowIcon ()
Return whether the icon should be shown.
Returns | |
---|---|
boolean |
public void writeToParcel (Parcel out, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
out |
Parcel : The Parcel in which the object should be written. |
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 |