FileDocCategorySizeDatePackage
AppWidgetProviderInfo.javaAPI DocAndroid 5.1 API15206Thu Mar 12 22:22:10 GMT 2015android.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 static final int
RESIZE_NONE
Widget is not resizable.
public static final int
RESIZE_HORIZONTAL
Widget is resizable in the horizontal axis only.
public static final int
RESIZE_VERTICAL
Widget is resizable in the vertical axis only.
public static final int
RESIZE_BOTH
Widget is resizable in both the horizontal and vertical axes.
public static final int
WIDGET_CATEGORY_HOME_SCREEN
Indicates that the widget can be displayed on the home screen. This is the default value.
public static final int
WIDGET_CATEGORY_KEYGUARD
Indicates that the widget can be displayed on the keyguard.
public static final int
WIDGET_CATEGORY_SEARCHBOX
Indicates that the widget can be displayed within a space reserved for the search box.
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
The default height of the widget when added to a host, in dp. The widget will get at least this width, and will often be given more, depending on the host.

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

public int
minHeight
The default height of the widget when added to a host, in dp. The widget will get at least this height, and will often be given more, depending on the host.

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

public int
minResizeWidth
Minimum width (in dp) which the widget can be resized to. This field has no effect if it is greater than minWidth or if horizontal resizing isn't enabled (see {@link #resizeMode}).

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

public int
minResizeHeight
Minimum height (in dp) which the widget can be resized to. This field has no effect if it is greater than minHeight or if vertical resizing isn't enabled (see {@link #resizeMode}).

This field corresponds to the android:minResizeHeight 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.

