java.lang.Object    ↳ android.widget.RemoteViews

Nested classes

class RemoteViews.ActionException

Exception to send when something goes wrong executing an action 

class RemoteViews.RemoteResponse

Class representing a response to an action performed on any element of a RemoteViews. 

@interface RemoteViews.RemoteView

This annotation indicates that a subclass of View is allowed to be used with the RemoteViews mechanism. 

class RemoteViews.RemoteViewOutlineProvider

OutlineProvider for a view with a radius set by RemoteViews.setViewOutlinePreferredRadius(int, float, int). 

Constants

String EXTRA_SHARED_ELEMENT_BOUNDS

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

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<RemoteViews> CREATOR

Parcelable.Creator that instantiates RemoteViews objects

Public constructors

RemoteViews(String packageName, int layoutId)

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

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(Map<PointF, RemoteViews> remoteViews)

Create a new RemoteViews object that will inflate the layout with the closest size specification.

RemoteViews(RemoteViews src)

Creates a copy of another RemoteViews.

RemoteViews(Parcel parcel)

Reads a RemoteViews object from a parcel.

Public methods

void addView(int viewId, RemoteViews nestedView)

Equivalent to calling ViewGroup#addView(View) after inflating the given RemoteViews.

View apply(Context context, ViewGroup parent)

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

RemoteViews clone()

This method was deprecated in API level 28. use RemoteViews(android.widget.RemoteViews) instead.

int describeContents()

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

int getLayoutId()

Returns the layout id of the root layout associated with this RemoteViews.

String getPackage() boolean onLoadClass(Class clazz)

This method is deprecated. Used by system to enforce safe inflation of RemoteViews. Apps should not override this method. Changing of this method will NOT affect the process where RemoteViews is rendered.

void reapply(Context context, View v)

Applies all of the actions to the provided view.

void removeAllViews(int viewId)

Equivalent to calling ViewGroup#removeAllViews().

void setAccessibilityTraversalAfter(int viewId, int nextId)

Equivalent to calling View.setAccessibilityTraversalAfter(int).

void setAccessibilityTraversalBefore(int viewId, int nextId)

Equivalent to calling View.setAccessibilityTraversalBefore(int).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void setChronometerCountDown(int viewId, boolean isCountDown)

Equivalent to calling Chronometer.setCountDown on the chronometer with the given viewId.

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.

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

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

void setCompoundButtonChecked(int viewId, boolean checked)

Equivalent to calling CompoundButton.setChecked(boolean).

void setContentDescription(int viewId, CharSequence contentDescription)

Equivalent to calling View.setContentDescription(CharSequence).

void setDisplayedChild(int viewId, int childIndex)

Equivalent to calling AdapterViewAnimator#setDisplayedChild(int)

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

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

void setEmptyView(int viewId, int emptyViewId)

Equivalent to calling AdapterView#setEmptyView(View)

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

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

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.

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.

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

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

void setImageViewBitmap(int viewId, Bitmap bitmap)

Equivalent to calling ImageView#setImageBitmap(Bitmap)

void setImageViewIcon(int viewId, Icon icon)

Equivalent to calling ImageView#setImageIcon(Icon)

void setImageViewResource(int viewId, int srcId)

Equivalent to calling ImageView#setImageResource(int)

void setImageViewUri(int viewId, Uri uri)

Equivalent to calling ImageView#setImageURI(Uri)

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

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

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.

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.

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

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

void setLabelFor(int viewId, int labeledId)

Equivalent to calling View#setLabelFor(int).

void setLightBackgroundLayoutId(int layoutId)

Provides an alternate layout ID, which can be used to inflate this view.

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

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

void setOnClickFillInIntent(int viewId, Intent fillInIntent)

