LauncherAppWidgetInfo.java revision 651077bdd603bb182be039925fd17bdf0da15016
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 */ 36651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal public static final int RESTORE_REMAP_PENDING = 1; 37651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal 38651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal /** 39651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal * Widget provider is not yet installed. 40651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal */ 41651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal public static final int RESTORE_PROVIDER_PENDING = 2; 42651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal 4331dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project /** 446569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy * Indicates that the widget hasn't been instantiated yet. 456569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy */ 466569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy static final int NO_ID = -1; 476569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy 486569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy /** 49629de3ef739883c0962423cc0c3a26299f162d3dRomain Guy * Identifier for this widget when talking with 50629de3ef739883c0962423cc0c3a26299f162d3dRomain Guy * {@link android.appwidget.AppWidgetManager} for updates. 5131dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project */ 526569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy int appWidgetId = NO_ID; 536569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy 54af44209bfa60da3c7ab49b7f508f9effd316ee41Michael Jurka ComponentName providerName; 55ded9f8d8658d0b6601006c0a954cd3bf530e55c1Adam Cohen 566569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy // TODO: Are these necessary here? 576569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy int minWidth = -1; 586569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy int minHeight = -1; 596569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy 60651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal /** 61651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal * Indicates the restore status of the widget. 62651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal */ 63651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal int restoreStatus; 64651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal 65211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung private boolean mHasNotifiedInitialWidgetSizeChanged; 66211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung 6731dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project /** 687376faefbbcbe30cc4e3f706ab95c254a4707d98The Android Open Source Project * View that holds this widget after it's been created. This view isn't created 6931dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project * until Launcher knows it's needed. 7031dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project */ 717376faefbbcbe30cc4e3f706ab95c254a4707d98The Android Open Source Project AppWidgetHostView hostView = null; 7231dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project 7311a4937fbff0dbc50fb022513dc3b6c643154445Winson Chung LauncherAppWidgetInfo(int appWidgetId, ComponentName providerName) { 746569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy itemType = LauncherSettings.Favorites.ITEM_TYPE_APPWIDGET; 7511a4937fbff0dbc50fb022513dc3b6c643154445Winson Chung this.appWidgetId = appWidgetId; 766569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy this.providerName = providerName; 776569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy 786569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy // Since the widget isn't instantiated yet, we don't know these values. Set them to -1 796569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy // to indicate that they should be calculated based on the layout and minWidth/minHeight 806569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy spanX = -1; 816569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy spanY = -1; 82ed13187a745866483139e2878037e1f8427ce567Kenny Guy // We only support app widgets on current user. 83ed13187a745866483139e2878037e1f8427ce567Kenny Guy user = UserHandleCompat.myUserHandle(); 84651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal restoreStatus = RESTORE_COMPLETED; 856569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy } 866569f2c80e179c2f8ed73dae6b01d971ec20f005Patrick Dubroy 8731dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project @Override 88ed13187a745866483139e2878037e1f8427ce567Kenny Guy void onAddToDatabase(Context context, ContentValues values) { 89ed13187a745866483139e2878037e1f8427ce567Kenny Guy super.onAddToDatabase(context, values); 907376faefbbcbe30cc4e3f706ab95c254a4707d98The Android Open Source Project values.put(LauncherSettings.Favorites.APPWIDGET_ID, appWidgetId); 91d5e66bfca1dc4fdbab7513d88c6568bc4d17bca8Chris Wren values.put(LauncherSettings.Favorites.APPWIDGET_PROVIDER, providerName.flattenToString()); 9231dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project } 9331dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project 94211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung /** 95211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung * When we bind the widget, we should notify the widget that the size has changed if we have not 96211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung * done so already (only really for default workspace widgets). 97211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung */ 98211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung void onBindAppWidget(Launcher launcher) { 99aaa5c21ee2e03def644fb6ba8eadbb59873ddd45Adam Cohen if (!mHasNotifiedInitialWidgetSizeChanged) { 100211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung notifyWidgetSizeChanged(launcher); 101211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung } 102211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung } 103211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung 104211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung /** 105211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung * Trigger an update callback to the widget to notify it that its size has changed. 106211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung */ 107211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung void notifyWidgetSizeChanged(Launcher launcher) { 108211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung AppWidgetResizeFrame.updateWidgetSizeRanges(hostView, launcher, spanX, spanY); 109211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung mHasNotifiedInitialWidgetSizeChanged = true; 110211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung } 111211bac3cd89b26bda4ff52df984731d11156dc38Winson Chung 11231dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project @Override 11331dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project public String toString() { 1148802e960495e61803c18ea3dda2e30ef0a611d8fDaniel Sandler return "AppWidget(id=" + Integer.toString(appWidgetId) + ")"; 11531dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project } 1169c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato 1179c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato @Override 1189c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato void unbind() { 1199c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato super.unbind(); 1209c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato hostView = null; 1219c1289cb3bfb74f86e53ec7ac6dd76bb39666b2dJoe Onorato } 122651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal 123651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal public final boolean isWidgetIdValid() { 124651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal return restoreStatus != RESTORE_REMAP_PENDING; 125651077bdd603bb182be039925fd17bdf0da15016Sunny Goyal } 12631dd503c6aa69018e694d91724d46db49ea09327The Android Open Source Project} 127