RemoteViews

EXTRA_SHARED_ELEMENT_BOUNDS

static val EXTRA_SHARED_ELEMENT_BOUNDS: String

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

Value: "android.widget.extra.SHARED_ELEMENT_BOUNDS"

<init>

RemoteViews(
    packageName: String!, 
    layoutId: Int)

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

<init>

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.

<init>

RemoteViews(src: RemoteViews!)

Creates a copy of another RemoteViews.

<init>

RemoteViews(parcel: Parcel!)

Reads a RemoteViews object from a parcel.

addView

open fun addView(
    viewId: Int, 
    nestedView: RemoteViews!
): Unit

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

open fun apply(
    context: Context!, 
    parent: ViewGroup!
): View!

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

Caller beware: this may throw

clone

open fun clone(): RemoteViews!

Deprecated: 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

open fun describeContents(): Int

getLayoutId

open fun getLayoutId(): Int

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

open fun getPackage(): String!

onLoadClass

open fun onLoadClass(clazz: Class<Any!>!): Boolean

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

open fun reapply(
    context: Context!, 
    v: View!
): Unit

Applies all of the actions to the provided view.

Caller beware: this may throw

removeAllViews

open fun removeAllViews(viewId: Int): Unit

Equivalent to calling ViewGroup#removeAllViews().

setBitmap

open fun setBitmap(
    viewId: Int, 
    methodName: String!, 
    value: Bitmap!
): Unit

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

setBoolean

open fun setBoolean(
    viewId: Int, 
    methodName: String!, 
    value: Boolean
): Unit

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

setBundle

open fun setBundle(
    viewId: Int, 
    methodName: String!, 
    value: Bundle!
): Unit

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

setByte

open fun setByte(
    viewId: Int, 
    methodName: String!, 
    value: Byte
): Unit

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

setChar

open fun setChar(
    viewId: Int, 
    methodName: String!, 
    value: Char
): Unit

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

setCharSequence

open fun setCharSequence(
    viewId: Int, 
    methodName: String!, 
    value: CharSequence!
): Unit

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

setChronometer

open fun setChronometer(
    viewId: Int, 
    base: Long, 
    format: String!, 
    started: Boolean
): Unit

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

setChronometerCountDown

open fun setChronometerCountDown(
    viewId: Int, 
    isCountDown: Boolean
): Unit

Equivalent to calling Chronometer#setCountDown(boolean) on the chronometer with the given viewId.

setContentDescription

open fun setContentDescription(
    viewId: Int, 
    contentDescription: CharSequence!
): Unit

Equivalent to calling View.setContentDescription(CharSequence).

setDisplayedChild

open fun setDisplayedChild(
    viewId: Int, 
    childIndex: Int
): Unit

Equivalent to calling AdapterViewAnimator#setDisplayedChild(int)

setDouble

open fun setDouble(
    viewId: Int, 
    methodName: String!, 
    value: Double
): Unit

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

setEmptyView

open fun setEmptyView(
    viewId: Int, 
    emptyViewId: Int
): Unit

Equivalent to calling AdapterView#setEmptyView(View)

setFloat

open fun setFloat(
    viewId: Int, 
    methodName: String!, 
    value: Float
): Unit

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

setIcon

open fun setIcon(
    viewId: Int, 
    methodName: String!, 
    value: Icon!
): Unit

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

setImageViewBitmap

open fun setImageViewBitmap(
    viewId: Int, 
    bitmap: Bitmap!
): Unit

Equivalent to calling ImageView#setImageBitmap(Bitmap)

setImageViewIcon

open fun setImageViewIcon(
    viewId: Int, 
    icon: Icon!
): Unit

Equivalent to calling ImageView#setImageIcon(Icon)

setImageViewResource

open fun setImageViewResource(
    viewId: Int, 
    srcId: Int
): Unit

Equivalent to calling ImageView#setImageResource(int)

setImageViewUri

open fun setImageViewUri(
    viewId: Int, 
    uri: Uri!
): Unit

Equivalent to calling ImageView#setImageURI(Uri)

setInt

open fun setInt(
    viewId: Int, 
    methodName: String!, 
    value: Int
): Unit

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

setIntent

open fun setIntent(
    viewId: Int, 
    methodName: String!, 
    value: Intent!
): Unit

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

setLabelFor

