RemoteViews  |  API reference  |  Android Developers (original) (raw)

public class RemoteViews
extends [Object](/reference/java/lang/Object) implements[LayoutInflater.Filter](/reference/android/view/LayoutInflater.Filter), [Parcelable](/reference/android/os/Parcelable)

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.

RemoteViews is limited to support for the following layouts:

• [AdapterViewFlipper](/reference/android/widget/AdapterViewFlipper)
• [FrameLayout](/reference/android/widget/FrameLayout)
• [GridLayout](/reference/android/widget/GridLayout)
• [GridView](/reference/android/widget/GridView)
• [LinearLayout](/reference/android/widget/LinearLayout)
• [ListView](/reference/android/widget/ListView)
• [RelativeLayout](/reference/android/widget/RelativeLayout)
• [StackView](/reference/android/widget/StackView)
• [ViewFlipper](/reference/android/widget/ViewFlipper)

And the following widgets:

• [AnalogClock](/reference/android/widget/AnalogClock)
• [Button](/reference/android/widget/Button)
• [Chronometer](/reference/android/widget/Chronometer)
• [ImageButton](/reference/android/widget/ImageButton)
• [ImageView](/reference/android/widget/ImageView)
• [ProgressBar](/reference/android/widget/ProgressBar)
• [TextClock](/reference/android/widget/TextClock)
• [TextView](/reference/android/widget/TextView)

As of API 31, the following widgets and layouts may also be used:

• [CheckBox](/reference/android/widget/CheckBox)
• [RadioButton](/reference/android/widget/RadioButton)
• [RadioGroup](/reference/android/widget/RadioGroup)
• [Switch](/reference/android/widget/Switch)

Descendants of these classes are not supported.

Summary

Constants

public static final String EXTRA_CHECKED

The intent extra for whether the view whose checked state changed is currently checked.

Constant Value: "android.widget.extra.CHECKED"

public static final String EXTRA_SHARED_ELEMENT_BOUNDS

The intent extra that contains the bounds for all shared elements.

Constant Value: "android.widget.extra.SHARED_ELEMENT_BOUNDS"

MARGIN_BOTTOM

public static final int MARGIN_BOTTOM

The value will apply to the marginBottom.

Constant Value: 3 (0x00000003)

MARGIN_END

public static final int MARGIN_END

The value will apply to the marginEnd.

Constant Value: 5 (0x00000005)

MARGIN_LEFT

public static final int MARGIN_LEFT

The value will apply to the marginLeft.

Constant Value: 0 (0x00000000)

MARGIN_RIGHT

public static final int MARGIN_RIGHT

The value will apply to the marginRight.

Constant Value: 2 (0x00000002)

MARGIN_START

public static final int MARGIN_START

The value will apply to the marginStart.

Constant Value: 4 (0x00000004)

MARGIN_TOP

public static final int MARGIN_TOP

The value will apply to the marginTop.

Constant Value: 1 (0x00000001)

Fields

CREATOR

public static final Creator<RemoteViews> CREATOR

Parcelable.Creator that instantiates RemoteViews objects

Public constructors

RemoteViews

public RemoteViews (Parcel parcel)

Reads a RemoteViews object from a parcel.

RemoteViews

public RemoteViews (RemoteViews src)

Creates a copy of another RemoteViews.

RemoteViews

public RemoteViews (RemoteViews landscape, RemoteViews portrait)

Create a new RemoteViews object that will inflate as the specified landspace or portrait RemoteViews, depending on the current configuration.

RemoteViews

public RemoteViews (RemoteViews.DrawInstructions drawInstructions)

Instantiates a RemoteViews object using [DrawInstructions](/reference/android/widget/RemoteViews.DrawInstructions), which serves as an alternative to XML layout. [DrawInstructions](/reference/android/widget/RemoteViews.DrawInstructions) objects contains the instructions which can be interpreted and rendered accordingly in the host process.

RemoteViews

public RemoteViews (String packageName, int layoutId)

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

RemoteViews

public RemoteViews (String packageName, int layoutId, int viewId)

