FileDocCategorySizeDatePackage
AppWidgetProviderInfo.javaAPI DocAndroid 1.5 API5567Wed May 06 22:41:54 BST 2009android.appwidget

AppWidgetProviderInfo

public class AppWidgetProviderInfo extends Object implements android.os.Parcelable
Describes the meta data for an installed AppWidget provider. The fields in this class correspond to the fields in the <appwidget-provider> xml tag.

Fields Summary
public android.content.ComponentName
provider
Identity of this AppWidget component. This component should be a {@link android.content.BroadcastReceiver}, and it will be sent the AppWidget intents {@link android.appwidget as described in the AppWidget package documentation}.

This field corresponds to the android:name attribute in the <receiver> element in the AndroidManifest.xml file.

public int
minWidth
Minimum width of the AppWidget, in dp.

This field corresponds to the android:minWidth attribute in the AppWidget meta-data file.

public int
minHeight
Minimum height of the AppWidget, in dp.

This field corresponds to the android:minHeight attribute in the AppWidget meta-data file.

public int
updatePeriodMillis
How often, in milliseconds, that this AppWidget wants to be updated. The AppWidget manager may place a limit on how often a AppWidget is updated.

This field corresponds to the android:updatePeriodMillis attribute in the AppWidget meta-data file.

public int
initialLayout
The resource id of the initial layout for this AppWidget. This should be displayed until the RemoteViews for the AppWidget is available.

This field corresponds to the android:initialLayout attribute in the AppWidget meta-data file.

public android.content.ComponentName
configure
The activity to launch that will configure the AppWidget.

This class name of field corresponds to the android:configure attribute in the AppWidget meta-data file. The package name always corresponds to the package containing the AppWidget provider.

public String
label
The label to display to the user in the AppWidget picker. If not supplied in the xml, the application label will be used.

This field corresponds to the android:label attribute in the <receiver> element in the AndroidManifest.xml file.

public int
icon
The icon to display for this AppWidget in the AppWidget picker. If not supplied in the xml, the application icon will be used.

This field corresponds to the android:icon attribute in the <receiver> element in the AndroidManifest.xml file.

public static final Parcelable.Creator
CREATOR
Parcelable.Creator that instantiates AppWidgetProviderInfo objects
Constructors Summary
public AppWidgetProviderInfo()
public AppWidgetProviderInfo(android.os.Parcel in)
Unflatten the AppWidgetProviderInfo from a parcel.

        if (0 != in.readInt()) {
            this.provider = new ComponentName(in);
        }
        this.minWidth = in.readInt();
        this.minHeight = in.readInt();
        this.updatePeriodMillis = in.readInt();
        this.initialLayout = in.readInt();
        if (0 != in.readInt()) {
            this.configure = new ComponentName(in);
        }
        this.label = in.readString();
        this.icon = in.readInt();
Methods Summary
public intdescribeContents()

        return 0;
public java.lang.StringtoString()


       
        return "AppWidgetProviderInfo(provider=" + this.provider + ")";
public voidwriteToParcel(android.os.Parcel out, int flags)

        if (this.provider != null) {
            out.writeInt(1);
            this.provider.writeToParcel(out, flags);
        } else {
            out.writeInt(0);
        }
        out.writeInt(this.minWidth);
        out.writeInt(this.minHeight);
        out.writeInt(this.updatePeriodMillis);
        out.writeInt(this.initialLayout);
        if (this.configure != null) {
            out.writeInt(1);
            this.configure.writeToParcel(out, flags);
        } else {
            out.writeInt(0);
        }
        out.writeString(this.label);
        out.writeInt(this.icon);