1 /*
2  * Copyright 2023 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 
17 package androidx.window.extensions.area;
18 
19 import android.util.DisplayMetrics;
20 
21 import androidx.window.extensions.RequiresVendorApiLevel;
22 
23 import org.jspecify.annotations.NonNull;
24 
25 /**
26  * Interface to provide information around the current status of a window area feature.
27  *
28  * @see WindowAreaComponent#addRearDisplayPresentationStatusListener
29  */
30 public interface ExtensionWindowAreaStatus {
31 
32     /**
33      * Returns the {@link androidx.window.extensions.area.WindowAreaComponent.WindowAreaStatus}
34      * value that relates to the current status of a feature.
35      */
36     @RequiresVendorApiLevel(level = 3)
37     @WindowAreaComponent.WindowAreaStatus
getWindowAreaStatus()38     int getWindowAreaStatus();
39 
40     /**
41      * Returns the {@link DisplayMetrics} that corresponds to the window area that a feature
42      * interacts with. This is converted to size class information provided to developers.
43      */
44     @RequiresVendorApiLevel(level = 3)
getWindowAreaDisplayMetrics()45     @NonNull DisplayMetrics getWindowAreaDisplayMetrics();
46 }
47