open fun setLabelFor(
    viewId: Int, 
    labeledId: Int
): Unit

Equivalent to calling View#setLabelFor(int).

setLightBackgroundLayoutId

open fun setLightBackgroundLayoutId(layoutId: Int): Unit

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

open fun setLong(
    viewId: Int, 
    methodName: String!, 
    value: Long
): Unit

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

setOnClickFillInIntent

open fun setOnClickFillInIntent(
    viewId: Int, 
    fillInIntent: Intent!
): Unit

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 RemoteViews#setPendingIntentTemplate(int, 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

open fun setOnClickPendingIntent(
    viewId: Int, 
    pendingIntent: PendingIntent!
): Unit

Equivalent to calling android.view.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 RemoteViews#setPendingIntentTemplate(int, PendingIntent) in conjunction with RemoteViews#setOnClickFillInIntent(int, Intent).

setOnClickResponse

open fun setOnClickResponse(
    viewId: Int, 
    response: RemoteViews.RemoteResponse
): Unit

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

setPendingIntentTemplate

open fun setPendingIntentTemplate(
    viewId: Int, 
    pendingIntentTemplate: PendingIntent!
): Unit

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

open fun setProgressBar(
    viewId: Int, 
    max: Int, 
    progress: Int, 
    indeterminate: Boolean
): Unit

Equivalent to calling ProgressBar#setMax, ProgressBar#setProgress, and ProgressBar#setIndeterminate If indeterminate is true, then the values for max and progress are ignored.

setRelativeScrollPosition

open fun setRelativeScrollPosition(
    viewId: Int, 
    offset: Int
): Unit

Equivalent to calling ListView#smoothScrollByOffset(int).

setRemoteAdapter

open fun setRemoteAdapter(
    appWidgetId: Int, 
    viewId: Int, 
    intent: Intent!
): Unit

Deprecated: This method has been deprecated. See android.widget.RemoteViews#setRemoteAdapter(int, Intent)

Equivalent to calling android.widget.AbsListView#setRemoteViewsAdapter(Intent).

setRemoteAdapter

open fun setRemoteAdapter(
    viewId: Int, 
    intent: Intent!
): Unit

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

setScrollPosition

open fun setScrollPosition(
    viewId: Int, 
    position: Int
): Unit

Equivalent to calling ListView#smoothScrollToPosition(int).

setShort

open fun setShort(
    viewId: Int, 
    methodName: String!, 
    value: Short
): Unit

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

setString

open fun setString(
    viewId: Int, 
    methodName: String!, 
    value: String!
): Unit

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

setTextColor

open fun setTextColor(
    viewId: Int, 
    color: Int
): Unit

Equivalent to calling android.widget.TextView#setTextColor(int).

setTextViewCompoundDrawables

open fun setTextViewCompoundDrawables(
    viewId: Int, 
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Unit

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

setTextViewCompoundDrawablesRelative

open fun setTextViewCompoundDrawablesRelative(
    viewId: Int, 
    start: Int, 
    top: Int, 
    end: Int, 
    bottom: Int
): Unit

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

setTextViewText

open fun setTextViewText(
    viewId: Int, 
    text: CharSequence!
): Unit

Equivalent to calling TextView#setText(CharSequence)

setTextViewTextSize

open fun setTextViewTextSize(
    viewId: Int, 
    units: Int, 
    size: Float
): Unit

Equivalent to calling TextView#setTextSize(int, float)

setUri

open fun setUri(
    viewId: Int, 
    methodName: String!, 
    value: Uri!
): Unit

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

setViewPadding

open fun setViewPadding(
    viewId: Int, 
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Unit

Equivalent to calling android.view.View#setPadding(int, int, int, int).

setViewVisibility

open fun setViewVisibility(
    viewId: Int, 
    visibility: Int
): Unit

Equivalent to calling View#setVisibility(int)

showNext

open fun showNext(viewId: Int): Unit

Equivalent to calling AdapterViewAnimator#showNext()

showPrevious

open fun showPrevious(viewId: Int): Unit

Equivalent to calling AdapterViewAnimator#showPrevious()

writeToParcel

open fun writeToParcel(
    dest: Parcel!, 
    flags: Int
): Unit

CREATOR

static val CREATOR: Parcelable.Creator<RemoteViews!>

Parcelable.Creator that instantiates RemoteViews objects