android.widget
Class RemoteViews

java.lang.Object
  android.widget.RemoteViews

All Implemented Interfaces:

Parcelable, LayoutInflater.Filter

public class RemoteViews
extends Object
implements Parcelable, LayoutInflater.Filter

A class that describes a view hierarchy that can be displayed in another process. The hierarchy is inflated from a layout resource file, and this class provides some basic operations for modifying the content of the inflated hierarchy.

Nested Class Summary

static class	RemoteViews.ActionException Exception to send when something goes wrong executing an action
static interface	RemoteViews.RemoteView This annotation indicates that a subclass of View is alllowed to be used with the RemoteViews mechanism.

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.Creator<T>

Field Summary

static Parcelable.Creator<RemoteViews>

CREATOR Parcelable.Creator that instantiates RemoteViews objects

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

RemoteViews(Parcel parcel)
Reads a RemoteViews object from a parcel.

RemoteViews(String packageName, int layoutId)
Create a new RemoteViews object that will display the views contained in the specified layout file.

Method Summary

View	apply(Context context, ViewGroup parent) Inflates the view hierarchy represented by this object and applies all of the actions.
int	describeContents() Describe the kinds of special objects contained in this Parcelable's marshalled representation.
int	getLayoutId()
String	getPackage()
boolean	onLoadClass(Class clazz) Hook to allow clients of the LayoutInflater to restrict the set of Views that are allowed to be inflated.
void	reapply(Context context, View v) Applies all of the actions to the provided view.
void	setChronometer(int viewId, long base, String format, boolean running) Equivalent to calling Chronometer.setBase, Chronometer.setFormat, and Chronometer.start() or Chronometer.stop().
void	setImageViewBitmap(int viewId, Bitmap bitmap) Equivalent to calling ImageView.setImageBitmap
void	setImageViewResource(int viewId, int srcId) Equivalent to calling ImageView.setImageResource
void	setImageViewUri(int viewId, Uri uri) Equivalent to calling ImageView.setImageURI
void	setProgressBar(int viewId, int max, int progress, boolean indeterminate) Equivalent to calling ProgressBar.setMax, ProgressBar.setProgress, and ProgressBar.setIndeterminate
void	setTextViewText(int viewId, CharSequence text) Equivalent to calling TextView.setText
void	setViewVisibility(int viewId, int visibility) Equivalent to calling View.setVisibility
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<RemoteViews> CREATOR

Parcelable.Creator that instantiates RemoteViews objects

Constructor Detail

RemoteViews

public RemoteViews(String packageName,
                   int layoutId)

Create a new RemoteViews object that will display the views contained in the specified layout file.

Parameters:

packageName - Name of the package that contains the layout resource

layoutId - The id of the layout resource

RemoteViews

public RemoteViews(Parcel parcel)

Reads a RemoteViews object from a parcel.

Parameters:

parcel -

Method Detail

getPackage

public String getPackage()

getLayoutId

public int getLayoutId()

setViewVisibility

public void setViewVisibility(int viewId,
                              int visibility)

Equivalent to calling View.setVisibility

Parameters:

viewId - The id of the view whose visibility should change

visibility - The new visibility for the view

setTextViewText

public void setTextViewText(int viewId,
                            CharSequence text)

Equivalent to calling TextView.setText

Parameters:

viewId - The id of the view whose text should change

text - The new text for the view

setImageViewResource

public void setImageViewResource(int viewId,
                                 int srcId)

Equivalent to calling ImageView.setImageResource

Parameters:

viewId - The id of the view whose drawable should change

srcId - The new resource id for the drawable

setImageViewUri

public void setImageViewUri(int viewId,
                            Uri uri)

Equivalent to calling ImageView.setImageURI

Parameters:

viewId - The id of the view whose drawable should change

uri - The Uri for the image

setImageViewBitmap

public void setImageViewBitmap(int viewId,
                               Bitmap bitmap)

Equivalent to calling ImageView.setImageBitmap

Parameters:

viewId - The id of the view whose drawable should change

bitmap - The new Bitmap for the drawable

setChronometer

public void setChronometer(int viewId,
                           long base,
                           String format,
                           boolean running)

Equivalent to calling Chronometer.setBase, Chronometer.setFormat, and Chronometer.start() or Chronometer.stop().

Parameters:

viewId - The id of the view whose text should change

base - The time at which the timer would have read 0:00. This time should be based off of SystemClock.elapsedRealtime().

format - The Chronometer format string, or null to simply display the timer value.

running - True if you want the clock to be running, false if not.

setProgressBar

public void setProgressBar(int viewId,
                           int max,
                           int progress,
                           boolean indeterminate)

Equivalent to calling ProgressBar.setMax, ProgressBar.setProgress, and ProgressBar.setIndeterminate

Parameters:

viewId - The id of the view whose text should change

max - The 100% value for the progress bar

progress - The current value of the progress bar.

indeterminate - True if the progress bar is indeterminate, false if not.

apply

public View apply(Context context,
                  ViewGroup parent)

Inflates the view hierarchy represented by this object and applies all of the actions.

Caller beware: this may throw

Parameters:

context - Default context to use

parent - Parent that the resulting view hierarchy will be attached to. This method does not attach the hierarchy. The caller should do so when appropriate.

Returns:

The inflated view hierarchy

reapply

public void reapply(Context context,
                    View v)

Applies all of the actions to the provided view.

Caller beware: this may throw

Parameters:

v - The view to apply the actions to. This should be the result of the apply(Context,ViewGroup) call.

onLoadClass

public boolean onLoadClass(Class clazz)

Description copied from interface: LayoutInflater.Filter

Hook to allow clients of the LayoutInflater to restrict the set of Views that are allowed to be inflated.

Specified by:

onLoadClass in interface LayoutInflater.Filter

Parameters:

clazz - The class object for the View that is about to be inflated

Returns:

True if this class is allowed to be inflated, or false otherwise

describeContents

public int describeContents()

Description copied from interface: Parcelable

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Specified by:

describeContents in interface Parcelable

Returns:

a bitmask indicating the set of special object types marshalled by the Parcelable.

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Description copied from interface: Parcelable

Flatten this object in to a Parcel.

Specified by:

writeToParcel in interface Parcelable

Parameters:

dest - The Parcel in which the object should be written.

flags - Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.