blob: de3f441c23f25712421ee0f04252c144aab97f2a [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 Goyalbe93f262017-10-20 17:05:27 -070022import android.view.View;
23
24import com.android.launcher3.states.AllAppsState;
Sunny Goyalc99cb172017-10-19 16:15:09 -070025import com.android.launcher3.states.OverviewState;
26import com.android.launcher3.states.SpringLoadedState;
Sunny Goyal4c7f2152017-10-17 17:17:16 -070027import com.android.launcher3.userevent.nano.LauncherLogProto.ContainerType;
28
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070029import java.util.Arrays;
30
Sunny Goyal4c7f2152017-10-17 17:17:16 -070031
32/**
Sunny Goyalbe93f262017-10-20 17:05:27 -070033 * Base state for various states used for the Launcher
Sunny Goyal4c7f2152017-10-17 17:17:16 -070034 */
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070035public class LauncherState {
Sunny Goyal4c7f2152017-10-17 17:17:16 -070036
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070037 protected static final int FLAG_SHOW_SCRIM = 1 << 0;
38 protected static final int FLAG_MULTI_PAGE = 1 << 1;
39 protected static final int FLAG_HIDE_HOTSEAT = 1 << 2;
40 protected static final int FLAG_DISABLE_ACCESSIBILITY = 1 << 3;
41 protected static final int FLAG_DO_NOT_RESTORE = 1 << 4;
Sunny Goyalbe93f262017-10-20 17:05:27 -070042 protected static final int FLAG_HAS_SPRING = 1 << 5;
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070043
44 private static final LauncherState[] sAllStates = new LauncherState[4];
45
Sunny Goyalc99cb172017-10-19 16:15:09 -070046 public static final LauncherState NORMAL = new LauncherState(0, ContainerType.WORKSPACE,
Sunny Goyalbe93f262017-10-20 17:05:27 -070047 0, 1f, FLAG_DO_NOT_RESTORE);
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070048
Sunny Goyalbe93f262017-10-20 17:05:27 -070049 public static final LauncherState ALL_APPS = new AllAppsState(1);
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070050
Sunny Goyalc99cb172017-10-19 16:15:09 -070051 public static final LauncherState SPRING_LOADED = new SpringLoadedState(2);
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070052
Sunny Goyalc99cb172017-10-19 16:15:09 -070053 public static final LauncherState OVERVIEW = new OverviewState(3);
Sunny Goyal4c7f2152017-10-17 17:17:16 -070054
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070055 public final int ordinal;
56
Sunny Goyalf9403d92017-10-18 10:55:56 -070057 /**
58 * Used for containerType in {@link com.android.launcher3.logging.UserEventDispatcher}
59 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -070060 public final int containerType;
61
Sunny Goyalf9403d92017-10-18 10:55:56 -070062 /**
63 * True if the state can be persisted across activity restarts.
64 */
65 public final boolean doNotRestore;
66
67 /**
68 * True if workspace has multiple pages visible.
69 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -070070 public final boolean hasMultipleVisiblePages;
Sunny Goyalf9403d92017-10-18 10:55:56 -070071
72 /**
73 * Accessibility flag for workspace and its pages.
74 * @see android.view.View#setImportantForAccessibility(int)
75 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -070076 public final int workspaceAccessibilityFlag;
77
Sunny Goyalbe93f262017-10-20 17:05:27 -070078 /**
79 * Properties related to state transition animation
80 *
81 * @see WorkspaceStateTransitionAnimation
82 */
Sunny Goyal4c7f2152017-10-17 17:17:16 -070083 public final boolean hasScrim;
84 public final boolean hideHotseat;
85 public final int transitionDuration;
86
Sunny Goyalbe93f262017-10-20 17:05:27 -070087 /**
88 * Fraction shift in the vertical translation UI and related properties
89 *
90 * @see com.android.launcher3.allapps.AllAppsTransitionController
91 */
92 public final float verticalProgress;
93 public final boolean hasVerticalSpring;
94
95 public LauncherState(int id, int containerType, int transitionDuration, float verticalProgress,
96 int flags) {
Sunny Goyal4c7f2152017-10-17 17:17:16 -070097 this.containerType = containerType;
98 this.transitionDuration = transitionDuration;
99
100 this.hasScrim = (flags & FLAG_SHOW_SCRIM) != 0;
101 this.hasMultipleVisiblePages = (flags & FLAG_MULTI_PAGE) != 0;
102 this.hideHotseat = (flags & FLAG_HIDE_HOTSEAT) != 0;
103 this.workspaceAccessibilityFlag = (flags & FLAG_DISABLE_ACCESSIBILITY) != 0
104 ? IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS
105 : IMPORTANT_FOR_ACCESSIBILITY_AUTO;
Sunny Goyalf9403d92017-10-18 10:55:56 -0700106 this.doNotRestore = (flags & FLAG_DO_NOT_RESTORE) != 0;
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700107
Sunny Goyalbe93f262017-10-20 17:05:27 -0700108 this.verticalProgress = verticalProgress;
109 this.hasVerticalSpring = (flags & FLAG_HAS_SPRING) != 0;
110
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700111 this.ordinal = id;
112 sAllStates[id] = this;
113 }
114
115 public static LauncherState[] values() {
116 return Arrays.copyOf(sAllStates, sAllStates.length);
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700117 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700118
119 public float[] getWorkspaceScaleAndTranslation(Launcher launcher) {
120 return new float[] {1, 0};
121 }
122
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700123 public void onStateEnabled(Launcher launcher) {
124 dispatchWindowStateChanged(launcher);
125 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700126
127 public void onStateDisabled(Launcher launcher) { }
Sunny Goyalbe93f262017-10-20 17:05:27 -0700128
129 public View getFinalFocus(Launcher launcher) {
130 return launcher.getWorkspace();
131 }
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700132
133 public String getDescription(Launcher launcher) {
134 return launcher.getWorkspace().getCurrentPageDescription();
135 }
136
137 protected static void dispatchWindowStateChanged(Launcher launcher) {
138 launcher.getWindow().getDecorView().sendAccessibilityEvent(TYPE_WINDOW_STATE_CHANGED);
139 }
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700140}