AppWidgetHost

extends Object

java.lang.Object
↳	android.appwidget.AppWidgetHost

Class Overview

AppWidgetHost provides the interaction with the AppWidget service for apps, like the home screen, that want to embed AppWidgets in their UI.

Summary

Public Constructors
	AppWidgetHost(Context context, int hostId)

Public Methods
int	allocateAppWidgetId() Get a appWidgetId for a host in the calling process.
final AppWidgetHostView	createView(Context context, int appWidgetId, AppWidgetProviderInfo appWidget)
static void	deleteAllHosts() Remove all records about all hosts for your package.
void	deleteAppWidgetId(int appWidgetId) Stop listening to changes for this AppWidget.
void	deleteHost() Remove all records about this host from the AppWidget manager.
void	startListening() Start receiving onAppWidgetChanged calls for your AppWidgets.
void	stopListening() Stop receiving onAppWidgetChanged calls for your AppWidgets.

Protected Methods
AppWidgetHostView	onCreateView(Context context, int appWidgetId, AppWidgetProviderInfo appWidget) Called to create the AppWidgetHostView. Override to return a custom subclass if you need it.
void	onProviderChanged(int appWidgetId, AppWidgetProviderInfo appWidget) Called when the AppWidget provider for a AppWidget has been upgraded to a new apk.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Is called before the object's memory is being reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of Class which represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.

Public Constructors

public AppWidgetHost (Context context, int hostId)

Public Methods

public int allocateAppWidgetId ()

Get a appWidgetId for a host in the calling process.

Returns

a appWidgetId

public final AppWidgetHostView createView (Context context, int appWidgetId, AppWidgetProviderInfo appWidget)

public static void deleteAllHosts ()

Remove all records about all hosts for your package.

Call this when initializing your database, as it might be because of a data wipe.
Call this to have the AppWidget manager release all resources associated with your host. Any future calls about this host will cause the records to be re-allocated.

public void deleteAppWidgetId (int appWidgetId)

Stop listening to changes for this AppWidget.

public void deleteHost ()

Remove all records about this host from the AppWidget manager.

Call this when initializing your database, as it might be because of a data wipe.
Call this to have the AppWidget manager release all resources associated with your host. Any future calls about this host will cause the records to be re-allocated.

public void startListening ()

Start receiving onAppWidgetChanged calls for your AppWidgets. Call this when your activity becomes visible, i.e. from onStart() in your Activity.

public void stopListening ()

Stop receiving onAppWidgetChanged calls for your AppWidgets. Call this when your activity is no longer visible, i.e. from onStop() in your Activity.

Protected Methods

protected AppWidgetHostView onCreateView (Context context, int appWidgetId, AppWidgetProviderInfo appWidget)

Called to create the AppWidgetHostView. Override to return a custom subclass if you need it.

protected void onProviderChanged (int appWidgetId, AppWidgetProviderInfo appWidget)

Called when the AppWidget provider for a AppWidget has been upgraded to a new apk.

Classes