LauncherAppWidgetInfo.java revision e7b8cd9e4f8d38d0445f3a032fafd44332f70878
131dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project/* 231dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * Copyright (C) 2009 The Android Open Source Project 331dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * 431dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 531dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * you may not use this file except in compliance with the License. 631dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * You may obtain a copy of the License at 731dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * 831dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 931dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * 1031dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 1131dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 1231dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1331dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * See the License for the specific language governing permissions and 1431dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * limitations under the License. 1531dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project */ 1631dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project 17325dc23624160689e59fbac708cf6f222b20d025Daniel Sandlerpackage com.android.launcher3; 1831dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project 197376faefbbcbe30cc4e3f706ab95c254a4707d98The Android Open Source Projectimport android.appwidget.AppWidgetHostView; 20af44209bfa60da3c7ab49b7f508f9effd316ee41Michael Jurkaimport android.content.ComponentName; 2131dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Projectimport android.content.ContentValues; 22ed13187a745866483139e2878037e1f8427ce567Kenny Guyimport android.content.Context; 23ed13187a745866483139e2878037e1f8427ce567Kenny Guy 24ed13187a745866483139e2878037e1f8427ce567Kenny Guyimport com.android.launcher3.compat.UserHandleCompat; 2531dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project 2631dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project/** 276569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy * Represents a widget (either instantiated or about to be) in the Launcher. 2831dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project */ 297b168a1bb94044d9ae11004bae18beba9eed46fdAnjali Koppalpublic class LauncherAppWidgetInfo extends ItemInfo { 3031dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project 31651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal public static final int RESTORE_COMPLETED = 0; 32651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal 33651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal /** 34651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal * This is set during the package backup creation. 35651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal */ 36ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal public static final int FLAG_ID_NOT_VALID = 1; 37651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal 38651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal /** 39ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal * Indicates that the provider is not available yet. 40651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal */ 41ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal public static final int FLAG_PROVIDER_NOT_READY = 2; 42ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal 43ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal /** 44ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal * Indicates that the widget UI is not yet ready, and user needs to set it up again. 45ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal */ 46ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal public static final int FLAG_UI_NOT_READY = 4; 47651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal 4831dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project /** 496569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy * Indicates that the widget hasn't been instantiated yet. 506569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy */ 516569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy static final int NO_ID = -1; 526569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy 536569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy /** 54629de3ef739883c0962423cc0c3a26299f162d3dRomain Guy * Identifier for this widget when talking with 55629de3ef739883c0962423cc0c3a26299f162d3dRomain Guy * {@link android.appwidget.AppWidgetManager} for updates. 5631dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project */ 576569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy int appWidgetId = NO_ID; 586569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy 59af44209bfa60da3c7ab49b7f508f9effd316ee41Michael Jurka ComponentName providerName; 60ded9f8d8658d0b6601006c0a954cd3bf530e55c1Adam Cohen 616569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy // TODO: Are these necessary here? 626569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy int minWidth = -1; 636569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy int minHeight = -1; 646569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy 65651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal /** 66651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal * Indicates the restore status of the widget. 67651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal */ 68651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal int restoreStatus; 69651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal 700fc1be164e982433e619bcbb16aa67e28ff681efSunny Goyal /** 710fc1be164e982433e619bcbb16aa67e28ff681efSunny Goyal * Indicates the installation progress of the widget provider 720fc1be164e982433e619bcbb16aa67e28ff681efSunny Goyal */ 73e7b8cd9e4f8d38d0445f3a032fafd44332f70878Sunny Goyal int installProgress = -1; 740fc1be164e982433e619bcbb16aa67e28ff681efSunny Goyal 75211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung private boolean mHasNotifiedInitialWidgetSizeChanged; 76211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung 7731dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project /** 787376faefbbcbe30cc4e3f706ab95c254a4707d98The Android Open Source Project * View that holds this widget after it's been created. This view isn't created 7931dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * until Launcher knows it's needed. 8031dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project */ 817376faefbbcbe30cc4e3f706ab95c254a4707d98The Android Open Source Project AppWidgetHostView hostView = null; 8231dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project 8311a4937fbff0dbc50fb022513dc3b6c643154445Winson Chung LauncherAppWidgetInfo(int appWidgetId, ComponentName providerName) { 846569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy itemType = LauncherSettings.Favorites.ITEM_TYPE_APPWIDGET; 8511a4937fbff0dbc50fb022513dc3b6c643154445Winson Chung this.appWidgetId = appWidgetId; 866569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy this.providerName = providerName; 876569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy 886569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy // Since the widget isn't instantiated yet, we don't know these values. Set them to -1 896569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy // to indicate that they should be calculated based on the layout and minWidth/minHeight 906569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy spanX = -1; 916569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy spanY = -1; 92ed13187a745866483139e2878037e1f8427ce567Kenny Guy // We only support app widgets on current user. 93ed13187a745866483139e2878037e1f8427ce567Kenny Guy user = UserHandleCompat.myUserHandle(); 94651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal restoreStatus = RESTORE_COMPLETED; 956569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy } 966569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy 9731dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project @Override 98ed13187a745866483139e2878037e1f8427ce567Kenny Guy void onAddToDatabase(Context context, ContentValues values) { 99ed13187a745866483139e2878037e1f8427ce567Kenny Guy super.onAddToDatabase(context, values); 1007376faefbbcbe30cc4e3f706ab95c254a4707d98The Android Open Source Project values.put(LauncherSettings.Favorites.APPWIDGET_ID, appWidgetId); 101d5e66bfca1dc4fdbab7513d88c6568bc4d17bca8Chris Wren values.put(LauncherSettings.Favorites.APPWIDGET_PROVIDER, providerName.flattenToString()); 102ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal values.put(LauncherSettings.Favorites.RESTORED, restoreStatus); 10331dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project } 10431dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project 105211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung /** 106211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung * When we bind the widget, we should notify the widget that the size has changed if we have not 107211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung * done so already (only really for default workspace widgets). 108211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung */ 109211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung void onBindAppWidget(Launcher launcher) { 110aaa5c21ee2e03def644fb6ba8eadbb59873ddd45Adam Cohen if (!mHasNotifiedInitialWidgetSizeChanged) { 111211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung notifyWidgetSizeChanged(launcher); 112211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung } 113211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung } 114211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung 115211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung /** 116211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung * Trigger an update callback to the widget to notify it that its size has changed. 117211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung */ 118211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung void notifyWidgetSizeChanged(Launcher launcher) { 119211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung AppWidgetResizeFrame.updateWidgetSizeRanges(hostView, launcher, spanX, spanY); 120211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung mHasNotifiedInitialWidgetSizeChanged = true; 121211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung } 122211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung 12331dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project @Override 12431dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project public String toString() { 1258802e960495e61803c18ea3dda2e30ef0a611d8fDaniel Sandler return "AppWidget(id=" + Integer.toString(appWidgetId) + ")"; 12631dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project } 1279c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato 1289c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato @Override 1299c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato void unbind() { 1309c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato super.unbind(); 1319c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato hostView = null; 1329c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato } 133651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal 134651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal public final boolean isWidgetIdValid() { 135ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal return (restoreStatus & FLAG_ID_NOT_VALID) == 0; 136ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal } 137ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal 138ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal public final boolean hasRestoreFlag(int flag) { 139ff572277112ec3d6a6a8c1be274d6fa1019e3648Sunny Goyal return (restoreStatus & flag) == flag; 140651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal } 14131dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project} 142