blob: f548095efb758a1ffea2113a91b12598408eed16 [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
Sunny Goyalbe93f262017-10-20 17:05:27 -070024import android.view.View;
Sunny Goyal0c723352017-12-12 12:02:29 -080025import android.view.animation.Interpolator;
Sunny Goyalbe93f262017-10-20 17:05:27 -070026
Sunny Goyalc99cb172017-10-19 16:15:09 -070027import com.android.launcher3.states.SpringLoadedState;
Sunny Goyal623eddd2018-03-02 12:24:41 -080028import com.android.launcher3.uioverrides.AllAppsState;
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080029import com.android.launcher3.uioverrides.FastOverviewState;
Sunny Goyal85525172017-11-06 13:00:42 -080030import com.android.launcher3.uioverrides.OverviewState;
Sunny Goyal75c59ac2018-01-15 14:23:11 -080031import com.android.launcher3.uioverrides.UiFactory;
Sunny Goyal4c7f2152017-10-17 17:17:16 -070032import com.android.launcher3.userevent.nano.LauncherLogProto.ContainerType;
33
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070034import java.util.Arrays;
35
Sunny Goyal4c7f2152017-10-17 17:17:16 -070036
37/**
Sunny Goyalbe93f262017-10-20 17:05:27 -070038 * Base state for various states used for the Launcher
Sunny Goyal4c7f2152017-10-17 17:17:16 -070039 */
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070040public class LauncherState {
Sunny Goyal4c7f2152017-10-17 17:17:16 -070041
Sunny Goyal7185dd62018-03-14 17:51:49 -070042
43 /**
44 * Set of elements indicating various workspace elements which change visibility across states
45 * Note that workspace is not included here as in that case, we animate individual pages
46 */
47 public static final int NONE = 0;
Tony Wickhambd6f05e2018-03-21 08:16:33 -070048 public static final int HOTSEAT_ICONS = 1 << 0;
Sunny Goyal81b4c7b2018-03-26 12:10:31 -070049 public static final int HOTSEAT_SEARCH_BOX = 1 << 1;
Tony Wickhambd6f05e2018-03-21 08:16:33 -070050 public static final int ALL_APPS_HEADER = 1 << 2;
51 public static final int ALL_APPS_HEADER_EXTRA = 1 << 3; // e.g. app predictions
52 public static final int ALL_APPS_CONTENT = 1 << 4;
Sunny Goyal81b4c7b2018-03-26 12:10:31 -070053 public static final int DRAG_HANDLE_INDICATOR = 1 << 5;
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 Goyal6c6c2f42018-03-02 14:57:46 -080064
Sunny Goyal0c723352017-12-12 12:02:29 -080065 protected static final PageAlphaProvider DEFAULT_ALPHA_PROVIDER =
66 new PageAlphaProvider(ACCEL_2) {
67 @Override
68 public float getPageAlpha(int pageIndex) {
69 return 1;
70 }
71 };
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070072
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080073 private static final LauncherState[] sAllStates = new LauncherState[5];
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070074
Sunny Goyal75c59ac2018-01-15 14:23:11 -080075 /**
76 * TODO: Create a separate class for NORMAL state.
77 */
Sunny Goyalc99cb172017-10-19 16:15:09 -070078 public static final LauncherState NORMAL = new LauncherState(0, ContainerType.WORKSPACE,
Tony Wickham76cf2362018-03-20 14:13:16 -070079 0, FLAG_DISABLE_RESTORE | FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED | FLAG_HIDE_BACK_BUTTON);
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070080
Sunny Goyal7185dd62018-03-14 17:51:49 -070081 /**
82 * Various Launcher states arranged in the increasing order of UI layers
83 */
84 public static final LauncherState SPRING_LOADED = new SpringLoadedState(1);
85 public static final LauncherState OVERVIEW = new OverviewState(2);
86 public static final LauncherState FAST_OVERVIEW = new FastOverviewState(3);
87 public static final LauncherState ALL_APPS = new AllAppsState(4);
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080088
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070089 public final int ordinal;
90
Sunny Goyalf9403d92017-10-18 10:55:56 -070091 /**
92 * Used for containerType in {@link com.android.launcher3.logging.UserEventDispatcher}
93 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -070094 public final int containerType;
95
Sunny Goyalf9403d92017-10-18 10:55:56 -070096 /**
97 * True if the state can be persisted across activity restarts.
98 */
Sunny Goyalbc683e92017-12-06 10:25:07 -080099 public final boolean disableRestore;
Sunny Goyalf9403d92017-10-18 10:55:56 -0700100
101 /**
102 * True if workspace has multiple pages visible.
103 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700104 public final boolean hasMultipleVisiblePages;
Sunny Goyalf9403d92017-10-18 10:55:56 -0700105
106 /**
107 * Accessibility flag for workspace and its pages.
108 * @see android.view.View#setImportantForAccessibility(int)
109 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700110 public final int workspaceAccessibilityFlag;
111
Sunny Goyalbe93f262017-10-20 17:05:27 -0700112 /**
113 * Properties related to state transition animation
114 *
115 * @see WorkspaceStateTransitionAnimation
116 */
Sunny Goyal6639a5d2018-02-28 15:09:36 -0800117 public final boolean hasWorkspacePageBackground;
Sunny Goyal6639a5d2018-02-28 15:09:36 -0800118
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700119 public final int transitionDuration;
120
Sunny Goyalbe93f262017-10-20 17:05:27 -0700121 /**
Tony Wickham53370672017-12-05 10:10:55 -0800122 * True if the state allows workspace icons to be dragged.
123 */
124 public final boolean workspaceIconsCanBeDragged;
125
Sunny Goyalbc683e92017-12-06 10:25:07 -0800126 /**
127 * True if the workspace pages should not be clipped relative to the workspace bounds
128 * for this state.
129 */
130 public final boolean disablePageClipping;
131
Sunny Goyal6c6c2f42018-03-02 14:57:46 -0800132 /**
133 * True if launcher can not be directly interacted in this state;
134 */
135 public final boolean disableInteraction;
136
137 /**
138 * True if the state has overview panel visible.
139 */
140 public final boolean overviewUi;
141
Tony Wickham76cf2362018-03-20 14:13:16 -0700142 /**
143 * True if the back button should be hidden when in this state (assuming no floating views are
144 * open, launcher has window focus, etc).
145 */
146 public final boolean hideBackButton;
147
Sunny Goyal228153d2018-01-04 15:35:22 -0800148 public LauncherState(int id, int containerType, int transitionDuration, int flags) {
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700149 this.containerType = containerType;
150 this.transitionDuration = transitionDuration;
151
Sunny Goyal6639a5d2018-02-28 15:09:36 -0800152 this.hasWorkspacePageBackground = (flags & FLAG_PAGE_BACKGROUNDS) != 0;
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700153 this.hasMultipleVisiblePages = (flags & FLAG_MULTI_PAGE) != 0;
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700154 this.workspaceAccessibilityFlag = (flags & FLAG_DISABLE_ACCESSIBILITY) != 0
155 ? IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS
156 : IMPORTANT_FOR_ACCESSIBILITY_AUTO;
Sunny Goyalbc683e92017-12-06 10:25:07 -0800157 this.disableRestore = (flags & FLAG_DISABLE_RESTORE) != 0;
Tony Wickham53370672017-12-05 10:10:55 -0800158 this.workspaceIconsCanBeDragged = (flags & FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED) != 0;
Sunny Goyalbc683e92017-12-06 10:25:07 -0800159 this.disablePageClipping = (flags & FLAG_DISABLE_PAGE_CLIPPING) != 0;
Sunny Goyal6c6c2f42018-03-02 14:57:46 -0800160 this.disableInteraction = (flags & FLAG_DISABLE_INTERACTION) != 0;
161 this.overviewUi = (flags & FLAG_OVERVIEW_UI) != 0;
Tony Wickham76cf2362018-03-20 14:13:16 -0700162 this.hideBackButton = (flags & FLAG_HIDE_BACK_BUTTON) != 0;
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700163
164 this.ordinal = id;
165 sAllStates[id] = this;
166 }
167
168 public static LauncherState[] values() {
169 return Arrays.copyOf(sAllStates, sAllStates.length);
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700170 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700171
172 public float[] getWorkspaceScaleAndTranslation(Launcher launcher) {
Sunny Goyal9328a512017-12-21 12:40:38 -0800173 return new float[] {1, 0, 0};
Sunny Goyalc99cb172017-10-19 16:15:09 -0700174 }
175
Tonye9054e32018-03-15 12:48:51 +0000176 /**
Tony0c955592018-04-04 10:23:36 -0700177 * Returns 2 floats designating how to transition overview:
178 * scale for the current and adjacent pages
179 * translationY factor where 0 is top aligned and 0.5 is centered vertically
Tonye9054e32018-03-15 12:48:51 +0000180 */
Tony0c955592018-04-04 10:23:36 -0700181 public float[] getOverviewScaleAndTranslationYFactor(Launcher launcher) {
182 return new float[] {1.2f, 0.2f};
Tony3bb5e8e2018-03-14 12:05:00 +0000183 }
184
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700185 public void onStateEnabled(Launcher launcher) {
186 dispatchWindowStateChanged(launcher);
187 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700188
189 public void onStateDisabled(Launcher launcher) { }
Sunny Goyalbe93f262017-10-20 17:05:27 -0700190
191 public View getFinalFocus(Launcher launcher) {
192 return launcher.getWorkspace();
193 }
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700194
Sunny Goyal7185dd62018-03-14 17:51:49 -0700195 public int getVisibleElements(Launcher launcher) {
Tony Wickhambd6f05e2018-03-21 08:16:33 -0700196 if (launcher.getDeviceProfile().isVerticalBarLayout()) {
Sunny Goyal81b4c7b2018-03-26 12:10:31 -0700197 return HOTSEAT_ICONS | DRAG_HANDLE_INDICATOR;
Tony Wickhambd6f05e2018-03-21 08:16:33 -0700198 }
Sunny Goyal81b4c7b2018-03-26 12:10:31 -0700199 return HOTSEAT_ICONS | DRAG_HANDLE_INDICATOR | HOTSEAT_SEARCH_BOX;
Sunny Goyal7185dd62018-03-14 17:51:49 -0700200 }
201
Sunny Goyal228153d2018-01-04 15:35:22 -0800202 /**
203 * Fraction shift in the vertical translation UI and related properties
204 *
205 * @see com.android.launcher3.allapps.AllAppsTransitionController
206 */
207 public float getVerticalProgress(Launcher launcher) {
208 return 1f;
209 }
210
Sunny Goyal927447e2018-05-04 13:19:29 -0700211 public float getWorkspaceScrimAlpha(Launcher launcher) {
212 return 0;
213 }
214
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700215 public String getDescription(Launcher launcher) {
216 return launcher.getWorkspace().getCurrentPageDescription();
217 }
218
Sunny Goyalbc683e92017-12-06 10:25:07 -0800219 public PageAlphaProvider getWorkspacePageAlphaProvider(Launcher launcher) {
220 if (this != NORMAL || !launcher.getDeviceProfile().shouldFadeAdjacentWorkspaceScreens()) {
221 return DEFAULT_ALPHA_PROVIDER;
222 }
Sunny Goyal228153d2018-01-04 15:35:22 -0800223 final int centerPage = launcher.getWorkspace().getNextPage();
Sunny Goyal0c723352017-12-12 12:02:29 -0800224 return new PageAlphaProvider(ACCEL_2) {
225 @Override
226 public float getPageAlpha(int pageIndex) {
227 return pageIndex != centerPage ? 0 : 1f;
228 }
229 };
Sunny Goyalbc683e92017-12-06 10:25:07 -0800230 }
231
Sunny Goyal49bcf342018-01-11 13:59:53 -0800232 public LauncherState getHistoryForState(LauncherState previousState) {
233 // No history is supported
234 return NORMAL;
235 }
236
Sunny Goyal75c59ac2018-01-15 14:23:11 -0800237 /**
238 * Called when the start transition ends and the user settles on this particular state.
239 */
240 public void onStateTransitionEnd(Launcher launcher) {
241 if (this == NORMAL) {
242 UiFactory.resetOverview(launcher);
Sunny Goyal623eddd2018-03-02 12:24:41 -0800243 // Clear any rotation locks when going to normal state
244 launcher.getRotationHelper().setCurrentStateRequest(REQUEST_NONE);
Sunny Goyal75c59ac2018-01-15 14:23:11 -0800245 }
246 }
247
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700248 protected static void dispatchWindowStateChanged(Launcher launcher) {
249 launcher.getWindow().getDecorView().sendAccessibilityEvent(TYPE_WINDOW_STATE_CHANGED);
250 }
Sunny Goyalbc683e92017-12-06 10:25:07 -0800251
Sunny Goyal0c723352017-12-12 12:02:29 -0800252 public static abstract class PageAlphaProvider {
Sunny Goyalbc683e92017-12-06 10:25:07 -0800253
Sunny Goyal0c723352017-12-12 12:02:29 -0800254 public final Interpolator interpolator;
255
256 public PageAlphaProvider(Interpolator interpolator) {
257 this.interpolator = interpolator;
258 }
259
260 public abstract float getPageAlpha(int pageIndex);
Sunny Goyalbc683e92017-12-06 10:25:07 -0800261 }
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700262}