SidePropagation

Kotlin |Java

public class SidePropagation
extends VisibilityPropagation

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

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.

Inherited methods

From class


        
          android.transition.VisibilityPropagation

`void`	`captureValues(TransitionValues values)` Captures the values in the start or end scene for the properties that this transition propagation monitors.
`String[]`	`getPropagationProperties()` 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.
`int`	`getViewVisibility(TransitionValues values)` Returns `View.getVisibility()` for the View at the time the values were captured.
`int`	`getViewX(TransitionValues values)` Returns the View's center x coordinate, relative to the screen, at the time the values were captured.
`int`	`getViewY(TransitionValues values)` Returns the View's center y coordinate, relative to the screen, at the time the values were captured.

From class


        
          android.transition.TransitionPropagation

`abstract void`	`captureValues(TransitionValues transitionValues)` Captures the values in the start or end scene for the properties that this transition propagation monitors.
`abstract String[]`	`getPropagationProperties()` 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.
`abstract long`	`getStartDelay(ViewGroup sceneRoot, Transition transition, TransitionValues startValues, TransitionValues endValues)` Called by Transition to alter the Animator start delay.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

SidePropagation

public SidePropagation ()

Public methods

getStartDelay

Added in API level 21

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`	`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.

Returns
`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.

setPropagationSpeed

Added in API level 21

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`	`float`: 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.

setSide

Added in API level 21

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 Gravity#BOTTOM.

Parameters
`side`	`int`: The side that is used to calculate the transition propagation. Must be one of `Gravity#LEFT`, `Gravity#TOP`, `Gravity#RIGHT`, `Gravity#BOTTOM`, `Gravity#START`, or `Gravity#END`. Value is `Gravity.LEFT`, `Gravity.TOP`, `Gravity.RIGHT`, `Gravity.BOTTOM`, `Gravity.START`, or `Gravity.END`