blob: fdbd5e6873e845037b54896d483d1eca69a3d64e (
plain)
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
|
/*
* Copyright (C) 2020 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 android.window;
import static android.view.WindowManager.LayoutParams.INVALID_WINDOW_TYPE;
import static android.view.WindowManager.LayoutParams.isSubWindowType;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.os.Bundle;
import android.os.IBinder;
import android.view.WindowManager.LayoutParams.WindowType;
/**
* An interface to provide a non-activity window.
* Examples are {@link WindowContext} and {@link WindowProviderService}.
*
* @hide
*/
public interface WindowProvider {
/** @hide */
String KEY_IS_WINDOW_PROVIDER_SERVICE = "android.window.WindowProvider.isWindowProviderService";
/**
* The key to indicate whether the WindowContext should be reparented to the default display
* when the currently attached display is removed.
* <p>
* By default, the value is {@code false}, which means the WindowContext is removed with
* the display removal. If the value is {@code true}, the WindowContext will be reparented to
* the default display instead.
* <p>
* Type: Boolean
*
* @hide
*/
String KEY_REPARENT_TO_DEFAULT_DISPLAY_WITH_DISPLAY_REMOVAL =
"android.window.WindowProvider.reparentToDefaultDisplayWithDisplayRemoval";
/** Gets the window type of this provider */
@WindowType
int getWindowType();
/** Gets the launch options of this provider */
@Nullable
Bundle getWindowContextOptions();
/**
* Gets the WindowContextToken of this provider.
* @see android.content.Context#getWindowContextToken
*/
@NonNull
IBinder getWindowContextToken();
/**
* Gets the window type to be overridden when {@link android.view.WindowManager#addView}
*/
@WindowType
default int getWindowTypeOverride() {
return INVALID_WINDOW_TYPE;
}
/**
* Returns {@code true} if the given type is a valid window type for this
* {@link WindowProvider}.
*
* @param type the requested window type
*/
default boolean isValidWindowType(@WindowType int type) {
if (type == getWindowType()) {
// Valid. The requested window type is the type of WindowContext.
return true;
}
// Don't need to check sub-window type because sub window should be allowed to be attached
// to the parent window.
return isSubWindowType(type);
}
}
|