Note: Updates requested with updatePeriodMillis will not be delivered more than once every 30 minutes.

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 int
initialKeyguardLayout
The resource id of the initial layout for this AppWidget when it is displayed on keyguard. This parameter only needs to be provided if the widget can be displayed on the keyguard, see {@link #widgetCategory}.

This field corresponds to the android:initialKeyguardLayout 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.
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 int
autoAdvanceViewId
The view id of the AppWidget subview which should be auto-advanced by the widget's host.

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

public int
previewImage
A preview of what the AppWidget will look like after it's configured. If not supplied, the AppWidget's icon will be used.

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

public int
resizeMode
The rules by which a widget can be resized. See {@link #RESIZE_NONE}, {@link #RESIZE_NONE}, {@link #RESIZE_HORIZONTAL}, {@link #RESIZE_VERTICAL}, {@link #RESIZE_BOTH}.

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

public int
widgetCategory
Determines whether this widget can be displayed on the home screen, the keyguard, or both. A widget which is displayed on both needs to ensure that it follows the design guidelines for both widget classes. This can be achieved by querying the AppWidget options in its widget provider's update method.

This field corresponds to the widgetCategory attribute in the AppWidget meta-data file.

public android.content.pm.ActivityInfo
providerInfo
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.minResizeWidth = in.readInt();
        this.minResizeHeight = in.readInt();
        this.updatePeriodMillis = in.readInt();
        this.initialLayout = in.readInt();
        this.initialKeyguardLayout = in.readInt();
        if (0 != in.readInt()) {
            this.configure = new ComponentName(in);
        }
        this.label = in.readString();
        this.icon = in.readInt();
        this.previewImage = in.readInt();
        this.autoAdvanceViewId = in.readInt();
        this.resizeMode = in.readInt();
        this.widgetCategory = in.readInt();
        this.providerInfo = in.readParcelable(null);
Methods Summary
public android.appwidget.AppWidgetProviderInfoclone()

        AppWidgetProviderInfo that = new AppWidgetProviderInfo();
        that.provider = this.provider == null ? null : this.provider.clone();
        that.minWidth = this.minWidth;
        that.minHeight = this.minHeight;
        that.minResizeWidth = this.minResizeHeight;
        that.minResizeHeight = this.minResizeHeight;
        that.updatePeriodMillis = this.updatePeriodMillis;
        that.initialLayout = this.initialLayout;
        that.initialKeyguardLayout = this.initialKeyguardLayout;
        that.configure = this.configure == null ? null : this.configure.clone();
        that.label = this.label == null ? null : this.label.substring(0);
        that.icon = this.icon;
        that.previewImage = this.previewImage;
        that.autoAdvanceViewId = this.autoAdvanceViewId;
        that.resizeMode = this.resizeMode;
        that.widgetCategory = this.widgetCategory;
        that.providerInfo = this.providerInfo;
        return that;
public intdescribeContents()

        return 0;
public final android.os.UserHandlegetProfile()
Gets the user profile in which the provider resides.

return
The hosting user profile.

        return new UserHandle(UserHandle.getUserId(providerInfo.applicationInfo.uid));
private android.graphics.drawable.DrawableloadDrawable(android.content.Context context, int density, int resourceId, boolean loadDefaultIcon)

        try {
            Resources resources = context.getPackageManager().getResourcesForApplication(
                    providerInfo.applicationInfo);
            if (resourceId > 0) {
                if (density <= 0) {
                    density = context.getResources().getDisplayMetrics().densityDpi;
                }
                return resources.getDrawableForDensity(resourceId, density);
            }
        } catch (PackageManager.NameNotFoundException | Resources.NotFoundException e) {
            /* ignore */
        }
        return loadDefaultIcon ? providerInfo.loadIcon(context.getPackageManager()) : null;
public final android.graphics.drawable.DrawableloadIcon(android.content.Context context, int density)
Loads the icon to display for this AppWidget in the AppWidget picker. If not supplied in the xml, the application icon will be used. A client can optionally provide a desired density such as {@link android.util.DisplayMetrics#DENSITY_LOW} {@link android.util.DisplayMetrics#DENSITY_MEDIUM}, etc. If no density is provided, the density of the current display will be used.

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

param
context Context for accessing resources.
param
density The optional desired density as per {@link android.util.DisplayMetrics#densityDpi}.
return
The provider icon.

        return loadDrawable(context, density, providerInfo.getIconResource(), true);
public final java.lang.StringloadLabel(android.content.pm.PackageManager packageManager)
Loads the localized label to display to the user in the AppWidget picker.

param
packageManager Package manager instance for loading resources.
return
The label for the current locale.

        CharSequence label = providerInfo.loadLabel(packageManager);
        if (label != null) {
            return label.toString().trim();
        }
        return null;
public final android.graphics.drawable.DrawableloadPreviewImage(android.content.Context context, int density)
Loads a preview of what the AppWidget will look like after it's configured. A client can optionally provide a desired density such as {@link android.util.DisplayMetrics#DENSITY_LOW} {@link android.util.DisplayMetrics#DENSITY_MEDIUM}, etc. If no density is provided, the density of the current display will be used.

The loaded image corresponds to the android:previewImage attribute in the <receiver> element in the AndroidManifest.xml file.

param
context Context for accessing resources.
param
density The optional desired density as per {@link android.util.DisplayMetrics#densityDpi}.
return
The widget preview image or null if preview image is not available.

        return loadDrawable(context, density, previewImage, false);
public java.lang.StringtoString()


       
        return "AppWidgetProviderInfo(" + getProfile() + '/" + 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.minResizeWidth);
        out.writeInt(this.minResizeHeight);
        out.writeInt(this.updatePeriodMillis);
        out.writeInt(this.initialLayout);
        out.writeInt(this.initialKeyguardLayout);
        if (this.configure != null) {
            out.writeInt(1);
            this.configure.writeToParcel(out, flags);
        } else {
            out.writeInt(0);
        }
        out.writeString(this.label);
        out.writeInt(this.icon);
        out.writeInt(this.previewImage);
        out.writeInt(this.autoAdvanceViewId);
        out.writeInt(this.resizeMode);
        out.writeInt(this.widgetCategory);
        out.writeParcelable(this.providerInfo, flags);