Android APIs
public class

SidePropagation

extends VisibilityPropagation
java.lang.Object
   ↳ android.transition.TransitionPropagation
     ↳ android.transition.VisibilityPropagation
       ↳ android.transition.SidePropagation

Class Overview

A TransitionPropagation that propagates based on the distance to the side and, orthogonally, the distance to epicenter. If the transitioning View is visible in the start of the transition, then it will transition sooner when closer to the side and later when farther. If the view is not visible in the start of the transition, then it will transition later when closer to the side and sooner when farther from the edge. This is the default TransitionPropagation used with Slide.

Summary

Public Constructors
SidePropagation()
Public Methods
long getStartDelay(ViewGroup sceneRoot, Transition transition, TransitionValues startValues, TransitionValues endValues)
Called by Transition to alter the Animator start delay.
void setPropagationSpeed(float propagationSpeed)
Sets the speed at which transition propagation happens, relative to the duration of the Transition.
void setSide(int side)
Sets the side that is used to calculate the transition propagation.
[Expand]
Inherited Methods
From class android.transition.VisibilityPropagation
From class android.transition.TransitionPropagation
From class java.lang.Object

Public Constructors

public SidePropagation ()

Public Methods

public long getStartDelay (ViewGroup sceneRoot, Transition transition, TransitionValues startValues, TransitionValues endValues)

Called by Transition to alter the Animator start delay. All start delays will be adjusted such that the minimum becomes zero.

Parameters
sceneRoot The root of the View hierarchy running the transition.
transition The transition that created the Animator
startValues The values for a specific target in the start scene.
endValues The values for the target in the end scene.
Returns
  • A start delay to use with the Animator created by transition. The delay will be offset by the minimum delay of all TransitionPropagations used in the Transition so that the smallest delay will be 0. Returned values may be negative.

public void setPropagationSpeed (float propagationSpeed)

Sets the speed at which transition propagation happens, relative to the duration of the Transition. A propagationSpeed of 1 means that a View centered at the side set in setSide(int) and View centered at the opposite edge will have a difference in start delay of approximately the duration of the Transition. A speed of 2 means the start delay difference will be approximately half of the duration of the transition. A value of 0 is illegal, but negative values will invert the propagation.

Parameters
propagationSpeed The speed at which propagation occurs, relative to the duration of the transition. A speed of 4 means it works 4 times as fast as the duration of the transition. May not be 0.

public void setSide (int side)

Sets the side that is used to calculate the transition propagation. If the transitioning View is visible in the start of the transition, then it will transition sooner when closer to the side and later when farther. If the view is not visible in the start of the transition, then it will transition later when closer to the side and sooner when farther from the edge. The default is BOTTOM.

Parameters
side The side that is used to calculate the transition propagation. Must be one of LEFT, TOP, RIGHT, or BOTTOM.