• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
20 @ProvidesInterface(action = OverlayPlugin.ACTION, version = OverlayPlugin.VERSION)
21 public interface OverlayPlugin extends Plugin {
22 
23     String ACTION = "com.android.systemui.action.PLUGIN_OVERLAY";
24     int VERSION = 3;
25 
26     /**
27      * Setup overlay plugin
28      */
setup(View statusBar, View navBar)29     void setup(View statusBar, View navBar);
30 
31     /**
32      * Setup overlay plugin with callback
33      */
setup(View statusBar, View navBar, Callback callback)34     default void setup(View statusBar, View navBar, Callback callback) {
35         setup(statusBar, navBar);
36     }
37 
holdStatusBarOpen()38     default boolean holdStatusBarOpen() {
39         return false;
40     }
41 
42     /**
43      * Only called if the plugin has returned true to holdStatusBarOpen().
44      */
setCollapseDesired(boolean collapseDesired)45     default void setCollapseDesired(boolean collapseDesired) {
46     }
47 
48     /**
49      * Used to update system ui whether to hold status bar open
50      */
51     interface Callback {
onHoldStatusBarOpenChange()52         void onHoldStatusBarOpenChange();
53     }
54 }
55