1 /*
2  * Copyright (C) 2015 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 android.view;
18 
19 import android.graphics.RecordingCanvas;
20 import android.graphics.Rect;
21 
22 /**
23  * These callbacks are used to communicate window configuration changes while the user is performing
24  * window changes.
25  * Note: Note that at the time of onWindowDragResizeStart the content size isn't known. A consumer
26  * should therfore not draw anything before the additional onContentDraw call has arrived.
27  * @hide
28  */
29 public interface WindowCallbacks {
30 
31     public static final int RESIZE_MODE_INVALID = -1;
32     public static final int RESIZE_MODE_FREEFORM = 0;
33     public static final int RESIZE_MODE_DOCKED_DIVIDER = 1;
34 
35     /**
36      * Called by the system when the window got changed by the user, before the layouter got called.
37      * It also gets called when the insets changed, or when the window switched between a fullscreen
38      * layout or a non-fullscreen layout. It can be used to perform a "quick and dirty" resize which
39      * should never take more then 4ms to complete.
40      *
41      * <p>At the time the layouting has not happened yet.
42      *
43      * @param newBounds The new window frame bounds.
44      * @param fullscreen Whether the window is currently drawing in fullscreen.
45      * @param systemInsets The current visible system insets for the window.
46      * @param stableInsets The stable insets for the window.
47      */
onWindowSizeIsChanging(Rect newBounds, boolean fullscreen, Rect systemInsets, Rect stableInsets)48     void onWindowSizeIsChanging(Rect newBounds, boolean fullscreen, Rect systemInsets,
49             Rect stableInsets);
50 
51     /**
52      * Called when a drag resize starts.
53      *
54      * @param initialBounds The initial bounds where the window will be.
55      * @param fullscreen Whether the window is currently drawing in fullscreen.
56      * @param systemInsets The current visible system insets for the window.
57      * @param stableInsets The stable insets for the window.
58      */
onWindowDragResizeStart(Rect initialBounds, boolean fullscreen, Rect systemInsets, Rect stableInsets, int resizeMode)59     void onWindowDragResizeStart(Rect initialBounds, boolean fullscreen, Rect systemInsets,
60             Rect stableInsets, int resizeMode);
61 
62     /**
63      * Called when a drag resize ends.
64      */
onWindowDragResizeEnd()65     void onWindowDragResizeEnd();
66 
67     /**
68      * The content will now be drawn to these bounds. Returns true if
69      * a draw should be requested after the next content draw.
70      */
onContentDrawn(int offsetX, int offsetY, int sizeX, int sizeY)71     boolean onContentDrawn(int offsetX, int offsetY, int sizeX, int sizeY);
72 
73     /**
74      * Called to request the window to draw one frame.
75      * @param reportNextDraw Whether it should report when the requested draw finishes.
76      */
onRequestDraw(boolean reportNextDraw)77     void onRequestDraw(boolean reportNextDraw);
78 
79     /**
80      * Called after all the content has drawn and the callback now has the ability to draw something
81      * on top of everything. Call {@link ViewRootImpl#requestInvalidateRootRenderNode} when this
82      * content needs to be redrawn.
83      *
84      * @param canvas The canvas to draw on.
85      */
onPostDraw(RecordingCanvas canvas)86     void onPostDraw(RecordingCanvas canvas);
87 }
88