Yunfan Chen | 02abf55 | 2019-12-05 14:51:09 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2019 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 | |
Adrian Roos | c22eec9 | 2020-06-12 18:48:10 +0200 | [diff] [blame] | 19 | import android.view.WindowInsets.Type.InsetsType; |
Adrian Roos | db5b0c2 | 2020-02-12 15:05:27 -0800 | [diff] [blame] | 20 | import android.view.WindowInsetsAnimation.Bounds; |
Jorim Jaggi | a51168a | 2019-12-27 15:17:44 +0100 | [diff] [blame] | 21 | |
Yunfan Chen | 02abf55 | 2019-12-05 14:51:09 +0900 | [diff] [blame] | 22 | /** |
| 23 | * Provide an interface to let InsetsAnimationControlImpl call back into its owner. |
| 24 | * @hide |
| 25 | */ |
| 26 | public interface InsetsAnimationControlCallbacks { |
Jorim Jaggi | a51168a | 2019-12-27 15:17:44 +0100 | [diff] [blame] | 27 | |
Yunfan Chen | 02abf55 | 2019-12-05 14:51:09 +0900 | [diff] [blame] | 28 | /** |
Jorim Jaggi | a51168a | 2019-12-27 15:17:44 +0100 | [diff] [blame] | 29 | * Executes the necessary code to start the animation in the correct order, including: |
| 30 | * <ul> |
Adrian Roos | db5b0c2 | 2020-02-12 15:05:27 -0800 | [diff] [blame] | 31 | * <li>Dispatch {@link WindowInsetsAnimation.Callback#onPrepare}</li> |
Jorim Jaggi | a51168a | 2019-12-27 15:17:44 +0100 | [diff] [blame] | 32 | * <li>Update insets state and run layout according to {@code layoutDuringAnimation}</li> |
Adrian Roos | db5b0c2 | 2020-02-12 15:05:27 -0800 | [diff] [blame] | 33 | * <li>Dispatch {@link WindowInsetsAnimation.Callback#onStart}</li> |
Jorim Jaggi | a51168a | 2019-12-27 15:17:44 +0100 | [diff] [blame] | 34 | * <li>Dispatch {@link WindowInsetsAnimationControlListener#onReady}</li> |
| 35 | * </ul> |
Yunfan Chen | 02abf55 | 2019-12-05 14:51:09 +0900 | [diff] [blame] | 36 | */ |
Jorim Jaggi | a51168a | 2019-12-27 15:17:44 +0100 | [diff] [blame] | 37 | void startAnimation(InsetsAnimationControlImpl controller, |
Adrian Roos | db5b0c2 | 2020-02-12 15:05:27 -0800 | [diff] [blame] | 38 | WindowInsetsAnimationControlListener listener, int types, |
| 39 | WindowInsetsAnimation animation, |
Jorim Jaggi | 6d5c801 | 2020-02-28 01:40:27 +0100 | [diff] [blame] | 40 | Bounds bounds); |
Yunfan Chen | 02abf55 | 2019-12-05 14:51:09 +0900 | [diff] [blame] | 41 | |
| 42 | /** |
| 43 | * Schedule the apply by posting the animation callback. |
Adrian Roos | 6a4448f | 2020-04-01 15:01:08 +0200 | [diff] [blame] | 44 | * |
| 45 | * @param runner The runner that requested applying insets |
Yunfan Chen | 02abf55 | 2019-12-05 14:51:09 +0900 | [diff] [blame] | 46 | */ |
Adrian Roos | 6a4448f | 2020-04-01 15:01:08 +0200 | [diff] [blame] | 47 | void scheduleApplyChangeInsets(InsetsAnimationControlRunner runner); |
Yunfan Chen | 02abf55 | 2019-12-05 14:51:09 +0900 | [diff] [blame] | 48 | |
| 49 | /** |
| 50 | * Finish the final steps after the animation. |
Jorim Jaggi | 6d5c801 | 2020-02-28 01:40:27 +0100 | [diff] [blame] | 51 | * @param runner The runner used to run the animation. |
Yunfan Chen | 02abf55 | 2019-12-05 14:51:09 +0900 | [diff] [blame] | 52 | * @param shown {@code true} if the insets are shown. |
| 53 | */ |
Jorim Jaggi | 6d5c801 | 2020-02-28 01:40:27 +0100 | [diff] [blame] | 54 | void notifyFinished(InsetsAnimationControlRunner runner, boolean shown); |
Yunfan Chen | 02abf55 | 2019-12-05 14:51:09 +0900 | [diff] [blame] | 55 | |
| 56 | /** |
Yunfan Chen | 02abf55 | 2019-12-05 14:51:09 +0900 | [diff] [blame] | 57 | * Apply the new params to the surface. |
| 58 | * @param params The {@link android.view.SyncRtSurfaceTransactionApplier.SurfaceParams} to |
| 59 | * apply. |
| 60 | */ |
| 61 | void applySurfaceParams(SyncRtSurfaceTransactionApplier.SurfaceParams... params); |
Rob Carr | 3a367c4b | 2020-03-10 15:51:35 -0700 | [diff] [blame] | 62 | |
| 63 | /** |
| 64 | * Post a message to release the Surface, guaranteed to happen after all |
| 65 | * previous calls to applySurfaceParams. |
| 66 | */ |
| 67 | void releaseSurfaceControlFromRt(SurfaceControl sc); |
Adrian Roos | c22eec9 | 2020-06-12 18:48:10 +0200 | [diff] [blame] | 68 | |
| 69 | /** |
| 70 | * Reports that the perceptibility of the given types has changed to the given value. |
| 71 | * |
| 72 | * A type is perceptible if it is not (almost) entirely off-screen and not (almost) entirely |
| 73 | * transparent. |
| 74 | * |
| 75 | * @param types the (public) types whose perceptibility has changed |
| 76 | * @param perceptible true, if the types are now perceptible, false if they are not perceptible |
| 77 | */ |
| 78 | void reportPerceptible(@InsetsType int types, boolean perceptible); |
Yunfan Chen | 02abf55 | 2019-12-05 14:51:09 +0900 | [diff] [blame] | 79 | } |