The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2008 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 | |
Daniel Sandler | 325dc23 | 2013-06-05 22:57:57 -0400 | [diff] [blame] | 17 | package com.android.launcher3; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 18 | |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 19 | import android.content.ContentValues; |
Kenny Guy | ed13187 | 2014-04-30 03:02:21 +0100 | [diff] [blame] | 20 | import android.content.Context; |
Winson Chung | be36516 | 2012-05-07 10:34:12 -0700 | [diff] [blame] | 21 | import android.content.Intent; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 22 | import android.graphics.Bitmap; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 23 | |
Kenny Guy | ed13187 | 2014-04-30 03:02:21 +0100 | [diff] [blame] | 24 | import com.android.launcher3.compat.UserHandleCompat; |
| 25 | import com.android.launcher3.compat.UserManagerCompat; |
| 26 | |
Sameer Padala | be3e410 | 2014-04-21 19:36:14 -0700 | [diff] [blame] | 27 | import java.util.Arrays; |
Winson Chung | be36516 | 2012-05-07 10:34:12 -0700 | [diff] [blame] | 28 | |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 29 | /** |
| 30 | * Represents an item in the launcher. |
| 31 | */ |
Mathew Inwood | 72fbec1 | 2013-11-19 15:45:07 +0000 | [diff] [blame] | 32 | public class ItemInfo { |
Kenny Guy | ed13187 | 2014-04-30 03:02:21 +0100 | [diff] [blame] | 33 | |
| 34 | /** |
| 35 | * Intent extra to store the profile. Format: UserHandle |
| 36 | */ |
| 37 | static final String EXTRA_PROFILE = "profile"; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 38 | |
Hyunyoung Song | 3f47144 | 2015-04-08 19:01:34 -0700 | [diff] [blame] | 39 | public static final int NO_ID = -1; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 40 | |
| 41 | /** |
| 42 | * The id in the settings database for this item |
| 43 | */ |
Anjali Koppal | e3e646e | 2014-03-17 09:34:39 -0700 | [diff] [blame] | 44 | public long id = NO_ID; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 45 | |
| 46 | /** |
| 47 | * One of {@link LauncherSettings.Favorites#ITEM_TYPE_APPLICATION}, |
| 48 | * {@link LauncherSettings.Favorites#ITEM_TYPE_SHORTCUT}, |
Adam Cohen | df2cc41 | 2011-04-27 16:56:57 -0700 | [diff] [blame] | 49 | * {@link LauncherSettings.Favorites#ITEM_TYPE_FOLDER}, or |
The Android Open Source Project | 7376fae | 2009-03-11 12:11:58 -0700 | [diff] [blame] | 50 | * {@link LauncherSettings.Favorites#ITEM_TYPE_APPWIDGET}. |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 51 | */ |
Anjali Koppal | e3e646e | 2014-03-17 09:34:39 -0700 | [diff] [blame] | 52 | public int itemType; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 53 | |
| 54 | /** |
| 55 | * The id of the container that holds this item. For the desktop, this will be |
| 56 | * {@link LauncherSettings.Favorites#CONTAINER_DESKTOP}. For the all applications folder it |
| 57 | * will be {@link #NO_ID} (since it is not stored in the settings DB). For user folders |
| 58 | * it will be the id of the folder. |
| 59 | */ |
Anjali Koppal | e3e646e | 2014-03-17 09:34:39 -0700 | [diff] [blame] | 60 | public long container = NO_ID; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 61 | |
| 62 | /** |
| 63 | * Iindicates the screen in which the shortcut appears. |
| 64 | */ |
Anjali Koppal | e3e646e | 2014-03-17 09:34:39 -0700 | [diff] [blame] | 65 | public long screenId = -1; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 66 | |
| 67 | /** |
| 68 | * Indicates the X position of the associated cell. |
| 69 | */ |
Anjali Koppal | e3e646e | 2014-03-17 09:34:39 -0700 | [diff] [blame] | 70 | public int cellX = -1; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 71 | |
| 72 | /** |
| 73 | * Indicates the Y position of the associated cell. |
| 74 | */ |
Anjali Koppal | e3e646e | 2014-03-17 09:34:39 -0700 | [diff] [blame] | 75 | public int cellY = -1; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 76 | |
| 77 | /** |
| 78 | * Indicates the X cell span. |
| 79 | */ |
Anjali Koppal | e3e646e | 2014-03-17 09:34:39 -0700 | [diff] [blame] | 80 | public int spanX = 1; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 81 | |
| 82 | /** |
| 83 | * Indicates the Y cell span. |
| 84 | */ |
Hyunyoung Song | 3f47144 | 2015-04-08 19:01:34 -0700 | [diff] [blame] | 85 | public int spanY = 1; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 86 | |
Romain Guy | 73b979d | 2009-06-09 12:57:21 -0700 | [diff] [blame] | 87 | /** |
Adam Cohen | d41fbf5 | 2012-02-16 23:53:59 -0800 | [diff] [blame] | 88 | * Indicates the minimum X cell span. |
| 89 | */ |
Anjali Koppal | e3e646e | 2014-03-17 09:34:39 -0700 | [diff] [blame] | 90 | public int minSpanX = 1; |
Adam Cohen | d41fbf5 | 2012-02-16 23:53:59 -0800 | [diff] [blame] | 91 | |
| 92 | /** |
| 93 | * Indicates the minimum Y cell span. |
| 94 | */ |
Anjali Koppal | e3e646e | 2014-03-17 09:34:39 -0700 | [diff] [blame] | 95 | public int minSpanY = 1; |
Adam Cohen | 487f7dd | 2012-06-28 18:12:10 -0700 | [diff] [blame] | 96 | |
Adam Cohen | d41fbf5 | 2012-02-16 23:53:59 -0800 | [diff] [blame] | 97 | /** |
Sunny Goyal | 08f7261 | 2015-01-05 13:41:43 -0800 | [diff] [blame] | 98 | * Indicates the position in an ordered list. |
| 99 | */ |
| 100 | public int rank = 0; |
| 101 | |
| 102 | /** |
Adam Cohen | 487f7dd | 2012-06-28 18:12:10 -0700 | [diff] [blame] | 103 | * Indicates that this item needs to be updated in the db |
Romain Guy | 73b979d | 2009-06-09 12:57:21 -0700 | [diff] [blame] | 104 | */ |
Anjali Koppal | e3e646e | 2014-03-17 09:34:39 -0700 | [diff] [blame] | 105 | public boolean requiresDbUpdate = false; |
Adam Cohen | 487f7dd | 2012-06-28 18:12:10 -0700 | [diff] [blame] | 106 | |
| 107 | /** |
| 108 | * Title of the item |
| 109 | */ |
Hyunyoung Song | 3f47144 | 2015-04-08 19:01:34 -0700 | [diff] [blame] | 110 | public CharSequence title; |
Romain Guy | 73b979d | 2009-06-09 12:57:21 -0700 | [diff] [blame] | 111 | |
Patrick Dubroy | bbaa75c | 2011-03-08 18:47:40 -0800 | [diff] [blame] | 112 | /** |
Kenny Guy | c2bd810 | 2014-06-30 12:30:31 +0100 | [diff] [blame] | 113 | * Content description of the item. |
| 114 | */ |
Hyunyoung Song | 3f47144 | 2015-04-08 19:01:34 -0700 | [diff] [blame] | 115 | public CharSequence contentDescription; |
Kenny Guy | c2bd810 | 2014-06-30 12:30:31 +0100 | [diff] [blame] | 116 | |
| 117 | /** |
Patrick Dubroy | bbaa75c | 2011-03-08 18:47:40 -0800 | [diff] [blame] | 118 | * The position of the item in a drag-and-drop operation. |
| 119 | */ |
Hyunyoung Song | 3f47144 | 2015-04-08 19:01:34 -0700 | [diff] [blame] | 120 | public int[] dropPos = null; |
Patrick Dubroy | bbaa75c | 2011-03-08 18:47:40 -0800 | [diff] [blame] | 121 | |
Hyunyoung Song | 3f47144 | 2015-04-08 19:01:34 -0700 | [diff] [blame] | 122 | public UserHandleCompat user; |
Kenny Guy | ed13187 | 2014-04-30 03:02:21 +0100 | [diff] [blame] | 123 | |
Hyunyoung Song | 3f47144 | 2015-04-08 19:01:34 -0700 | [diff] [blame] | 124 | public ItemInfo() { |
Kenny Guy | c2bd810 | 2014-06-30 12:30:31 +0100 | [diff] [blame] | 125 | user = UserHandleCompat.myUserHandle(); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 126 | } |
| 127 | |
Michael Jurka | c9d95c5 | 2011-08-29 14:03:34 -0700 | [diff] [blame] | 128 | ItemInfo(ItemInfo info) { |
Sunny Goyal | ff57227 | 2014-07-23 13:58:07 -0700 | [diff] [blame] | 129 | copyFrom(info); |
| 130 | // tempdebug: |
| 131 | LauncherModel.checkItemInfo(this); |
| 132 | } |
| 133 | |
| 134 | public void copyFrom(ItemInfo info) { |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 135 | id = info.id; |
| 136 | cellX = info.cellX; |
| 137 | cellY = info.cellY; |
| 138 | spanX = info.spanX; |
| 139 | spanY = info.spanY; |
Sunny Goyal | 08f7261 | 2015-01-05 13:41:43 -0800 | [diff] [blame] | 140 | rank = info.rank; |
Adam Cohen | dcd297f | 2013-06-18 13:13:40 -0700 | [diff] [blame] | 141 | screenId = info.screenId; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 142 | itemType = info.itemType; |
| 143 | container = info.container; |
Kenny Guy | ed13187 | 2014-04-30 03:02:21 +0100 | [diff] [blame] | 144 | user = info.user; |
Kenny Guy | c2bd810 | 2014-06-30 12:30:31 +0100 | [diff] [blame] | 145 | contentDescription = info.contentDescription; |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 146 | } |
| 147 | |
Anjali Koppal | e3e646e | 2014-03-17 09:34:39 -0700 | [diff] [blame] | 148 | public Intent getIntent() { |
Winson Chung | 997a923 | 2013-07-24 15:33:46 -0700 | [diff] [blame] | 149 | throw new RuntimeException("Unexpected Intent"); |
| 150 | } |
| 151 | |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 152 | /** |
| 153 | * Write the fields of this item to the DB |
| 154 | * |
Kenny Guy | ed13187 | 2014-04-30 03:02:21 +0100 | [diff] [blame] | 155 | * @param context A context object to use for getting UserManagerCompat |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 156 | * @param values |
| 157 | */ |
Kenny Guy | ed13187 | 2014-04-30 03:02:21 +0100 | [diff] [blame] | 158 | |
| 159 | void onAddToDatabase(Context context, ContentValues values) { |
Romain Guy | 73b979d | 2009-06-09 12:57:21 -0700 | [diff] [blame] | 160 | values.put(LauncherSettings.BaseLauncherColumns.ITEM_TYPE, itemType); |
Adam Cohen | 487f7dd | 2012-06-28 18:12:10 -0700 | [diff] [blame] | 161 | values.put(LauncherSettings.Favorites.CONTAINER, container); |
Adam Cohen | dcd297f | 2013-06-18 13:13:40 -0700 | [diff] [blame] | 162 | values.put(LauncherSettings.Favorites.SCREEN, screenId); |
Adam Cohen | 487f7dd | 2012-06-28 18:12:10 -0700 | [diff] [blame] | 163 | values.put(LauncherSettings.Favorites.CELLX, cellX); |
| 164 | values.put(LauncherSettings.Favorites.CELLY, cellY); |
| 165 | values.put(LauncherSettings.Favorites.SPANX, spanX); |
| 166 | values.put(LauncherSettings.Favorites.SPANY, spanY); |
Sunny Goyal | 08f7261 | 2015-01-05 13:41:43 -0800 | [diff] [blame] | 167 | values.put(LauncherSettings.Favorites.RANK, rank); |
Kenny Guy | ed13187 | 2014-04-30 03:02:21 +0100 | [diff] [blame] | 168 | long serialNumber = UserManagerCompat.getInstance(context).getSerialNumberForUser(user); |
| 169 | values.put(LauncherSettings.Favorites.PROFILE_ID, serialNumber); |
Adrian Roos | 8f3f683 | 2014-04-28 15:45:52 +0200 | [diff] [blame] | 170 | |
| 171 | if (screenId == Workspace.EXTRA_EMPTY_SCREEN_ID) { |
| 172 | // We should never persist an item on the extra empty screen. |
| 173 | throw new RuntimeException("Screen id should not be EXTRA_EMPTY_SCREEN_ID"); |
| 174 | } |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | static void writeBitmap(ContentValues values, Bitmap bitmap) { |
| 178 | if (bitmap != null) { |
Sunny Goyal | 5b0e669 | 2015-03-19 14:31:19 -0700 | [diff] [blame] | 179 | byte[] data = Utilities.flattenBitmap(bitmap); |
Joe Onorato | 0589f0f | 2010-02-08 13:44:00 -0800 | [diff] [blame] | 180 | values.put(LauncherSettings.Favorites.ICON, data); |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 181 | } |
| 182 | } |
Adam Cohen | 4eac29a | 2011-07-11 17:53:37 -0700 | [diff] [blame] | 183 | |
| 184 | /** |
| 185 | * It is very important that sub-classes implement this if they contain any references |
| 186 | * to the activity (anything in the view hierarchy etc.). If not, leaks can result since |
| 187 | * ItemInfo objects persist across rotation and can hence leak by holding stale references |
| 188 | * to the old view hierarchy / activity. |
| 189 | */ |
Joe Onorato | 9c1289c | 2009-08-17 11:03:03 -0400 | [diff] [blame] | 190 | void unbind() { |
| 191 | } |
Daniel Sandler | 8802e96 | 2010-05-26 16:28:16 -0400 | [diff] [blame] | 192 | |
| 193 | @Override |
| 194 | public String toString() { |
Winson Chung | c07918d | 2011-07-01 15:35:26 -0700 | [diff] [blame] | 195 | return "Item(id=" + this.id + " type=" + this.itemType + " container=" + this.container |
Adam Cohen | dcd297f | 2013-06-18 13:13:40 -0700 | [diff] [blame] | 196 | + " screen=" + screenId + " cellX=" + cellX + " cellY=" + cellY + " spanX=" + spanX |
Kenny Guy | ed13187 | 2014-04-30 03:02:21 +0100 | [diff] [blame] | 197 | + " spanY=" + spanY + " dropPos=" + Arrays.toString(dropPos) |
| 198 | + " user=" + user + ")"; |
Daniel Sandler | 8802e96 | 2010-05-26 16:28:16 -0400 | [diff] [blame] | 199 | } |
The Android Open Source Project | 31dd503 | 2009-03-03 19:32:27 -0800 | [diff] [blame] | 200 | } |