LauncherAppWidgetInfo.java revision 6d02c7a0337d37e5b1c596a4acec0c292a9b7f93 
1/*
2 * Copyright (C) 2009 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.launcher3;
18
19import android.appwidget.AppWidgetHostView;
20import android.content.ComponentName;
21import android.content.ContentValues;
22import android.content.Context;
23
24import com.android.launcher3.compat.UserHandleCompat;
25
26/**
27 * Represents a widget (either instantiated or about to be) in the Launcher.
28 */
29public class LauncherAppWidgetInfo extends ItemInfo {
30
31    public static final int RESTORE_COMPLETED = 0;
32
33    /**
34     * This is set during the package backup creation.
35     */
36    public static final int FLAG_ID_NOT_VALID = 1;
37
38    /**
39     * Indicates that the provider is not available yet.
40     */
41    public static final int FLAG_PROVIDER_NOT_READY = 2;
42
43    /**
44     * Indicates that the widget UI is not yet ready, and user needs to set it up again.
45     */
46    public static final int FLAG_UI_NOT_READY = 4;
47
48    /**
49     * Indicates that the widget restore has started.
50     */
51    public static final int FLAG_RESTORE_STARTED = 8;
52
53    /**
54     * Indicates that the widget hasn't been instantiated yet.
55     */
56    static final int NO_ID = -1;
57
58    /**
59     * Indicates that this is a locally defined widget and hence has no system allocated id.
60     */
61    static final int CUSTOM_WIDGET_ID = -100;
62
63    /**
64     * Identifier for this widget when talking with
65     * {@link android.appwidget.AppWidgetManager} for updates.
66     */
67    int appWidgetId = NO_ID;
68
69    public ComponentName providerName;
70
71    /**
72     * Indicates the restore status of the widget.
73     */
74    int restoreStatus;
75
76    /**
77     * Indicates the installation progress of the widget provider
78     */
79    int installProgress = -1;
80
81    private boolean mHasNotifiedInitialWidgetSizeChanged;
82
83    LauncherAppWidgetInfo(int appWidgetId, ComponentName providerName) {
84        if (appWidgetId == CUSTOM_WIDGET_ID) {
85            itemType = LauncherSettings.Favorites.ITEM_TYPE_CUSTOM_APPWIDGET;
86        } else {
87            itemType = LauncherSettings.Favorites.ITEM_TYPE_APPWIDGET;
88        }
89
90        this.appWidgetId = appWidgetId;
91        this.providerName = providerName;
92
93        // Since the widget isn't instantiated yet, we don't know these values. Set them to -1
94        // to indicate that they should be calculated based on the layout and minWidth/minHeight
95        spanX = -1;
96        spanY = -1;
97        // We only support app widgets on current user.
98        user = UserHandleCompat.myUserHandle();
99        restoreStatus = RESTORE_COMPLETED;
100    }
101
102    public boolean isCustomWidget() {
103        return appWidgetId == CUSTOM_WIDGET_ID;
104    }
105
106    @Override
107    void onAddToDatabase(Context context, ContentValues values) {
108        super.onAddToDatabase(context, values);
109        values.put(LauncherSettings.Favorites.APPWIDGET_ID, appWidgetId);
110        values.put(LauncherSettings.Favorites.APPWIDGET_PROVIDER, providerName.flattenToString());
111        values.put(LauncherSettings.Favorites.RESTORED, restoreStatus);
112    }
113
114    /**
115     * When we bind the widget, we should notify the widget that the size has changed if we have not
116     * done so already (only really for default workspace widgets).
117     */
118    void onBindAppWidget(Launcher launcher, AppWidgetHostView hostView) {
119        if (!mHasNotifiedInitialWidgetSizeChanged) {
120            AppWidgetResizeFrame.updateWidgetSizeRanges(hostView, launcher, spanX, spanY);
121            mHasNotifiedInitialWidgetSizeChanged = true;
122        }
123    }
124
125    @Override
126    public String toString() {
127        return "AppWidget(id=" + Integer.toString(appWidgetId) + ")";
128    }
129
130    public final boolean isWidgetIdValid() {
131        return (restoreStatus & FLAG_ID_NOT_VALID) == 0;
132    }
133
134    public final boolean hasRestoreFlag(int flag) {
135        return (restoreStatus & flag) == flag;
136    }
137}
138