TransitionPropagation
abstract class TransitionPropagation
kotlin.Any | |
↳ | android.transition.TransitionPropagation |
Extend TransitionPropagation
to customize start delays for Animators created in android.transition.Transition#createAnimator(ViewGroup, * TransitionValues, TransitionValues)
. A Transition such as android.transition.Explode
defaults to using android.transition.CircularPropagation
and Views closer to the epicenter will move out of the scene later and into the scene sooner than Views farther from the epicenter, giving the appearance of inertia. With no TransitionPropagation, all Views will react simultaneously to the start of the transition.
Summary
Public constructors | |
---|---|
Public methods | |
---|---|
abstract Unit |
captureValues(transitionValues: TransitionValues!) Captures the values in the start or end scene for the properties that this transition propagation monitors. |
abstract Array<String!>! |
Returns the set of property names stored in the |
abstract Long |
getStartDelay(sceneRoot: ViewGroup!, transition: Transition!, startValues: TransitionValues!, endValues: TransitionValues!) Called by Transition to alter the Animator start delay. |
Public constructors
TransitionPropagation
TransitionPropagation()
Public methods
captureValues
abstract fun captureValues(transitionValues: TransitionValues!): Unit
Captures the values in the start or end scene for the properties that this transition propagation monitors. These values are then passed as the startValues or endValues structure in a later call to getStartDelay(android.view.ViewGroup,android.transition.Transition,android.transition.TransitionValues,android.transition.TransitionValues)
. The main concern for an implementation is what the properties are that the transition cares about and what the values are for all of those properties. The start and end values will be compared later during the getStartDelay(android.view.ViewGroup,android.transition.Transition,android.transition.TransitionValues,android.transition.TransitionValues)
. method to determine the start delay.
Subclasses must implement this method. The method should only be called by the transition system; it is not intended to be called from external classes.
Parameters | |
---|---|
transitionValues |
TransitionValues!: The holder for any values that the Transition wishes to store. Values are stored in the values field of this TransitionValues object and are keyed from a String value. For example, to store a view's rotation value, a transition might call transitionValues.values.put("appname:transitionname:rotation", view.getRotation()) . The target view will already be stored in the transitionValues structure when this method is called. |
getPropagationProperties
abstract fun getPropagationProperties(): Array<String!>!
Returns the set of property names stored in the TransitionValues
object passed into captureValues(android.transition.TransitionValues)
that this transition propagation cares about for the purposes of preventing duplicate capturing of property values.
A TransitionPropagation
must override this method to prevent duplicate capturing of values and must contain at least one
Return | |
---|---|
Array<String!>! |
An array of property names as described in the class documentation for TransitionValues . |
getStartDelay
abstract fun getStartDelay(
sceneRoot: ViewGroup!,
transition: Transition!,
startValues: TransitionValues!,
endValues: TransitionValues!
): Long
Called by Transition to alter the Animator start delay. All start delays will be adjusted such that the minimum becomes zero.
Parameters | |
---|---|
sceneRoot |
ViewGroup!: The root of the View hierarchy running the transition. |
transition |
Transition!: The transition that created the Animator |
startValues |
TransitionValues!: The values for a specific target in the start scene. |
endValues |
TransitionValues!: The values for the target in the end scene. |
Return | |
---|---|
Long |
A start delay to use with the Animator created by transition . The delay will be offset by the minimum delay of all TransitionPropagation s used in the Transition so that the smallest delay will be 0. Returned values may be negative. |