blob: a3d5994e8c892a794b26625776661ba6e209e48f [file] [log] [blame]
Sunny Goyal4c7f2152017-10-17 17:17:16 -07001/*
2 * Copyright (C) 2017 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 */
16package com.android.launcher3;
17
18import static android.view.View.IMPORTANT_FOR_ACCESSIBILITY_AUTO;
19import static android.view.View.IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS;
Sunny Goyal3e3f44c2017-10-23 17:14:52 -070020import static android.view.accessibility.AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED;
vadimt2a648aa2019-02-14 17:47:11 -080021import static com.android.launcher3.TestProtocol.ALL_APPS_STATE_ORDINAL;
22import static com.android.launcher3.TestProtocol.BACKGROUND_APP_STATE_ORDINAL;
vadimt6895e402019-02-15 16:42:14 -080023import static com.android.launcher3.TestProtocol.NORMAL_STATE_ORDINAL;
Tony1787ee92019-03-20 12:38:35 -050024import static com.android.launcher3.TestProtocol.OVERVIEW_PEEK_STATE_ORDINAL;
vadimt2a648aa2019-02-14 17:47:11 -080025import static com.android.launcher3.TestProtocol.OVERVIEW_STATE_ORDINAL;
26import static com.android.launcher3.TestProtocol.SPRING_LOADED_STATE_ORDINAL;
Sunny Goyal0c723352017-12-12 12:02:29 -080027import static com.android.launcher3.anim.Interpolators.ACCEL_2;
Sunny Goyal623eddd2018-03-02 12:24:41 -080028import static com.android.launcher3.states.RotationHelper.REQUEST_NONE;
Sunny Goyal0c723352017-12-12 12:02:29 -080029
Sunny Goyal0c723352017-12-12 12:02:29 -080030import android.view.animation.Interpolator;
Sunny Goyalbe93f262017-10-20 17:05:27 -070031
Tony1787ee92019-03-20 12:38:35 -050032import com.android.launcher3.config.FeatureFlags;
Sunny Goyalc99cb172017-10-19 16:15:09 -070033import com.android.launcher3.states.SpringLoadedState;
Sunny Goyal623eddd2018-03-02 12:24:41 -080034import com.android.launcher3.uioverrides.AllAppsState;
Sunny Goyal85525172017-11-06 13:00:42 -080035import com.android.launcher3.uioverrides.OverviewState;
Sunny Goyal75c59ac2018-01-15 14:23:11 -080036import com.android.launcher3.uioverrides.UiFactory;
Sunny Goyale39690b2018-08-02 13:35:07 -070037import com.android.launcher3.userevent.nano.LauncherLogProto.Action;
Sunny Goyal4c7f2152017-10-17 17:17:16 -070038import com.android.launcher3.userevent.nano.LauncherLogProto.ContainerType;
39
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070040import java.util.Arrays;
41
Sunny Goyal4c7f2152017-10-17 17:17:16 -070042
43/**
Sunny Goyalbe93f262017-10-20 17:05:27 -070044 * Base state for various states used for the Launcher
Sunny Goyal4c7f2152017-10-17 17:17:16 -070045 */
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070046public class LauncherState {
Sunny Goyal4c7f2152017-10-17 17:17:16 -070047
Sunny Goyal7185dd62018-03-14 17:51:49 -070048
49 /**
50 * Set of elements indicating various workspace elements which change visibility across states
51 * Note that workspace is not included here as in that case, we animate individual pages
52 */
53 public static final int NONE = 0;
Tony Wickhambd6f05e2018-03-21 08:16:33 -070054 public static final int HOTSEAT_ICONS = 1 << 0;
Sunny Goyal81b4c7b2018-03-26 12:10:31 -070055 public static final int HOTSEAT_SEARCH_BOX = 1 << 1;
Tony Wickhambd6f05e2018-03-21 08:16:33 -070056 public static final int ALL_APPS_HEADER = 1 << 2;
57 public static final int ALL_APPS_HEADER_EXTRA = 1 << 3; // e.g. app predictions
58 public static final int ALL_APPS_CONTENT = 1 << 4;
Sunny Goyal56e10192018-05-22 13:22:25 -070059 public static final int VERTICAL_SWIPE_INDICATOR = 1 << 5;
Sunny Goyal7185dd62018-03-14 17:51:49 -070060
Sunny Goyal927447e2018-05-04 13:19:29 -070061 protected static final int FLAG_MULTI_PAGE = 1 << 0;
62 protected static final int FLAG_DISABLE_ACCESSIBILITY = 1 << 1;
63 protected static final int FLAG_DISABLE_RESTORE = 1 << 2;
64 protected static final int FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED = 1 << 3;
65 protected static final int FLAG_DISABLE_PAGE_CLIPPING = 1 << 4;
66 protected static final int FLAG_PAGE_BACKGROUNDS = 1 << 5;
67 protected static final int FLAG_DISABLE_INTERACTION = 1 << 6;
68 protected static final int FLAG_OVERVIEW_UI = 1 << 7;
69 protected static final int FLAG_HIDE_BACK_BUTTON = 1 << 8;
Sunny Goyal5d1873a2018-05-08 11:10:44 -070070 protected static final int FLAG_HAS_SYS_UI_SCRIM = 1 << 9;
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080071
Sunny Goyal0c723352017-12-12 12:02:29 -080072 protected static final PageAlphaProvider DEFAULT_ALPHA_PROVIDER =
73 new PageAlphaProvider(ACCEL_2) {
74 @Override
75 public float getPageAlpha(int pageIndex) {
76 return 1;
77 }
78 };
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070079
Sunny Goyalcf300fc2018-09-05 12:47:21 -070080 private static final LauncherState[] sAllStates = new LauncherState[6];
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070081
Sunny Goyal75c59ac2018-01-15 14:23:11 -080082 /**
83 * TODO: Create a separate class for NORMAL state.
84 */
vadimt6895e402019-02-15 16:42:14 -080085 public static final LauncherState NORMAL = new LauncherState(NORMAL_STATE_ORDINAL,
86 ContainerType.WORKSPACE, 0,
Sunny Goyal5d1873a2018-05-08 11:10:44 -070087 FLAG_DISABLE_RESTORE | FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED | FLAG_HIDE_BACK_BUTTON |
88 FLAG_HAS_SYS_UI_SCRIM);
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070089
Sunny Goyal7185dd62018-03-14 17:51:49 -070090 /**
91 * Various Launcher states arranged in the increasing order of UI layers
92 */
vadimt2a648aa2019-02-14 17:47:11 -080093 public static final LauncherState SPRING_LOADED = new SpringLoadedState(
94 SPRING_LOADED_STATE_ORDINAL);
vadimt2a648aa2019-02-14 17:47:11 -080095 public static final LauncherState ALL_APPS = new AllAppsState(ALL_APPS_STATE_ORDINAL);
Tony1787ee92019-03-20 12:38:35 -050096
97 public static final LauncherState OVERVIEW = new OverviewState(OVERVIEW_STATE_ORDINAL);
98 public static final LauncherState OVERVIEW_PEEK =
99 OverviewState.newPeekState(OVERVIEW_PEEK_STATE_ORDINAL);
100 public static final LauncherState BACKGROUND_APP =
101 OverviewState.newBackgroundState(BACKGROUND_APP_STATE_ORDINAL);
Tony Wickham6becf7c2018-04-19 11:39:34 -0700102
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700103 public final int ordinal;
104
Sunny Goyalf9403d92017-10-18 10:55:56 -0700105 /**
106 * Used for containerType in {@link com.android.launcher3.logging.UserEventDispatcher}
107 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700108 public final int containerType;
109
Sunny Goyalf9403d92017-10-18 10:55:56 -0700110 /**
111 * True if the state can be persisted across activity restarts.
112 */
Sunny Goyalbc683e92017-12-06 10:25:07 -0800113 public final boolean disableRestore;
Sunny Goyalf9403d92017-10-18 10:55:56 -0700114
115 /**
116 * True if workspace has multiple pages visible.
117 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700118 public final boolean hasMultipleVisiblePages;
Sunny Goyalf9403d92017-10-18 10:55:56 -0700119
120 /**
121 * Accessibility flag for workspace and its pages.
122 * @see android.view.View#setImportantForAccessibility(int)
123 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700124 public final int workspaceAccessibilityFlag;
125
Sunny Goyalbe93f262017-10-20 17:05:27 -0700126 /**
127 * Properties related to state transition animation
128 *
129 * @see WorkspaceStateTransitionAnimation
130 */
Sunny Goyal6639a5d2018-02-28 15:09:36 -0800131 public final boolean hasWorkspacePageBackground;
Sunny Goyal6639a5d2018-02-28 15:09:36 -0800132
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700133 public final int transitionDuration;
134
Sunny Goyalbe93f262017-10-20 17:05:27 -0700135 /**
Tony Wickham53370672017-12-05 10:10:55 -0800136 * True if the state allows workspace icons to be dragged.
137 */
138 public final boolean workspaceIconsCanBeDragged;
139
Sunny Goyalbc683e92017-12-06 10:25:07 -0800140 /**
141 * True if the workspace pages should not be clipped relative to the workspace bounds
142 * for this state.
143 */
144 public final boolean disablePageClipping;
145
Sunny Goyal6c6c2f42018-03-02 14:57:46 -0800146 /**
147 * True if launcher can not be directly interacted in this state;
148 */
149 public final boolean disableInteraction;
150
151 /**
152 * True if the state has overview panel visible.
153 */
154 public final boolean overviewUi;
155
Tony Wickham76cf2362018-03-20 14:13:16 -0700156 /**
157 * True if the back button should be hidden when in this state (assuming no floating views are
158 * open, launcher has window focus, etc).
159 */
160 public final boolean hideBackButton;
161
Sunny Goyal5d1873a2018-05-08 11:10:44 -0700162 public final boolean hasSysUiScrim;
163
Sunny Goyal228153d2018-01-04 15:35:22 -0800164 public LauncherState(int id, int containerType, int transitionDuration, int flags) {
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700165 this.containerType = containerType;
166 this.transitionDuration = transitionDuration;
167
Sunny Goyal6639a5d2018-02-28 15:09:36 -0800168 this.hasWorkspacePageBackground = (flags & FLAG_PAGE_BACKGROUNDS) != 0;
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700169 this.hasMultipleVisiblePages = (flags & FLAG_MULTI_PAGE) != 0;
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700170 this.workspaceAccessibilityFlag = (flags & FLAG_DISABLE_ACCESSIBILITY) != 0
171 ? IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS
172 : IMPORTANT_FOR_ACCESSIBILITY_AUTO;
Sunny Goyalbc683e92017-12-06 10:25:07 -0800173 this.disableRestore = (flags & FLAG_DISABLE_RESTORE) != 0;
Tony Wickham53370672017-12-05 10:10:55 -0800174 this.workspaceIconsCanBeDragged = (flags & FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED) != 0;
Sunny Goyalbc683e92017-12-06 10:25:07 -0800175 this.disablePageClipping = (flags & FLAG_DISABLE_PAGE_CLIPPING) != 0;
Sunny Goyal6c6c2f42018-03-02 14:57:46 -0800176 this.disableInteraction = (flags & FLAG_DISABLE_INTERACTION) != 0;
177 this.overviewUi = (flags & FLAG_OVERVIEW_UI) != 0;
Tony Wickham76cf2362018-03-20 14:13:16 -0700178 this.hideBackButton = (flags & FLAG_HIDE_BACK_BUTTON) != 0;
Sunny Goyal5d1873a2018-05-08 11:10:44 -0700179 this.hasSysUiScrim = (flags & FLAG_HAS_SYS_UI_SCRIM) != 0;
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700180
181 this.ordinal = id;
182 sAllStates[id] = this;
183 }
184
185 public static LauncherState[] values() {
186 return Arrays.copyOf(sAllStates, sAllStates.length);
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700187 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700188
Tonybc234402019-03-19 13:30:25 -0500189 public ScaleAndTranslation getWorkspaceScaleAndTranslation(Launcher launcher) {
190 return new ScaleAndTranslation(1, 0, 0);
Sunny Goyalc99cb172017-10-19 16:15:09 -0700191 }
192
Tonybc234402019-03-19 13:30:25 -0500193 public ScaleAndTranslation getHotseatScaleAndTranslation(Launcher launcher) {
Tony Wickham57e489c2019-03-04 14:57:07 -0800194 // For most states, treat the hotseat as if it were part of the workspace.
195 return getWorkspaceScaleAndTranslation(launcher);
Tony4bb4b892019-03-03 15:32:12 -0800196 }
197
Tonybc234402019-03-19 13:30:25 -0500198 public ScaleAndTranslation getOverviewScaleAndTranslation(Launcher launcher) {
Tony1787ee92019-03-20 12:38:35 -0500199 if (FeatureFlags.SWIPE_HOME.get()) {
200 float offscreenTranslationX = launcher.getDragLayer().getWidth()
201 - launcher.getOverviewPanel().getPaddingStart();
202 return new ScaleAndTranslation(1f, offscreenTranslationX, 0f);
203 }
Tonybc234402019-03-19 13:30:25 -0500204 return new ScaleAndTranslation(1.1f, 0f, 0f);
Tony3bb5e8e2018-03-14 12:05:00 +0000205 }
206
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700207 public void onStateEnabled(Launcher launcher) {
208 dispatchWindowStateChanged(launcher);
209 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700210
211 public void onStateDisabled(Launcher launcher) { }
Sunny Goyalbe93f262017-10-20 17:05:27 -0700212
Sunny Goyal7185dd62018-03-14 17:51:49 -0700213 public int getVisibleElements(Launcher launcher) {
Tony Wickhambd6f05e2018-03-21 08:16:33 -0700214 if (launcher.getDeviceProfile().isVerticalBarLayout()) {
Sunny Goyal56e10192018-05-22 13:22:25 -0700215 return HOTSEAT_ICONS | VERTICAL_SWIPE_INDICATOR;
Tony Wickhambd6f05e2018-03-21 08:16:33 -0700216 }
Sunny Goyal56e10192018-05-22 13:22:25 -0700217 return HOTSEAT_ICONS | HOTSEAT_SEARCH_BOX | VERTICAL_SWIPE_INDICATOR;
Sunny Goyal7185dd62018-03-14 17:51:49 -0700218 }
219
Sunny Goyal228153d2018-01-04 15:35:22 -0800220 /**
221 * Fraction shift in the vertical translation UI and related properties
222 *
223 * @see com.android.launcher3.allapps.AllAppsTransitionController
224 */
225 public float getVerticalProgress(Launcher launcher) {
226 return 1f;
227 }
228
Sunny Goyal927447e2018-05-04 13:19:29 -0700229 public float getWorkspaceScrimAlpha(Launcher launcher) {
230 return 0;
231 }
232
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700233 public String getDescription(Launcher launcher) {
234 return launcher.getWorkspace().getCurrentPageDescription();
235 }
236
Sunny Goyalbc683e92017-12-06 10:25:07 -0800237 public PageAlphaProvider getWorkspacePageAlphaProvider(Launcher launcher) {
238 if (this != NORMAL || !launcher.getDeviceProfile().shouldFadeAdjacentWorkspaceScreens()) {
239 return DEFAULT_ALPHA_PROVIDER;
240 }
Sunny Goyal228153d2018-01-04 15:35:22 -0800241 final int centerPage = launcher.getWorkspace().getNextPage();
Sunny Goyal0c723352017-12-12 12:02:29 -0800242 return new PageAlphaProvider(ACCEL_2) {
243 @Override
244 public float getPageAlpha(int pageIndex) {
245 return pageIndex != centerPage ? 0 : 1f;
246 }
247 };
Sunny Goyalbc683e92017-12-06 10:25:07 -0800248 }
249
Sunny Goyal49bcf342018-01-11 13:59:53 -0800250 public LauncherState getHistoryForState(LauncherState previousState) {
251 // No history is supported
252 return NORMAL;
253 }
254
Sunny Goyal75c59ac2018-01-15 14:23:11 -0800255 /**
256 * Called when the start transition ends and the user settles on this particular state.
257 */
258 public void onStateTransitionEnd(Launcher launcher) {
Hyunyoung Song4bd47252018-06-05 16:26:32 -0700259 if (this == NORMAL || this == SPRING_LOADED) {
Sunny Goyal75c59ac2018-01-15 14:23:11 -0800260 UiFactory.resetOverview(launcher);
Hyunyoung Song4bd47252018-06-05 16:26:32 -0700261 }
262 if (this == NORMAL) {
Sunny Goyal623eddd2018-03-02 12:24:41 -0800263 // Clear any rotation locks when going to normal state
264 launcher.getRotationHelper().setCurrentStateRequest(REQUEST_NONE);
Sunny Goyal75c59ac2018-01-15 14:23:11 -0800265 }
266 }
267
Sunny Goyale39690b2018-08-02 13:35:07 -0700268 public void onBackPressed(Launcher launcher) {
269 if (this != NORMAL) {
270 LauncherStateManager lsm = launcher.getStateManager();
271 LauncherState lastState = lsm.getLastState();
272 launcher.getUserEventDispatcher().logActionCommand(Action.Command.BACK,
273 containerType, lastState.containerType);
274 lsm.goToState(lastState);
275 }
276 }
277
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700278 protected static void dispatchWindowStateChanged(Launcher launcher) {
279 launcher.getWindow().getDecorView().sendAccessibilityEvent(TYPE_WINDOW_STATE_CHANGED);
280 }
Sunny Goyalbc683e92017-12-06 10:25:07 -0800281
Sunny Goyal0c723352017-12-12 12:02:29 -0800282 public static abstract class PageAlphaProvider {
Sunny Goyalbc683e92017-12-06 10:25:07 -0800283
Sunny Goyal0c723352017-12-12 12:02:29 -0800284 public final Interpolator interpolator;
285
286 public PageAlphaProvider(Interpolator interpolator) {
287 this.interpolator = interpolator;
288 }
289
290 public abstract float getPageAlpha(int pageIndex);
Sunny Goyalbc683e92017-12-06 10:25:07 -0800291 }
Tonybc234402019-03-19 13:30:25 -0500292
293 public static class ScaleAndTranslation {
294 public float scale;
295 public float translationX;
296 public float translationY;
297
298 public ScaleAndTranslation(float scale, float translationX, float translationY) {
299 this.scale = scale;
300 this.translationX = translationX;
301 this.translationY = translationY;
302 }
303 }
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700304}