blob: f99c08a595da09df163cef5fcf1dff942a9ce145 [file] [log] [blame]
Winson Chung97d85d22011-04-13 11:27:36 -07001/*
Hyunyoung Songee3e6a72015-02-20 14:25:27 -08002 * Copyright (C) 2015 The Android Open Source Project
Winson Chung97d85d22011-04-13 11:27:36 -07003 *
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 Sandler325dc232013-06-05 22:57:57 -040017package com.android.launcher3;
Winson Chung97d85d22011-04-13 11:27:36 -070018
Hyunyoung Songee3e6a72015-02-20 14:25:27 -080019import android.util.Log;
Winson Chung97d85d22011-04-13 11:27:36 -070020import android.view.KeyEvent;
Sunny Goyalb3726d92014-08-20 16:58:17 -070021import android.view.SoundEffectConstants;
Winson Chung97d85d22011-04-13 11:27:36 -070022import android.view.View;
23import android.view.ViewGroup;
Winson Chung97d85d22011-04-13 11:27:36 -070024
Sunny Goyal6c56c682015-07-16 14:09:05 -070025import com.android.launcher3.config.ProviderConfig;
Adam Cohenf9c184a2016-01-15 16:47:43 -080026import com.android.launcher3.folder.Folder;
27import com.android.launcher3.folder.FolderPagedView;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -080028import com.android.launcher3.util.FocusLogic;
Adam Cohen091440a2015-03-18 14:16:05 -070029import com.android.launcher3.util.Thunk;
Winson Chungfaa13252011-06-13 18:15:54 -070030
Winson Chung97d85d22011-04-13 11:27:36 -070031/**
Winson Chung4d279d92011-07-21 11:46:32 -070032 * A keyboard listener we set on all the workspace icons.
33 */
Adam Cohenac56cff2011-09-28 20:45:37 -070034class IconKeyEventListener implements View.OnKeyListener {
Hyunyoung Songee3e6a72015-02-20 14:25:27 -080035 @Override
Winson Chung4d279d92011-07-21 11:46:32 -070036 public boolean onKey(View v, int keyCode, KeyEvent event) {
Adam Cohenac56cff2011-09-28 20:45:37 -070037 return FocusHelper.handleIconKeyEvent(v, keyCode, event);
38 }
39}
40
41/**
Winson Chung3d503fb2011-07-13 17:25:49 -070042 * A keyboard listener we set on all the hotseat buttons.
Winson Chung4e6a9762011-05-09 11:56:34 -070043 */
Adam Cohenac56cff2011-09-28 20:45:37 -070044class HotseatIconKeyEventListener implements View.OnKeyListener {
Hyunyoung Songee3e6a72015-02-20 14:25:27 -080045 @Override
Winson Chung4e6a9762011-05-09 11:56:34 -070046 public boolean onKey(View v, int keyCode, KeyEvent event) {
Hyunyoung Songee3e6a72015-02-20 14:25:27 -080047 return FocusHelper.handleHotseatButtonKeyEvent(v, keyCode, event);
Winson Chung4e6a9762011-05-09 11:56:34 -070048 }
49}
50
Tony Wickham0fa5ada2015-11-13 17:32:20 -080051/**
52 * A keyboard listener we set on full screen pages (e.g. custom content).
53 */
54class FullscreenKeyEventListener implements View.OnKeyListener {
55 @Override
56 public boolean onKey(View v, int keyCode, KeyEvent event) {
57 if (keyCode == KeyEvent.KEYCODE_DPAD_LEFT || keyCode == KeyEvent.KEYCODE_DPAD_RIGHT
58 || keyCode == KeyEvent.KEYCODE_PAGE_DOWN || keyCode == KeyEvent.KEYCODE_PAGE_UP) {
59 // Handle the key event just like a workspace icon would in these cases. In this case,
60 // it will basically act as if there is a single icon in the top left (so you could
61 // think of the fullscreen page as a focusable fullscreen widget).
62 return FocusHelper.handleIconKeyEvent(v, keyCode, event);
63 }
64 return false;
65 }
66}
67
Winson Chung97d85d22011-04-13 11:27:36 -070068public class FocusHelper {
Winson Chung97d85d22011-04-13 11:27:36 -070069
Hyunyoung Songee3e6a72015-02-20 14:25:27 -080070 private static final String TAG = "FocusHelper";
71 private static final boolean DEBUG = false;
72
Hyunyoung Songee3e6a72015-02-20 14:25:27 -080073 /**
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -070074 * Handles key events in paged folder.
Sunny Goyal290800b2015-03-05 11:33:33 -080075 */
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -070076 public static class PagedFolderKeyEventListener implements View.OnKeyListener {
Sunny Goyal290800b2015-03-05 11:33:33 -080077
78 private final Folder mFolder;
79
80 public PagedFolderKeyEventListener(Folder folder) {
81 mFolder = folder;
82 }
83
84 @Override
Hyunyoung Songada50982015-04-10 14:35:23 -070085 public boolean onKey(View v, int keyCode, KeyEvent e) {
86 boolean consume = FocusLogic.shouldConsume(keyCode);
87 if (e.getAction() == KeyEvent.ACTION_UP) {
88 return consume;
Sunny Goyal290800b2015-03-05 11:33:33 -080089 }
Hyunyoung Songada50982015-04-10 14:35:23 -070090 if (DEBUG) {
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -070091 Log.v(TAG, String.format("Handle ALL Folders keyevent=[%s].",
Hyunyoung Songada50982015-04-10 14:35:23 -070092 KeyEvent.keyCodeToString(keyCode)));
93 }
Sunny Goyal290800b2015-03-05 11:33:33 -080094
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -070095 if (!(v.getParent() instanceof ShortcutAndWidgetContainer)) {
Sunny Goyal6c56c682015-07-16 14:09:05 -070096 if (ProviderConfig.IS_DOGFOOD_BUILD) {
Hyunyoung Songada50982015-04-10 14:35:23 -070097 throw new IllegalStateException("Parent of the focused item is not supported.");
98 } else {
99 return false;
100 }
101 }
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800102
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700103 // Initialize variables.
104 final ShortcutAndWidgetContainer itemContainer = (ShortcutAndWidgetContainer) v.getParent();
105 final CellLayout cellLayout = (CellLayout) itemContainer.getParent();
Hyunyoung Songada50982015-04-10 14:35:23 -0700106
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700107 final int iconIndex = itemContainer.indexOfChild(v);
108 final FolderPagedView pagedView = (FolderPagedView) cellLayout.getParent();
109
110 final int pageIndex = pagedView.indexOfChild(cellLayout);
111 final int pageCount = pagedView.getPageCount();
Sunny Goyalc6205602015-05-21 20:46:33 -0700112 final boolean isLayoutRtl = Utilities.isRtl(v.getResources());
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700113
114 int[][] matrix = FocusLogic.createSparseMatrix(cellLayout);
Hyunyoung Songada50982015-04-10 14:35:23 -0700115 // Process focus.
Tony Wickham329d8bf2015-12-04 09:48:17 -0800116 int newIconIndex = FocusLogic.handleKeyEvent(keyCode, matrix, iconIndex, pageIndex,
117 pageCount, isLayoutRtl);
Hyunyoung Songada50982015-04-10 14:35:23 -0700118 if (newIconIndex == FocusLogic.NOOP) {
119 handleNoopKey(keyCode, v);
120 return consume;
121 }
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700122 ShortcutAndWidgetContainer newParent = null;
123 View child = null;
124
Hyunyoung Songada50982015-04-10 14:35:23 -0700125 switch (newIconIndex) {
126 case FocusLogic.PREVIOUS_PAGE_RIGHT_COLUMN:
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700127 case FocusLogic.PREVIOUS_PAGE_LEFT_COLUMN:
128 newParent = getCellLayoutChildrenForIndex(pagedView, pageIndex - 1);
Hyunyoung Songada50982015-04-10 14:35:23 -0700129 if (newParent != null) {
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700130 int row = ((CellLayout.LayoutParams) v.getLayoutParams()).cellY;
131 pagedView.snapToPage(pageIndex - 1);
132 child = newParent.getChildAt(
133 ((newIconIndex == FocusLogic.PREVIOUS_PAGE_LEFT_COLUMN)
Tony Wickham329d8bf2015-12-04 09:48:17 -0800134 ^ newParent.invertLayoutHorizontally()) ? 0 : matrix.length - 1,
135 row);
Hyunyoung Songada50982015-04-10 14:35:23 -0700136 }
137 break;
138 case FocusLogic.PREVIOUS_PAGE_FIRST_ITEM:
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700139 newParent = getCellLayoutChildrenForIndex(pagedView, pageIndex - 1);
Hyunyoung Songada50982015-04-10 14:35:23 -0700140 if (newParent != null) {
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700141 pagedView.snapToPage(pageIndex - 1);
142 child = newParent.getChildAt(0, 0);
Hyunyoung Songada50982015-04-10 14:35:23 -0700143 }
144 break;
145 case FocusLogic.PREVIOUS_PAGE_LAST_ITEM:
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700146 newParent = getCellLayoutChildrenForIndex(pagedView, pageIndex - 1);
Hyunyoung Songada50982015-04-10 14:35:23 -0700147 if (newParent != null) {
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700148 pagedView.snapToPage(pageIndex - 1);
Tony Wickham329d8bf2015-12-04 09:48:17 -0800149 child = newParent.getChildAt(matrix.length - 1, matrix[0].length - 1);
Hyunyoung Songada50982015-04-10 14:35:23 -0700150 }
151 break;
152 case FocusLogic.NEXT_PAGE_FIRST_ITEM:
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700153 newParent = getCellLayoutChildrenForIndex(pagedView, pageIndex + 1);
Hyunyoung Songada50982015-04-10 14:35:23 -0700154 if (newParent != null) {
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700155 pagedView.snapToPage(pageIndex + 1);
156 child = newParent.getChildAt(0, 0);
Hyunyoung Songada50982015-04-10 14:35:23 -0700157 }
158 break;
159 case FocusLogic.NEXT_PAGE_LEFT_COLUMN:
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700160 case FocusLogic.NEXT_PAGE_RIGHT_COLUMN:
161 newParent = getCellLayoutChildrenForIndex(pagedView, pageIndex + 1);
Hyunyoung Songada50982015-04-10 14:35:23 -0700162 if (newParent != null) {
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700163 pagedView.snapToPage(pageIndex + 1);
Tony Wickham25189852015-11-04 17:44:32 -0800164 child = FocusLogic.getAdjacentChildInNextFolderPage(
165 newParent, v, newIconIndex);
Hyunyoung Songada50982015-04-10 14:35:23 -0700166 }
167 break;
168 case FocusLogic.CURRENT_PAGE_FIRST_ITEM:
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700169 child = cellLayout.getChildAt(0, 0);
Hyunyoung Songada50982015-04-10 14:35:23 -0700170 break;
171 case FocusLogic.CURRENT_PAGE_LAST_ITEM:
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700172 child = pagedView.getLastItem();
Hyunyoung Songada50982015-04-10 14:35:23 -0700173 break;
174 default: // Go to some item on the current page.
175 child = itemContainer.getChildAt(newIconIndex);
176 break;
177 }
178 if (child != null) {
179 child.requestFocus();
180 playSoundEffect(keyCode, v);
181 } else {
182 handleNoopKey(keyCode, v);
183 }
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800184 return consume;
185 }
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800186
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700187 public void handleNoopKey(int keyCode, View v) {
188 if (keyCode == KeyEvent.KEYCODE_DPAD_DOWN) {
189 mFolder.mFolderName.requestFocus();
190 playSoundEffect(keyCode, v);
191 }
192 }
Sunny Goyal290800b2015-03-05 11:33:33 -0800193 }
194
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800195 /**
Tony Wickham4fc82872015-11-10 16:52:14 -0800196 * Handles key events in the workspace hotseat (bottom of the screen).
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800197 * <p>Currently we don't special case for the phone UI in different orientations, even though
198 * the hotseat is on the side in landscape mode. This is to ensure that accessibility
199 * consistency is maintained across rotations.
200 */
201 static boolean handleHotseatButtonKeyEvent(View v, int keyCode, KeyEvent e) {
202 boolean consume = FocusLogic.shouldConsume(keyCode);
203 if (e.getAction() == KeyEvent.ACTION_UP || !consume) {
204 return consume;
205 }
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800206
Winsonc0b52fe2015-09-09 16:38:15 -0700207 final Launcher launcher = (Launcher) v.getContext();
208 final DeviceProfile profile = launcher.getDeviceProfile();
Adam Cohen2e6da152015-05-06 11:42:25 -0700209
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800210 if (DEBUG) {
211 Log.v(TAG, String.format(
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700212 "Handle HOTSEAT BUTTONS keyevent=[%s] on hotseat buttons, isVertical=%s",
213 KeyEvent.keyCodeToString(keyCode), profile.isVerticalBarLayout()));
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800214 }
215
216 // Initialize the variables.
Winsonfa56b3f2015-09-14 12:01:13 -0700217 final Workspace workspace = (Workspace) v.getRootView().findViewById(R.id.workspace);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800218 final ShortcutAndWidgetContainer hotseatParent = (ShortcutAndWidgetContainer) v.getParent();
219 final CellLayout hotseatLayout = (CellLayout) hotseatParent.getParent();
Hyunyoung Song31178b82015-02-24 14:12:51 -0800220
Winsonfa56b3f2015-09-14 12:01:13 -0700221 final ItemInfo itemInfo = (ItemInfo) v.getTag();
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700222 int pageIndex = workspace.getNextPage();
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800223 int pageCount = workspace.getChildCount();
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700224 int iconIndex = hotseatParent.indexOfChild(v);
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700225 int iconRank = ((CellLayout.LayoutParams) hotseatLayout.getShortcutsAndWidgets()
226 .getChildAt(iconIndex).getLayoutParams()).cellX;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800227
228 final CellLayout iconLayout = (CellLayout) workspace.getChildAt(pageIndex);
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700229 if (iconLayout == null) {
230 // This check is to guard against cases where key strokes rushes in when workspace
231 // child creation/deletion is still in flux. (e.g., during drop or fling
232 // animation.)
233 return consume;
234 }
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800235 final ViewGroup iconParent = iconLayout.getShortcutsAndWidgets();
236
237 ViewGroup parent = null;
Hyunyoung Song31178b82015-02-24 14:12:51 -0800238 int[][] matrix = null;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800239
240 if (keyCode == KeyEvent.KEYCODE_DPAD_UP &&
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700241 !profile.isVerticalBarLayout()) {
Tony Wickham329d8bf2015-12-04 09:48:17 -0800242 matrix = FocusLogic.createSparseMatrixWithHotseat(iconLayout, hotseatLayout,
Tony Wickham6cbd2222015-11-09 17:51:08 -0800243 true /* hotseat horizontal */, profile.inv.hotseatAllAppsRank);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800244 iconIndex += iconParent.getChildCount();
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800245 parent = iconParent;
246 } else if (keyCode == KeyEvent.KEYCODE_DPAD_LEFT &&
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700247 profile.isVerticalBarLayout()) {
Tony Wickham329d8bf2015-12-04 09:48:17 -0800248 matrix = FocusLogic.createSparseMatrixWithHotseat(iconLayout, hotseatLayout,
Tony Wickham6cbd2222015-11-09 17:51:08 -0800249 false /* hotseat horizontal */, profile.inv.hotseatAllAppsRank);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800250 iconIndex += iconParent.getChildCount();
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800251 parent = iconParent;
Hyunyoung Song31178b82015-02-24 14:12:51 -0800252 } else if (keyCode == KeyEvent.KEYCODE_DPAD_RIGHT &&
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700253 profile.isVerticalBarLayout()) {
Hyunyoung Song31178b82015-02-24 14:12:51 -0800254 keyCode = KeyEvent.KEYCODE_PAGE_DOWN;
Winsonfa56b3f2015-09-14 12:01:13 -0700255 } else if (isUninstallKeyChord(e)) {
256 matrix = FocusLogic.createSparseMatrix(iconLayout);
257 if (UninstallDropTarget.supportsDrop(launcher, itemInfo)) {
258 UninstallDropTarget.startUninstallActivity(launcher, itemInfo);
259 }
260 } else if (isDeleteKeyChord(e)) {
261 matrix = FocusLogic.createSparseMatrix(iconLayout);
Winson2949fb52015-09-24 09:56:11 -0700262 launcher.removeItem(v, itemInfo, true /* deleteFromDb */);
Winsonc0b52fe2015-09-09 16:38:15 -0700263 } else {
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800264 // For other KEYCODE_DPAD_LEFT and KEYCODE_DPAD_RIGHT navigation, do not use the
265 // matrix extended with hotseat.
266 matrix = FocusLogic.createSparseMatrix(hotseatLayout);
Hyunyoung Song31178b82015-02-24 14:12:51 -0800267 parent = hotseatParent;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800268 }
269
270 // Process the focus.
Tony Wickham329d8bf2015-12-04 09:48:17 -0800271 int newIconIndex = FocusLogic.handleKeyEvent(keyCode, matrix, iconIndex, pageIndex,
272 pageCount, Utilities.isRtl(v.getResources()));
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800273
Hyunyoung Song31178b82015-02-24 14:12:51 -0800274 View newIcon = null;
Tony Wickham4fc82872015-11-10 16:52:14 -0800275 switch (newIconIndex) {
276 case FocusLogic.NEXT_PAGE_FIRST_ITEM:
277 parent = getCellLayoutChildrenForIndex(workspace, pageIndex + 1);
278 newIcon = parent.getChildAt(0);
279 // TODO(hyunyoungs): handle cases where the child is not an icon but
280 // a folder or a widget.
281 workspace.snapToPage(pageIndex + 1);
282 break;
283 case FocusLogic.PREVIOUS_PAGE_FIRST_ITEM:
284 parent = getCellLayoutChildrenForIndex(workspace, pageIndex - 1);
285 newIcon = parent.getChildAt(0);
286 // TODO(hyunyoungs): handle cases where the child is not an icon but
287 // a folder or a widget.
288 workspace.snapToPage(pageIndex - 1);
289 break;
290 case FocusLogic.PREVIOUS_PAGE_LAST_ITEM:
291 parent = getCellLayoutChildrenForIndex(workspace, pageIndex - 1);
292 newIcon = parent.getChildAt(parent.getChildCount() - 1);
293 // TODO(hyunyoungs): handle cases where the child is not an icon but
294 // a folder or a widget.
295 workspace.snapToPage(pageIndex - 1);
296 break;
297 case FocusLogic.PREVIOUS_PAGE_LEFT_COLUMN:
298 case FocusLogic.PREVIOUS_PAGE_RIGHT_COLUMN:
299 // Go to the previous page but keep the focus on the same hotseat icon.
300 workspace.snapToPage(pageIndex - 1);
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800301 // If the page we are going to is fullscreen, have it take the focus from hotseat.
302 CellLayout prevPage = (CellLayout) workspace.getPageAt(pageIndex - 1);
303 boolean isPrevPageFullscreen = ((CellLayout.LayoutParams) prevPage
304 .getShortcutsAndWidgets().getChildAt(0).getLayoutParams()).isFullscreen;
305 if (isPrevPageFullscreen) {
306 workspace.getPageAt(pageIndex - 1).requestFocus();
307 }
Tony Wickham4fc82872015-11-10 16:52:14 -0800308 break;
309 case FocusLogic.NEXT_PAGE_LEFT_COLUMN:
310 case FocusLogic.NEXT_PAGE_RIGHT_COLUMN:
311 // Go to the next page but keep the focus on the same hotseat icon.
312 workspace.snapToPage(pageIndex + 1);
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800313 // If the page we are going to is fullscreen, have it take the focus from hotseat.
314 CellLayout nextPage = (CellLayout) workspace.getPageAt(pageIndex + 1);
315 boolean isNextPageFullscreen = ((CellLayout.LayoutParams) nextPage
316 .getShortcutsAndWidgets().getChildAt(0).getLayoutParams()).isFullscreen;
317 if (isNextPageFullscreen) {
318 workspace.getPageAt(pageIndex + 1).requestFocus();
319 }
Tony Wickham4fc82872015-11-10 16:52:14 -0800320 break;
Hyunyoung Song31178b82015-02-24 14:12:51 -0800321 }
322 if (parent == iconParent && newIconIndex >= iconParent.getChildCount()) {
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800323 newIconIndex -= iconParent.getChildCount();
324 }
325 if (parent != null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800326 if (newIcon == null && newIconIndex >= 0) {
Hyunyoung Song31178b82015-02-24 14:12:51 -0800327 newIcon = parent.getChildAt(newIconIndex);
328 }
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800329 if (newIcon != null) {
330 newIcon.requestFocus();
331 playSoundEffect(keyCode, v);
332 }
333 }
334 return consume;
335 }
336
337 /**
338 * Handles key events in a workspace containing icons.
339 */
340 static boolean handleIconKeyEvent(View v, int keyCode, KeyEvent e) {
341 boolean consume = FocusLogic.shouldConsume(keyCode);
342 if (e.getAction() == KeyEvent.ACTION_UP || !consume) {
343 return consume;
344 }
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700345
Adam Cohen2e6da152015-05-06 11:42:25 -0700346 Launcher launcher = (Launcher) v.getContext();
347 DeviceProfile profile = launcher.getDeviceProfile();
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700348
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800349 if (DEBUG) {
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700350 Log.v(TAG, String.format("Handle WORKSPACE ICONS keyevent=[%s] isVerticalBar=%s",
351 KeyEvent.keyCodeToString(keyCode), profile.isVerticalBarLayout()));
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800352 }
353
354 // Initialize the variables.
355 ShortcutAndWidgetContainer parent = (ShortcutAndWidgetContainer) v.getParent();
Hyunyoung Song38531712015-03-03 19:25:16 -0800356 CellLayout iconLayout = (CellLayout) parent.getParent();
Hyunyoung Song31178b82015-02-24 14:12:51 -0800357 final Workspace workspace = (Workspace) iconLayout.getParent();
Adam Cohen2e6da152015-05-06 11:42:25 -0700358 final ViewGroup dragLayer = (ViewGroup) workspace.getParent();
359 final ViewGroup tabs = (ViewGroup) dragLayer.findViewById(R.id.search_drop_target_bar);
360 final Hotseat hotseat = (Hotseat) dragLayer.findViewById(R.id.hotseat);
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700361
Winsonfa56b3f2015-09-14 12:01:13 -0700362 final ItemInfo itemInfo = (ItemInfo) v.getTag();
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700363 final int iconIndex = parent.indexOfChild(v);
364 final int pageIndex = workspace.indexOfChild(iconLayout);
365 final int pageCount = workspace.getChildCount();
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800366
367 CellLayout hotseatLayout = (CellLayout) hotseat.getChildAt(0);
368 ShortcutAndWidgetContainer hotseatParent = hotseatLayout.getShortcutsAndWidgets();
369 int[][] matrix;
370
Hyunyoung Song31178b82015-02-24 14:12:51 -0800371 // KEYCODE_DPAD_DOWN in portrait (KEYCODE_DPAD_RIGHT in landscape) is the only key allowed
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800372 // to take a user to the hotseat. For other dpad navigation, do not use the matrix extended
373 // with the hotseat.
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700374 if (keyCode == KeyEvent.KEYCODE_DPAD_DOWN && !profile.isVerticalBarLayout()) {
Tony Wickham329d8bf2015-12-04 09:48:17 -0800375 matrix = FocusLogic.createSparseMatrixWithHotseat(iconLayout, hotseatLayout,
376 true /* horizontal */, profile.inv.hotseatAllAppsRank);
Hyunyoung Song31178b82015-02-24 14:12:51 -0800377 } else if (keyCode == KeyEvent.KEYCODE_DPAD_RIGHT &&
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700378 profile.isVerticalBarLayout()) {
Tony Wickham329d8bf2015-12-04 09:48:17 -0800379 matrix = FocusLogic.createSparseMatrixWithHotseat(iconLayout, hotseatLayout,
380 false /* horizontal */, profile.inv.hotseatAllAppsRank);
Winsonfa56b3f2015-09-14 12:01:13 -0700381 } else if (isUninstallKeyChord(e)) {
382 matrix = FocusLogic.createSparseMatrix(iconLayout);
383 if (UninstallDropTarget.supportsDrop(launcher, itemInfo)) {
384 UninstallDropTarget.startUninstallActivity(launcher, itemInfo);
385 }
386 } else if (isDeleteKeyChord(e)) {
387 matrix = FocusLogic.createSparseMatrix(iconLayout);
Winson2949fb52015-09-24 09:56:11 -0700388 launcher.removeItem(v, itemInfo, true /* deleteFromDb */);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800389 } else {
Hyunyoung Song31178b82015-02-24 14:12:51 -0800390 matrix = FocusLogic.createSparseMatrix(iconLayout);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800391 }
392
393 // Process the focus.
Tony Wickham329d8bf2015-12-04 09:48:17 -0800394 int newIconIndex = FocusLogic.handleKeyEvent(keyCode, matrix, iconIndex, pageIndex,
395 pageCount, Utilities.isRtl(v.getResources()));
Tony Wickhamaf78b592015-11-11 09:25:38 -0800396 boolean isRtl = Utilities.isRtl(v.getResources());
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800397 View newIcon = null;
Tony Wickhamaf78b592015-11-11 09:25:38 -0800398 CellLayout workspaceLayout = (CellLayout) workspace.getChildAt(pageIndex);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800399 switch (newIconIndex) {
400 case FocusLogic.NOOP:
401 if (keyCode == KeyEvent.KEYCODE_DPAD_UP) {
402 newIcon = tabs;
403 }
404 break;
Hyunyoung Song38531712015-03-03 19:25:16 -0800405 case FocusLogic.PREVIOUS_PAGE_RIGHT_COLUMN:
Hyunyoung Songada50982015-04-10 14:35:23 -0700406 case FocusLogic.NEXT_PAGE_RIGHT_COLUMN:
407 int newPageIndex = pageIndex - 1;
408 if (newIconIndex == FocusLogic.NEXT_PAGE_RIGHT_COLUMN) {
409 newPageIndex = pageIndex + 1;
410 }
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700411 int row = ((CellLayout.LayoutParams) v.getLayoutParams()).cellY;
Hyunyoung Songada50982015-04-10 14:35:23 -0700412 parent = getCellLayoutChildrenForIndex(workspace, newPageIndex);
Hyunyoung Song38531712015-03-03 19:25:16 -0800413 if (parent != null) {
414 iconLayout = (CellLayout) parent.getParent();
Tony Wickham329d8bf2015-12-04 09:48:17 -0800415 matrix = FocusLogic.createSparseMatrixWithPivotColumn(iconLayout,
Tony Wickham4fc82872015-11-10 16:52:14 -0800416 iconLayout.getCountX(), row);
Tony Wickham329d8bf2015-12-04 09:48:17 -0800417 newIconIndex = FocusLogic.handleKeyEvent(keyCode, matrix, FocusLogic.PIVOT,
418 newPageIndex, pageCount, Utilities.isRtl(v.getResources()));
Tony Wickhamaf78b592015-11-11 09:25:38 -0800419 if (newIconIndex == FocusLogic.NEXT_PAGE_FIRST_ITEM) {
420 newIcon = handleNextPageFirstItem(workspace, hotseatLayout, pageIndex,
421 isRtl);
422 } else if (newIconIndex == FocusLogic.PREVIOUS_PAGE_LAST_ITEM) {
423 newIcon = handlePreviousPageLastItem(workspace, hotseatLayout, pageIndex,
424 isRtl);
425 } else {
426 newIcon = parent.getChildAt(newIconIndex);
427 }
Hyunyoung Song38531712015-03-03 19:25:16 -0800428 }
429 break;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800430 case FocusLogic.PREVIOUS_PAGE_FIRST_ITEM:
Tony Wickhamaf78b592015-11-11 09:25:38 -0800431 workspaceLayout = (CellLayout) workspace.getChildAt(pageIndex - 1);
432 newIcon = getFirstFocusableIconInReadingOrder(workspaceLayout, isRtl);
433 if (newIcon == null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800434 // Check the hotseat if no focusable item was found on the workspace.
Tony Wickhamaf78b592015-11-11 09:25:38 -0800435 newIcon = getFirstFocusableIconInReadingOrder(hotseatLayout, isRtl);
436 workspace.snapToPage(pageIndex - 1);
437 }
Hyunyoung Song38531712015-03-03 19:25:16 -0800438 break;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800439 case FocusLogic.PREVIOUS_PAGE_LAST_ITEM:
Tony Wickhamaf78b592015-11-11 09:25:38 -0800440 newIcon = handlePreviousPageLastItem(workspace, hotseatLayout, pageIndex, isRtl);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800441 break;
442 case FocusLogic.NEXT_PAGE_FIRST_ITEM:
Tony Wickhamaf78b592015-11-11 09:25:38 -0800443 newIcon = handleNextPageFirstItem(workspace, hotseatLayout, pageIndex, isRtl);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800444 break;
Hyunyoung Song38531712015-03-03 19:25:16 -0800445 case FocusLogic.NEXT_PAGE_LEFT_COLUMN:
Hyunyoung Songada50982015-04-10 14:35:23 -0700446 case FocusLogic.PREVIOUS_PAGE_LEFT_COLUMN:
447 newPageIndex = pageIndex + 1;
448 if (newIconIndex == FocusLogic.PREVIOUS_PAGE_LEFT_COLUMN) {
449 newPageIndex = pageIndex - 1;
450 }
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700451 row = ((CellLayout.LayoutParams) v.getLayoutParams()).cellY;
Hyunyoung Songada50982015-04-10 14:35:23 -0700452 parent = getCellLayoutChildrenForIndex(workspace, newPageIndex);
Hyunyoung Song38531712015-03-03 19:25:16 -0800453 if (parent != null) {
454 iconLayout = (CellLayout) parent.getParent();
Tony Wickham329d8bf2015-12-04 09:48:17 -0800455 matrix = FocusLogic.createSparseMatrixWithPivotColumn(iconLayout, -1, row);
456 newIconIndex = FocusLogic.handleKeyEvent(keyCode, matrix, FocusLogic.PIVOT,
457 newPageIndex, pageCount, Utilities.isRtl(v.getResources()));
Tony Wickhamaf78b592015-11-11 09:25:38 -0800458 if (newIconIndex == FocusLogic.NEXT_PAGE_FIRST_ITEM) {
459 newIcon = handleNextPageFirstItem(workspace, hotseatLayout, pageIndex,
460 isRtl);
461 } else if (newIconIndex == FocusLogic.PREVIOUS_PAGE_LAST_ITEM) {
462 newIcon = handlePreviousPageLastItem(workspace, hotseatLayout, pageIndex,
463 isRtl);
464 } else {
465 newIcon = parent.getChildAt(newIconIndex);
466 }
Hyunyoung Song38531712015-03-03 19:25:16 -0800467 }
468 break;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800469 case FocusLogic.CURRENT_PAGE_FIRST_ITEM:
Tony Wickhamaf78b592015-11-11 09:25:38 -0800470 newIcon = getFirstFocusableIconInReadingOrder(workspaceLayout, isRtl);
471 if (newIcon == null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800472 // Check the hotseat if no focusable item was found on the workspace.
Tony Wickhamaf78b592015-11-11 09:25:38 -0800473 newIcon = getFirstFocusableIconInReadingOrder(hotseatLayout, isRtl);
474 }
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800475 break;
476 case FocusLogic.CURRENT_PAGE_LAST_ITEM:
Tony Wickhamaf78b592015-11-11 09:25:38 -0800477 newIcon = getFirstFocusableIconInReverseReadingOrder(workspaceLayout, isRtl);
478 if (newIcon == null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800479 // Check the hotseat if no focusable item was found on the workspace.
Tony Wickhamaf78b592015-11-11 09:25:38 -0800480 newIcon = getFirstFocusableIconInReverseReadingOrder(hotseatLayout, isRtl);
481 }
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800482 break;
483 default:
484 // current page, some item.
485 if (0 <= newIconIndex && newIconIndex < parent.getChildCount()) {
486 newIcon = parent.getChildAt(newIconIndex);
487 } else if (parent.getChildCount() <= newIconIndex &&
488 newIconIndex < parent.getChildCount() + hotseatParent.getChildCount()) {
489 newIcon = hotseatParent.getChildAt(newIconIndex - parent.getChildCount());
490 }
491 break;
492 }
493 if (newIcon != null) {
494 newIcon.requestFocus();
495 playSoundEffect(keyCode, v);
496 }
497 return consume;
498 }
499
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800500 //
501 // Helper methods.
502 //
503
Winson Chung97d85d22011-04-13 11:27:36 -0700504 /**
Winson Chung97d85d22011-04-13 11:27:36 -0700505 * Private helper method to get the CellLayoutChildren given a CellLayout index.
506 */
Sunny Goyal316490e2015-06-02 09:38:28 -0700507 @Thunk static ShortcutAndWidgetContainer getCellLayoutChildrenForIndex(
Michael Jurkaa52570f2012-03-20 03:18:20 -0700508 ViewGroup container, int i) {
Sunny Goyalb3726d92014-08-20 16:58:17 -0700509 CellLayout parent = (CellLayout) container.getChildAt(i);
510 return parent.getShortcutsAndWidgets();
Winson Chung97d85d22011-04-13 11:27:36 -0700511 }
512
Winson Chung97d85d22011-04-13 11:27:36 -0700513 /**
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800514 * Helper method to be used for playing sound effects.
Winson Chung97d85d22011-04-13 11:27:36 -0700515 */
Adam Cohen091440a2015-03-18 14:16:05 -0700516 @Thunk static void playSoundEffect(int keyCode, View v) {
Winson Chung97d85d22011-04-13 11:27:36 -0700517 switch (keyCode) {
518 case KeyEvent.KEYCODE_DPAD_LEFT:
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800519 v.playSoundEffect(SoundEffectConstants.NAVIGATION_LEFT);
Winson Chung97d85d22011-04-13 11:27:36 -0700520 break;
521 case KeyEvent.KEYCODE_DPAD_RIGHT:
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800522 v.playSoundEffect(SoundEffectConstants.NAVIGATION_RIGHT);
Winson Chung97d85d22011-04-13 11:27:36 -0700523 break;
524 case KeyEvent.KEYCODE_DPAD_DOWN:
Winson Chung97d85d22011-04-13 11:27:36 -0700525 case KeyEvent.KEYCODE_PAGE_DOWN:
Winson Chung97d85d22011-04-13 11:27:36 -0700526 case KeyEvent.KEYCODE_MOVE_END:
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800527 v.playSoundEffect(SoundEffectConstants.NAVIGATION_DOWN);
Adam Cohenac56cff2011-09-28 20:45:37 -0700528 break;
529 case KeyEvent.KEYCODE_DPAD_UP:
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800530 case KeyEvent.KEYCODE_PAGE_UP:
Adam Cohenac56cff2011-09-28 20:45:37 -0700531 case KeyEvent.KEYCODE_MOVE_HOME:
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800532 v.playSoundEffect(SoundEffectConstants.NAVIGATION_UP);
Adam Cohenac56cff2011-09-28 20:45:37 -0700533 break;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800534 default:
Winson Chung97d85d22011-04-13 11:27:36 -0700535 break;
Winson Chung97d85d22011-04-13 11:27:36 -0700536 }
Winson Chung97d85d22011-04-13 11:27:36 -0700537 }
Winsonfa56b3f2015-09-14 12:01:13 -0700538
539 /**
540 * Returns whether the key event represents a valid uninstall key chord.
541 */
542 private static boolean isUninstallKeyChord(KeyEvent event) {
543 int keyCode = event.getKeyCode();
544 return (keyCode == KeyEvent.KEYCODE_DEL || keyCode == KeyEvent.KEYCODE_FORWARD_DEL) &&
545 event.hasModifiers(KeyEvent.META_CTRL_ON | KeyEvent.META_SHIFT_ON);
546 }
547
548 /**
549 * Returns whether the key event represents a valid delete key chord.
550 */
551 private static boolean isDeleteKeyChord(KeyEvent event) {
552 int keyCode = event.getKeyCode();
553 return (keyCode == KeyEvent.KEYCODE_DEL || keyCode == KeyEvent.KEYCODE_FORWARD_DEL) &&
554 event.hasModifiers(KeyEvent.META_CTRL_ON);
555 }
Tony Wickhamaf78b592015-11-11 09:25:38 -0800556
557 private static View handlePreviousPageLastItem(Workspace workspace, CellLayout hotseatLayout,
558 int pageIndex, boolean isRtl) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800559 if (pageIndex - 1 < 0) {
560 return null;
561 }
Tony Wickhamaf78b592015-11-11 09:25:38 -0800562 CellLayout workspaceLayout = (CellLayout) workspace.getChildAt(pageIndex - 1);
563 View newIcon = getFirstFocusableIconInReverseReadingOrder(workspaceLayout, isRtl);
564 if (newIcon == null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800565 // Check the hotseat if no focusable item was found on the workspace.
Tony Wickhamaf78b592015-11-11 09:25:38 -0800566 newIcon = getFirstFocusableIconInReverseReadingOrder(hotseatLayout,isRtl);
567 workspace.snapToPage(pageIndex - 1);
568 }
569 return newIcon;
570 }
571
572 private static View handleNextPageFirstItem(Workspace workspace, CellLayout hotseatLayout,
573 int pageIndex, boolean isRtl) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800574 if (pageIndex + 1 >= workspace.getPageCount()) {
575 return null;
576 }
Tony Wickhamaf78b592015-11-11 09:25:38 -0800577 CellLayout workspaceLayout = (CellLayout) workspace.getChildAt(pageIndex + 1);
578 View newIcon = getFirstFocusableIconInReadingOrder(workspaceLayout, isRtl);
579 if (newIcon == null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800580 // Check the hotseat if no focusable item was found on the workspace.
Tony Wickhamaf78b592015-11-11 09:25:38 -0800581 newIcon = getFirstFocusableIconInReadingOrder(hotseatLayout, isRtl);
582 workspace.snapToPage(pageIndex + 1);
583 }
584 return newIcon;
585 }
586
587 private static View getFirstFocusableIconInReadingOrder(CellLayout cellLayout, boolean isRtl) {
588 View icon;
589 int countX = cellLayout.getCountX();
590 for (int y = 0; y < cellLayout.getCountY(); y++) {
591 int increment = isRtl ? -1 : 1;
592 for (int x = isRtl ? countX - 1 : 0; 0 <= x && x < countX; x += increment) {
593 if ((icon = cellLayout.getChildAt(x, y)) != null && icon.isFocusable()) {
594 return icon;
595 }
596 }
597 }
598 return null;
599 }
600
601 private static View getFirstFocusableIconInReverseReadingOrder(CellLayout cellLayout,
602 boolean isRtl) {
603 View icon;
604 int countX = cellLayout.getCountX();
605 for (int y = cellLayout.getCountY() - 1; y >= 0; y--) {
606 int increment = isRtl ? 1 : -1;
607 for (int x = isRtl ? 0 : countX - 1; 0 <= x && x < countX; x += increment) {
608 if ((icon = cellLayout.getChildAt(x, y)) != null && icon.isFocusable()) {
609 return icon;
610 }
611 }
612 }
613 return null;
614 }
Winson Chung97d85d22011-04-13 11:27:36 -0700615}