RemoteViews

Kotlin |Java

open class RemoteViews : LayoutInflater.Filter, Parcelable

kotlin.Any
↳	android.widget.RemoteViews

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:

And the following widgets:

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

Descendants of these classes are not supported.

Summary

Nested classes
open	`ActionException` Exception to send when something goes wrong executing an action
	`DrawInstructions` A data parcel that carries the instructions to draw the RemoteViews, as an alternative to XML layout.
	`RemoteCollectionItems` Representation of a fixed list of items to be displayed in a RemoteViews collection.
open	`RemoteResponse` Class representing a response to an action performed on any element of a RemoteViews.
	`RemoteView` This annotation indicates that a subclass of View is allowed to be used with the `RemoteViews` mechanism.
	`RemoteViewOutlineProvider` OutlineProvider for a view with a radius set by `setViewOutlinePreferredRadius(int,float,int)`.

Constants
static String	`EXTRA_CHECKED` The intent extra for whether the view whose checked state changed is currently checked.
static String	`EXTRA_SHARED_ELEMENT_BOUNDS` The intent extra that contains the bounds for all shared elements.
static Int	`MARGIN_BOTTOM` The value will apply to the marginBottom.
static Int	`MARGIN_END` The value will apply to the marginEnd.
static Int	`MARGIN_LEFT` The value will apply to the marginLeft.
static Int	`MARGIN_RIGHT` The value will apply to the marginRight.
static Int	`MARGIN_START` The value will apply to the marginStart.
static Int	`MARGIN_TOP` The value will apply to the marginTop.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`RemoteViews(parcel: Parcel!)` Reads a RemoteViews object from a parcel.
`RemoteViews(src: RemoteViews!)` Creates a copy of another RemoteViews.
`RemoteViews(landscape: RemoteViews!, portrait: RemoteViews!)` Create a new RemoteViews object that will inflate as the specified landspace or portrait RemoteViews, depending on the current configuration.
`RemoteViews(drawInstructions: RemoteViews.DrawInstructions)` Instantiates a RemoteViews object using `DrawInstructions`, which serves as an alternative to XML layout.
`RemoteViews(packageName: String!, layoutId: Int)` Create a new RemoteViews object that will display the views contained in the specified layout file.
`RemoteViews(packageName: String, layoutId: Int, viewId: Int)` 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(remoteViews: MutableMap<SizeF!, RemoteViews!>)` Create a new RemoteViews object that will inflate the layout with the closest size specification.

Public methods
open Unit	`addStableView(viewId: Int, nestedView: RemoteViews, stableId: Int)` Equivalent to calling `ViewGroup.addView(View)` after inflating the given `RemoteViews`.
open Unit	`addView(viewId: Int, nestedView: RemoteViews!)` Equivalent to calling `ViewGroup.addView(View)` after inflating the given `RemoteViews`.
open View!	`apply(context: Context!, parent: ViewGroup!)` Inflates the view hierarchy represented by this object and applies all of the actions.
open RemoteViews!	`clone()` Returns a deep copy of the RemoteViews object.
open Int	`describeContents()`
open Int	`getLayoutId()` Returns the layout id of the root layout associated with this RemoteViews.
open String!	`getPackage()`
open Int	`getViewId()` Get the ID of the top-level view of the XML layout, if set using `RemoteViews.RemoteViews(String, int, int)`.
open Boolean	`onLoadClass(clazz: Class<Any!>!)` Used to restrict the views which can be inflated
open Unit	`reapply(context: Context!, v: View!)` Applies all of the actions to the provided view.
open Unit	`removeAllViews(viewId: Int)` Equivalent to calling `ViewGroup.removeAllViews()`.
open Unit	`setAccessibilityTraversalAfter(viewId: Int, nextId: Int)` Equivalent to calling `android.view.View#setAccessibilityTraversalAfter(int)`.
open Unit	`setAccessibilityTraversalBefore(viewId: Int, nextId: Int)` Equivalent to calling `android.view.View#setAccessibilityTraversalBefore(int)`.
open Unit	`setBitmap(viewId: Int, methodName: String!, value: Bitmap!)` Call a method taking one Bitmap on a view in the layout for this RemoteViews.
open Unit	`setBlendMode(viewId: Int, methodName: String, value: BlendMode?)` Call a method taking one BlendMode on a view in the layout for this RemoteViews.
open Unit	`setBoolean(viewId: Int, methodName: String!, value: Boolean)` Call a method taking one boolean on a view in the layout for this RemoteViews.
open Unit	`setBundle(viewId: Int, methodName: String!, value: Bundle!)` Call a method taking one Bundle on a view in the layout for this RemoteViews.
open Unit	`setByte(viewId: Int, methodName: String!, value: Byte)` Call a method taking one byte on a view in the layout for this RemoteViews.
open Unit	`setChar(viewId: Int, methodName: String!, value: Char)` Call a method taking one char on a view in the layout for this RemoteViews.
open Unit	`setCharSequence(viewId: Int, methodName: String, stringResource: Int)` Call a method taking one CharSequence on a view in the layout for this RemoteViews.
open Unit	`setCharSequence(viewId: Int, methodName: String!, value: CharSequence!)` Call a method taking one CharSequence on a view in the layout for this RemoteViews.
open Unit	`setCharSequenceAttr(viewId: Int, methodName: String, stringAttribute: Int)` Call a method taking one CharSequence on a view in the layout for this RemoteViews.
open Unit	`setChronometer(viewId: Int, base: Long, format: String!, started: Boolean)` Equivalent to calling `Chronometer.setBase`, `Chronometer.setFormat`, and `Chronometer.start()` or `Chronometer.stop()`.
open Unit	`setChronometerCountDown(viewId: Int, isCountDown: Boolean)` Equivalent to calling `Chronometer.setCountDown` on the chronometer with the given viewId.
open Unit	`setColor(viewId: Int, methodName: String, colorResource: Int)` Call a method taking one int, a color, on a view in the layout for this RemoteViews.
open Unit	`setColorAttr(viewId: Int, methodName: String, colorAttribute: Int)` Call a method taking one int, a color, on a view in the layout for this RemoteViews.
open Unit	`setColorInt(viewId: Int, methodName: String, notNight: Int, night: Int)` Call a method taking one int, a color, on a view in the layout for this RemoteViews.
open Unit	`setColorStateList(viewId: Int, methodName: String, value: ColorStateList?)` Call a method taking one ColorStateList on a view in the layout for this RemoteViews.
open Unit	`setColorStateList(viewId: Int, methodName: String, notNight: ColorStateList?, night: ColorStateList?)` Call a method taking one ColorStateList on a view in the layout for this RemoteViews.
open Unit	`setColorStateList(viewId: Int, methodName: String, colorResource: Int)` Call a method taking one ColorStateList on a view in the layout for this RemoteViews.
open Unit	`setColorStateListAttr(viewId: Int, methodName: String, colorAttr: Int)` Call a method taking one ColorStateList on a view in the layout for this RemoteViews.
open Unit	`setCompoundButtonChecked(viewId: Int, checked: Boolean)` Equivalent to calling `android.widget.CompoundButton#setChecked(boolean)`.
open Unit	`setContentDescription(viewId: Int, contentDescription: CharSequence!)` Equivalent to calling View.
open Unit	`setDisplayedChild(viewId: Int, childIndex: Int)` Equivalent to calling `AdapterViewAnimator.setDisplayedChild(int)`
open Unit	`setDouble(viewId: Int, methodName: String!, value: Double)` Call a method taking one double on a view in the layout for this RemoteViews.
open Unit	`setEmptyView(viewId: Int, emptyViewId: Int)` Equivalent to calling `AdapterView.setEmptyView(View)`
open Unit	`setFloat(viewId: Int, methodName: String!, value: Float)` Call a method taking one float on a view in the layout for this RemoteViews.
open Unit	`setFloatDimen(viewId: Int, methodName: String, value: Float, unit: Int)` Call a method taking one float, a size in pixels, on a view in the layout for this RemoteViews.
open Unit	`setFloatDimen(viewId: Int, methodName: String, dimenResource: Int)` Call a method taking one float, a size in pixels, on a view in the layout for this RemoteViews.
open Unit	`setFloatDimenAttr(viewId: Int, methodName: String, dimenAttr: Int)` Call a method taking one float, a size in pixels, on a view in the layout for this RemoteViews.
open Unit	`setIcon(viewId: Int, methodName: String!, value: Icon!)` Call a method taking one Icon on a view in the layout for this RemoteViews.
open Unit	`setIcon(viewId: Int, methodName: String, notNight: Icon?, night: Icon?)` Call a method taking one Icon on a view in the layout for this RemoteViews.
open Unit	`setImageViewBitmap(viewId: Int, bitmap: Bitmap!)` Equivalent to calling `ImageView.setImageBitmap(Bitmap)`
open Unit	`setImageViewIcon(viewId: Int, icon: Icon!)` Equivalent to calling `ImageView.setImageIcon(Icon)`
open Unit	`setImageViewResource(viewId: Int, srcId: Int)` Equivalent to calling `ImageView.setImageResource(int)`
open Unit	`setImageViewUri(viewId: Int, uri: Uri!)` Equivalent to calling `ImageView.setImageURI(Uri)`
open Unit	`setInt(viewId: Int, methodName: String!, value: Int)` Call a method taking one int on a view in the layout for this RemoteViews.
open Unit	`setIntDimen(viewId: Int, methodName: String, value: Float, unit: Int)` Call a method taking one int, a size in pixels, on a view in the layout for this RemoteViews.
open Unit	`setIntDimen(viewId: Int, methodName: String, dimenResource: Int)` Call a method taking one int, a size in pixels, on a view in the layout for this RemoteViews.
open Unit	`setIntDimenAttr(viewId: Int, methodName: String, dimenAttr: Int)` Call a method taking one int, a size in pixels, on a view in the layout for this RemoteViews.
open Unit	`setIntent(viewId: Int, methodName: String!, value: Intent!)` Call a method taking one Intent on a view in the layout for this RemoteViews.
open Unit	`setLabelFor(viewId: Int, labeledId: Int)` Equivalent to calling `View.setLabelFor(int)`.
open Unit	`setLightBackgroundLayoutId(layoutId: Int)` Provides an alternate layout ID, which can be used to inflate this view.
open Unit	`setLong(viewId: Int, methodName: String!, value: Long)` Call a method taking one long on a view in the layout for this RemoteViews.
open Unit	`setOnCheckedChangeResponse(viewId: Int, response: RemoteViews.RemoteResponse)` Equivalent to calling `android.widget.CompoundButton#setOnCheckedChangeListener( * android.widget.CompoundButton.OnCheckedChangeListener)` to launch the provided `RemoteResponse`.
open Unit	`setOnClickFillInIntent(viewId: Int, fillInIntent: Intent!)` When using collections (eg.
open Unit	`setOnClickPendingIntent(viewId: Int, pendingIntent: PendingIntent!)` Equivalent to calling `android.view.View#setOnClickListener(android.view.View.OnClickListener)` to launch the provided `PendingIntent`.
open Unit	`setOnClickResponse(viewId: Int, response: RemoteViews.RemoteResponse)` Equivalent of calling `android.view.View#setOnClickListener(android.view.View.OnClickListener)` to launch the provided `RemoteResponse`.
open Unit	`setOnStylusHandwritingPendingIntent(viewId: Int, pendingIntent: PendingIntent?)` Equivalent to calling `View.setHandwritingDelegatorCallback(Runnable)` to send the provided `PendingIntent`.
open Unit	`setPendingIntentTemplate(viewId: Int, pendingIntentTemplate: PendingIntent!)` When using collections (eg.
open Unit	`setProgressBar(viewId: Int, max: Int, progress: Int, indeterminate: Boolean)` Equivalent to calling `ProgressBar.setMax`, android.
open Unit	`setRadioGroupChecked(viewId: Int, checkedId: Int)` Equivalent to calling `android.widget.RadioGroup#check(int)`.
open Unit	`setRelativeScrollPosition(viewId: Int, offset: Int)` Equivalent to calling `ListView.smoothScrollByOffset(int)`.
open Unit	`setRemoteAdapter(viewId: Int, intent: Intent!)` Equivalent to calling `android.widget.AbsListView#setRemoteViewsAdapter(Intent)`.
open Unit	`setRemoteAdapter(viewId: Int, items: RemoteViews.RemoteCollectionItems)` Creates a simple Adapter for the viewId specified.
open Unit	`setRemoteAdapter(appWidgetId: Int, viewId: Int, intent: Intent!)` Equivalent to calling `android.widget.AbsListView#setRemoteViewsAdapter(Intent)`.
open Unit	`setScrollPosition(viewId: Int, position: Int)` Equivalent to calling `ListView.smoothScrollToPosition(int)`.
open Unit	`setShort(viewId: Int, methodName: String!, value: Short)` Call a method taking one short on a view in the layout for this RemoteViews.
open Unit	`setString(viewId: Int, methodName: String!, value: String!)` Call a method taking one String on a view in the layout for this RemoteViews.
open Unit	`setTextColor(viewId: Int, color: Int)` Equivalent to calling `android.widget.TextView#setTextColor(int)`.
open Unit	`setTextViewCompoundDrawables(viewId: Int, left: Int, top: Int, right: Int, bottom: Int)` Equivalent to calling `TextView.setCompoundDrawablesWithIntrinsicBounds(int, int, int, int)`.
open Unit	`setTextViewCompoundDrawablesRelative(viewId: Int, start: Int, top: Int, end: Int, bottom: Int)` Equivalent to calling `android.widget.TextView#setCompoundDrawablesRelativeWithIntrinsicBounds(int,int,int,int)`.
open Unit	`setTextViewText(viewId: Int, text: CharSequence!)` Equivalent to calling `TextView.setText(CharSequence)`
open Unit	`setTextViewTextSize(viewId: Int, units: Int, size: Float)` Equivalent to calling `TextView.setTextSize(int, float)`
open Unit	`setUri(viewId: Int, methodName: String!, value: Uri!)` Call a method taking one Uri on a view in the layout for this RemoteViews.
open Unit	`setViewLayoutHeight(viewId: Int, height: Float, units: Int)` Equivalent to setting `android.view.ViewGroup.LayoutParams#height` except that you may provide the value in any dimension units.
open Unit	`setViewLayoutHeightAttr(viewId: Int, heightAttr: Int)` Equivalent to setting `android.view.ViewGroup.LayoutParams#height` with the value of the given attribute in the current theme.
open Unit	`setViewLayoutHeightDimen(viewId: Int, heightDimen: Int)` Equivalent to setting `android.view.ViewGroup.LayoutParams#height` with the result of `Resources.getDimensionPixelSize(int)`.
open Unit	`setViewLayoutMargin(viewId: Int, type: Int, value: Float, units: Int)` Equivalent to calling `MarginLayoutParams.setMarginEnd`.
open Unit	`setViewLayoutMarginAttr(viewId: Int, type: Int, attr: Int)` Equivalent to calling `MarginLayoutParams.setMarginEnd`.
open Unit	`setViewLayoutMarginDimen(viewId: Int, type: Int, dimen: Int)` Equivalent to calling `MarginLayoutParams.setMarginEnd`.
open Unit	`setViewLayoutWidth(viewId: Int, width: Float, units: Int)` Equivalent to setting `android.view.ViewGroup.LayoutParams#width` except that you may provide the value in any dimension units.
open Unit	`setViewLayoutWidthAttr(viewId: Int, widthAttr: Int)` Equivalent to setting `android.view.ViewGroup.LayoutParams#width` with the value of the given attribute in the current theme.
open Unit	`setViewLayoutWidthDimen(viewId: Int, widthDimen: Int)` Equivalent to setting `android.view.ViewGroup.LayoutParams#width` with the result of `Resources.getDimensionPixelSize(int)`.
open Unit	`setViewOutlinePreferredRadius(viewId: Int, radius: Float, units: Int)` Sets an OutlineProvider on the view whose corner radius is a dimension calculated using `TypedValue.applyDimension(int, float, DisplayMetrics)`.
open Unit	`setViewOutlinePreferredRadiusAttr(viewId: Int, attrId: Int)` Sets an OutlineProvider on the view whose corner radius is a dimension attribute with `attrId`.
open Unit	`setViewOutlinePreferredRadiusDimen(viewId: Int, resId: Int)` Sets an OutlineProvider on the view whose corner radius is a dimension resource with `resId`.
open Unit	`setViewPadding(viewId: Int, left: Int, top: Int, right: Int, bottom: Int)` Equivalent to calling `android.view.View#setPadding(int, int, int, int)`.
open Unit	`setViewVisibility(viewId: Int, visibility: Int)` Equivalent to calling `View.setVisibility(int)`
open Unit	`showNext(viewId: Int)` Equivalent to calling `AdapterViewAnimator.showNext()`
open Unit	`showPrevious(viewId: Int)` Equivalent to calling `AdapterViewAnimator.showPrevious()`
open Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<RemoteViews!>	`CREATOR` Parcelable.

Parameters
`landscape`	RemoteViews!: The RemoteViews to inflate in landscape configuration
`portrait`	RemoteViews!: The RemoteViews to inflate in portrait configuration

Parameters
`packageName`	String!: Name of the package that contains the layout resource
`layoutId`	Int: The id of the layout resource

Parameters
`packageName`	String: Name of the package that contains the layout resource This value cannot be `null`.
`layoutId`	Int: The id of the layout resource

Parameters
`viewId`	Int: The id of the parent `ViewGroup` to add child into.
`nestedView`	RemoteViews: `RemoteViews` that describes the child. This value cannot be `null`.
`stableId`	Int: An id that is stable across different versions of RemoteViews.

Parameters
`context`	Context!: Default context to use
`parent`	ViewGroup!: Parent that the resulting view hierarchy will be attached to. This method does not attach the hierarchy. The caller should do so when appropriate.

Exceptions
`java.lang.CloneNotSupportedException`	if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.
`java.lang.IllegalStateException`	if this is not the root of a RemoteView hierarchy

Parameters
`viewId`	Int: The id of the view whose after view in accessibility traversal to set.
`nextId`	Int: The id of the next in the accessibility traversal.

Parameters
`viewId`	Int: The id of the view whose before view in accessibility traversal to set.
`nextId`	Int: The id of the next in the accessibility traversal.

Parameters
`viewId`	Int: The id of the view on which to call the method.
`methodName`	String!: The name of the method to call.
`value`	Bitmap!: The value to pass to the method.

Parameters
`viewId`	Int: The id of the `Chronometer` to change
`base`	Long: The time at which the timer would have read 0:00. This time should be based off of `SystemClock.elapsedRealtime()`.
`format`	String!: The Chronometer format string, or null to simply display the timer value.
`started`	Boolean: True if you want the clock to be started, false if not.

Parameters
`viewId`	Int: The id of the `Chronometer` to change
`isCountDown`	Boolean: True if you want the chronometer to count down to base instead of counting up.

Parameters
`viewId`	Int: The id of the view whose property to set.
`checked`	Boolean: true to check the button, false to uncheck it.

Parameters
`viewId`	Int: The id of the view whose content description should change.
`contentDescription`	CharSequence!: The new content description for the view.

Parameters
`viewId`	Int: The id of the view on which to set the empty view
`emptyViewId`	Int: The view id of the empty view

Parameters
`viewId`	Int: The id of the view whose bitmap should change
`bitmap`	Bitmap!: The new Bitmap for the drawable

Parameters
`viewId`	Int: The id of the view whose bitmap should change
`icon`	Icon!: The new Icon for the ImageView

Parameters
`viewId`	Int: The id of the view whose drawable should change
`srcId`	Int: The new resource id for the drawable

Parameters
`viewId`	Int: The id of the view whose drawable should change
`uri`	Uri!: The Uri for the image

Parameters
`viewId`	Int: The id of the view whose property to set.
`labeledId`	Int: The id of a view for which this view serves as a label.

Parameters
`viewId`	Int: The id of the view that will trigger the `PendingIntent` when checked state changes.
`response`	RemoteViews.RemoteResponse: The `RemoteResponse` to send when the checked state changes. This value cannot be `null`.

RemoteViews

Summary

Constants

EXTRA_CHECKED

EXTRA_SHARED_ELEMENT_BOUNDS

MARGIN_BOTTOM

MARGIN_END

MARGIN_LEFT

MARGIN_RIGHT

MARGIN_START

MARGIN_TOP

Public constructors

RemoteViews

RemoteViews

RemoteViews

RemoteViews

RemoteViews

RemoteViews

RemoteViews

Public methods

addStableView

addView

apply

clone

describeContents

getLayoutId

getPackage

getViewId

onLoadClass

reapply

removeAllViews

setAccessibilityTraversalAfter

setAccessibilityTraversalBefore

setBitmap

setBlendMode

setBoolean

setBundle

setByte

setChar

setCharSequence

setCharSequence

setCharSequenceAttr

setChronometer

setChronometerCountDown

setColor

setColorAttr

setColorInt

setColorStateList

setColorStateList

setColorStateList

setColorStateListAttr

setCompoundButtonChecked

setContentDescription

setDisplayedChild

setDouble

setEmptyView

setFloat

setFloatDimen

setFloatDimen

setFloatDimenAttr

setIcon

setIcon

setImageViewBitmap

setImageViewIcon

setImageViewResource

setImageViewUri

setInt

setIntDimen

setIntDimen

setIntDimenAttr

setIntent

setLabelFor

setLightBackgroundLayoutId

setLong

setOnCheckedChangeResponse

setOnClickFillInIntent

setOnClickPendingIntent

setOnClickResponse

setOnStylusHandwritingPendingIntent

setPendingIntentTemplate

Parameters
`viewId`	Int: The id of the view on which to set the fillInIntent
`fillInIntent`	Intent!: The intent which will be combined with the parent's PendingIntent in order to determine the on-click behavior of the view specified by viewId

Parameters
`viewId`	Int: The id of the view that will trigger the `PendingIntent` when clicked
`pendingIntent`	PendingIntent!: The `PendingIntent` to send when user clicks

Parameters
`viewId`	Int: identifier of the view that will trigger the `PendingIntent` when a stylus `MotionEvent` occurs within the view's bounds
`pendingIntent`	PendingIntent?: the `PendingIntent` to send, or `null` to clear the handwriting delegation

Parameters
`viewId`	Int: The id of the collection who's children will use this PendingIntent template when clicked
`pendingIntentTemplate`	PendingIntent!: The `PendingIntent` to be combined with extras specified by a child of viewId and executed when that child is clicked

Parameters
`viewId`	Int: The id of the `ProgressBar` to change
`max`	Int: The 100% value for the progress bar
`progress`	Int: The current value of the progress bar.
`indeterminate`	Boolean: True if the progress bar is indeterminate, false if not.

Parameters
`viewId`	Int: The id of the view whose property to set.
`checkedId`	Int: The unique id of the radio button to select in the group.

Parameters
`viewId`	Int: The id of the view to change
`offset`	Int: Scroll by this adapter position offset

Parameters
`viewId`	Int: The id of the `AdapterView`
`intent`	Intent!: The intent of the service which will be providing data to the RemoteViewsAdapter

Parameters
`viewId`	Int: The id of the `AdapterView`.
`items`	RemoteViews.RemoteCollectionItems: The items to display in the `AdapterView`. This value cannot be `null`.

Parameters
`appWidgetId`	Int: The id of the app widget which contains the specified view. (This parameter is ignored in this deprecated method)
`viewId`	Int: The id of the `AdapterView`
`intent`	Intent!: The intent of the service which will be providing data to the RemoteViewsAdapter