Animator.kt
/*
* Copyright (C) 2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.core.animation
import android.animation.Animator
import androidx.annotation.RequiresApi
/**
* Add an action which will be invoked when the animation has ended.
*
* @return the [Animator.AnimatorListener] added to the Animator
* @see Animator.end
*/
inline fun Animator.doOnEnd(crossinline action: (animator: Animator) -> Unit) =
addListener(onEnd = action)
/**
* Add an action which will be invoked when the animation has started.
*
* @return the [Animator.AnimatorListener] added to the Animator
* @see Animator.start
*/
inline fun Animator.doOnStart(crossinline action: (animator: Animator) -> Unit) =
addListener(onStart = action)
/**
* Add an action which will be invoked when the animation has been cancelled.
*
* @return the [Animator.AnimatorListener] added to the Animator
* @see Animator.cancel
*/
inline fun Animator.doOnCancel(crossinline action: (animator: Animator) -> Unit) =
addListener(onCancel = action)
/**
* Add an action which will be invoked when the animation has repeated.
*
* @return the [Animator.AnimatorListener] added to the Animator
*/
inline fun Animator.doOnRepeat(crossinline action: (animator: Animator) -> Unit) =
addListener(onRepeat = action)
/**
* Add an action which will be invoked when the animation has resumed after a pause.
*
* @return the [Animator.AnimatorPauseListener] added to the Animator
* @see Animator.resume
*/
@RequiresApi(19)
inline fun Animator.doOnResume(crossinline action: (animator: Animator) -> Unit) =
addPauseListener(onResume = action)
/**
* Add an action which will be invoked when the animation has been paused.
*
* @return the [Animator.AnimatorPauseListener] added to the Animator
* @see Animator.pause
*/
@RequiresApi(19)
inline fun Animator.doOnPause(crossinline action: (animator: Animator) -> Unit) =
addPauseListener(onPause = action)
/**
* Add a listener to this Animator using the provided actions.
*
* @return the [Animator.AnimatorListener] added to the Animator
*/
inline fun Animator.addListener(
crossinline onEnd: (animator: Animator) -> Unit = {},
crossinline onStart: (animator: Animator) -> Unit = {},
crossinline onCancel: (animator: Animator) -> Unit = {},
crossinline onRepeat: (animator: Animator) -> Unit = {}
): Animator.AnimatorListener {
val listener = object : Animator.AnimatorListener {
override fun onAnimationRepeat(animator: Animator) = onRepeat(animator)
override fun onAnimationEnd(animator: Animator) = onEnd(animator)
override fun onAnimationCancel(animator: Animator) = onCancel(animator)
override fun onAnimationStart(animator: Animator) = onStart(animator)
}
addListener(listener)
return listener
}
/**
* Add a pause and resume listener to this Animator using the provided actions.
*
* @return the [Animator.AnimatorPauseListener] added to the Animator
*/
@RequiresApi(19)
inline fun Animator.addPauseListener(
crossinline onResume: (animator: Animator) -> Unit = {},
crossinline onPause: (animator: Animator) -> Unit = {}
): Animator.AnimatorPauseListener {
val listener = object : Animator.AnimatorPauseListener {
override fun onAnimationPause(animator: Animator) = onPause(animator)
override fun onAnimationResume(animator: Animator) = onResume(animator)
}
addPauseListener(listener)
return listener
}