Added in API level 21

Slide


open class Slide : Visibility
kotlin.Any
   ↳ android.transition.Transition
   ↳ android.transition.Visibility
   ↳ android.transition.Slide

This transition tracks changes to the visibility of target views in the start and end scenes and moves views in or out from one of the edges of the scene. Visibility is determined by both the View.setVisibility(int) state of the view as well as whether it is parented in the current view hierarchy. Disappearing Views are limited as described in Visibility.onDisappear(android.view.ViewGroup, TransitionValues, int, TransitionValues, int).

Summary

Inherited constants
Public constructors

Constructor using the default Gravity.BOTTOM slide edge direction.

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

Slide(slideEdge: Int)

Constructor using the provided slide edge direction.

Public methods
open Unit
captureEndValues(transitionValues: TransitionValues!)

Captures the values in the end scene for the properties that this transition monitors.

open Unit

Captures the values in the start scene for the properties that this transition monitors.

open Int

Returns the edge that Views appear and disappear from.

open Animator!
onAppear(sceneRoot: ViewGroup!, view: View!, startValues: TransitionValues!, endValues: TransitionValues!)

The default implementation of this method returns a null Animator.

open Animator!
onDisappear(sceneRoot: ViewGroup!, view: View!, startValues: TransitionValues!, endValues: TransitionValues!)

The default implementation of this method returns a null Animator.

open Unit
setSlideEdge(slideEdge: Int)

Change the edge that Views appear and disappear from.

Inherited functions

Public constructors

Slide

Added in API level 21
Slide()

Constructor using the default Gravity.BOTTOM slide edge direction.

Slide

Added in API level 21
Slide(
    context: Context!,
    attrs: AttributeSet!)

Slide

Added in API level 21
Slide(slideEdge: Int)

Constructor using the provided slide edge direction.

Parameters
slideEdge Int: Value is one of the following:

Public methods

captureEndValues

Added in API level 21
open fun captureEndValues(transitionValues: TransitionValues!): Unit

Captures the values in the end scene for the properties that this transition monitors. These values are then passed as the endValues structure in a later call to createAnimator(android.view.ViewGroup,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 createAnimator(android.view.ViewGroup,android.transition.TransitionValues,android.transition.TransitionValues) method to determine what, if any, animations, should be run.

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.

captureStartValues

Added in API level 21
open fun captureStartValues(transitionValues: TransitionValues!): Unit

Captures the values in the start scene for the properties that this transition monitors. These values are then passed as the startValues structure in a later call to createAnimator(android.view.ViewGroup,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 createAnimator(android.view.ViewGroup,android.transition.TransitionValues,android.transition.TransitionValues) method to determine what, if any, animations, should be run.

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.

getSlideEdge

Added in API level 21
open fun getSlideEdge(): Int

Returns the edge that Views appear and disappear from.

Return
Int the edge of the scene to use for Views appearing and disappearing. One of android.view.Gravity#LEFT, android.view.Gravity#TOP, android.view.Gravity#RIGHT, android.view.Gravity#BOTTOM, android.view.Gravity#START, android.view.Gravity#END.
Value is one of the following:

onAppear

Added in API level 21
open fun onAppear(
    sceneRoot: ViewGroup!,
    view: View!,
    startValues: TransitionValues!,
    endValues: TransitionValues!
): Animator!

The default implementation of this method returns a null Animator. Subclasses should override this method to make targets appear with the desired transition. The method should only be called from onAppear(android.view.ViewGroup,android.transition.TransitionValues,int,android.transition.TransitionValues,int).

Parameters
sceneRoot ViewGroup!: The root of the transition hierarchy
view View!: The View to make appear. This will be in the target scene's View hierarchy and will be VISIBLE.
startValues TransitionValues!: The target values in the start scene
endValues TransitionValues!: The target values in the end scene
Return
Animator! An Animator to be started at the appropriate time in the overall transition for this scene change. A null value means no animation should be run.

onDisappear

Added in API level 21
open fun onDisappear(
    sceneRoot: ViewGroup!,
    view: View!,
    startValues: TransitionValues!,
    endValues: TransitionValues!
): Animator!

The default implementation of this method returns a null Animator. Subclasses should override this method to make targets disappear with the desired transition. The method should only be called from onDisappear(android.view.ViewGroup,android.transition.TransitionValues,int,android.transition.TransitionValues,int).

Parameters
sceneRoot ViewGroup!: The root of the transition hierarchy
view View!: The View to make disappear. This will be in the target scene's View hierarchy or in an android.view.ViewGroupOverlay and will be VISIBLE.
startValues TransitionValues!: The target values in the start scene
endValues TransitionValues!: The target values in the end scene
Return
Animator! An Animator to be started at the appropriate time in the overall transition for this scene change. A null value means no animation should be run.

setSlideEdge

Added in API level 21
open fun setSlideEdge(slideEdge: Int): Unit

Change the edge that Views appear and disappear from.

Parameters
slideEdge Int: The edge of the scene to use for Views appearing and disappearing. One of android.view.Gravity#LEFT, android.view.Gravity#TOP, android.view.Gravity#RIGHT, android.view.Gravity#BOTTOM, android.view.Gravity#START, android.view.Gravity#END.
Value is one of the following: