1 /* 2 * Copyright (C) 2021 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.taskbar; 17 18 import static com.android.launcher3.util.FlagDebugUtils.appendFlag; 19 20 import androidx.annotation.IntDef; 21 22 import com.android.quickstep.SystemUiProxy; 23 24 import java.io.PrintWriter; 25 import java.lang.annotation.Retention; 26 import java.lang.annotation.RetentionPolicy; 27 import java.util.StringJoiner; 28 29 /** 30 * Normally Taskbar will auto-hide when entering immersive (fullscreen) apps. This controller allows 31 * us to suspend that behavior in certain cases (e.g. opening a Folder or dragging an icon). 32 */ 33 public class TaskbarAutohideSuspendController implements 34 TaskbarControllers.LoggableTaskbarController { 35 36 // Taskbar window is fullscreen. 37 public static final int FLAG_AUTOHIDE_SUSPEND_FULLSCREEN = 1 << 0; 38 // User is dragging item. 39 public static final int FLAG_AUTOHIDE_SUSPEND_DRAGGING = 1 << 1; 40 // User has touched down but has not lifted finger. 41 public static final int FLAG_AUTOHIDE_SUSPEND_TOUCHING = 1 << 2; 42 // Taskbar EDU overlay is open above the Taskbar. */ 43 public static final int FLAG_AUTOHIDE_SUSPEND_EDU_OPEN = 1 << 3; 44 // Taskbar is in immersive mode in overview 45 public static final int FLAG_AUTOHIDE_SUSPEND_IN_LAUNCHER = 1 << 4; 46 // Transient Taskbar is temporarily unstashed (pending a timeout). 47 public static final int FLAG_AUTOHIDE_SUSPEND_TRANSIENT_TASKBAR = 1 << 5; 48 // User has hovered the taskbar. 49 public static final int FLAG_AUTOHIDE_SUSPEND_HOVERING_ICONS = 1 << 6; 50 // User has multi instance window open. 51 public static final int FLAG_AUTOHIDE_SUSPEND_MULTI_INSTANCE_MENU_OPEN = 1 << 7; 52 // User has taskbar overflow open. 53 public static final int FLAG_AUTOHIDE_SUSPEND_TASKBAR_OVERFLOW = 1 << 8; 54 55 @IntDef(flag = true, value = { 56 FLAG_AUTOHIDE_SUSPEND_FULLSCREEN, 57 FLAG_AUTOHIDE_SUSPEND_DRAGGING, 58 FLAG_AUTOHIDE_SUSPEND_TOUCHING, 59 FLAG_AUTOHIDE_SUSPEND_EDU_OPEN, 60 FLAG_AUTOHIDE_SUSPEND_IN_LAUNCHER, 61 FLAG_AUTOHIDE_SUSPEND_TRANSIENT_TASKBAR, 62 FLAG_AUTOHIDE_SUSPEND_HOVERING_ICONS, 63 FLAG_AUTOHIDE_SUSPEND_MULTI_INSTANCE_MENU_OPEN, 64 FLAG_AUTOHIDE_SUSPEND_TASKBAR_OVERFLOW, 65 }) 66 @Retention(RetentionPolicy.SOURCE) 67 public @interface AutohideSuspendFlag {} 68 69 private final TaskbarActivityContext mActivity; 70 private final SystemUiProxy mSystemUiProxy; 71 72 private @AutohideSuspendFlag int mAutohideSuspendFlags = 0; 73 TaskbarAutohideSuspendController(TaskbarActivityContext activity)74 public TaskbarAutohideSuspendController(TaskbarActivityContext activity) { 75 mActivity = activity; 76 mSystemUiProxy = SystemUiProxy.INSTANCE.get(activity); 77 } 78 onDestroy()79 public void onDestroy() { 80 mSystemUiProxy.notifyTaskbarAutohideSuspend(false); 81 } 82 83 /** 84 * Adds or removes the given flag, then notifies system UI proxy whether to suspend auto-hide. 85 */ updateFlag(@utohideSuspendFlag int flag, boolean enabled)86 public void updateFlag(@AutohideSuspendFlag int flag, boolean enabled) { 87 int flagsBefore = mAutohideSuspendFlags; 88 if (enabled) { 89 mAutohideSuspendFlags |= flag; 90 } else { 91 mAutohideSuspendFlags &= ~flag; 92 } 93 if (flagsBefore == mAutohideSuspendFlags) { 94 // Nothing has changed, no need to notify. 95 return; 96 } 97 98 boolean isSuspended = isSuspended(); 99 mSystemUiProxy.notifyTaskbarAutohideSuspend(isSuspended); 100 mActivity.onTransientAutohideSuspendFlagChanged(isTransientTaskbarStashingSuspended()); 101 } 102 103 /** 104 * Returns true iff taskbar autohide is currently suspended. 105 */ isSuspended()106 private boolean isSuspended() { 107 return mAutohideSuspendFlags != 0; 108 } 109 110 /** 111 * Returns whether Transient Taskbar should avoid auto-stashing in Launcher(Overview). 112 */ isSuspendedForTransientTaskbarInLauncher()113 public boolean isSuspendedForTransientTaskbarInLauncher() { 114 return (mAutohideSuspendFlags & FLAG_AUTOHIDE_SUSPEND_IN_LAUNCHER) != 0; 115 } 116 117 /** 118 * Returns whether Transient Taskbar should avoid auto-stashing. 119 */ isTransientTaskbarStashingSuspended()120 public boolean isTransientTaskbarStashingSuspended() { 121 return (mAutohideSuspendFlags & ~FLAG_AUTOHIDE_SUSPEND_TRANSIENT_TASKBAR) != 0; 122 } 123 124 @Override dumpLogs(String prefix, PrintWriter pw)125 public void dumpLogs(String prefix, PrintWriter pw) { 126 pw.println(prefix + "TaskbarAutohideSuspendController:"); 127 128 pw.println(prefix + "\tmAutohideSuspendFlags=" + getStateString(mAutohideSuspendFlags)); 129 } 130 getStateString(int flags)131 private static String getStateString(int flags) { 132 StringJoiner str = new StringJoiner("|"); 133 appendFlag(str, flags, FLAG_AUTOHIDE_SUSPEND_FULLSCREEN, 134 "FLAG_AUTOHIDE_SUSPEND_FULLSCREEN"); 135 appendFlag(str, flags, FLAG_AUTOHIDE_SUSPEND_DRAGGING, "FLAG_AUTOHIDE_SUSPEND_DRAGGING"); 136 appendFlag(str, flags, FLAG_AUTOHIDE_SUSPEND_TOUCHING, "FLAG_AUTOHIDE_SUSPEND_TOUCHING"); 137 appendFlag(str, flags, FLAG_AUTOHIDE_SUSPEND_EDU_OPEN, "FLAG_AUTOHIDE_SUSPEND_EDU_OPEN"); 138 appendFlag(str, flags, FLAG_AUTOHIDE_SUSPEND_IN_LAUNCHER, 139 "FLAG_AUTOHIDE_SUSPEND_IN_LAUNCHER"); 140 appendFlag(str, flags, FLAG_AUTOHIDE_SUSPEND_TRANSIENT_TASKBAR, 141 "FLAG_AUTOHIDE_SUSPEND_TRANSIENT_TASKBAR"); 142 appendFlag(str, flags, FLAG_AUTOHIDE_SUSPEND_MULTI_INSTANCE_MENU_OPEN, 143 "FLAG_AUTOHIDE_SUSPEND_MULTI_INSTANCE_MENU_OPEN"); 144 appendFlag(str, flags, FLAG_AUTOHIDE_SUSPEND_TASKBAR_OVERFLOW, 145 "FLAG_AUTOHIDE_SUSPEND_TASKBAR_OVERFLOW"); 146 return str.toString(); 147 } 148 } 149