Create a new RemoteViews object that will display the views contained in the specified layout file and change the id of the root view to the specified one.

RemoteViews

public RemoteViews (Map<SizeF, RemoteViews> remoteViews)

Create a new RemoteViews object that will inflate the layout with the closest size specification. The default remote views in that case is always the one with the smallest area. If the [RemoteViews](/reference/android/widget/RemoteViews) host provides the size of the view, the layout with the largest area that fits entirely in the provided size will be used (i.e. the width and height of the layout must be less than the size of the view, with a 1dp margin to account for rounding). If no layout fits in the view, the layout with the smallest area will be used.

Public methods

addStableView

public void addStableView (int viewId, RemoteViews nestedView, int stableId)

Equivalent to calling [ViewGroup.addView(View)](/reference/android/view/ViewGroup#addView%28android.view.View%29) after inflating the given[RemoteViews](/reference/android/widget/RemoteViews). If the [RemoteViews](/reference/android/widget/RemoteViews) may be re-inflated or updated,[removeAllViews(int)](/reference/android/widget/RemoteViews#removeAllViews%28int%29) must be called on the same viewId before the first call to this method for the behavior of this method to be predictable. The stableId will be used to identify a potential view to recycled when the remote view is inflated. Views can be re-used if inserted in the same order, potentially with some views appearing / disappearing. To be recycled the view must not change the layout used to inflate it or its view id (see [RemoteViews.RemoteViews(String, int, int)](/reference/android/widget/RemoteViews#RemoteViews%28java.lang.String,%20int,%20int%29)). Note: if a view is re-used, all the actions will be re-applied on it. However, its properties are not reset, so what was applied in previous round will have an effect. As a view may be re-created at any time by the host, the RemoteViews should not rely on keeping information from previous applications and always re-set all the properties they need.

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

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)](/reference/android/os/Parcelable#writeToParcel%28android.os.Parcel,%20int%29), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](/reference/android/os/Parcelable#CONTENTS%5FFILE%5FDESCRIPTOR) bit.

getLayoutId

public int getLayoutId ()

Returns the layout id of the root layout associated with this RemoteViews. In the case that the RemoteViews has both a landscape and portrait root, this will return the layout id associated with the portrait layout.

onLoadClass

public boolean onLoadClass (Class clazz)

This method is deprecated.
Used by system to enforce safe inflation of [RemoteViews](/reference/android/widget/RemoteViews). Apps should not override this method. Changing of this method will NOT affect the process where RemoteViews is rendered.

Used to restrict the views which can be inflated

removeAllViews

public void removeAllViews (int viewId)

Equivalent to calling [ViewGroup.removeAllViews()](/reference/android/view/ViewGroup#removeAllViews%28%29).

setAccessibilityTraversalAfter

public void setAccessibilityTraversalAfter (int viewId, int nextId)

Equivalent to calling [View.setAccessibilityTraversalAfter(int)](/reference/android/view/View#setAccessibilityTraversalAfter%28int%29).

setAccessibilityTraversalBefore

public void setAccessibilityTraversalBefore (int viewId, int nextId)

Equivalent to calling [View.setAccessibilityTraversalBefore(int)](/reference/android/view/View#setAccessibilityTraversalBefore%28int%29).

setBitmap

public void setBitmap (int viewId, String methodName, Bitmap value)

Call a method taking one Bitmap on a view in the layout for this RemoteViews.

setBlendMode

public void setBlendMode (int viewId, String methodName, BlendMode value)

Call a method taking one BlendMode on a view in the layout for this RemoteViews.

setBoolean

public void setBoolean (int viewId, String methodName, boolean value)

Call a method taking one boolean on a view in the layout for this RemoteViews.

setBundle

public void setBundle (int viewId, String methodName, Bundle value)

Call a method taking one Bundle on a view in the layout for this RemoteViews.

setByte

public void setByte (int viewId, String methodName, byte value)

Call a method taking one byte on a view in the layout for this RemoteViews.

setChar

public void setChar (int viewId, String methodName, char value)

Call a method taking one char on a view in the layout for this RemoteViews.

setCharSequence

public void setCharSequence (int viewId, String methodName, int stringResource)

Call a method taking one CharSequence on a view in the layout for this RemoteViews. The CharSequence will be resolved from the resources at the time the [RemoteViews](/reference/android/widget/RemoteViews) is (re-)applied. Undefined resources will result in an exception, except 0 which will resolve to null.

setCharSequence

public void setCharSequence (int viewId, String methodName, CharSequence value)

Call a method taking one CharSequence on a view in the layout for this RemoteViews.

setCharSequenceAttr

public void setCharSequenceAttr (int viewId, String methodName, int stringAttribute)

Call a method taking one CharSequence on a view in the layout for this RemoteViews. The CharSequence will be resolved from the theme attribute at the time the[RemoteViews](/reference/android/widget/RemoteViews) is (re-)applied. Unresolvable attributes will result in an exception, except 0 which will resolve to null.

setChronometerCountDown

public void setChronometerCountDown (int viewId, boolean isCountDown)

Equivalent to calling [Chronometer.setCountDown](/reference/android/widget/Chronometer#setCountDown%28boolean%29) on the chronometer with the given viewId.

setColor

public void setColor (int viewId, String methodName, int colorResource)

Call a method taking one int, a color, on a view in the layout for this RemoteViews. The Color will be resolved from the resources at the time the [RemoteViews](/reference/android/widget/RemoteViews) is (re-) applied. Undefined resources will result in an exception, except 0 which will resolve to 0.

setColorAttr

public void setColorAttr (int viewId, String methodName, int colorAttribute)

Call a method taking one int, a color, on a view in the layout for this RemoteViews. The Color will be resolved from the theme attribute at the time the [RemoteViews](/reference/android/widget/RemoteViews) is (re-)applied. Unresolvable attributes will result in an exception, except 0 which will resolve to 0.

setColorInt

public void setColorInt (int viewId, String methodName, int notNight, int night)

Call a method taking one int, a color, on a view in the layout for this RemoteViews.

setColorStateList

public void setColorStateList (int viewId, String methodName, ColorStateList notNight, ColorStateList night)

Call a method taking one ColorStateList on a view in the layout for this RemoteViews.

setColorStateList

public void setColorStateList (int viewId, String methodName, ColorStateList value)

Call a method taking one ColorStateList on a view in the layout for this RemoteViews.

setColorStateList

public void setColorStateList (int viewId, String methodName, int colorResource)

Call a method taking one ColorStateList on a view in the layout for this RemoteViews. The ColorStateList will be resolved from the resources at the time the [RemoteViews](/reference/android/widget/RemoteViews) is (re-)applied. Undefined resources will result in an exception, except 0 which will resolve to null.

setColorStateListAttr

public void setColorStateListAttr (int viewId, String methodName, int colorAttr)

Call a method taking one ColorStateList on a view in the layout for this RemoteViews. The ColorStateList will be resolved from the theme attribute at the time the[RemoteViews](/reference/android/widget/RemoteViews) is (re-)applied. Unresolvable attributes will result in an exception, except 0 which will resolve to null.

setCompoundButtonChecked

public void setCompoundButtonChecked (int viewId, boolean checked)

Equivalent to calling [CompoundButton.setChecked(boolean)](/reference/android/widget/CompoundButton#setChecked%28boolean%29).

setContentDescription

public void setContentDescription (int viewId, CharSequence contentDescription)

Equivalent to calling View.setContentDescription(CharSequence).

setDouble

public void setDouble (int viewId, String methodName, double value)

Call a method taking one double on a view in the layout for this RemoteViews.

setEmptyView

public void setEmptyView (int viewId, int emptyViewId)

Equivalent to calling [AdapterView.setEmptyView(View)](/reference/android/widget/AdapterView#setEmptyView%28android.view.View%29)

setFloat

public void setFloat (int viewId, String methodName, float value)

Call a method taking one float on a view in the layout for this RemoteViews.

setFloatDimen

public void setFloatDimen (int viewId, String methodName, int dimenResource)

Call a method taking one float, a size in pixels, on a view in the layout for this RemoteViews. The dimension will be resolved from the resources at the time the [RemoteViews](/reference/android/widget/RemoteViews) is (re-)applied. Undefined resources will result in an exception, except 0 which will resolve to 0f.

setFloatDimen

public void setFloatDimen (int viewId, String methodName, float value, int unit)

Call a method taking one float, a size in pixels, on a view in the layout for this RemoteViews. The dimension will be resolved from the resources at the time the [RemoteViews](/reference/android/widget/RemoteViews) is (re-)applied.

setFloatDimenAttr

public void setFloatDimenAttr (int viewId, String methodName, int dimenAttr)

Call a method taking one float, a size in pixels, on a view in the layout for this RemoteViews. The dimension will be resolved from the theme attribute at the time the [RemoteViews](/reference/android/widget/RemoteViews) is (re-)applied. Unresolvable attributes will result in an exception, except 0 which will resolve to 0f.

setIcon

public void setIcon (int viewId, String methodName, Icon value)

Call a method taking one Icon on a view in the layout for this RemoteViews.

setIcon

public void setIcon (int viewId, String methodName, Icon notNight, Icon night)

Call a method taking one Icon on a view in the layout for this RemoteViews.

setImageViewBitmap

public void setImageViewBitmap (int viewId, Bitmap bitmap)

Equivalent to calling [ImageView.setImageBitmap(Bitmap)](/reference/android/widget/ImageView#setImageBitmap%28android.graphics.Bitmap%29)

setImageViewIcon

public void setImageViewIcon (int viewId, Icon icon)

Equivalent to calling [ImageView.setImageIcon(Icon)](/reference/android/widget/ImageView#setImageIcon%28android.graphics.drawable.Icon%29)

setImageViewResource

public void setImageViewResource (int viewId, int srcId)

Equivalent to calling [ImageView.setImageResource(int)](/reference/android/widget/ImageView#setImageResource%28int%29)

setImageViewUri

public void setImageViewUri (int viewId, Uri uri)

Equivalent to calling [ImageView.setImageURI(Uri)](/reference/android/widget/ImageView#setImageURI%28android.net.Uri%29)

setInt

public void setInt (int viewId, String methodName, int value)

Call a method taking one int on a view in the layout for this RemoteViews.

setIntDimen

public void setIntDimen (int viewId, String methodName, float value, int unit)

Call a method taking one int, a size in pixels, on a view in the layout for this RemoteViews. The dimension will be resolved from the specified dimension at the time of inflation.

setIntDimen

public void setIntDimen (int viewId, String methodName, int dimenResource)

Call a method taking one int, a size in pixels, on a view in the layout for this RemoteViews. The dimension will be resolved from the resources at the time the [RemoteViews](/reference/android/widget/RemoteViews) is (re-)applied. Undefined resources will result in an exception, except 0 which will resolve to 0.

setIntDimenAttr

public void setIntDimenAttr (int viewId, String methodName, int dimenAttr)

Call a method taking one int, a size in pixels, on a view in the layout for this RemoteViews. The dimension will be resolved from the theme attribute at the time the[RemoteViews](/reference/android/widget/RemoteViews) is (re-)applied. Unresolvable attributes will result in an exception, except 0 which will resolve to 0.

setIntent

public void setIntent (int viewId, String methodName, Intent value)

Call a method taking one Intent on a view in the layout for this RemoteViews.

setLabelFor

public void setLabelFor (int viewId, int labeledId)

Equivalent to calling [View.setLabelFor(int)](/reference/android/view/View#setLabelFor%28int%29).

setLightBackgroundLayoutId

public void setLightBackgroundLayoutId (int layoutId)

Provides an alternate layout ID, which can be used to inflate this view. This layout will be used by the host when the widgets displayed on a light-background where foreground elements and text can safely draw using a dark color without any additional background protection.

setLong

public void setLong (int viewId, String methodName, long value)

Call a method taking one long on a view in the layout for this RemoteViews.

setOnClickFillInIntent

public void setOnClickFillInIntent (int viewId, Intent fillInIntent)

When using collections (eg. [ListView](/reference/android/widget/ListView), [StackView](/reference/android/widget/StackView) etc.) in widgets, it is very costly to set PendingIntents on the individual items, and is hence not recommended. Instead a single PendingIntent template can be set on the collection, see [setPendingIntentTemplate(int, android.app.PendingIntent)](/reference/android/widget/RemoteViews#setPendingIntentTemplate%28int,%20android.app.PendingIntent%29), and the individual on-click action of a given item can be distinguished by setting a fillInIntent on that item. The fillInIntent is then combined with the PendingIntent template in order to determine the final intent which will be executed when the item is clicked. This works as follows: any fields which are left blank in the PendingIntent template, but are provided by the fillInIntent will be overwritten, and the resulting PendingIntent will be used. The rest of the PendingIntent template will then be filled in with the associated fields that are set in fillInIntent. See [Intent.fillIn(Intent, int)](/reference/android/content/Intent#fillIn%28android.content.Intent,%20int%29) for more details.

setPendingIntentTemplate

public void setPendingIntentTemplate (int viewId, PendingIntent pendingIntentTemplate)

When using collections (eg. [ListView](/reference/android/widget/ListView), [StackView](/reference/android/widget/StackView) etc.) in widgets, it is very costly to set PendingIntents on the individual items, and is hence not recommended. Instead this method should be used to set a single PendingIntent template on the collection, and individual items can differentiate their on-click behavior using[RemoteViews.setOnClickFillInIntent(int, Intent)](/reference/android/widget/RemoteViews#setOnClickFillInIntent%28int,%20android.content.Intent%29).

setProgressBar

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

Equivalent to calling [ProgressBar.setMax](/reference/android/widget/ProgressBar#setMax%28int%29),[ProgressBar.setProgress](/reference/android/widget/ProgressBar#setProgress%28int%29), and[ProgressBar.setIndeterminate](/reference/android/widget/ProgressBar#setIndeterminate%28boolean%29) If indeterminate is true, then the values for max and progress are ignored.

setRadioGroupChecked

public void setRadioGroupChecked (int viewId, int checkedId)

Equivalent to calling [RadioGroup.check(int)](/reference/android/widget/RadioGroup#check%28int%29).

setRelativeScrollPosition

public void setRelativeScrollPosition (int viewId, int offset)

Equivalent to calling [ListView.smoothScrollByOffset(int)](/reference/android/widget/ListView#smoothScrollByOffset%28int%29).

setRemoteAdapter

public void setRemoteAdapter (int appWidgetId, int viewId, Intent intent)

This method was deprecated in API level 15.
This method has been deprecated. See[setRemoteAdapter(int, Intent)](/reference/android/widget/RemoteViews#setRemoteAdapter%28int,%20android.content.Intent%29)

Equivalent to calling [AbsListView.setRemoteViewsAdapter(Intent)](/reference/android/widget/AbsListView#setRemoteViewsAdapter%28android.content.Intent%29).

setRemoteAdapter

public void setRemoteAdapter (int viewId, RemoteViews.RemoteCollectionItems items)

Creates a simple Adapter for the viewId specified. The viewId must point to an AdapterView, ie. [ListView](/reference/android/widget/ListView), [GridView](/reference/android/widget/GridView), [StackView](/reference/android/widget/StackView) or [AdapterViewAnimator](/reference/android/widget/AdapterViewAnimator). This is a simpler but less flexible approach to populating collection widgets. Its use is encouraged for most scenarios, as long as the total memory within the list of RemoteViews is relatively small (ie. doesn't contain large or numerous Bitmaps, see [setImageViewBitmap(int, Bitmap)](/reference/android/widget/RemoteViews#setImageViewBitmap%28int,%20android.graphics.Bitmap%29)). In the case of numerous images, the use of API is still possible by setting image URIs instead of Bitmaps, see [RemoteViews.setImageViewUri](/reference/android/widget/RemoteViews#setImageViewUri%28int,%20android.net.Uri%29). This API is supported in the compatibility library for previous API levels, see RemoteViewsCompat.

setScrollPosition

public void setScrollPosition (int viewId, int position)

Equivalent to calling [ListView.smoothScrollToPosition(int)](/reference/android/widget/ListView#smoothScrollToPosition%28int%29).

setShort

public void setShort (int viewId, String methodName, short value)

Call a method taking one short on a view in the layout for this RemoteViews.

setString

public void setString (int viewId, String methodName, String value)

Call a method taking one String on a view in the layout for this RemoteViews.

setTextColor

public void setTextColor (int viewId, int color)

Equivalent to calling [TextView.setTextColor(int)](/reference/android/widget/TextView#setTextColor%28int%29).

setTextViewCompoundDrawables

public void setTextViewCompoundDrawables (int viewId, int left, int top, int right, int bottom)

Equivalent to calling[TextView.setCompoundDrawablesWithIntrinsicBounds(int, int, int, int)](/reference/android/widget/TextView#setCompoundDrawablesWithIntrinsicBounds%28int,%20int,%20int,%20int%29).

setTextViewCompoundDrawablesRelative

public void setTextViewCompoundDrawablesRelative (int viewId, int start, int top, int end, int bottom)

Equivalent to calling [TextView.setCompoundDrawablesRelativeWithIntrinsicBounds(int, int, int, int)](/reference/android/widget/TextView#setCompoundDrawablesRelativeWithIntrinsicBounds%28int,%20int,%20int,%20int%29).

setTextViewText

public void setTextViewText (int viewId, CharSequence text)

Equivalent to calling [TextView.setText(CharSequence)](/reference/android/widget/TextView#setText%28java.lang.CharSequence%29)

setTextViewTextSize

public void setTextViewTextSize (int viewId, int units, float size)

Equivalent to calling [TextView.setTextSize(int, float)](/reference/android/widget/TextView#setTextSize%28int,%20float%29)

setUri

public void setUri (int viewId, String methodName, Uri value)

Call a method taking one Uri on a view in the layout for this RemoteViews.

setViewLayoutHeightAttr

public void setViewLayoutHeightAttr (int viewId, int heightAttr)

Equivalent to setting [ViewGroup.LayoutParams.height](/reference/android/view/ViewGroup.LayoutParams#height) with the value of the given attribute in the current theme.

setViewLayoutMargin

public void setViewLayoutMargin (int viewId, int type, float value, int units)

Equivalent to calling [MarginLayoutParams.setMarginEnd](/reference/android/view/ViewGroup.MarginLayoutParams#setMarginEnd%28int%29). Only works if the [View.getLayoutParams()](/reference/android/view/View#getLayoutParams%28%29) supports margins.

NOTE: It is recommended to use [TypedValue.COMPLEX_UNIT_PX](/reference/android/util/TypedValue#COMPLEX%5FUNIT%5FPX) only for 0. Setting margins in pixels will behave poorly when the RemoteViews object is used on a display with a different density.

setViewLayoutWidthAttr

public void setViewLayoutWidthAttr (int viewId, int widthAttr)

Equivalent to setting [ViewGroup.LayoutParams.width](/reference/android/view/ViewGroup.LayoutParams#width) with the value of the given attribute in the current theme.

setViewOutlinePreferredRadiusAttr

public void setViewOutlinePreferredRadiusAttr (int viewId, int attrId)

Sets an OutlineProvider on the view whose corner radius is a dimension attribute withattrId.

setViewOutlinePreferredRadiusDimen

public void setViewOutlinePreferredRadiusDimen (int viewId, int resId)

Sets an OutlineProvider on the view whose corner radius is a dimension resource withresId.

setViewPadding

public void setViewPadding (int viewId, int left, int top, int right, int bottom)

Equivalent to calling [View.setPadding(int, int, int, int)](/reference/android/view/View#setPadding%28int,%20int,%20int,%20int%29).

setViewVisibility

public void setViewVisibility (int viewId, int visibility)

Equivalent to calling [View.setVisibility(int)](/reference/android/view/View#setVisibility%28int%29)

writeToParcel

public void writeToParcel (Parcel dest, int flags)

Flatten this object in to a Parcel.