blob: 5052674162ff2ca87b0ec6aadb24616701e9b39a [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;
Sunny Goyal0c723352017-12-12 12:02:29 -080021import static com.android.launcher3.anim.Interpolators.ACCEL_2;
Sunny Goyal623eddd2018-03-02 12:24:41 -080022import static com.android.launcher3.states.RotationHelper.REQUEST_NONE;
Sunny Goyal0c723352017-12-12 12:02:29 -080023
Tony Wickham6becf7c2018-04-19 11:39:34 -070024import android.graphics.Rect;
Sunny Goyalbe93f262017-10-20 17:05:27 -070025import android.view.View;
Sunny Goyal0c723352017-12-12 12:02:29 -080026import android.view.animation.Interpolator;
Sunny Goyalbe93f262017-10-20 17:05:27 -070027
Sunny Goyalc99cb172017-10-19 16:15:09 -070028import com.android.launcher3.states.SpringLoadedState;
Sunny Goyal623eddd2018-03-02 12:24:41 -080029import com.android.launcher3.uioverrides.AllAppsState;
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080030import com.android.launcher3.uioverrides.FastOverviewState;
Sunny Goyal85525172017-11-06 13:00:42 -080031import com.android.launcher3.uioverrides.OverviewState;
Sunny Goyal75c59ac2018-01-15 14:23:11 -080032import com.android.launcher3.uioverrides.UiFactory;
Sunny Goyal4c7f2152017-10-17 17:17:16 -070033import com.android.launcher3.userevent.nano.LauncherLogProto.ContainerType;
34
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070035import java.util.Arrays;
36
Sunny Goyal4c7f2152017-10-17 17:17:16 -070037
38/**
Sunny Goyalbe93f262017-10-20 17:05:27 -070039 * Base state for various states used for the Launcher
Sunny Goyal4c7f2152017-10-17 17:17:16 -070040 */
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070041public class LauncherState {
Sunny Goyal4c7f2152017-10-17 17:17:16 -070042
Sunny Goyal7185dd62018-03-14 17:51:49 -070043
44 /**
45 * Set of elements indicating various workspace elements which change visibility across states
46 * Note that workspace is not included here as in that case, we animate individual pages
47 */
48 public static final int NONE = 0;
Tony Wickhambd6f05e2018-03-21 08:16:33 -070049 public static final int HOTSEAT_ICONS = 1 << 0;
Sunny Goyal81b4c7b2018-03-26 12:10:31 -070050 public static final int HOTSEAT_SEARCH_BOX = 1 << 1;
Tony Wickhambd6f05e2018-03-21 08:16:33 -070051 public static final int ALL_APPS_HEADER = 1 << 2;
52 public static final int ALL_APPS_HEADER_EXTRA = 1 << 3; // e.g. app predictions
53 public static final int ALL_APPS_CONTENT = 1 << 4;
Sunny Goyal7185dd62018-03-14 17:51:49 -070054
Sunny Goyal927447e2018-05-04 13:19:29 -070055 protected static final int FLAG_MULTI_PAGE = 1 << 0;
56 protected static final int FLAG_DISABLE_ACCESSIBILITY = 1 << 1;
57 protected static final int FLAG_DISABLE_RESTORE = 1 << 2;
58 protected static final int FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED = 1 << 3;
59 protected static final int FLAG_DISABLE_PAGE_CLIPPING = 1 << 4;
60 protected static final int FLAG_PAGE_BACKGROUNDS = 1 << 5;
61 protected static final int FLAG_DISABLE_INTERACTION = 1 << 6;
62 protected static final int FLAG_OVERVIEW_UI = 1 << 7;
63 protected static final int FLAG_HIDE_BACK_BUTTON = 1 << 8;
Sunny Goyal5d1873a2018-05-08 11:10:44 -070064 protected static final int FLAG_HAS_SYS_UI_SCRIM = 1 << 9;
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080065
Sunny Goyal0c723352017-12-12 12:02:29 -080066 protected static final PageAlphaProvider DEFAULT_ALPHA_PROVIDER =
67 new PageAlphaProvider(ACCEL_2) {
68 @Override
69 public float getPageAlpha(int pageIndex) {
70 return 1;
71 }
72 };
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070073
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080074 private static final LauncherState[] sAllStates = new LauncherState[5];
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070075
Sunny Goyal75c59ac2018-01-15 14:23:11 -080076 /**
77 * TODO: Create a separate class for NORMAL state.
78 */
Sunny Goyal5d1873a2018-05-08 11:10:44 -070079 public static final LauncherState NORMAL = new LauncherState(0, ContainerType.WORKSPACE, 0,
80 FLAG_DISABLE_RESTORE | FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED | FLAG_HIDE_BACK_BUTTON |
81 FLAG_HAS_SYS_UI_SCRIM);
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070082
Sunny Goyal7185dd62018-03-14 17:51:49 -070083 /**
84 * Various Launcher states arranged in the increasing order of UI layers
85 */
86 public static final LauncherState SPRING_LOADED = new SpringLoadedState(1);
87 public static final LauncherState OVERVIEW = new OverviewState(2);
88 public static final LauncherState FAST_OVERVIEW = new FastOverviewState(3);
89 public static final LauncherState ALL_APPS = new AllAppsState(4);
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080090
Tony Wickham6becf7c2018-04-19 11:39:34 -070091 protected static final Rect sTempRect = new Rect();
92
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070093 public final int ordinal;
94
Sunny Goyalf9403d92017-10-18 10:55:56 -070095 /**
96 * Used for containerType in {@link com.android.launcher3.logging.UserEventDispatcher}
97 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -070098 public final int containerType;
99
Sunny Goyalf9403d92017-10-18 10:55:56 -0700100 /**
101 * True if the state can be persisted across activity restarts.
102 */
Sunny Goyalbc683e92017-12-06 10:25:07 -0800103 public final boolean disableRestore;
Sunny Goyalf9403d92017-10-18 10:55:56 -0700104
105 /**
106 * True if workspace has multiple pages visible.
107 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700108 public final boolean hasMultipleVisiblePages;
Sunny Goyalf9403d92017-10-18 10:55:56 -0700109
110 /**
111 * Accessibility flag for workspace and its pages.
112 * @see android.view.View#setImportantForAccessibility(int)
113 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700114 public final int workspaceAccessibilityFlag;
115
Sunny Goyalbe93f262017-10-20 17:05:27 -0700116 /**
117 * Properties related to state transition animation
118 *
119 * @see WorkspaceStateTransitionAnimation
120 */
Sunny Goyal6639a5d2018-02-28 15:09:36 -0800121 public final boolean hasWorkspacePageBackground;
Sunny Goyal6639a5d2018-02-28 15:09:36 -0800122
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700123 public final int transitionDuration;
124
Sunny Goyalbe93f262017-10-20 17:05:27 -0700125 /**
Tony Wickham53370672017-12-05 10:10:55 -0800126 * True if the state allows workspace icons to be dragged.
127 */
128 public final boolean workspaceIconsCanBeDragged;
129
Sunny Goyalbc683e92017-12-06 10:25:07 -0800130 /**
131 * True if the workspace pages should not be clipped relative to the workspace bounds
132 * for this state.
133 */
134 public final boolean disablePageClipping;
135
Sunny Goyal6c6c2f42018-03-02 14:57:46 -0800136 /**
137 * True if launcher can not be directly interacted in this state;
138 */
139 public final boolean disableInteraction;
140
141 /**
142 * True if the state has overview panel visible.
143 */
144 public final boolean overviewUi;
145
Tony Wickham76cf2362018-03-20 14:13:16 -0700146 /**
147 * True if the back button should be hidden when in this state (assuming no floating views are
148 * open, launcher has window focus, etc).
149 */
150 public final boolean hideBackButton;
151
Sunny Goyal5d1873a2018-05-08 11:10:44 -0700152 public final boolean hasSysUiScrim;
153
Sunny Goyal228153d2018-01-04 15:35:22 -0800154 public LauncherState(int id, int containerType, int transitionDuration, int flags) {
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700155 this.containerType = containerType;
156 this.transitionDuration = transitionDuration;
157
Sunny Goyal6639a5d2018-02-28 15:09:36 -0800158 this.hasWorkspacePageBackground = (flags & FLAG_PAGE_BACKGROUNDS) != 0;
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700159 this.hasMultipleVisiblePages = (flags & FLAG_MULTI_PAGE) != 0;
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700160 this.workspaceAccessibilityFlag = (flags & FLAG_DISABLE_ACCESSIBILITY) != 0
161 ? IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS
162 : IMPORTANT_FOR_ACCESSIBILITY_AUTO;
Sunny Goyalbc683e92017-12-06 10:25:07 -0800163 this.disableRestore = (flags & FLAG_DISABLE_RESTORE) != 0;
Tony Wickham53370672017-12-05 10:10:55 -0800164 this.workspaceIconsCanBeDragged = (flags & FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED) != 0;
Sunny Goyalbc683e92017-12-06 10:25:07 -0800165 this.disablePageClipping = (flags & FLAG_DISABLE_PAGE_CLIPPING) != 0;
Sunny Goyal6c6c2f42018-03-02 14:57:46 -0800166 this.disableInteraction = (flags & FLAG_DISABLE_INTERACTION) != 0;
167 this.overviewUi = (flags & FLAG_OVERVIEW_UI) != 0;
Tony Wickham76cf2362018-03-20 14:13:16 -0700168 this.hideBackButton = (flags & FLAG_HIDE_BACK_BUTTON) != 0;
Sunny Goyal5d1873a2018-05-08 11:10:44 -0700169 this.hasSysUiScrim = (flags & FLAG_HAS_SYS_UI_SCRIM) != 0;
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700170
171 this.ordinal = id;
172 sAllStates[id] = this;
173 }
174
175 public static LauncherState[] values() {
176 return Arrays.copyOf(sAllStates, sAllStates.length);
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700177 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700178
179 public float[] getWorkspaceScaleAndTranslation(Launcher launcher) {
Sunny Goyal9328a512017-12-21 12:40:38 -0800180 return new float[] {1, 0, 0};
Sunny Goyalc99cb172017-10-19 16:15:09 -0700181 }
182
Tonye9054e32018-03-15 12:48:51 +0000183 /**
Tony0c955592018-04-04 10:23:36 -0700184 * Returns 2 floats designating how to transition overview:
185 * scale for the current and adjacent pages
186 * translationY factor where 0 is top aligned and 0.5 is centered vertically
Tonye9054e32018-03-15 12:48:51 +0000187 */
Tony0c955592018-04-04 10:23:36 -0700188 public float[] getOverviewScaleAndTranslationYFactor(Launcher launcher) {
189 return new float[] {1.2f, 0.2f};
Tony3bb5e8e2018-03-14 12:05:00 +0000190 }
191
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700192 public void onStateEnabled(Launcher launcher) {
193 dispatchWindowStateChanged(launcher);
194 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700195
196 public void onStateDisabled(Launcher launcher) { }
Sunny Goyalbe93f262017-10-20 17:05:27 -0700197
198 public View getFinalFocus(Launcher launcher) {
199 return launcher.getWorkspace();
200 }
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700201
Sunny Goyal7185dd62018-03-14 17:51:49 -0700202 public int getVisibleElements(Launcher launcher) {
Tony Wickhambd6f05e2018-03-21 08:16:33 -0700203 if (launcher.getDeviceProfile().isVerticalBarLayout()) {
Sunny Goyalef395402018-05-09 08:42:24 -0700204 return HOTSEAT_ICONS;
Tony Wickhambd6f05e2018-03-21 08:16:33 -0700205 }
Sunny Goyalef395402018-05-09 08:42:24 -0700206 return HOTSEAT_ICONS | HOTSEAT_SEARCH_BOX;
Sunny Goyal7185dd62018-03-14 17:51:49 -0700207 }
208
Sunny Goyal228153d2018-01-04 15:35:22 -0800209 /**
210 * Fraction shift in the vertical translation UI and related properties
211 *
212 * @see com.android.launcher3.allapps.AllAppsTransitionController
213 */
214 public float getVerticalProgress(Launcher launcher) {
215 return 1f;
216 }
217
Sunny Goyal927447e2018-05-04 13:19:29 -0700218 public float getWorkspaceScrimAlpha(Launcher launcher) {
219 return 0;
220 }
221
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700222 public String getDescription(Launcher launcher) {
223 return launcher.getWorkspace().getCurrentPageDescription();
224 }
225
Sunny Goyalbc683e92017-12-06 10:25:07 -0800226 public PageAlphaProvider getWorkspacePageAlphaProvider(Launcher launcher) {
227 if (this != NORMAL || !launcher.getDeviceProfile().shouldFadeAdjacentWorkspaceScreens()) {
228 return DEFAULT_ALPHA_PROVIDER;
229 }
Sunny Goyal228153d2018-01-04 15:35:22 -0800230 final int centerPage = launcher.getWorkspace().getNextPage();
Sunny Goyal0c723352017-12-12 12:02:29 -0800231 return new PageAlphaProvider(ACCEL_2) {
232 @Override
233 public float getPageAlpha(int pageIndex) {
234 return pageIndex != centerPage ? 0 : 1f;
235 }
236 };
Sunny Goyalbc683e92017-12-06 10:25:07 -0800237 }
238
Sunny Goyal49bcf342018-01-11 13:59:53 -0800239 public LauncherState getHistoryForState(LauncherState previousState) {
240 // No history is supported
241 return NORMAL;
242 }
243
Sunny Goyal75c59ac2018-01-15 14:23:11 -0800244 /**
245 * Called when the start transition ends and the user settles on this particular state.
246 */
247 public void onStateTransitionEnd(Launcher launcher) {
248 if (this == NORMAL) {
249 UiFactory.resetOverview(launcher);
Sunny Goyal623eddd2018-03-02 12:24:41 -0800250 // Clear any rotation locks when going to normal state
251 launcher.getRotationHelper().setCurrentStateRequest(REQUEST_NONE);
Sunny Goyal75c59ac2018-01-15 14:23:11 -0800252 }
253 }
254
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700255 protected static void dispatchWindowStateChanged(Launcher launcher) {
256 launcher.getWindow().getDecorView().sendAccessibilityEvent(TYPE_WINDOW_STATE_CHANGED);
257 }
Sunny Goyalbc683e92017-12-06 10:25:07 -0800258
Sunny Goyal0c723352017-12-12 12:02:29 -0800259 public static abstract class PageAlphaProvider {
Sunny Goyalbc683e92017-12-06 10:25:07 -0800260
Sunny Goyal0c723352017-12-12 12:02:29 -0800261 public final Interpolator interpolator;
262
263 public PageAlphaProvider(Interpolator interpolator) {
264 this.interpolator = interpolator;
265 }
266
267 public abstract float getPageAlpha(int pageIndex);
Sunny Goyalbc683e92017-12-06 10:25:07 -0800268 }
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700269}