blob: 9fef64ae1b348c0d2399ae02ee852c72f81ca94a [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 Goyal4c7f2152017-10-17 17:17:16 -070021
Sunny Goyal0c723352017-12-12 12:02:29 -080022import static com.android.launcher3.anim.Interpolators.ACCEL_2;
Sunny Goyal623eddd2018-03-02 12:24:41 -080023import static com.android.launcher3.states.RotationHelper.REQUEST_NONE;
Sunny Goyal0c723352017-12-12 12:02:29 -080024
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;
49 public static final int HOTSEAT = 1 << 0;
50 public static final int ALL_APPS_HEADER = 1 << 1;
51 public static final int ALL_APPS_CONTENT = 1 << 2;
52
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070053 protected static final int FLAG_SHOW_SCRIM = 1 << 0;
54 protected static final int FLAG_MULTI_PAGE = 1 << 1;
Sunny Goyalc4fa8c32017-11-07 12:23:58 -080055 protected static final int FLAG_DISABLE_ACCESSIBILITY = 1 << 2;
Sunny Goyalbc683e92017-12-06 10:25:07 -080056 protected static final int FLAG_DISABLE_RESTORE = 1 << 3;
Tony Wickham53370672017-12-05 10:10:55 -080057 protected static final int FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED = 1 << 4;
Sunny Goyalbc683e92017-12-06 10:25:07 -080058 protected static final int FLAG_DISABLE_PAGE_CLIPPING = 1 << 5;
Sunny Goyal6639a5d2018-02-28 15:09:36 -080059 protected static final int FLAG_PAGE_BACKGROUNDS = 1 << 6;
60 protected static final int FLAG_ALL_APPS_SCRIM = 1 << 7;
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080061 protected static final int FLAG_DISABLE_INTERACTION = 1 << 8;
62 protected static final int FLAG_OVERVIEW_UI = 1 << 9;
63
Sunny Goyal0c723352017-12-12 12:02:29 -080064 protected static final PageAlphaProvider DEFAULT_ALPHA_PROVIDER =
65 new PageAlphaProvider(ACCEL_2) {
66 @Override
67 public float getPageAlpha(int pageIndex) {
68 return 1;
69 }
70 };
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070071
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080072 private static final LauncherState[] sAllStates = new LauncherState[5];
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070073
Sunny Goyal75c59ac2018-01-15 14:23:11 -080074 /**
75 * TODO: Create a separate class for NORMAL state.
76 */
Sunny Goyalc99cb172017-10-19 16:15:09 -070077 public static final LauncherState NORMAL = new LauncherState(0, ContainerType.WORKSPACE,
Sunny Goyal228153d2018-01-04 15:35:22 -080078 0, FLAG_DISABLE_RESTORE | FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED);
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070079
Sunny Goyal7185dd62018-03-14 17:51:49 -070080 /**
81 * Various Launcher states arranged in the increasing order of UI layers
82 */
83 public static final LauncherState SPRING_LOADED = new SpringLoadedState(1);
84 public static final LauncherState OVERVIEW = new OverviewState(2);
85 public static final LauncherState FAST_OVERVIEW = new FastOverviewState(3);
86 public static final LauncherState ALL_APPS = new AllAppsState(4);
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080087
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070088 public final int ordinal;
89
Sunny Goyalf9403d92017-10-18 10:55:56 -070090 /**
91 * Used for containerType in {@link com.android.launcher3.logging.UserEventDispatcher}
92 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -070093 public final int containerType;
94
Sunny Goyalf9403d92017-10-18 10:55:56 -070095 /**
96 * True if the state can be persisted across activity restarts.
97 */
Sunny Goyalbc683e92017-12-06 10:25:07 -080098 public final boolean disableRestore;
Sunny Goyalf9403d92017-10-18 10:55:56 -070099
100 /**
101 * True if workspace has multiple pages visible.
102 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700103 public final boolean hasMultipleVisiblePages;
Sunny Goyalf9403d92017-10-18 10:55:56 -0700104
105 /**
106 * Accessibility flag for workspace and its pages.
107 * @see android.view.View#setImportantForAccessibility(int)
108 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700109 public final int workspaceAccessibilityFlag;
110
Sunny Goyalbe93f262017-10-20 17:05:27 -0700111 /**
112 * Properties related to state transition animation
113 *
114 * @see WorkspaceStateTransitionAnimation
115 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700116 public final boolean hasScrim;
Sunny Goyal6639a5d2018-02-28 15:09:36 -0800117 public final boolean hasWorkspacePageBackground;
118 public final boolean hasAllAppsScrim;
119
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700120 public final int transitionDuration;
121
Sunny Goyalbe93f262017-10-20 17:05:27 -0700122 /**
Tony Wickham53370672017-12-05 10:10:55 -0800123 * True if the state allows workspace icons to be dragged.
124 */
125 public final boolean workspaceIconsCanBeDragged;
126
Sunny Goyalbc683e92017-12-06 10:25:07 -0800127 /**
128 * True if the workspace pages should not be clipped relative to the workspace bounds
129 * for this state.
130 */
131 public final boolean disablePageClipping;
132
Sunny Goyal6c6c2f42018-03-02 14:57:46 -0800133 /**
134 * True if launcher can not be directly interacted in this state;
135 */
136 public final boolean disableInteraction;
137
138 /**
139 * True if the state has overview panel visible.
140 */
141 public final boolean overviewUi;
142
Sunny Goyal228153d2018-01-04 15:35:22 -0800143 public LauncherState(int id, int containerType, int transitionDuration, int flags) {
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700144 this.containerType = containerType;
145 this.transitionDuration = transitionDuration;
146
147 this.hasScrim = (flags & FLAG_SHOW_SCRIM) != 0;
Sunny Goyal6639a5d2018-02-28 15:09:36 -0800148 this.hasWorkspacePageBackground = (flags & FLAG_PAGE_BACKGROUNDS) != 0;
149 this.hasAllAppsScrim = (flags & FLAG_ALL_APPS_SCRIM) != 0;
150
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700151 this.hasMultipleVisiblePages = (flags & FLAG_MULTI_PAGE) != 0;
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700152 this.workspaceAccessibilityFlag = (flags & FLAG_DISABLE_ACCESSIBILITY) != 0
153 ? IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS
154 : IMPORTANT_FOR_ACCESSIBILITY_AUTO;
Sunny Goyalbc683e92017-12-06 10:25:07 -0800155 this.disableRestore = (flags & FLAG_DISABLE_RESTORE) != 0;
Tony Wickham53370672017-12-05 10:10:55 -0800156 this.workspaceIconsCanBeDragged = (flags & FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED) != 0;
Sunny Goyalbc683e92017-12-06 10:25:07 -0800157 this.disablePageClipping = (flags & FLAG_DISABLE_PAGE_CLIPPING) != 0;
Sunny Goyal6c6c2f42018-03-02 14:57:46 -0800158 this.disableInteraction = (flags & FLAG_DISABLE_INTERACTION) != 0;
159 this.overviewUi = (flags & FLAG_OVERVIEW_UI) != 0;
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700160
161 this.ordinal = id;
162 sAllStates[id] = this;
163 }
164
165 public static LauncherState[] values() {
166 return Arrays.copyOf(sAllStates, sAllStates.length);
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700167 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700168
169 public float[] getWorkspaceScaleAndTranslation(Launcher launcher) {
Sunny Goyal9328a512017-12-21 12:40:38 -0800170 return new float[] {1, 0, 0};
Sunny Goyalc99cb172017-10-19 16:15:09 -0700171 }
172
Tony3bb5e8e2018-03-14 12:05:00 +0000173 public float getOverviewTranslationX(Launcher launcher) {
174 return launcher.getDragLayer().getMeasuredWidth();
175 }
176
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700177 public void onStateEnabled(Launcher launcher) {
178 dispatchWindowStateChanged(launcher);
179 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700180
181 public void onStateDisabled(Launcher launcher) { }
Sunny Goyalbe93f262017-10-20 17:05:27 -0700182
183 public View getFinalFocus(Launcher launcher) {
184 return launcher.getWorkspace();
185 }
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700186
Sunny Goyal7185dd62018-03-14 17:51:49 -0700187 public int getVisibleElements(Launcher launcher) {
188 return HOTSEAT;
189 }
190
Sunny Goyal228153d2018-01-04 15:35:22 -0800191 /**
192 * Fraction shift in the vertical translation UI and related properties
193 *
194 * @see com.android.launcher3.allapps.AllAppsTransitionController
195 */
196 public float getVerticalProgress(Launcher launcher) {
197 return 1f;
198 }
199
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700200 public String getDescription(Launcher launcher) {
201 return launcher.getWorkspace().getCurrentPageDescription();
202 }
203
Sunny Goyalbc683e92017-12-06 10:25:07 -0800204 public PageAlphaProvider getWorkspacePageAlphaProvider(Launcher launcher) {
205 if (this != NORMAL || !launcher.getDeviceProfile().shouldFadeAdjacentWorkspaceScreens()) {
206 return DEFAULT_ALPHA_PROVIDER;
207 }
Sunny Goyal228153d2018-01-04 15:35:22 -0800208 final int centerPage = launcher.getWorkspace().getNextPage();
Sunny Goyal0c723352017-12-12 12:02:29 -0800209 return new PageAlphaProvider(ACCEL_2) {
210 @Override
211 public float getPageAlpha(int pageIndex) {
212 return pageIndex != centerPage ? 0 : 1f;
213 }
214 };
Sunny Goyalbc683e92017-12-06 10:25:07 -0800215 }
216
Sunny Goyal49bcf342018-01-11 13:59:53 -0800217 public LauncherState getHistoryForState(LauncherState previousState) {
218 // No history is supported
219 return NORMAL;
220 }
221
Sunny Goyal75c59ac2018-01-15 14:23:11 -0800222 /**
223 * Called when the start transition ends and the user settles on this particular state.
224 */
225 public void onStateTransitionEnd(Launcher launcher) {
226 if (this == NORMAL) {
227 UiFactory.resetOverview(launcher);
Sunny Goyal623eddd2018-03-02 12:24:41 -0800228 // Clear any rotation locks when going to normal state
229 launcher.getRotationHelper().setCurrentStateRequest(REQUEST_NONE);
Sunny Goyal75c59ac2018-01-15 14:23:11 -0800230 }
231 }
232
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700233 protected static void dispatchWindowStateChanged(Launcher launcher) {
234 launcher.getWindow().getDecorView().sendAccessibilityEvent(TYPE_WINDOW_STATE_CHANGED);
235 }
Sunny Goyalbc683e92017-12-06 10:25:07 -0800236
Sunny Goyal0c723352017-12-12 12:02:29 -0800237 public static abstract class PageAlphaProvider {
Sunny Goyalbc683e92017-12-06 10:25:07 -0800238
Sunny Goyal0c723352017-12-12 12:02:29 -0800239 public final Interpolator interpolator;
240
241 public PageAlphaProvider(Interpolator interpolator) {
242 this.interpolator = interpolator;
243 }
244
245 public abstract float getPageAlpha(int pageIndex);
Sunny Goyalbc683e92017-12-06 10:25:07 -0800246 }
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700247}