Sunny Goyal | 4c7f215 | 2017-10-17 17:17:16 -0700 | [diff] [blame] | 1 | /* |
| 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 | */ |
| 16 | package com.android.launcher3; |
| 17 | |
Kateryna Ivanova | 7120373 | 2023-05-24 15:09:00 +0000 | [diff] [blame] | 18 | import static com.android.app.animation.Interpolators.ACCELERATE_2; |
| 19 | import static com.android.app.animation.Interpolators.DECELERATE_2; |
Winson Chung | f993518 | 2020-10-23 09:26:44 -0700 | [diff] [blame] | 20 | import static com.android.launcher3.logging.StatsLogManager.LAUNCHER_STATE_HOME; |
Tony Wickham | c5d168d | 2021-03-25 09:28:19 -0700 | [diff] [blame] | 21 | import static com.android.launcher3.logging.StatsLogManager.LAUNCHER_STATE_OVERVIEW; |
vadimt | f6ef879 | 2022-07-26 13:54:31 -0700 | [diff] [blame] | 22 | import static com.android.launcher3.testing.shared.TestProtocol.ALL_APPS_STATE_ORDINAL; |
| 23 | import static com.android.launcher3.testing.shared.TestProtocol.BACKGROUND_APP_STATE_ORDINAL; |
Charlie Anderson | 438d405 | 2023-04-25 14:38:57 -0400 | [diff] [blame] | 24 | import static com.android.launcher3.testing.shared.TestProtocol.EDIT_MODE_STATE_ORDINAL; |
vadimt | f6ef879 | 2022-07-26 13:54:31 -0700 | [diff] [blame] | 25 | import static com.android.launcher3.testing.shared.TestProtocol.HINT_STATE_ORDINAL; |
| 26 | import static com.android.launcher3.testing.shared.TestProtocol.HINT_STATE_TWO_BUTTON_ORDINAL; |
| 27 | import static com.android.launcher3.testing.shared.TestProtocol.NORMAL_STATE_ORDINAL; |
| 28 | import static com.android.launcher3.testing.shared.TestProtocol.OVERVIEW_MODAL_TASK_STATE_ORDINAL; |
| 29 | import static com.android.launcher3.testing.shared.TestProtocol.OVERVIEW_SPLIT_SELECT_ORDINAL; |
| 30 | import static com.android.launcher3.testing.shared.TestProtocol.OVERVIEW_STATE_ORDINAL; |
| 31 | import static com.android.launcher3.testing.shared.TestProtocol.QUICK_SWITCH_STATE_ORDINAL; |
| 32 | import static com.android.launcher3.testing.shared.TestProtocol.SPRING_LOADED_STATE_ORDINAL; |
Sunny Goyal | 0c72335 | 2017-12-12 12:02:29 -0800 | [diff] [blame] | 33 | |
Winson Chung | 8687bc2 | 2020-02-27 23:34:24 -0800 | [diff] [blame] | 34 | import android.content.Context; |
Zak Cohen | 4d35ac3 | 2021-04-23 16:28:12 -0700 | [diff] [blame] | 35 | import android.graphics.Color; |
Sunny Goyal | 0c72335 | 2017-12-12 12:02:29 -0800 | [diff] [blame] | 36 | import android.view.animation.Interpolator; |
Sunny Goyal | be93f26 | 2017-10-20 17:05:27 -0700 | [diff] [blame] | 37 | |
Fengjiang Li | e884c2c | 2022-12-19 14:42:14 -0800 | [diff] [blame] | 38 | import androidx.annotation.FloatRange; |
| 39 | |
Sunny Goyal | 35e7d38 | 2020-05-08 13:37:58 -0700 | [diff] [blame] | 40 | import com.android.launcher3.statemanager.BaseState; |
| 41 | import com.android.launcher3.statemanager.StateManager; |
Charlie Anderson | 438d405 | 2023-04-25 14:38:57 -0400 | [diff] [blame] | 42 | import com.android.launcher3.states.EditModeState; |
Tony Wickham | 4fdba14 | 2019-11-04 16:23:51 -0800 | [diff] [blame] | 43 | import com.android.launcher3.states.HintState; |
Sunny Goyal | c99cb17 | 2017-10-19 16:15:09 -0700 | [diff] [blame] | 44 | import com.android.launcher3.states.SpringLoadedState; |
vadimt | f6ef879 | 2022-07-26 13:54:31 -0700 | [diff] [blame] | 45 | import com.android.launcher3.testing.shared.TestProtocol; |
Tony | e06fef4 | 2019-03-22 15:44:28 -0500 | [diff] [blame] | 46 | import com.android.launcher3.uioverrides.states.AllAppsState; |
| 47 | import com.android.launcher3.uioverrides.states.OverviewState; |
Sunny Goyal | 54fa110 | 2022-12-07 22:48:37 -0800 | [diff] [blame] | 48 | import com.android.launcher3.views.ActivityContext; |
Sunny Goyal | 4c7f215 | 2017-10-17 17:17:16 -0700 | [diff] [blame] | 49 | |
Sunny Goyal | cd7c0aa | 2017-10-19 12:36:27 -0700 | [diff] [blame] | 50 | import java.util.Arrays; |
| 51 | |
Sunny Goyal | 4c7f215 | 2017-10-17 17:17:16 -0700 | [diff] [blame] | 52 | /** |
Sunny Goyal | be93f26 | 2017-10-20 17:05:27 -0700 | [diff] [blame] | 53 | * Base state for various states used for the Launcher |
Sunny Goyal | 4c7f215 | 2017-10-17 17:17:16 -0700 | [diff] [blame] | 54 | */ |
Sunny Goyal | 35e7d38 | 2020-05-08 13:37:58 -0700 | [diff] [blame] | 55 | public abstract class LauncherState implements BaseState<LauncherState> { |
Sunny Goyal | 4c7f215 | 2017-10-17 17:17:16 -0700 | [diff] [blame] | 56 | |
Sunny Goyal | 7185dd6 | 2018-03-14 17:51:49 -0700 | [diff] [blame] | 57 | /** |
| 58 | * Set of elements indicating various workspace elements which change visibility across states |
| 59 | * Note that workspace is not included here as in that case, we animate individual pages |
| 60 | */ |
| 61 | public static final int NONE = 0; |
Tony Wickham | bd6f05e | 2018-03-21 08:16:33 -0700 | [diff] [blame] | 62 | public static final int HOTSEAT_ICONS = 1 << 0; |
Sunny Goyal | c373e1c | 2021-03-09 17:27:53 -0800 | [diff] [blame] | 63 | public static final int ALL_APPS_CONTENT = 1 << 1; |
| 64 | public static final int VERTICAL_SWIPE_INDICATOR = 1 << 2; |
| 65 | public static final int OVERVIEW_ACTIONS = 1 << 3; |
Tony Wickham | 7af5440 | 2021-12-06 15:54:43 -0800 | [diff] [blame] | 66 | public static final int CLEAR_ALL_BUTTON = 1 << 4; |
| 67 | public static final int WORKSPACE_PAGE_INDICATOR = 1 << 5; |
| 68 | public static final int SPLIT_PLACHOLDER_VIEW = 1 << 6; |
Andy Wickham | 64896f3 | 2023-05-30 21:46:24 -0700 | [diff] [blame^] | 69 | public static final int FLOATING_SEARCH_BAR = 1 << 7; |
Zak Cohen | 43a1615 | 2020-02-25 14:29:37 -0800 | [diff] [blame] | 70 | |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 71 | // Flag indicating workspace has multiple pages visible. |
Sunny Goyal | 35e7d38 | 2020-05-08 13:37:58 -0700 | [diff] [blame] | 72 | public static final int FLAG_MULTI_PAGE = BaseState.getFlag(0); |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 73 | // Flag indicating that workspace and its contents are not accessible |
Sunny Goyal | 35e7d38 | 2020-05-08 13:37:58 -0700 | [diff] [blame] | 74 | public static final int FLAG_WORKSPACE_INACCESSIBLE = BaseState.getFlag(1); |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 75 | |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 76 | // Flag indicating the state allows workspace icons to be dragged. |
Sunny Goyal | 35e7d38 | 2020-05-08 13:37:58 -0700 | [diff] [blame] | 77 | public static final int FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED = BaseState.getFlag(2); |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 78 | // Flag to indicate that workspace should draw page background |
Sunny Goyal | 35e7d38 | 2020-05-08 13:37:58 -0700 | [diff] [blame] | 79 | public static final int FLAG_WORKSPACE_HAS_BACKGROUNDS = BaseState.getFlag(3); |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 80 | // Flag to indicate if the state would have scrim over sysui region: statu sbar and nav bar |
Sunny Goyal | 1eb1124 | 2022-09-09 17:14:45 -0700 | [diff] [blame] | 81 | public static final int FLAG_HAS_SYS_UI_SCRIM = BaseState.getFlag(4); |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 82 | // Flag to inticate that all popups should be closed when this state is enabled. |
Sunny Goyal | 1eb1124 | 2022-09-09 17:14:45 -0700 | [diff] [blame] | 83 | public static final int FLAG_CLOSE_POPUPS = BaseState.getFlag(5); |
| 84 | public static final int FLAG_OVERVIEW_UI = BaseState.getFlag(6); |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 85 | |
Anushree Ganjam | f6254c5 | 2022-04-29 00:46:22 +0000 | [diff] [blame] | 86 | // Flag indicating that hotseat and its contents are not accessible. |
Sunny Goyal | 1eb1124 | 2022-09-09 17:14:45 -0700 | [diff] [blame] | 87 | public static final int FLAG_HOTSEAT_INACCESSIBLE = BaseState.getFlag(7); |
Anushree Ganjam | f6254c5 | 2022-04-29 00:46:22 +0000 | [diff] [blame] | 88 | |
Sunny Goyal | 6c6c2f4 | 2018-03-02 14:57:46 -0800 | [diff] [blame] | 89 | |
Sunny Goyal | f2393f1 | 2020-04-01 20:13:12 -0700 | [diff] [blame] | 90 | public static final float NO_OFFSET = 0; |
| 91 | public static final float NO_SCALE = 1; |
| 92 | |
Sunny Goyal | 0c72335 | 2017-12-12 12:02:29 -0800 | [diff] [blame] | 93 | protected static final PageAlphaProvider DEFAULT_ALPHA_PROVIDER = |
Kateryna Ivanova | 7120373 | 2023-05-24 15:09:00 +0000 | [diff] [blame] | 94 | new PageAlphaProvider(ACCELERATE_2) { |
Sunny Goyal | 0c72335 | 2017-12-12 12:02:29 -0800 | [diff] [blame] | 95 | @Override |
| 96 | public float getPageAlpha(int pageIndex) { |
| 97 | return 1; |
| 98 | } |
| 99 | }; |
Sunny Goyal | cd7c0aa | 2017-10-19 12:36:27 -0700 | [diff] [blame] | 100 | |
Pat Manning | b04dd60 | 2022-03-09 14:19:10 +0000 | [diff] [blame] | 101 | protected static final PageTranslationProvider DEFAULT_PAGE_TRANSLATION_PROVIDER = |
Kateryna Ivanova | 7120373 | 2023-05-24 15:09:00 +0000 | [diff] [blame] | 102 | new PageTranslationProvider(DECELERATE_2) { |
Pat Manning | b04dd60 | 2022-03-09 14:19:10 +0000 | [diff] [blame] | 103 | @Override |
| 104 | public float getPageTranslation(int pageIndex) { |
| 105 | return 0; |
| 106 | } |
| 107 | }; |
| 108 | |
Charlie Anderson | 438d405 | 2023-04-25 14:38:57 -0400 | [diff] [blame] | 109 | private static final LauncherState[] sAllStates = new LauncherState[11]; |
Sunny Goyal | cd7c0aa | 2017-10-19 12:36:27 -0700 | [diff] [blame] | 110 | |
Sunny Goyal | 75c59ac | 2018-01-15 14:23:11 -0800 | [diff] [blame] | 111 | /** |
| 112 | * TODO: Create a separate class for NORMAL state. |
| 113 | */ |
vadimt | 6895e40 | 2019-02-15 16:42:14 -0800 | [diff] [blame] | 114 | public static final LauncherState NORMAL = new LauncherState(NORMAL_STATE_ORDINAL, |
Winson Chung | f993518 | 2020-10-23 09:26:44 -0700 | [diff] [blame] | 115 | LAUNCHER_STATE_HOME, |
Sunny Goyal | 1eb1124 | 2022-09-09 17:14:45 -0700 | [diff] [blame] | 116 | FLAG_DISABLE_RESTORE | FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED | FLAG_HAS_SYS_UI_SCRIM) { |
Tony Wickham | c7203ad | 2020-02-03 18:36:06 -0800 | [diff] [blame] | 117 | @Override |
Alex Chau | f39cc12 | 2022-04-14 17:51:59 +0100 | [diff] [blame] | 118 | public int getTransitionDuration(Context context, boolean isToState) { |
Tony Wickham | c7203ad | 2020-02-03 18:36:06 -0800 | [diff] [blame] | 119 | // Arbitrary duration, when going to NORMAL we use the state we're coming from instead. |
| 120 | return 0; |
| 121 | } |
| 122 | }; |
Sunny Goyal | cd7c0aa | 2017-10-19 12:36:27 -0700 | [diff] [blame] | 123 | |
Sunny Goyal | 7185dd6 | 2018-03-14 17:51:49 -0700 | [diff] [blame] | 124 | /** |
| 125 | * Various Launcher states arranged in the increasing order of UI layers |
| 126 | */ |
vadimt | 2a648aa | 2019-02-14 17:47:11 -0800 | [diff] [blame] | 127 | public static final LauncherState SPRING_LOADED = new SpringLoadedState( |
| 128 | SPRING_LOADED_STATE_ORDINAL); |
Charlie Anderson | 438d405 | 2023-04-25 14:38:57 -0400 | [diff] [blame] | 129 | public static final LauncherState EDIT_MODE = new EditModeState(EDIT_MODE_STATE_ORDINAL); |
vadimt | 2a648aa | 2019-02-14 17:47:11 -0800 | [diff] [blame] | 130 | public static final LauncherState ALL_APPS = new AllAppsState(ALL_APPS_STATE_ORDINAL); |
Tony Wickham | 4fdba14 | 2019-11-04 16:23:51 -0800 | [diff] [blame] | 131 | public static final LauncherState HINT_STATE = new HintState(HINT_STATE_ORDINAL); |
Tony Wickham | c5d168d | 2021-03-25 09:28:19 -0700 | [diff] [blame] | 132 | public static final LauncherState HINT_STATE_TWO_BUTTON = new HintState( |
| 133 | HINT_STATE_TWO_BUTTON_ORDINAL, LAUNCHER_STATE_OVERVIEW); |
Tony | 1787ee9 | 2019-03-20 12:38:35 -0500 | [diff] [blame] | 134 | |
| 135 | public static final LauncherState OVERVIEW = new OverviewState(OVERVIEW_STATE_ORDINAL); |
Zak Cohen | a39544d | 2020-04-27 16:26:55 -0700 | [diff] [blame] | 136 | public static final LauncherState OVERVIEW_MODAL_TASK = OverviewState.newModalTaskState( |
| 137 | OVERVIEW_MODAL_TASK_STATE_ORDINAL); |
Vinit Nayak | 82b8aa5 | 2023-02-03 10:15:50 -0800 | [diff] [blame] | 138 | /** |
| 139 | * State when user performs a quickswitch gesture from home/workspace to the most recent |
| 140 | * app |
| 141 | */ |
| 142 | public static final LauncherState QUICK_SWITCH_FROM_HOME = |
Tony | e4c2e2b | 2019-03-25 10:23:39 -0500 | [diff] [blame] | 143 | OverviewState.newSwitchState(QUICK_SWITCH_STATE_ORDINAL); |
Tony | 1787ee9 | 2019-03-20 12:38:35 -0500 | [diff] [blame] | 144 | public static final LauncherState BACKGROUND_APP = |
| 145 | OverviewState.newBackgroundState(BACKGROUND_APP_STATE_ORDINAL); |
Vinit Nayak | d987a82 | 2021-02-22 14:49:27 -0800 | [diff] [blame] | 146 | public static final LauncherState OVERVIEW_SPLIT_SELECT = |
| 147 | OverviewState.newSplitSelectState(OVERVIEW_SPLIT_SELECT_ORDINAL); |
Tony Wickham | 6becf7c | 2018-04-19 11:39:34 -0700 | [diff] [blame] | 148 | |
Sunny Goyal | cd7c0aa | 2017-10-19 12:36:27 -0700 | [diff] [blame] | 149 | public final int ordinal; |
| 150 | |
Sunny Goyal | f9403d9 | 2017-10-18 10:55:56 -0700 | [diff] [blame] | 151 | /** |
Winson Chung | f993518 | 2020-10-23 09:26:44 -0700 | [diff] [blame] | 152 | * Used for {@link com.android.launcher3.logging.StatsLogManager} |
Sunny Goyal | f9403d9 | 2017-10-18 10:55:56 -0700 | [diff] [blame] | 153 | */ |
Winson Chung | f993518 | 2020-10-23 09:26:44 -0700 | [diff] [blame] | 154 | public final int statsLogOrdinal; |
Sunny Goyal | 4c7f215 | 2017-10-17 17:17:16 -0700 | [diff] [blame] | 155 | |
Sunny Goyal | f9403d9 | 2017-10-18 10:55:56 -0700 | [diff] [blame] | 156 | /** |
Sunny Goyal | 6c6c2f4 | 2018-03-02 14:57:46 -0800 | [diff] [blame] | 157 | * True if the state has overview panel visible. |
| 158 | */ |
| 159 | public final boolean overviewUi; |
| 160 | |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 161 | private final int mFlags; |
Sunny Goyal | 5d1873a | 2018-05-08 11:10:44 -0700 | [diff] [blame] | 162 | |
Winson Chung | f993518 | 2020-10-23 09:26:44 -0700 | [diff] [blame] | 163 | public LauncherState(int id, int statsLogOrdinal, int flags) { |
| 164 | this.statsLogOrdinal = statsLogOrdinal; |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 165 | this.mFlags = flags; |
Sunny Goyal | 6c6c2f4 | 2018-03-02 14:57:46 -0800 | [diff] [blame] | 166 | this.overviewUi = (flags & FLAG_OVERVIEW_UI) != 0; |
Sunny Goyal | cd7c0aa | 2017-10-19 12:36:27 -0700 | [diff] [blame] | 167 | this.ordinal = id; |
| 168 | sAllStates[id] = this; |
| 169 | } |
| 170 | |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 171 | /** |
| 172 | * Returns if the state has the provided flag |
| 173 | */ |
Sunny Goyal | 35e7d38 | 2020-05-08 13:37:58 -0700 | [diff] [blame] | 174 | @Override |
Sunny Goyal | 8f96546 | 2020-04-23 19:00:36 -0700 | [diff] [blame] | 175 | public final boolean hasFlag(int mask) { |
| 176 | return (mFlags & mask) != 0; |
| 177 | } |
| 178 | |
Sunny Goyal | cd7c0aa | 2017-10-19 12:36:27 -0700 | [diff] [blame] | 179 | public static LauncherState[] values() { |
| 180 | return Arrays.copyOf(sAllStates, sAllStates.length); |
Sunny Goyal | 4c7f215 | 2017-10-17 17:17:16 -0700 | [diff] [blame] | 181 | } |
Sunny Goyal | c99cb17 | 2017-10-19 16:15:09 -0700 | [diff] [blame] | 182 | |
Tony | bc23440 | 2019-03-19 13:30:25 -0500 | [diff] [blame] | 183 | public ScaleAndTranslation getWorkspaceScaleAndTranslation(Launcher launcher) { |
Sunny Goyal | f2393f1 | 2020-04-01 20:13:12 -0700 | [diff] [blame] | 184 | return new ScaleAndTranslation(NO_SCALE, NO_OFFSET, NO_OFFSET); |
Sunny Goyal | c99cb17 | 2017-10-19 16:15:09 -0700 | [diff] [blame] | 185 | } |
| 186 | |
Tony | bc23440 | 2019-03-19 13:30:25 -0500 | [diff] [blame] | 187 | public ScaleAndTranslation getHotseatScaleAndTranslation(Launcher launcher) { |
Tony Wickham | 57e489c | 2019-03-04 14:57:07 -0800 | [diff] [blame] | 188 | // For most states, treat the hotseat as if it were part of the workspace. |
| 189 | return getWorkspaceScaleAndTranslation(launcher); |
Tony | 4bb4b89 | 2019-03-03 15:32:12 -0800 | [diff] [blame] | 190 | } |
| 191 | |
Sunny Goyal | f2393f1 | 2020-04-01 20:13:12 -0700 | [diff] [blame] | 192 | /** |
Tony Wickham | 82d5a06 | 2021-05-14 14:37:12 -0700 | [diff] [blame] | 193 | * Returns an array of two elements. |
Samuel Fufa | 2ea01e4 | 2020-12-02 13:48:18 -0600 | [diff] [blame] | 194 | * The first specifies the scale for the overview |
| 195 | * The second is the factor ([0, 1], 0 => center-screen; 1 => offscreen) by which overview |
| 196 | * should be shifted horizontally. |
Sunny Goyal | f2393f1 | 2020-04-01 20:13:12 -0700 | [diff] [blame] | 197 | */ |
| 198 | public float[] getOverviewScaleAndOffset(Launcher launcher) { |
| 199 | return launcher.getNormalOverviewScaleAndOffset(); |
Tony | 3bb5e8e | 2018-03-14 12:05:00 +0000 | [diff] [blame] | 200 | } |
| 201 | |
Tony | 5406817 | 2019-05-12 13:24:51 -0500 | [diff] [blame] | 202 | public float getOverviewFullscreenProgress() { |
| 203 | return 0; |
| 204 | } |
| 205 | |
Andy Wickham | 64896f3 | 2023-05-30 21:46:24 -0700 | [diff] [blame^] | 206 | /** |
| 207 | * How far from the bottom of the screen the <em>floating</em> search bar should rest in this |
| 208 | * state when the IME is not present. |
| 209 | * <p> |
| 210 | * To hide offscreen, use a negative value. |
| 211 | * <p> |
| 212 | * Note: if the provided value is non-negative but less than the current bottom insets, the |
| 213 | * insets will be applied. As such, you can use 0 to default to this. |
| 214 | */ |
| 215 | public int getFloatingSearchBarRestingMarginBottom(Launcher launcher) { |
| 216 | DeviceProfile dp = launcher.getDeviceProfile(); |
| 217 | return areElementsVisible(launcher, FLOATING_SEARCH_BAR) ? dp.getQsbOffsetY() |
| 218 | : -dp.hotseatQsbHeight; |
| 219 | } |
| 220 | |
| 221 | /** Whether the <em>floating</em> search bar should use the pill UI when not focused. */ |
| 222 | public boolean shouldFloatingSearchBarUsePillWhenUnfocused(Launcher launcher) { |
| 223 | return false; |
| 224 | } |
| 225 | |
Sunny Goyal | 7185dd6 | 2018-03-14 17:51:49 -0700 | [diff] [blame] | 226 | public int getVisibleElements(Launcher launcher) { |
Andy Wickham | 64896f3 | 2023-05-30 21:46:24 -0700 | [diff] [blame^] | 227 | int elements = HOTSEAT_ICONS | WORKSPACE_PAGE_INDICATOR | VERTICAL_SWIPE_INDICATOR; |
| 228 | // Floating search bar is visible in normal state except in landscape on phones. |
| 229 | if (!(launcher.getDeviceProfile().isPhone && launcher.getDeviceProfile().isLandscape)) { |
| 230 | elements |= FLOATING_SEARCH_BAR; |
| 231 | } |
| 232 | return elements; |
Sunny Goyal | 7185dd6 | 2018-03-14 17:51:49 -0700 | [diff] [blame] | 233 | } |
| 234 | |
Sunny Goyal | 228153d | 2018-01-04 15:35:22 -0800 | [diff] [blame] | 235 | /** |
Tony Wickham | a29a046 | 2021-03-02 12:28:25 -0800 | [diff] [blame] | 236 | * A shorthand for checking getVisibleElements() & elements == elements. |
| 237 | * @return Whether all of the given elements are visible. |
| 238 | */ |
| 239 | public boolean areElementsVisible(Launcher launcher, int elements) { |
| 240 | return (getVisibleElements(launcher) & elements) == elements; |
| 241 | } |
| 242 | |
Schneider Victor-tulias | 3f6c473 | 2022-06-23 11:25:10 -0700 | [diff] [blame] | 243 | /** |
| 244 | * Returns whether taskbar is stashed and thus should either: |
| 245 | * 1) replace hotseat or taskbar icons with a handle in gesture navigation mode or |
| 246 | * 2) fade out the hotseat or taskbar icons in 3-button navigation mode. |
| 247 | */ |
Tony Wickham | 24675d3 | 2021-11-24 15:43:52 -0800 | [diff] [blame] | 248 | public boolean isTaskbarStashed(Launcher launcher) { |
Tracy Zhou | 308851d | 2021-09-09 21:18:25 -0700 | [diff] [blame] | 249 | return false; |
| 250 | } |
| 251 | |
Tony Wickham | 24675d3 | 2021-11-24 15:43:52 -0800 | [diff] [blame] | 252 | /** Returns whether taskbar is aligned with the hotseat vs position inside apps */ |
| 253 | public boolean isTaskbarAlignedWithHotseat(Launcher launcher) { |
Schneider Victor-tulias | 3f6c473 | 2022-06-23 11:25:10 -0700 | [diff] [blame] | 254 | return true; |
Tony Wickham | 24675d3 | 2021-11-24 15:43:52 -0800 | [diff] [blame] | 255 | } |
| 256 | |
Tony Wickham | a29a046 | 2021-03-02 12:28:25 -0800 | [diff] [blame] | 257 | /** |
Winson Chung | 3bce15d | 2023-02-18 06:34:08 +0000 | [diff] [blame] | 258 | * Returns whether taskbar global drag is disallowed in this state. |
| 259 | */ |
| 260 | public boolean disallowTaskbarGlobalDrag() { |
| 261 | return false; |
| 262 | } |
| 263 | |
| 264 | /** |
| 265 | * Returns whether the taskbar shortcut should trigger split selection mode. |
| 266 | */ |
| 267 | public boolean allowTaskbarInitialSplitSelection() { |
| 268 | return false; |
| 269 | } |
| 270 | |
| 271 | /** |
Sunny Goyal | 228153d | 2018-01-04 15:35:22 -0800 | [diff] [blame] | 272 | * Fraction shift in the vertical translation UI and related properties |
| 273 | * |
| 274 | * @see com.android.launcher3.allapps.AllAppsTransitionController |
| 275 | */ |
| 276 | public float getVerticalProgress(Launcher launcher) { |
| 277 | return 1f; |
| 278 | } |
| 279 | |
Sunny Goyal | c82916f | 2021-04-06 13:03:54 -0700 | [diff] [blame] | 280 | public float getWorkspaceBackgroundAlpha(Launcher launcher) { |
Sunny Goyal | 927447e | 2018-05-04 13:19:29 -0700 | [diff] [blame] | 281 | return 0; |
| 282 | } |
| 283 | |
Zak Cohen | 4d35ac3 | 2021-04-23 16:28:12 -0700 | [diff] [blame] | 284 | /** |
| 285 | * What color should the workspace scrim be in when at rest in this state. |
| 286 | * Return {@link Color#TRANSPARENT} for no scrim. |
| 287 | */ |
| 288 | public int getWorkspaceScrimColor(Launcher launcher) { |
| 289 | return Color.TRANSPARENT; |
Tony Wickham | c088051 | 2019-07-24 17:32:08 -0700 | [diff] [blame] | 290 | } |
| 291 | |
Winson Chung | 8687bc2 | 2020-02-27 23:34:24 -0800 | [diff] [blame] | 292 | /** |
Zak Cohen | a39544d | 2020-04-27 16:26:55 -0700 | [diff] [blame] | 293 | * For this state, how modal should over view been shown. 0 modalness means all tasks drawn, |
| 294 | * 1 modalness means the current task is show on its own. |
| 295 | */ |
| 296 | public float getOverviewModalness() { |
| 297 | return 0; |
| 298 | } |
| 299 | |
| 300 | /** |
Vinit Nayak | f4f0c4d | 2021-05-05 10:28:05 -0700 | [diff] [blame] | 301 | * For this state, how much additional translation there should be for each of the |
| 302 | * child TaskViews. Note that the translation can be its primary or secondary dimension. |
Vinit Nayak | d987a82 | 2021-02-22 14:49:27 -0800 | [diff] [blame] | 303 | */ |
Vinit Nayak | f4f0c4d | 2021-05-05 10:28:05 -0700 | [diff] [blame] | 304 | public float getSplitSelectTranslation(Launcher launcher) { |
Vinit Nayak | d987a82 | 2021-02-22 14:49:27 -0800 | [diff] [blame] | 305 | return 0; |
| 306 | } |
| 307 | |
| 308 | /** |
Lucas Dupin | 4918ed3 | 2020-03-17 17:11:32 -0700 | [diff] [blame] | 309 | * The amount of blur and wallpaper zoom to apply to the background of either the app |
| 310 | * or Launcher surface in this state. Should be a number between 0 and 1, inclusive. |
| 311 | * |
| 312 | * 0 means completely zoomed in, without blurs. 1 is zoomed out, with blurs. |
Winson Chung | 8687bc2 | 2020-02-27 23:34:24 -0800 | [diff] [blame] | 313 | */ |
Sunny Goyal | 54fa110 | 2022-12-07 22:48:37 -0800 | [diff] [blame] | 314 | public final <DEVICE_PROFILE_CONTEXT extends Context & ActivityContext> |
Alex Chau | 3193522 | 2022-09-01 21:24:52 +0100 | [diff] [blame] | 315 | float getDepth(DEVICE_PROFILE_CONTEXT context) { |
Jon Miranda | 36d1015 | 2020-06-19 16:35:08 -0700 | [diff] [blame] | 316 | return getDepth(context, |
| 317 | BaseDraggingActivity.fromContext(context).getDeviceProfile().isMultiWindowMode); |
| 318 | } |
| 319 | |
| 320 | /** |
| 321 | * Returns the amount of blur and wallpaper zoom for this state with {@param isMultiWindowMode}. |
Samuel Fufa | 2ea01e4 | 2020-12-02 13:48:18 -0600 | [diff] [blame] | 322 | * |
Jon Miranda | 36d1015 | 2020-06-19 16:35:08 -0700 | [diff] [blame] | 323 | * @see #getDepth(Context). |
| 324 | */ |
Sunny Goyal | 54fa110 | 2022-12-07 22:48:37 -0800 | [diff] [blame] | 325 | public final <DEVICE_PROFILE_CONTEXT extends Context & ActivityContext> |
Alex Chau | 3193522 | 2022-09-01 21:24:52 +0100 | [diff] [blame] | 326 | float getDepth(DEVICE_PROFILE_CONTEXT context, boolean isMultiWindowMode) { |
Jon Miranda | 36d1015 | 2020-06-19 16:35:08 -0700 | [diff] [blame] | 327 | if (isMultiWindowMode) { |
Winson Chung | b330d6e | 2020-04-20 11:57:11 -0700 | [diff] [blame] | 328 | return 0; |
| 329 | } |
| 330 | return getDepthUnchecked(context); |
| 331 | } |
| 332 | |
Sunny Goyal | 54fa110 | 2022-12-07 22:48:37 -0800 | [diff] [blame] | 333 | protected <DEVICE_PROFILE_CONTEXT extends Context & ActivityContext> |
Alex Chau | 3193522 | 2022-09-01 21:24:52 +0100 | [diff] [blame] | 334 | float getDepthUnchecked(DEVICE_PROFILE_CONTEXT context) { |
Lucas Dupin | 4918ed3 | 2020-03-17 17:11:32 -0700 | [diff] [blame] | 335 | return 0f; |
Winson Chung | 8687bc2 | 2020-02-27 23:34:24 -0800 | [diff] [blame] | 336 | } |
| 337 | |
Sunny Goyal | 3e3f44c | 2017-10-23 17:14:52 -0700 | [diff] [blame] | 338 | public String getDescription(Launcher launcher) { |
| 339 | return launcher.getWorkspace().getCurrentPageDescription(); |
| 340 | } |
| 341 | |
Sunny Goyal | bc683e9 | 2017-12-06 10:25:07 -0800 | [diff] [blame] | 342 | public PageAlphaProvider getWorkspacePageAlphaProvider(Launcher launcher) { |
Jon Miranda | e383222 | 2020-07-06 15:38:38 -0700 | [diff] [blame] | 343 | if ((this != NORMAL && this != HINT_STATE) |
| 344 | || !launcher.getDeviceProfile().shouldFadeAdjacentWorkspaceScreens()) { |
Sunny Goyal | bc683e9 | 2017-12-06 10:25:07 -0800 | [diff] [blame] | 345 | return DEFAULT_ALPHA_PROVIDER; |
| 346 | } |
Sunny Goyal | 228153d | 2018-01-04 15:35:22 -0800 | [diff] [blame] | 347 | final int centerPage = launcher.getWorkspace().getNextPage(); |
Kateryna Ivanova | 7120373 | 2023-05-24 15:09:00 +0000 | [diff] [blame] | 348 | return new PageAlphaProvider(ACCELERATE_2) { |
Sunny Goyal | 0c72335 | 2017-12-12 12:02:29 -0800 | [diff] [blame] | 349 | @Override |
| 350 | public float getPageAlpha(int pageIndex) { |
Samuel Fufa | 2ea01e4 | 2020-12-02 13:48:18 -0600 | [diff] [blame] | 351 | return pageIndex != centerPage ? 0 : 1f; |
Sunny Goyal | 0c72335 | 2017-12-12 12:02:29 -0800 | [diff] [blame] | 352 | } |
| 353 | }; |
Sunny Goyal | bc683e9 | 2017-12-06 10:25:07 -0800 | [diff] [blame] | 354 | } |
| 355 | |
Pat Manning | b04dd60 | 2022-03-09 14:19:10 +0000 | [diff] [blame] | 356 | /** |
| 357 | * Gets the translation provider for workspace pages. |
| 358 | */ |
| 359 | public PageTranslationProvider getWorkspacePageTranslationProvider(Launcher launcher) { |
Charlie Anderson | 438d405 | 2023-04-25 14:38:57 -0400 | [diff] [blame] | 360 | if (this != SPRING_LOADED |
| 361 | || this != EDIT_MODE |
| 362 | || !launcher.getDeviceProfile().isTwoPanels) { |
Pat Manning | b04dd60 | 2022-03-09 14:19:10 +0000 | [diff] [blame] | 363 | return DEFAULT_PAGE_TRANSLATION_PROVIDER; |
| 364 | } |
| 365 | final float quarterPageSpacing = launcher.getWorkspace().getPageSpacing() / 4f; |
Kateryna Ivanova | 7120373 | 2023-05-24 15:09:00 +0000 | [diff] [blame] | 366 | return new PageTranslationProvider(DECELERATE_2) { |
Pat Manning | b04dd60 | 2022-03-09 14:19:10 +0000 | [diff] [blame] | 367 | @Override |
| 368 | public float getPageTranslation(int pageIndex) { |
| 369 | boolean isRtl = launcher.getWorkspace().mIsRtl; |
| 370 | boolean isFirstPage = pageIndex % 2 == 0; |
| 371 | return ((isFirstPage && !isRtl) || (!isFirstPage && isRtl)) ? -quarterPageSpacing |
| 372 | : quarterPageSpacing; |
| 373 | } |
| 374 | }; |
| 375 | } |
| 376 | |
Charlie Anderson | 438d405 | 2023-04-25 14:38:57 -0400 | [diff] [blame] | 377 | /** |
| 378 | * Called when leaving this LauncherState |
| 379 | * @param launcher - Launcher instance |
| 380 | * @param toState - New LauncherState that is being entered |
| 381 | */ |
| 382 | public void onLeavingState(Launcher launcher, LauncherState toState) { |
| 383 | // no-op |
| 384 | // override to handle when leaving current LauncherState |
| 385 | } |
| 386 | |
Sunny Goyal | 35e7d38 | 2020-05-08 13:37:58 -0700 | [diff] [blame] | 387 | @Override |
Sunny Goyal | 49bcf34 | 2018-01-11 13:59:53 -0800 | [diff] [blame] | 388 | public LauncherState getHistoryForState(LauncherState previousState) { |
| 389 | // No history is supported |
| 390 | return NORMAL; |
| 391 | } |
| 392 | |
Sunny Goyal | 35e7d38 | 2020-05-08 13:37:58 -0700 | [diff] [blame] | 393 | @Override |
| 394 | public String toString() { |
Tony Wickham | f844ee9 | 2020-05-27 15:41:32 -0500 | [diff] [blame] | 395 | return TestProtocol.stateOrdinalToString(ordinal); |
Sunny Goyal | 35e7d38 | 2020-05-08 13:37:58 -0700 | [diff] [blame] | 396 | } |
| 397 | |
Sunny Goyal | e39690b | 2018-08-02 13:35:07 -0700 | [diff] [blame] | 398 | public void onBackPressed(Launcher launcher) { |
| 399 | if (this != NORMAL) { |
Sunny Goyal | 35e7d38 | 2020-05-08 13:37:58 -0700 | [diff] [blame] | 400 | StateManager<LauncherState> lsm = launcher.getStateManager(); |
Sunny Goyal | e39690b | 2018-08-02 13:35:07 -0700 | [diff] [blame] | 401 | LauncherState lastState = lsm.getLastState(); |
Sunny Goyal | e39690b | 2018-08-02 13:35:07 -0700 | [diff] [blame] | 402 | lsm.goToState(lastState); |
| 403 | } |
| 404 | } |
| 405 | |
Fengjiang Li | e884c2c | 2022-12-19 14:42:14 -0800 | [diff] [blame] | 406 | /** |
| 407 | * Find {@link StateManager} and target {@link LauncherState} to handle back progress in |
| 408 | * predictive back gesture. |
| 409 | */ |
| 410 | public void onBackProgressed( |
| 411 | Launcher launcher, @FloatRange(from = 0.0, to = 1.0) float backProgress) { |
| 412 | StateManager<LauncherState> lsm = launcher.getStateManager(); |
| 413 | LauncherState toState = lsm.getLastState(); |
| 414 | lsm.onBackProgressed(toState, backProgress); |
| 415 | } |
| 416 | |
| 417 | /** |
| 418 | * Find {@link StateManager} and target {@link LauncherState} to handle backProgress in |
| 419 | * predictive back gesture. |
| 420 | */ |
| 421 | public void onBackCancelled(Launcher launcher) { |
| 422 | StateManager<LauncherState> lsm = launcher.getStateManager(); |
| 423 | LauncherState toState = lsm.getLastState(); |
| 424 | lsm.onBackCancelled(toState); |
| 425 | } |
| 426 | |
Sunny Goyal | 0c72335 | 2017-12-12 12:02:29 -0800 | [diff] [blame] | 427 | public static abstract class PageAlphaProvider { |
Sunny Goyal | bc683e9 | 2017-12-06 10:25:07 -0800 | [diff] [blame] | 428 | |
Sunny Goyal | 0c72335 | 2017-12-12 12:02:29 -0800 | [diff] [blame] | 429 | public final Interpolator interpolator; |
| 430 | |
| 431 | public PageAlphaProvider(Interpolator interpolator) { |
| 432 | this.interpolator = interpolator; |
| 433 | } |
| 434 | |
| 435 | public abstract float getPageAlpha(int pageIndex); |
Sunny Goyal | bc683e9 | 2017-12-06 10:25:07 -0800 | [diff] [blame] | 436 | } |
Tony | bc23440 | 2019-03-19 13:30:25 -0500 | [diff] [blame] | 437 | |
Pat Manning | b04dd60 | 2022-03-09 14:19:10 +0000 | [diff] [blame] | 438 | /** |
| 439 | * Provider for the translation and animation interpolation of workspace pages. |
| 440 | */ |
| 441 | public abstract static class PageTranslationProvider { |
| 442 | |
| 443 | public final Interpolator interpolator; |
| 444 | |
| 445 | public PageTranslationProvider(Interpolator interpolator) { |
| 446 | this.interpolator = interpolator; |
| 447 | } |
| 448 | |
| 449 | /** |
| 450 | * Gets the translation of the workspace page at the provided page index. |
| 451 | */ |
| 452 | public abstract float getPageTranslation(int pageIndex); |
| 453 | } |
| 454 | |
Tony | bc23440 | 2019-03-19 13:30:25 -0500 | [diff] [blame] | 455 | public static class ScaleAndTranslation { |
| 456 | public float scale; |
| 457 | public float translationX; |
| 458 | public float translationY; |
| 459 | |
| 460 | public ScaleAndTranslation(float scale, float translationX, float translationY) { |
| 461 | this.scale = scale; |
| 462 | this.translationX = translationX; |
| 463 | this.translationY = translationY; |
| 464 | } |
| 465 | } |
Sunny Goyal | 4c7f215 | 2017-10-17 17:17:16 -0700 | [diff] [blame] | 466 | } |