1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/*
* Copyright (C) 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.systemui.shade;
import android.view.MotionEvent;
import com.android.systemui.statusbar.NotificationPresenter;
import com.android.systemui.statusbar.StatusBarState;
import com.android.systemui.statusbar.phone.CentralSurfaces;
import com.android.systemui.statusbar.phone.StatusBarKeyguardViewManager;
/**
* {@link ShadeController} is an abstraction of the work that used to be hard-coded in
* {@link CentralSurfaces}. The shade itself represents the concept of the status bar window state,
* and can be in multiple states: dozing, locked, showing the bouncer, occluded, etc. All/some of
* these are coordinated with {@link StatusBarKeyguardViewManager} via
* {@link com.android.systemui.keyguard.KeyguardViewMediator} and others.
*/
public interface ShadeController {
/** Make our window larger and the shade expanded */
void instantExpandShade();
/** Collapse the shade instantly with no animation. */
void instantCollapseShade();
/** See {@link #animateCollapsePanels(int, boolean, boolean, float)}. */
void animateCollapseShade();
/** See {@link #animateCollapsePanels(int, boolean, boolean, float)}. */
void animateCollapseShade(int flags);
/** See {@link #animateCollapsePanels(int, boolean, boolean, float)}. */
void animateCollapseShadeForced();
/** See {@link #animateCollapsePanels(int, boolean, boolean, float)}. */
void animateCollapseShadeDelayed();
/**
* Collapse the shade animated, showing the bouncer when on {@link StatusBarState#KEYGUARD} or
* dismissing status bar when on {@link StatusBarState#SHADE}.
*/
void animateCollapsePanels(int flags, boolean force, boolean delayed, float speedUpFactor);
/**
* If the shade is not fully expanded, collapse it animated.
*
* @return Seems to always return false
*/
boolean closeShadeIfOpen();
/**
* Returns whether the shade is currently open.
* Even though in the current implementation shade is in expanded state on keyguard, this
* method makes distinction between shade being truly open and plain keyguard state:
* - if QS and notifications are visible on the screen, return true
* - for any other state, including keyguard, return false
*/
boolean isShadeFullyOpen();
/**
* Add a runnable for NotificationPanelView to post when the panel is expanded.
*
* @param action the action to post
*/
void postOnShadeExpanded(Runnable action);
/**
* Add a runnable to be executed after the shade collapses. Post-collapse runnables are
* aggregated and run serially.
*
* @param action the action to execute
*/
void addPostCollapseAction(Runnable action);
/** Run all of the runnables added by {@link #addPostCollapseAction}. */
void runPostCollapseRunnables();
/**
* Close the shade if it was open
*
* @return true if the shade was open, else false
*/
boolean collapseShade();
/**
* If animate is true, does the same as {@link #collapseShade()}. Otherwise, instantly collapse
* the shade. Post collapse runnables will be executed
*
* @param animate true to animate the collapse, false for instantaneous collapse
*/
void collapseShade(boolean animate);
/** Makes shade expanded but not visible. */
void makeExpandedInvisible();
/** Makes shade expanded and visible. */
void makeExpandedVisible(boolean force);
/** Returns whether the shade is expanded and visible. */
boolean isExpandedVisible();
/** Handle status bar touch event. */
void onStatusBarTouch(MotionEvent event);
/** Called when the shade finishes collapsing. */
void onClosingFinished();
/** Sets the listener for when the visibility of the shade changes. */
void setVisibilityListener(ShadeVisibilityListener listener);
/** */
void setNotificationPresenter(NotificationPresenter presenter);
/** */
void setNotificationShadeWindowViewController(
NotificationShadeWindowViewController notificationShadeWindowViewController);
/** */
void setNotificationPanelViewController(
NotificationPanelViewController notificationPanelViewController);
/** Listens for shade visibility changes. */
interface ShadeVisibilityListener {
/** Called when the visibility of the shade changes. */
void visibilityChanged(boolean visible);
/** Called when shade expanded and visible state changed. */
void expandedVisibleChanged(boolean expandedVisible);
}
}
|
