1 /*
2  * Copyright (C) 2011 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 com.android.server.wm;
18 
19 import com.android.server.policy.WindowManagerPolicy.StartingSurface;
20 
21 /**
22  * Represents the model about how a starting window should be constructed.
23  */
24 public abstract class StartingData {
25 
26     protected final WindowManagerService mService;
27     protected final int mTypeParams;
28 
29     /**
30      * Tell whether the launching activity should use
31      * {@link android.view.WindowManager.LayoutParams#SOFT_INPUT_IS_FORWARD_NAVIGATION}.
32      */
33     boolean mIsTransitionForward;
34 
35     /**
36      * Non-null if the starting window should cover the bounds of associated task. It is assigned
37      * when the parent activity of starting window may be put in a partial area of the task.
38      */
39     Task mAssociatedTask;
40 
StartingData(WindowManagerService service, int typeParams)41     protected StartingData(WindowManagerService service, int typeParams) {
42         mService = service;
43         mTypeParams = typeParams;
44     }
45 
46     /**
47      * Creates the actual starting window surface. DO NOT HOLD THE WINDOW MANAGER LOCK WHEN CALLING
48      * THIS METHOD.
49      *
50      * @param activity the app to add the starting window to
51      * @return a class implementing {@link StartingSurface} for easy removal with
52      *         {@link StartingSurface#remove}
53      */
createStartingSurface(ActivityRecord activity)54     abstract StartingSurface createStartingSurface(ActivityRecord activity);
55 
56     /**
57      * @return Whether to apply reveal animation when exiting the starting window.
58      */
needRevealAnimation()59     abstract boolean needRevealAnimation();
60 
61     /** @see android.window.TaskSnapshot#hasImeSurface() */
hasImeSurface()62     boolean hasImeSurface() {
63         return false;
64     }
65 }
66