1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
5  * except in compliance with the License. You may obtain a copy of the License at
6  *
7  *      http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software distributed under the
10  * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
11  * KIND, either express or implied. See the License for the specific language governing
12  * permissions and limitations under the License.
13  */
14 package com.android.systemui.plugins;
15 
16 import android.view.View;
17 
18 import com.android.systemui.plugins.annotations.ProvidesInterface;
19 import com.android.systemui.plugins.statusbar.DozeParameters;
20 
21 @ProvidesInterface(action = OverlayPlugin.ACTION, version = OverlayPlugin.VERSION)
22 public interface OverlayPlugin extends Plugin {
23 
24     String ACTION = "com.android.systemui.action.PLUGIN_OVERLAY";
25     int VERSION = 4;
26 
27     /**
28      * Setup overlay plugin
29      */
setup(View statusBar, View navBar)30     void setup(View statusBar, View navBar);
31 
32     /**
33      * Setup overlay plugin with callback and DozeParameters
34      */
setup(View statusBar, View navBar, Callback callback, DozeParameters dozeParameters)35     default void setup(View statusBar, View navBar, Callback callback,
36             DozeParameters dozeParameters) {
37         setup(statusBar, navBar);
38     }
39 
holdStatusBarOpen()40     default boolean holdStatusBarOpen() {
41         return false;
42     }
43 
44     /**
45      * Only called if the plugin has returned true to holdStatusBarOpen().
46      */
setCollapseDesired(boolean collapseDesired)47     default void setCollapseDesired(boolean collapseDesired) {
48     }
49 
50     /**
51      * Used to update system ui whether to hold status bar open
52      */
53     interface Callback {
onHoldStatusBarOpenChange()54         void onHoldStatusBarOpenChange();
55     }
56 }
57