When using collections (eg.

void setOnClickPendingIntent(int viewId, PendingIntent pendingIntent)

Equivalent to calling View.setOnClickListener(android.view.View.OnClickListener) to launch the provided PendingIntent.

void setOnClickResponse(int viewId, RemoteViews.RemoteResponse response)

Equivalent of calling View.setOnClickListener(android.view.View.OnClickListener) to launch the provided RemoteResponse.

void setPendingIntentTemplate(int viewId, PendingIntent pendingIntentTemplate)

When using collections (eg.

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

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

If indeterminate is true, then the values for max and progress are ignored.

void setRadioGroupChecked(int viewId, int checkedId)

Equivalent to calling RadioGroup.check(int).

void setRelativeScrollPosition(int viewId, int offset)

Equivalent to calling ListView#smoothScrollByOffset(int).

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)

void setRemoteAdapter(int viewId, Intent intent)

Equivalent to calling AbsListView.setRemoteViewsAdapter(Intent).

void setScrollPosition(int viewId, int position)

Equivalent to calling ListView#smoothScrollToPosition(int).

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

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

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

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

void setTextColor(int viewId, int color)

Equivalent to calling TextView.setTextColor(int).

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

Equivalent to calling TextView#setCompoundDrawablesWithIntrinsicBounds(int, int, int, int).

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

Equivalent to calling TextView.setCompoundDrawablesRelativeWithIntrinsicBounds(int, int, int, int).

void setTextViewText(int viewId, CharSequence text)

Equivalent to calling TextView#setText(CharSequence)

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

Equivalent to calling TextView#setTextSize(int, float)

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

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

void setViewOutlinePreferredRadius(int viewId, float radius, int units)

Sets an OutlineProvider on the view whose corner radius is a dimension calculated using TypedValue#applyDimension(int, float, DisplayMetrics).

void setViewOutlinePreferredRadiusDimen(int viewId, int resId)

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

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

Equivalent to calling View.setPadding(int, int, int, int).

void setViewVisibility(int viewId, int visibility)

Equivalent to calling View#setVisibility(int)

void showNext(int viewId)

Equivalent to calling AdapterViewAnimator#showNext()

void showPrevious(int viewId)

Equivalent to calling AdapterViewAnimator#showPrevious()

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

EXTRA_SHARED_ELEMENT_BOUNDS

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"

CREATOR

public static final Creator<RemoteViews> CREATOR

Parcelable.Creator that instantiates RemoteViews objects

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 (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 (Map<PointF, 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 smallest one provided.

RemoteViews

public RemoteViews (RemoteViews src)

Creates a copy of another RemoteViews.

RemoteViews

public RemoteViews (Parcel parcel)

Reads a RemoteViews object from a parcel.

addView

public void addView (int viewId, 
                RemoteViews nestedView)

Equivalent to calling ViewGroup#addView(View) after inflating the given RemoteViews. This allows users to build "nested" RemoteViews. In cases where consumers of RemoteViews may recycle layouts, use removeAllViews(int) to clear any existing children.

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

clone

public RemoteViews clone ()

This method was deprecated in API level 28.
use RemoteViews(android.widget.RemoteViews) instead.

Returns a deep copy of the RemoteViews object. The RemoteView may not be attached to another RemoteView -- it must be the root of a hierarchy.

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.

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.

getPackage

public String getPackage ()

onLoadClass

public boolean onLoadClass (Class clazz)

This method is deprecated.
Used by system to enforce safe inflation of 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

reapply

public void reapply (Context context, 
                View v)

Applies all of the actions to the provided view.

Caller beware: this may throw

removeAllViews

public void removeAllViews (int viewId)

Equivalent to calling ViewGroup#removeAllViews().

setAccessibilityTraversalAfter

public void setAccessibilityTraversalAfter (int viewId, 
                int nextId)

Equivalent to calling View.setAccessibilityTraversalAfter(int).

setAccessibilityTraversalBefore

public void setAccessibilityTraversalBefore (int viewId, 
                int nextId)

Equivalent to calling View.setAccessibilityTraversalBefore(int).

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 of inflation.

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.

setChronometer

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

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

setChronometerCountDown

public void setChronometerCountDown (int viewId, 
                boolean isCountDown)

Equivalent to calling Chronometer.setCountDown 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 ColorStateList will be resolved from the resources at the time of inflation.

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 of inflation.

setCompoundButtonChecked

public void setCompoundButtonChecked (int viewId, 
                boolean checked)

Equivalent to calling CompoundButton.setChecked(boolean).

setContentDescription

public void setContentDescription (int viewId, 
                CharSequence contentDescription)

Equivalent to calling View.setContentDescription(CharSequence).

setDisplayedChild

public void setDisplayedChild (int viewId, 
                int childIndex)

Equivalent to calling AdapterViewAnimator#setDisplayedChild(int)

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)

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 of inflation.

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 specified dimension at the time of inflation.

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.

setImageViewBitmap

public void setImageViewBitmap (int viewId, 
                Bitmap bitmap)

Equivalent to calling ImageView#setImageBitmap(Bitmap)

setImageViewIcon

public void setImageViewIcon (int viewId, 
                Icon icon)

Equivalent to calling ImageView#setImageIcon(Icon)

setImageViewResource

public void setImageViewResource (int viewId, 
                int srcId)

Equivalent to calling ImageView#setImageResource(int)

setImageViewUri

public void setImageViewUri (int viewId, 
                Uri uri)

Equivalent to calling ImageView#setImageURI(Uri)

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 of inflation.

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).

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, 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), 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) for more details.

