1 /* 2 * Copyright (C) 2020 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.InsetsController.AnimationType; 20 import android.view.InsetsState.InternalInsetsType; 21 import android.view.WindowInsets.Type.InsetsType; 22 23 /** 24 * Interface representing a runner for an insets animation. 25 * 26 * @hide 27 */ 28 public interface InsetsAnimationControlRunner { 29 30 /** 31 * @return The {@link InsetsType} the animation of this runner is controlling. 32 */ getTypes()33 @InsetsType int getTypes(); 34 35 /** 36 * Cancels the animation. 37 */ cancel()38 void cancel(); 39 40 /** 41 * @return The animation this runner is running. 42 */ getAnimation()43 WindowInsetsAnimation getAnimation(); 44 45 /** 46 * @return Whether {@link #getTypes()} maps to a specific {@link InternalInsetsType}. 47 */ controlsInternalType(@nternalInsetsType int type)48 default boolean controlsInternalType(@InternalInsetsType int type) { 49 return InsetsState.toInternalType(getTypes()).contains(type); 50 } 51 52 /** 53 * @return The animation type this runner is running. 54 */ getAnimationType()55 @AnimationType int getAnimationType(); 56 } 57