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