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     * Identifier for this widget when talking with
60     * {@link android.appwidget.AppWidgetManager} for updates.
61     */
62    int appWidgetId = NO_ID;
63
64    ComponentName providerName;
65
66    // TODO: Are these necessary here?
67    int minWidth = -1;
68    int minHeight = -1;
69
70    /**
71     * Indicates the restore status of the widget.
72     */
73    int restoreStatus;
74
75    /**
76     * Indicates the installation progress of the widget provider
77     */
78    int installProgress = -1;
79
80    private boolean mHasNotifiedInitialWidgetSizeChanged;
81
82    /**
83     * View that holds this widget after it's been created.  This view isn't created
84     * until Launcher knows it's needed.
85     */
86    AppWidgetHostView hostView = null;
87
88    LauncherAppWidgetInfo(int appWidgetId, ComponentName providerName) {
89        itemType = LauncherSettings.Favorites.ITEM_TYPE_APPWIDGET;
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    @Override
103    void onAddToDatabase(Context context, ContentValues values) {
104        super.onAddToDatabase(context, values);
105        values.put(LauncherSettings.Favorites.APPWIDGET_ID, appWidgetId);
106        values.put(LauncherSettings.Favorites.APPWIDGET_PROVIDER, providerName.flattenToString());
107        values.put(LauncherSettings.Favorites.RESTORED, restoreStatus);
108    }
109
110    /**
111     * When we bind the widget, we should notify the widget that the size has changed if we have not
112     * done so already (only really for default workspace widgets).
113     */
114    void onBindAppWidget(Launcher launcher) {
115        if (!mHasNotifiedInitialWidgetSizeChanged) {
116            notifyWidgetSizeChanged(launcher);
117        }
118    }
119
120    /**
121     * Trigger an update callback to the widget to notify it that its size has changed.
122     */
123    void notifyWidgetSizeChanged(Launcher launcher) {
124        AppWidgetResizeFrame.updateWidgetSizeRanges(hostView, launcher, spanX, spanY);
125        mHasNotifiedInitialWidgetSizeChanged = true;
126    }
127
128    @Override
129    public String toString() {
130        return "AppWidget(id=" + Integer.toString(appWidgetId) + ")";
131    }
132
133    @Override
134    void unbind() {
135        super.unbind();
136        hostView = null;
137    }
138
139    public final boolean isWidgetIdValid() {
140        return (restoreStatus & FLAG_ID_NOT_VALID) == 0;
141    }
142
143    public final boolean hasRestoreFlag(int flag) {
144        return (restoreStatus & flag) == flag;
145    }
146}
147