setOnClickPendingIntent

public void setOnClickPendingIntent (int viewId, 
                PendingIntent pendingIntent)

Equivalent to calling View.setOnClickListener(android.view.View.OnClickListener) to launch the provided PendingIntent. The source bounds (Intent#getSourceBounds()) of the intent will be set to the bounds of the clicked view in screen space. Note that any activity options associated with the mPendingIntent may get overridden before starting the intent.

When setting the on-click action of items within collections (eg. ListView, StackView etc.), this method will not work. Instead, use setPendingIntentTemplate(int, android.app.PendingIntent) in conjunction with RemoteViews#setOnClickFillInIntent(int, Intent).

setOnClickResponse

public void setOnClickResponse (int viewId, 
                RemoteViews.RemoteResponse response)

Equivalent of calling View.setOnClickListener(android.view.View.OnClickListener) to launch the provided RemoteResponse.

setPendingIntentTemplate

public void setPendingIntentTemplate (int viewId, 
                PendingIntent pendingIntentTemplate)

When using collections (eg. ListView, 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).

setProgressBar

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

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

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).

setRelativeScrollPosition

public void setRelativeScrollPosition (int viewId, 
                int offset)

Equivalent to calling ListView#smoothScrollByOffset(int).

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)

Equivalent to calling AbsListView.setRemoteViewsAdapter(Intent).

setRemoteAdapter

public void setRemoteAdapter (int viewId, 
                Intent intent)

Equivalent to calling AbsListView.setRemoteViewsAdapter(Intent). Can only be used for App Widgets.

setScrollPosition

public void setScrollPosition (int viewId, 
                int position)

Equivalent to calling ListView#smoothScrollToPosition(int).

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).

setTextViewCompoundDrawables

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

Equivalent to calling TextView#setCompoundDrawablesWithIntrinsicBounds(int, int, int, int).

setTextViewCompoundDrawablesRelative

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

Equivalent to calling TextView.setCompoundDrawablesRelativeWithIntrinsicBounds(int, int, int, int).

setTextViewText

public void setTextViewText (int viewId, 
                CharSequence text)

Equivalent to calling TextView#setText(CharSequence)

setTextViewTextSize

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

Equivalent to calling TextView#setTextSize(int, float)

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.

setViewOutlinePreferredRadius

public void setViewOutlinePreferredRadius (int viewId, 
                float radius, 
                int units)

Sets an OutlineProvider on the view whose corner radius is a dimension calculated using TypedValue#applyDimension(int, float, DisplayMetrics). This outline may change shape during system transitions.

NOTE: It is recommended to use TypedValue#COMPLEX_UNIT_PX only for 0. Setting margins in pixels will behave poorly when the RemoteViews object is used on a display with a different density.

setViewOutlinePreferredRadiusDimen

public void setViewOutlinePreferredRadiusDimen (int viewId, 
                int resId)

Sets an OutlineProvider on the view whose corner radius is a dimension resource with resId. This outline may change shape during system transitions.

setViewPadding

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

Equivalent to calling View.setPadding(int, int, int, int).

setViewVisibility

public void setViewVisibility (int viewId, 
                int visibility)

Equivalent to calling View#setVisibility(int)

showNext

public void showNext (int viewId)

Equivalent to calling AdapterViewAnimator#showNext()

showPrevious

public void showPrevious (int viewId)

Equivalent to calling AdapterViewAnimator#showPrevious()

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.