blob: c73ceea14ac0b519171da60e87abb061ef742915 [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;
Sunny Goyal26119432016-02-18 22:09:23 +000026import com.android.launcher3.folder.Folder;
Adam Cohenf9c184a2016-01-15 16:47:43 -080027import 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()) {
Sunny Goyalbb011da2016-06-15 15:42:29 -0700242 matrix = FocusLogic.createSparseMatrixWithHotseat(iconLayout, hotseatLayout, profile);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800243 iconIndex += iconParent.getChildCount();
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800244 parent = iconParent;
245 } else if (keyCode == KeyEvent.KEYCODE_DPAD_LEFT &&
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700246 profile.isVerticalBarLayout()) {
Sunny Goyalbb011da2016-06-15 15:42:29 -0700247 matrix = FocusLogic.createSparseMatrixWithHotseat(iconLayout, hotseatLayout, profile);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800248 iconIndex += iconParent.getChildCount();
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800249 parent = iconParent;
Hyunyoung Song31178b82015-02-24 14:12:51 -0800250 } else if (keyCode == KeyEvent.KEYCODE_DPAD_RIGHT &&
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700251 profile.isVerticalBarLayout()) {
Hyunyoung Song31178b82015-02-24 14:12:51 -0800252 keyCode = KeyEvent.KEYCODE_PAGE_DOWN;
Winsonfa56b3f2015-09-14 12:01:13 -0700253 } else if (isUninstallKeyChord(e)) {
254 matrix = FocusLogic.createSparseMatrix(iconLayout);
255 if (UninstallDropTarget.supportsDrop(launcher, itemInfo)) {
256 UninstallDropTarget.startUninstallActivity(launcher, itemInfo);
257 }
258 } else if (isDeleteKeyChord(e)) {
259 matrix = FocusLogic.createSparseMatrix(iconLayout);
Winson2949fb52015-09-24 09:56:11 -0700260 launcher.removeItem(v, itemInfo, true /* deleteFromDb */);
Winsonc0b52fe2015-09-09 16:38:15 -0700261 } else {
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800262 // For other KEYCODE_DPAD_LEFT and KEYCODE_DPAD_RIGHT navigation, do not use the
263 // matrix extended with hotseat.
264 matrix = FocusLogic.createSparseMatrix(hotseatLayout);
Hyunyoung Song31178b82015-02-24 14:12:51 -0800265 parent = hotseatParent;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800266 }
267
268 // Process the focus.
Tony Wickham329d8bf2015-12-04 09:48:17 -0800269 int newIconIndex = FocusLogic.handleKeyEvent(keyCode, matrix, iconIndex, pageIndex,
270 pageCount, Utilities.isRtl(v.getResources()));
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800271
Hyunyoung Song31178b82015-02-24 14:12:51 -0800272 View newIcon = null;
Tony Wickham4fc82872015-11-10 16:52:14 -0800273 switch (newIconIndex) {
274 case FocusLogic.NEXT_PAGE_FIRST_ITEM:
275 parent = getCellLayoutChildrenForIndex(workspace, pageIndex + 1);
276 newIcon = parent.getChildAt(0);
277 // TODO(hyunyoungs): handle cases where the child is not an icon but
278 // a folder or a widget.
279 workspace.snapToPage(pageIndex + 1);
280 break;
281 case FocusLogic.PREVIOUS_PAGE_FIRST_ITEM:
282 parent = getCellLayoutChildrenForIndex(workspace, pageIndex - 1);
283 newIcon = parent.getChildAt(0);
284 // TODO(hyunyoungs): handle cases where the child is not an icon but
285 // a folder or a widget.
286 workspace.snapToPage(pageIndex - 1);
287 break;
288 case FocusLogic.PREVIOUS_PAGE_LAST_ITEM:
289 parent = getCellLayoutChildrenForIndex(workspace, pageIndex - 1);
290 newIcon = parent.getChildAt(parent.getChildCount() - 1);
291 // TODO(hyunyoungs): handle cases where the child is not an icon but
292 // a folder or a widget.
293 workspace.snapToPage(pageIndex - 1);
294 break;
295 case FocusLogic.PREVIOUS_PAGE_LEFT_COLUMN:
296 case FocusLogic.PREVIOUS_PAGE_RIGHT_COLUMN:
297 // Go to the previous page but keep the focus on the same hotseat icon.
298 workspace.snapToPage(pageIndex - 1);
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800299 // If the page we are going to is fullscreen, have it take the focus from hotseat.
300 CellLayout prevPage = (CellLayout) workspace.getPageAt(pageIndex - 1);
301 boolean isPrevPageFullscreen = ((CellLayout.LayoutParams) prevPage
302 .getShortcutsAndWidgets().getChildAt(0).getLayoutParams()).isFullscreen;
303 if (isPrevPageFullscreen) {
304 workspace.getPageAt(pageIndex - 1).requestFocus();
305 }
Tony Wickham4fc82872015-11-10 16:52:14 -0800306 break;
307 case FocusLogic.NEXT_PAGE_LEFT_COLUMN:
308 case FocusLogic.NEXT_PAGE_RIGHT_COLUMN:
309 // Go to the next page but keep the focus on the same hotseat icon.
310 workspace.snapToPage(pageIndex + 1);
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800311 // If the page we are going to is fullscreen, have it take the focus from hotseat.
312 CellLayout nextPage = (CellLayout) workspace.getPageAt(pageIndex + 1);
313 boolean isNextPageFullscreen = ((CellLayout.LayoutParams) nextPage
314 .getShortcutsAndWidgets().getChildAt(0).getLayoutParams()).isFullscreen;
315 if (isNextPageFullscreen) {
316 workspace.getPageAt(pageIndex + 1).requestFocus();
317 }
Tony Wickham4fc82872015-11-10 16:52:14 -0800318 break;
Hyunyoung Song31178b82015-02-24 14:12:51 -0800319 }
320 if (parent == iconParent && newIconIndex >= iconParent.getChildCount()) {
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800321 newIconIndex -= iconParent.getChildCount();
322 }
323 if (parent != null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800324 if (newIcon == null && newIconIndex >= 0) {
Hyunyoung Song31178b82015-02-24 14:12:51 -0800325 newIcon = parent.getChildAt(newIconIndex);
326 }
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800327 if (newIcon != null) {
328 newIcon.requestFocus();
329 playSoundEffect(keyCode, v);
330 }
331 }
332 return consume;
333 }
334
335 /**
336 * Handles key events in a workspace containing icons.
337 */
338 static boolean handleIconKeyEvent(View v, int keyCode, KeyEvent e) {
339 boolean consume = FocusLogic.shouldConsume(keyCode);
340 if (e.getAction() == KeyEvent.ACTION_UP || !consume) {
341 return consume;
342 }
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700343
Adam Cohen2e6da152015-05-06 11:42:25 -0700344 Launcher launcher = (Launcher) v.getContext();
345 DeviceProfile profile = launcher.getDeviceProfile();
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700346
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800347 if (DEBUG) {
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700348 Log.v(TAG, String.format("Handle WORKSPACE ICONS keyevent=[%s] isVerticalBar=%s",
349 KeyEvent.keyCodeToString(keyCode), profile.isVerticalBarLayout()));
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800350 }
351
352 // Initialize the variables.
353 ShortcutAndWidgetContainer parent = (ShortcutAndWidgetContainer) v.getParent();
Hyunyoung Song38531712015-03-03 19:25:16 -0800354 CellLayout iconLayout = (CellLayout) parent.getParent();
Hyunyoung Song31178b82015-02-24 14:12:51 -0800355 final Workspace workspace = (Workspace) iconLayout.getParent();
Adam Cohen2e6da152015-05-06 11:42:25 -0700356 final ViewGroup dragLayer = (ViewGroup) workspace.getParent();
Sunny Goyal47328fd2016-05-25 18:56:41 -0700357 final ViewGroup tabs = (ViewGroup) dragLayer.findViewById(R.id.drop_target_bar);
Adam Cohen2e6da152015-05-06 11:42:25 -0700358 final Hotseat hotseat = (Hotseat) dragLayer.findViewById(R.id.hotseat);
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700359
Winsonfa56b3f2015-09-14 12:01:13 -0700360 final ItemInfo itemInfo = (ItemInfo) v.getTag();
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700361 final int iconIndex = parent.indexOfChild(v);
362 final int pageIndex = workspace.indexOfChild(iconLayout);
363 final int pageCount = workspace.getChildCount();
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800364
365 CellLayout hotseatLayout = (CellLayout) hotseat.getChildAt(0);
366 ShortcutAndWidgetContainer hotseatParent = hotseatLayout.getShortcutsAndWidgets();
367 int[][] matrix;
368
Hyunyoung Song31178b82015-02-24 14:12:51 -0800369 // KEYCODE_DPAD_DOWN in portrait (KEYCODE_DPAD_RIGHT in landscape) is the only key allowed
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800370 // to take a user to the hotseat. For other dpad navigation, do not use the matrix extended
371 // with the hotseat.
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700372 if (keyCode == KeyEvent.KEYCODE_DPAD_DOWN && !profile.isVerticalBarLayout()) {
Sunny Goyalbb011da2016-06-15 15:42:29 -0700373 matrix = FocusLogic.createSparseMatrixWithHotseat(iconLayout, hotseatLayout, profile);
Hyunyoung Song31178b82015-02-24 14:12:51 -0800374 } else if (keyCode == KeyEvent.KEYCODE_DPAD_RIGHT &&
Hyunyoung Song18bfaaf2015-03-17 11:32:21 -0700375 profile.isVerticalBarLayout()) {
Sunny Goyalbb011da2016-06-15 15:42:29 -0700376 matrix = FocusLogic.createSparseMatrixWithHotseat(iconLayout, hotseatLayout, profile);
Winsonfa56b3f2015-09-14 12:01:13 -0700377 } else if (isUninstallKeyChord(e)) {
378 matrix = FocusLogic.createSparseMatrix(iconLayout);
379 if (UninstallDropTarget.supportsDrop(launcher, itemInfo)) {
380 UninstallDropTarget.startUninstallActivity(launcher, itemInfo);
381 }
382 } else if (isDeleteKeyChord(e)) {
383 matrix = FocusLogic.createSparseMatrix(iconLayout);
Winson2949fb52015-09-24 09:56:11 -0700384 launcher.removeItem(v, itemInfo, true /* deleteFromDb */);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800385 } else {
Hyunyoung Song31178b82015-02-24 14:12:51 -0800386 matrix = FocusLogic.createSparseMatrix(iconLayout);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800387 }
388
389 // Process the focus.
Tony Wickham329d8bf2015-12-04 09:48:17 -0800390 int newIconIndex = FocusLogic.handleKeyEvent(keyCode, matrix, iconIndex, pageIndex,
391 pageCount, Utilities.isRtl(v.getResources()));
Tony Wickhamaf78b592015-11-11 09:25:38 -0800392 boolean isRtl = Utilities.isRtl(v.getResources());
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800393 View newIcon = null;
Tony Wickhamaf78b592015-11-11 09:25:38 -0800394 CellLayout workspaceLayout = (CellLayout) workspace.getChildAt(pageIndex);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800395 switch (newIconIndex) {
396 case FocusLogic.NOOP:
397 if (keyCode == KeyEvent.KEYCODE_DPAD_UP) {
398 newIcon = tabs;
399 }
400 break;
Hyunyoung Song38531712015-03-03 19:25:16 -0800401 case FocusLogic.PREVIOUS_PAGE_RIGHT_COLUMN:
Hyunyoung Songada50982015-04-10 14:35:23 -0700402 case FocusLogic.NEXT_PAGE_RIGHT_COLUMN:
403 int newPageIndex = pageIndex - 1;
404 if (newIconIndex == FocusLogic.NEXT_PAGE_RIGHT_COLUMN) {
405 newPageIndex = pageIndex + 1;
406 }
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700407 int row = ((CellLayout.LayoutParams) v.getLayoutParams()).cellY;
Hyunyoung Songada50982015-04-10 14:35:23 -0700408 parent = getCellLayoutChildrenForIndex(workspace, newPageIndex);
Hyunyoung Song38531712015-03-03 19:25:16 -0800409 if (parent != null) {
410 iconLayout = (CellLayout) parent.getParent();
Tony Wickham329d8bf2015-12-04 09:48:17 -0800411 matrix = FocusLogic.createSparseMatrixWithPivotColumn(iconLayout,
Tony Wickham4fc82872015-11-10 16:52:14 -0800412 iconLayout.getCountX(), row);
Tony Wickham329d8bf2015-12-04 09:48:17 -0800413 newIconIndex = FocusLogic.handleKeyEvent(keyCode, matrix, FocusLogic.PIVOT,
414 newPageIndex, pageCount, Utilities.isRtl(v.getResources()));
Tony Wickhamaf78b592015-11-11 09:25:38 -0800415 if (newIconIndex == FocusLogic.NEXT_PAGE_FIRST_ITEM) {
416 newIcon = handleNextPageFirstItem(workspace, hotseatLayout, pageIndex,
417 isRtl);
418 } else if (newIconIndex == FocusLogic.PREVIOUS_PAGE_LAST_ITEM) {
419 newIcon = handlePreviousPageLastItem(workspace, hotseatLayout, pageIndex,
420 isRtl);
421 } else {
422 newIcon = parent.getChildAt(newIconIndex);
423 }
Hyunyoung Song38531712015-03-03 19:25:16 -0800424 }
425 break;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800426 case FocusLogic.PREVIOUS_PAGE_FIRST_ITEM:
Tony Wickhamaf78b592015-11-11 09:25:38 -0800427 workspaceLayout = (CellLayout) workspace.getChildAt(pageIndex - 1);
428 newIcon = getFirstFocusableIconInReadingOrder(workspaceLayout, isRtl);
429 if (newIcon == null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800430 // Check the hotseat if no focusable item was found on the workspace.
Tony Wickhamaf78b592015-11-11 09:25:38 -0800431 newIcon = getFirstFocusableIconInReadingOrder(hotseatLayout, isRtl);
432 workspace.snapToPage(pageIndex - 1);
433 }
Hyunyoung Song38531712015-03-03 19:25:16 -0800434 break;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800435 case FocusLogic.PREVIOUS_PAGE_LAST_ITEM:
Tony Wickhamaf78b592015-11-11 09:25:38 -0800436 newIcon = handlePreviousPageLastItem(workspace, hotseatLayout, pageIndex, isRtl);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800437 break;
438 case FocusLogic.NEXT_PAGE_FIRST_ITEM:
Tony Wickhamaf78b592015-11-11 09:25:38 -0800439 newIcon = handleNextPageFirstItem(workspace, hotseatLayout, pageIndex, isRtl);
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800440 break;
Hyunyoung Song38531712015-03-03 19:25:16 -0800441 case FocusLogic.NEXT_PAGE_LEFT_COLUMN:
Hyunyoung Songada50982015-04-10 14:35:23 -0700442 case FocusLogic.PREVIOUS_PAGE_LEFT_COLUMN:
443 newPageIndex = pageIndex + 1;
444 if (newIconIndex == FocusLogic.PREVIOUS_PAGE_LEFT_COLUMN) {
445 newPageIndex = pageIndex - 1;
446 }
Sunny Goyalfc3c1ed2015-04-09 18:48:21 -0700447 row = ((CellLayout.LayoutParams) v.getLayoutParams()).cellY;
Hyunyoung Songada50982015-04-10 14:35:23 -0700448 parent = getCellLayoutChildrenForIndex(workspace, newPageIndex);
Hyunyoung Song38531712015-03-03 19:25:16 -0800449 if (parent != null) {
450 iconLayout = (CellLayout) parent.getParent();
Tony Wickham329d8bf2015-12-04 09:48:17 -0800451 matrix = FocusLogic.createSparseMatrixWithPivotColumn(iconLayout, -1, row);
452 newIconIndex = FocusLogic.handleKeyEvent(keyCode, matrix, FocusLogic.PIVOT,
453 newPageIndex, pageCount, Utilities.isRtl(v.getResources()));
Tony Wickhamaf78b592015-11-11 09:25:38 -0800454 if (newIconIndex == FocusLogic.NEXT_PAGE_FIRST_ITEM) {
455 newIcon = handleNextPageFirstItem(workspace, hotseatLayout, pageIndex,
456 isRtl);
457 } else if (newIconIndex == FocusLogic.PREVIOUS_PAGE_LAST_ITEM) {
458 newIcon = handlePreviousPageLastItem(workspace, hotseatLayout, pageIndex,
459 isRtl);
460 } else {
461 newIcon = parent.getChildAt(newIconIndex);
462 }
Hyunyoung Song38531712015-03-03 19:25:16 -0800463 }
464 break;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800465 case FocusLogic.CURRENT_PAGE_FIRST_ITEM:
Tony Wickhamaf78b592015-11-11 09:25:38 -0800466 newIcon = getFirstFocusableIconInReadingOrder(workspaceLayout, isRtl);
467 if (newIcon == null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800468 // Check the hotseat if no focusable item was found on the workspace.
Tony Wickhamaf78b592015-11-11 09:25:38 -0800469 newIcon = getFirstFocusableIconInReadingOrder(hotseatLayout, isRtl);
470 }
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800471 break;
472 case FocusLogic.CURRENT_PAGE_LAST_ITEM:
Tony Wickhamaf78b592015-11-11 09:25:38 -0800473 newIcon = getFirstFocusableIconInReverseReadingOrder(workspaceLayout, isRtl);
474 if (newIcon == null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800475 // Check the hotseat if no focusable item was found on the workspace.
Tony Wickhamaf78b592015-11-11 09:25:38 -0800476 newIcon = getFirstFocusableIconInReverseReadingOrder(hotseatLayout, isRtl);
477 }
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800478 break;
479 default:
480 // current page, some item.
481 if (0 <= newIconIndex && newIconIndex < parent.getChildCount()) {
482 newIcon = parent.getChildAt(newIconIndex);
483 } else if (parent.getChildCount() <= newIconIndex &&
484 newIconIndex < parent.getChildCount() + hotseatParent.getChildCount()) {
485 newIcon = hotseatParent.getChildAt(newIconIndex - parent.getChildCount());
486 }
487 break;
488 }
489 if (newIcon != null) {
490 newIcon.requestFocus();
491 playSoundEffect(keyCode, v);
492 }
493 return consume;
494 }
495
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800496 //
497 // Helper methods.
498 //
499
Winson Chung97d85d22011-04-13 11:27:36 -0700500 /**
Winson Chung97d85d22011-04-13 11:27:36 -0700501 * Private helper method to get the CellLayoutChildren given a CellLayout index.
502 */
Sunny Goyal316490e2015-06-02 09:38:28 -0700503 @Thunk static ShortcutAndWidgetContainer getCellLayoutChildrenForIndex(
Michael Jurkaa52570f2012-03-20 03:18:20 -0700504 ViewGroup container, int i) {
Sunny Goyalb3726d92014-08-20 16:58:17 -0700505 CellLayout parent = (CellLayout) container.getChildAt(i);
506 return parent.getShortcutsAndWidgets();
Winson Chung97d85d22011-04-13 11:27:36 -0700507 }
508
Winson Chung97d85d22011-04-13 11:27:36 -0700509 /**
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800510 * Helper method to be used for playing sound effects.
Winson Chung97d85d22011-04-13 11:27:36 -0700511 */
Adam Cohen091440a2015-03-18 14:16:05 -0700512 @Thunk static void playSoundEffect(int keyCode, View v) {
Winson Chung97d85d22011-04-13 11:27:36 -0700513 switch (keyCode) {
514 case KeyEvent.KEYCODE_DPAD_LEFT:
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800515 v.playSoundEffect(SoundEffectConstants.NAVIGATION_LEFT);
Winson Chung97d85d22011-04-13 11:27:36 -0700516 break;
517 case KeyEvent.KEYCODE_DPAD_RIGHT:
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800518 v.playSoundEffect(SoundEffectConstants.NAVIGATION_RIGHT);
Winson Chung97d85d22011-04-13 11:27:36 -0700519 break;
520 case KeyEvent.KEYCODE_DPAD_DOWN:
Winson Chung97d85d22011-04-13 11:27:36 -0700521 case KeyEvent.KEYCODE_PAGE_DOWN:
Winson Chung97d85d22011-04-13 11:27:36 -0700522 case KeyEvent.KEYCODE_MOVE_END:
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800523 v.playSoundEffect(SoundEffectConstants.NAVIGATION_DOWN);
Adam Cohenac56cff2011-09-28 20:45:37 -0700524 break;
525 case KeyEvent.KEYCODE_DPAD_UP:
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800526 case KeyEvent.KEYCODE_PAGE_UP:
Adam Cohenac56cff2011-09-28 20:45:37 -0700527 case KeyEvent.KEYCODE_MOVE_HOME:
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800528 v.playSoundEffect(SoundEffectConstants.NAVIGATION_UP);
Adam Cohenac56cff2011-09-28 20:45:37 -0700529 break;
Hyunyoung Songee3e6a72015-02-20 14:25:27 -0800530 default:
Winson Chung97d85d22011-04-13 11:27:36 -0700531 break;
Winson Chung97d85d22011-04-13 11:27:36 -0700532 }
Winson Chung97d85d22011-04-13 11:27:36 -0700533 }
Winsonfa56b3f2015-09-14 12:01:13 -0700534
535 /**
536 * Returns whether the key event represents a valid uninstall key chord.
537 */
538 private static boolean isUninstallKeyChord(KeyEvent event) {
539 int keyCode = event.getKeyCode();
540 return (keyCode == KeyEvent.KEYCODE_DEL || keyCode == KeyEvent.KEYCODE_FORWARD_DEL) &&
541 event.hasModifiers(KeyEvent.META_CTRL_ON | KeyEvent.META_SHIFT_ON);
542 }
543
544 /**
545 * Returns whether the key event represents a valid delete key chord.
546 */
547 private static boolean isDeleteKeyChord(KeyEvent event) {
548 int keyCode = event.getKeyCode();
549 return (keyCode == KeyEvent.KEYCODE_DEL || keyCode == KeyEvent.KEYCODE_FORWARD_DEL) &&
550 event.hasModifiers(KeyEvent.META_CTRL_ON);
551 }
Tony Wickhamaf78b592015-11-11 09:25:38 -0800552
553 private static View handlePreviousPageLastItem(Workspace workspace, CellLayout hotseatLayout,
554 int pageIndex, boolean isRtl) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800555 if (pageIndex - 1 < 0) {
556 return null;
557 }
Tony Wickhamaf78b592015-11-11 09:25:38 -0800558 CellLayout workspaceLayout = (CellLayout) workspace.getChildAt(pageIndex - 1);
559 View newIcon = getFirstFocusableIconInReverseReadingOrder(workspaceLayout, isRtl);
560 if (newIcon == null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800561 // Check the hotseat if no focusable item was found on the workspace.
Tony Wickhamaf78b592015-11-11 09:25:38 -0800562 newIcon = getFirstFocusableIconInReverseReadingOrder(hotseatLayout,isRtl);
563 workspace.snapToPage(pageIndex - 1);
564 }
565 return newIcon;
566 }
567
568 private static View handleNextPageFirstItem(Workspace workspace, CellLayout hotseatLayout,
569 int pageIndex, boolean isRtl) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800570 if (pageIndex + 1 >= workspace.getPageCount()) {
571 return null;
572 }
Tony Wickhamaf78b592015-11-11 09:25:38 -0800573 CellLayout workspaceLayout = (CellLayout) workspace.getChildAt(pageIndex + 1);
574 View newIcon = getFirstFocusableIconInReadingOrder(workspaceLayout, isRtl);
575 if (newIcon == null) {
Tony Wickham0fa5ada2015-11-13 17:32:20 -0800576 // Check the hotseat if no focusable item was found on the workspace.
Tony Wickhamaf78b592015-11-11 09:25:38 -0800577 newIcon = getFirstFocusableIconInReadingOrder(hotseatLayout, isRtl);
578 workspace.snapToPage(pageIndex + 1);
579 }
580 return newIcon;
581 }
582
583 private static View getFirstFocusableIconInReadingOrder(CellLayout cellLayout, boolean isRtl) {
584 View icon;
585 int countX = cellLayout.getCountX();
586 for (int y = 0; y < cellLayout.getCountY(); y++) {
587 int increment = isRtl ? -1 : 1;
588 for (int x = isRtl ? countX - 1 : 0; 0 <= x && x < countX; x += increment) {
589 if ((icon = cellLayout.getChildAt(x, y)) != null && icon.isFocusable()) {
590 return icon;
591 }
592 }
593 }
594 return null;
595 }
596
597 private static View getFirstFocusableIconInReverseReadingOrder(CellLayout cellLayout,
598 boolean isRtl) {
599 View icon;
600 int countX = cellLayout.getCountX();
601 for (int y = cellLayout.getCountY() - 1; y >= 0; y--) {
602 int increment = isRtl ? 1 : -1;
603 for (int x = isRtl ? 0 : countX - 1; 0 <= x && x < countX; x += increment) {
604 if ((icon = cellLayout.getChildAt(x, y)) != null && icon.isFocusable()) {
605 return icon;
606 }
607 }
608 }
609 return null;
610 }
Winson Chung97d85d22011-04-13 11:27:36 -0700611}