com.facebook.litho

Class Transition.TransitionUnitsBuilder

java.lang.Object

com.facebook.litho.Transition

com.facebook.litho.Transition.BaseTransitionUnitsBuilder

com.facebook.litho.Transition.TransitionUnitsBuilder

Enclosing class:

Transition

public static class Transition.TransitionUnitsBuilder
extends Transition.BaseTransitionUnitsBuilder

Transition builder that allows targeting arbitrary keys and properties. By default CHANGE animation is supported and it is possible to add support for APPEARING/DISAPPEARING animations by providing start/end values for given property with appearFrom(float)/disappearTo(float). Default animator is SpringTransition but that can be customized by providing other animator with #animator(TransitionAnimator).

Nested Class Summary

Nested classes/interfaces inherited from class com.facebook.litho.Transition

Transition.AnimationTarget, Transition.AutoBoundsTransitionBuilder, Transition.BaseTransitionUnitsBuilder, Transition.ComponentTarget, Transition.PropertyTarget, Transition.RootBoundsTransition, Transition.SpringTransitionAnimator, Transition.TimingTransitionAnimator, Transition.TransitionAnimator, Transition.TransitionKeyType, Transition.TransitionUnit, Transition.TransitionUnitsBuilder

Field Summary

Fields inherited from class com.facebook.litho.Transition

SPRING_WITH_OVERSHOOT, SPRING_WITHOUT_OVERSHOOT

Method Summary

Modifier and Type	Method and Description
Transition.TransitionUnitsBuilder	animate(AnimatedProperty... properties) Adds a set of properties to animate.
Transition.TransitionUnitsBuilder	animate(AnimatedProperty property) Adds a given property to animate.
Transition.TransitionUnitsBuilder	animate(Transition.PropertyTarget propertyTarget) Adds a target of properties to animate.
Transition.TransitionUnitsBuilder	animator(Transition.TransitionAnimator animator) Use to define the Transition.TransitionAnimator that drives the animation.
Transition.TransitionUnitsBuilder	appearFrom(float value) Define a constant value where appear animations should start from.
Transition.TransitionUnitsBuilder	appearFrom(RuntimeValue value) Define where appear animations should start from.
Transition.TransitionUnitsBuilder	disappearTo(float value) Define a constant value where disappear animations should end at.
Transition.TransitionUnitsBuilder	disappearTo(RuntimeValue value) Define where disappear animations should end at.
Transition.TransitionUnitsBuilder	traceName(java.lang.String name)
Transition.TransitionUnitsBuilder	transitionEndHandler(Function<java.lang.Void> transitionEndHandler) Add a transition end handler that would get a callback whenever the transition finishes.

Methods inherited from class com.facebook.litho.Transition.BaseTransitionUnitsBuilder

getTransitionUnits

Methods inherited from class com.facebook.litho.Transition

allLayout, create, create, create, create, create, delay, parallel, sequence, springWithConfig, stagger, timing, timing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

animate

public Transition.TransitionUnitsBuilder animate(AnimatedProperty property)

Adds a given property to animate. This also puts the Builder in a state to configure the animation of this property using animator(com.facebook.litho.Transition.TransitionAnimator), appearFrom(com.facebook.litho.animation.RuntimeValue), and disappearTo(com.facebook.litho.animation.RuntimeValue).

Parameters:

property - the property to animate

animate

public Transition.TransitionUnitsBuilder animate(AnimatedProperty... properties)

Adds a set of properties to animate. This also puts the Builder in a state to configure the animation of these properties using animator(com.facebook.litho.Transition.TransitionAnimator). To specify appearFrom/disappearTo values, address properties individually using animate(AnimatedProperty).

Parameters:

properties - the properties to animate

animate

public Transition.TransitionUnitsBuilder animate(Transition.PropertyTarget propertyTarget)

Adds a target of properties to animate. This also puts the Builder in a state to configure the animation of these properties using animator(com.facebook.litho.Transition.TransitionAnimator). To specify appearFrom/disappearTo values, address properties individually using animate(AnimatedProperty).

Parameters:

propertyTarget - the target properties to animate

animator

public Transition.TransitionUnitsBuilder animator(Transition.TransitionAnimator animator)

Use to define the Transition.TransitionAnimator that drives the animation. The default is a spring.

transitionEndHandler

public Transition.TransitionUnitsBuilder transitionEndHandler(Function<java.lang.Void> transitionEndHandler)

Add a transition end handler that would get a callback whenever the transition finishes.

Parameters:

transitionEndHandler -

Returns:

appearFrom

public Transition.TransitionUnitsBuilder appearFrom(RuntimeValue value)

Define where appear animations should start from.

See Also:

FloatValue, DimensionValue

traceName

public Transition.TransitionUnitsBuilder traceName(java.lang.String name)

disappearTo

public Transition.TransitionUnitsBuilder disappearTo(RuntimeValue value)

Define where disappear animations should end at.

See Also:

FloatValue, DimensionValue

appearFrom

public Transition.TransitionUnitsBuilder appearFrom(float value)

Define a constant value where appear animations should start from.

disappearTo

public Transition.TransitionUnitsBuilder disappearTo(float value)

Define a constant value where disappear animations should end at.