blob: 9d01ed82d41ecf4871f937c69e89aee1971e1b6f [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;
20
21import static com.android.launcher3.LauncherAnimUtils.ALL_APPS_TRANSITION_MS;
Sunny Goyal4c7f2152017-10-17 17:17:16 -070022
Sunny Goyalbe93f262017-10-20 17:05:27 -070023import android.view.View;
24
25import com.android.launcher3.states.AllAppsState;
Sunny Goyalc99cb172017-10-19 16:15:09 -070026import com.android.launcher3.states.OverviewState;
27import com.android.launcher3.states.SpringLoadedState;
Sunny Goyal4c7f2152017-10-17 17:17:16 -070028import com.android.launcher3.userevent.nano.LauncherLogProto.ContainerType;
29
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070030import java.util.Arrays;
31
Sunny Goyal4c7f2152017-10-17 17:17:16 -070032
33/**
Sunny Goyalbe93f262017-10-20 17:05:27 -070034 * Base state for various states used for the Launcher
Sunny Goyal4c7f2152017-10-17 17:17:16 -070035 */
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070036public class LauncherState {
Sunny Goyal4c7f2152017-10-17 17:17:16 -070037
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070038 protected static final int FLAG_SHOW_SCRIM = 1 << 0;
39 protected static final int FLAG_MULTI_PAGE = 1 << 1;
40 protected static final int FLAG_HIDE_HOTSEAT = 1 << 2;
41 protected static final int FLAG_DISABLE_ACCESSIBILITY = 1 << 3;
42 protected static final int FLAG_DO_NOT_RESTORE = 1 << 4;
Sunny Goyalbe93f262017-10-20 17:05:27 -070043 protected static final int FLAG_HAS_SPRING = 1 << 5;
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070044
45 private static final LauncherState[] sAllStates = new LauncherState[4];
46
Sunny Goyalc99cb172017-10-19 16:15:09 -070047 public static final LauncherState NORMAL = new LauncherState(0, ContainerType.WORKSPACE,
Sunny Goyalbe93f262017-10-20 17:05:27 -070048 0, 1f, FLAG_DO_NOT_RESTORE);
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070049
Sunny Goyalbe93f262017-10-20 17:05:27 -070050 public static final LauncherState ALL_APPS = new AllAppsState(1);
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070051
Sunny Goyalc99cb172017-10-19 16:15:09 -070052 public static final LauncherState SPRING_LOADED = new SpringLoadedState(2);
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070053
Sunny Goyalc99cb172017-10-19 16:15:09 -070054 public static final LauncherState OVERVIEW = new OverviewState(3);
Sunny Goyal4c7f2152017-10-17 17:17:16 -070055
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070056 public final int ordinal;
57
Sunny Goyalf9403d92017-10-18 10:55:56 -070058 /**
59 * Used for containerType in {@link com.android.launcher3.logging.UserEventDispatcher}
60 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -070061 public final int containerType;
62
Sunny Goyalf9403d92017-10-18 10:55:56 -070063 /**
64 * True if the state can be persisted across activity restarts.
65 */
66 public final boolean doNotRestore;
67
68 /**
69 * True if workspace has multiple pages visible.
70 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -070071 public final boolean hasMultipleVisiblePages;
Sunny Goyalf9403d92017-10-18 10:55:56 -070072
73 /**
74 * Accessibility flag for workspace and its pages.
75 * @see android.view.View#setImportantForAccessibility(int)
76 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -070077 public final int workspaceAccessibilityFlag;
78
Sunny Goyalbe93f262017-10-20 17:05:27 -070079 /**
80 * Properties related to state transition animation
81 *
82 * @see WorkspaceStateTransitionAnimation
83 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -070084 public final boolean hasScrim;
85 public final boolean hideHotseat;
86 public final int transitionDuration;
87
Sunny Goyalbe93f262017-10-20 17:05:27 -070088 /**
89 * Fraction shift in the vertical translation UI and related properties
90 *
91 * @see com.android.launcher3.allapps.AllAppsTransitionController
92 */
93 public final float verticalProgress;
94 public final boolean hasVerticalSpring;
95
96 public LauncherState(int id, int containerType, int transitionDuration, float verticalProgress,
97 int flags) {
Sunny Goyal4c7f2152017-10-17 17:17:16 -070098 this.containerType = containerType;
99 this.transitionDuration = transitionDuration;
100
101 this.hasScrim = (flags & FLAG_SHOW_SCRIM) != 0;
102 this.hasMultipleVisiblePages = (flags & FLAG_MULTI_PAGE) != 0;
103 this.hideHotseat = (flags & FLAG_HIDE_HOTSEAT) != 0;
104 this.workspaceAccessibilityFlag = (flags & FLAG_DISABLE_ACCESSIBILITY) != 0
105 ? IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS
106 : IMPORTANT_FOR_ACCESSIBILITY_AUTO;
Sunny Goyalf9403d92017-10-18 10:55:56 -0700107 this.doNotRestore = (flags & FLAG_DO_NOT_RESTORE) != 0;
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700108
Sunny Goyalbe93f262017-10-20 17:05:27 -0700109 this.verticalProgress = verticalProgress;
110 this.hasVerticalSpring = (flags & FLAG_HAS_SPRING) != 0;
111
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700112 this.ordinal = id;
113 sAllStates[id] = this;
114 }
115
116 public static LauncherState[] values() {
117 return Arrays.copyOf(sAllStates, sAllStates.length);
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700118 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700119
120 public float[] getWorkspaceScaleAndTranslation(Launcher launcher) {
121 return new float[] {1, 0};
122 }
123
124 public void onStateEnabled(Launcher launcher) { }
125
126 public void onStateDisabled(Launcher launcher) { }
Sunny Goyalbe93f262017-10-20 17:05:27 -0700127
128 public View getFinalFocus(Launcher launcher) {
129 return launcher.getWorkspace();
130 }
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700131}