Added in API level 23

ChangeScroll


open class ChangeScroll : Transition
kotlin.Any
   ↳ android.transition.Transition
   ↳ android.transition.ChangeScroll

This transition captures the scroll properties of targets before and after the scene change and animates any changes.

Summary

Inherited constants
Public constructors

ChangeScroll(context: Context!, attrs: AttributeSet!)

Public methods
open Unit
captureEndValues(transitionValues: TransitionValues!)

open Unit

open Animator?
createAnimator(sceneRoot: ViewGroup, startValues: TransitionValues?, endValues: TransitionValues?)

This method creates an animation that will be run for this transition given the information in the startValues and endValues structures captured earlier for the start and end scenes.

open Array<String!>!

Inherited functions

Public constructors

ChangeScroll

Added in API level 23
ChangeScroll()

ChangeScroll

Added in API level 23
ChangeScroll(
    context: Context!,
    attrs: AttributeSet!)

Public methods

captureEndValues

Added in API level 23
open fun captureEndValues(transitionValues: TransitionValues!): Unit
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.

captureStartValues

Added in API level 23
open fun captureStartValues(transitionValues: TransitionValues!): Unit
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.

createAnimator

Added in API level 23
open fun createAnimator(
    sceneRoot: ViewGroup,
    startValues: TransitionValues?,
    endValues: TransitionValues?
): Animator?

This method creates an animation that will be run for this transition given the information in the startValues and endValues structures captured earlier for the start and end scenes. Subclasses of Transition should override this method. The method should only be called by the transition system; it is not intended to be called from external classes.

This method is called by the transition's parent (all the way up to the topmost Transition in the hierarchy) with the sceneRoot and start/end values that the transition may need to set up initial target values and construct an appropriate animation. For example, if an overall Transition is a TransitionSet consisting of several child transitions in sequence, then some of the child transitions may want to set initial values on target views prior to the overall Transition commencing, to put them in an appropriate state for the delay between that start and the child Transition start time. For example, a transition that fades an item in may wish to set the starting alpha value to 0, to avoid it blinking in prior to the transition actually starting the animation. This is necessary because the scene change that triggers the Transition will automatically set the end-scene on all target views, so a Transition that wants to animate from a different value should set that value prior to returning from this method.

Additionally, a Transition can perform logic to determine whether the transition needs to run on the given target and start/end values. For example, a transition that resizes objects on the screen may wish to avoid running for views which are not present in either the start or end scenes.

If there is an animator created and returned from this method, the transition mechanism will apply any applicable duration, startDelay, and interpolator to that animation and start it. A return value of null indicates that no animation should run. The default implementation returns null.

The method is called for every applicable target object, which is stored in the TransitionValues#view field.

Parameters
sceneRoot ViewGroup: This value cannot be null.
startValues TransitionValues?: This value may be null.
endValues TransitionValues?: This value may be null.
Return
Animator? This value may be null.

getTransitionProperties

Added in API level 23
open fun getTransitionProperties(): Array<String!>!
Return
Array<String!>! An array of property names as described in the class documentation for TransitionValues. The default implementation returns null.