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 19 import android.view.WindowInsets.Type.InsetsType; 20 import android.view.WindowInsetsAnimation.Bounds; 21 22 /** 23 * Provide an interface to let InsetsAnimationControlImpl call back into its owner. 24 * @hide 25 */ 26 public interface InsetsAnimationControlCallbacks { 27 28 /** 29 * Executes the necessary code to start the animation in the correct order, including: 30 * <ul> 31 * <li>Dispatch {@link WindowInsetsAnimation.Callback#onPrepare}</li> 32 * <li>Update insets state and run layout according to {@code layoutDuringAnimation}</li> 33 * <li>Dispatch {@link WindowInsetsAnimation.Callback#onStart}</li> 34 * <li>Dispatch {@link WindowInsetsAnimationControlListener#onReady}</li> 35 * </ul> 36 */ startAnimation(InsetsAnimationControlImpl controller, WindowInsetsAnimationControlListener listener, int types, WindowInsetsAnimation animation, Bounds bounds)37 void startAnimation(InsetsAnimationControlImpl controller, 38 WindowInsetsAnimationControlListener listener, int types, 39 WindowInsetsAnimation animation, 40 Bounds bounds); 41 42 /** 43 * Schedule the apply by posting the animation callback. 44 * 45 * @param runner The runner that requested applying insets 46 */ scheduleApplyChangeInsets(InsetsAnimationControlRunner runner)47 void scheduleApplyChangeInsets(InsetsAnimationControlRunner runner); 48 49 /** 50 * Finish the final steps after the animation. 51 * @param runner The runner used to run the animation. 52 * @param shown {@code true} if the insets are shown. 53 */ notifyFinished(InsetsAnimationControlRunner runner, boolean shown)54 void notifyFinished(InsetsAnimationControlRunner runner, boolean shown); 55 56 /** 57 * Apply the new params to the surface. 58 * @param params The {@link android.view.SyncRtSurfaceTransactionApplier.SurfaceParams} to 59 * apply. 60 */ applySurfaceParams(SyncRtSurfaceTransactionApplier.SurfaceParams... params)61 void applySurfaceParams(SyncRtSurfaceTransactionApplier.SurfaceParams... params); 62 63 /** 64 * Post a message to release the Surface, guaranteed to happen after all 65 * previous calls to applySurfaceParams. 66 */ releaseSurfaceControlFromRt(SurfaceControl sc)67 void releaseSurfaceControlFromRt(SurfaceControl sc); 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 */ reportPerceptible(@nsetsType int types, boolean perceptible)78 void reportPerceptible(@InsetsType int types, boolean perceptible); 79 } 80