TransitionSet

public class TransitionSet extends Transition

Known direct subclasses
AutoTransition

Utility class for creating a default transition that automatically fades, moves, and resizes views during a scene change.


A TransitionSet is a parent of child transitions (including other TransitionSets). Using TransitionSets enables more complex choreography of transitions, where some sets play ORDERING_TOGETHER and others play ORDERING_SEQUENTIAL. For example, AutoTransition uses a TransitionSet to sequentially play a Fade(Fade.OUT), followed by a ChangeBounds, followed by a Fade(Fade.OUT) transition.

A TransitionSet can be described in a resource file by using the tag transitionSet, along with the standard attributes of TransitionSet and Transition. Child transitions of the TransitionSet object can be loaded by adding those child tags inside the enclosing transitionSet tag. For example, the following xml describes a TransitionSet that plays a Fade and then a ChangeBounds transition on the affected view targets:

    <transitionSet xmlns:android="http://schemas.android.com/apk/res/android"
            android:transitionOrdering="sequential">
        <fade/>
        <changeBounds/>
    </transitionSet>

Summary

Constants

static final int

A flag used to indicate that the child transitions of this set should play in sequence; when one child transition ends, the next child transition begins.

static final int

A flag used to indicate that the child transitions of this set should all start at the same time.

Public constructors

Constructs an empty transition set.

Public methods

@NonNull TransitionSet

Adds a listener to the set of listeners that are sent events through the life of an animation, such as start, repeat, and end.

@NonNull TransitionSet
addTarget(@IdRes int targetId)

Adds the id of a target view that this Transition is interested in animating.

@NonNull TransitionSet
addTarget(@NonNull String targetName)

Adds the transitionName of a target view that this Transition is interested in animating.

@NonNull TransitionSet
addTarget(@NonNull Class<Object> targetType)

Adds the Class of a target view that this Transition is interested in animating.

@NonNull TransitionSet

Sets the target view instances that this Transition is interested in animating.

@NonNull TransitionSet

Adds child transition to this set.

void

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

void

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

@NonNull Transition
@NonNull Transition
excludeTarget(int targetId, boolean exclude)

Whether to add the given id to the list of target ids to exclude from this transition.

@NonNull Transition
excludeTarget(@NonNull String targetName, boolean exclude)

Whether to add the given transitionName to the list of target transitionNames to exclude from this transition.

@NonNull Transition
excludeTarget(@NonNull View target, boolean exclude)

Whether to add the given target to the list of targets to exclude from this transition.

@NonNull Transition
excludeTarget(@NonNull Class<Object> type, boolean exclude)

Whether to add the given type to the list of types to exclude from this transition.

int

Returns the ordering of this TransitionSet.

@Nullable Transition
getTransitionAt(int index)

Returns the child Transition at the specified position in the TransitionSet.

int

Returns the number of child transitions in the TransitionSet.

boolean

Returns true if the Transition can be used by controlDelayedTransition.

@NonNull TransitionSet

Removes a listener from the set listening to this animation.

@NonNull TransitionSet

Removes the given target from the list of targets that this Transition is interested in animating.

@NonNull TransitionSet
removeTarget(@IdRes int targetId)

Removes the given targetId from the list of ids that this Transition is interested in animating.

@NonNull TransitionSet

Removes the given targetName from the list of transitionNames that this Transition is interested in animating.

@NonNull TransitionSet

Removes the given target from the list of targets that this Transition is interested in animating.

@NonNull TransitionSet

Removes the specified child transition from this set.

@NonNull TransitionSet
setDuration(long duration)

Setting a non-negative duration on a TransitionSet causes all of the child transitions (current and future) to inherit this duration.

void

Sets the callback to use to find the epicenter of a Transition.

@NonNull TransitionSet

Sets the interpolator of this transition.

@NonNull TransitionSet
setOrdering(int ordering)

Sets the play order of this set's child transitions.

void

Sets the algorithm used to calculate two-dimensional interpolation.

void

Sets the method for determining Animator start delays.

@NonNull TransitionSet
setStartDelay(long startDelay)

Sets the startDelay of this transition.

Inherited Constants

From androidx.transition.Transition
static final int

With setMatchOrder, chooses to match by getId.

static final int

With setMatchOrder, chooses to match by View instance.

static final int

With setMatchOrder, chooses to match by the android.widget.Adapter item id.

static final int

With setMatchOrder, chooses to match by getTransitionName.

Inherited methods

From androidx.transition.Transition
@Nullable Animator
createAnimator(
    @NonNull ViewGroup sceneRoot,
    @Nullable TransitionValues startValues,
    @Nullable TransitionValues endValues
)

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.

@NonNull Transition
excludeChildren(@IdRes int targetId, boolean exclude)

Whether to add the children of the given id to the list of targets to exclude from this transition.

@NonNull Transition
excludeChildren(@NonNull View target, boolean exclude)

Whether to add the children of given target to the list of target children to exclude from this transition.

@NonNull Transition
excludeChildren(@NonNull Class<Object> type, boolean exclude)

Whether to add the given type to the list of types whose children should be excluded from this transition.

long

Returns the duration set on this transition.

@Nullable Rect

Returns the epicenter as specified by the android.transition.Transition.EpicenterCallback or null if no callback exists.

@Nullable Transition.EpicenterCallback

Returns the callback used to find the epicenter of the Transition.

@Nullable TimeInterpolator

Returns the interpolator set on this transition.

@NonNull String

Returns the name of this Transition.

@NonNull PathMotion

Returns the algorithm object used to interpolate along two dimensions.

@Nullable TransitionPropagation

Returns the android.transition.TransitionPropagation used to calculate Animator start delays.

final @NonNull Transition

If this Transition is not part of a TransitionSet, this is returned.

long

Returns the startDelay set on this transition.

@NonNull List<Integer>

Returns the array of target IDs that this transition limits itself to tracking and animating.

@Nullable List<String>

Returns the list of target transitionNames that this transition limits itself to tracking and animating.

@Nullable List<Class<Object>>

Returns the list of target transitionNames that this transition limits itself to tracking and animating.

@NonNull List<View>

Returns the array of target views that this transition limits itself to tracking and animating.

@Nullable String[]

Returns the set of property names used stored in the TransitionValues object passed into captureStartValues that this transition cares about for the purposes of canceling overlapping animations.

@Nullable TransitionValues
getTransitionValues(@NonNull View view, boolean start)

This method can be called by transitions to get the TransitionValues for any particular view during the transition-playing process.

boolean
isTransitionRequired(
    @Nullable TransitionValues startValues,
    @Nullable TransitionValues endValues
)

Returns whether or not the transition should create an Animator, based on the values captured during captureStartValues and captureEndValues.

void
setMatchOrder(@Nullable int[] matches)

Sets the order in which Transition matches View start and end values.

@NonNull String

Constants

ORDERING_SEQUENTIAL

Added in 1.0.0
public static final int ORDERING_SEQUENTIAL = 1

A flag used to indicate that the child transitions of this set should play in sequence; when one child transition ends, the next child transition begins. Note that a transition does not end until all instances of it (which are playing on all applicable targets of the transition) end.

ORDERING_TOGETHER

Added in 1.0.0
public static final int ORDERING_TOGETHER = 0

A flag used to indicate that the child transitions of this set should all start at the same time.

Public constructors

TransitionSet

Added in 1.0.0
public TransitionSet()

Constructs an empty transition set. Add child transitions to the set by calling addTransition )}. By default, child transitions will play together.

TransitionSet

Added in 1.0.0
public TransitionSet(@NonNull Context context, @NonNull AttributeSet attrs)

Public methods

addListener

Added in 1.5.0-alpha06
public @NonNull TransitionSet addListener(@NonNull Transition.TransitionListener listener)

Adds a listener to the set of listeners that are sent events through the life of an animation, such as start, repeat, and end.

Parameters
@NonNull Transition.TransitionListener listener

the listener to be added to the current set of listeners for this animation.

Returns
@NonNull TransitionSet

This transition object.

addTarget

Added in 1.5.0-alpha06
public @NonNull TransitionSet addTarget(@IdRes int targetId)

Adds the id of a target view that this Transition is interested in animating. By default, there are no targetIds, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targetIds constrains the Transition to only listen for, and act on, views with these IDs. Views with different IDs, or no IDs whatsoever, will be ignored.

Note that using ids to specify targets implies that ids should be unique within the view hierarchy underneath the scene root.

Parameters
@IdRes int targetId

The id of a target view, must be a positive number.

Returns
@NonNull TransitionSet

The Transition to which the targetId is added. Returning the same object makes it easier to chain calls during construction, such as transitionSet.addTransitions(new Fade()).addTarget(someId);

See also
getId

addTarget

Added in 1.5.0-alpha06
public @NonNull TransitionSet addTarget(@NonNull String targetName)

Adds the transitionName of a target view that this Transition is interested in animating. By default, there are no targetNames, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targetNames constrains the Transition to only listen for, and act on, views with these transitionNames. Views with different transitionNames, or no transitionName whatsoever, will be ignored.

Note that transitionNames should be unique within the view hierarchy.

Parameters
@NonNull String targetName

The transitionName of a target view, must be non-null.

Returns
@NonNull TransitionSet

The Transition to which the target transitionName is added. Returning the same object makes it easier to chain calls during construction, such as transitionSet.addTransitions(new Fade()).addTarget(someName);

addTarget

Added in 1.5.0-alpha06
public @NonNull TransitionSet addTarget(@NonNull Class<Object> targetType)

Adds the Class of a target view that this Transition is interested in animating. By default, there are no targetTypes, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targetTypes constrains the Transition to only listen for, and act on, views with these classes. Views with different classes will be ignored.

Note that any View that can be cast to targetType will be included, so if targetType is View.class, all Views will be included.

Parameters
@NonNull Class<Object> targetType

The type to include when running this transition.

Returns
@NonNull TransitionSet

The Transition to which the target class was added. Returning the same object makes it easier to chain calls during construction, such as transitionSet.addTransitions(new Fade()).addTarget(ImageView.class);

addTarget

Added in 1.5.0-alpha06
public @NonNull TransitionSet addTarget(@NonNull View target)

Sets the target view instances that this Transition is interested in animating. By default, there are no targets, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targets constrains the Transition to only listen for, and act on, these views. All other views will be ignored.

The target list is like the targetId list except this list specifies the actual View instances, not the ids of the views. This is an important distinction when scene changes involve view hierarchies which have been inflated separately; different views may share the same id but not actually be the same instance. If the transition should treat those views as the same, then addTarget should be used instead of addTarget. If, on the other hand, scene changes involve changes all within the same view hierarchy, among views which do not necessarily have ids set on them, then the target list of views may be more convenient.

Parameters
@NonNull View target

A View on which the Transition will act, must be non-null.

Returns
@NonNull TransitionSet

The Transition to which the target is added. Returning the same object makes it easier to chain calls during construction, such as transitionSet.addTransitions(new Fade()).addTarget(someView);

See also
addTarget

addTransition

Added in 1.0.0
public @NonNull TransitionSet addTransition(@NonNull Transition transition)

Adds child transition to this set. The order in which this child transition is added relative to other child transitions that are added, in addition to the ordering property, determines the order in which the transitions are started.

If this transitionSet has a duration, interpolator, propagation delay, path motion, or epicenter callback set on it, the child transition will inherit the values that are set. Transitions are assumed to have a maximum of one transitionSet parent.

Parameters
@NonNull Transition transition

A non-null child transition to be added to this set.

Returns
@NonNull TransitionSet

This transitionSet object.

captureEndValues

Added in 1.5.0-alpha06
public void captureEndValues(@NonNull TransitionValues transitionValues)

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. 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 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
@NonNull 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 1.5.0-alpha06
public void captureStartValues(@NonNull TransitionValues transitionValues)

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. 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 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
@NonNull 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.

clone

public @NonNull Transition clone()

excludeTarget

public @NonNull Transition excludeTarget(int targetId, boolean exclude)

Whether to add the given id to the list of target ids to exclude from this transition. The exclude parameter specifies whether the target should be added to or removed from the excluded list.

Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, Spinner).

Parameters
int targetId

The id of a target to ignore when running this transition.

boolean exclude

Whether to add the target to or remove the target from the current list of excluded targets.

Returns
@NonNull Transition

This transition object.

excludeTarget

public @NonNull Transition excludeTarget(@NonNull String targetName, boolean exclude)

Whether to add the given transitionName to the list of target transitionNames to exclude from this transition. The exclude parameter specifies whether the target should be added to or removed from the excluded list.

Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded by their id, their instance reference, their transitionName, or by the Class of that view (eg, Spinner).

Parameters
@NonNull String targetName

The name of a target to ignore when running this transition.

boolean exclude

Whether to add the target to or remove the target from the current list of excluded targets.

Returns
@NonNull Transition

This transition object.

excludeTarget

public @NonNull Transition excludeTarget(@NonNull View target, boolean exclude)

Whether to add the given target to the list of targets to exclude from this transition. The exclude parameter specifies whether the target should be added to or removed from the excluded list.

Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, Spinner).

Parameters
@NonNull View target

The target to ignore when running this transition.

boolean exclude

Whether to add the target to or remove the target from the current list of excluded targets.

Returns
@NonNull Transition

This transition object.

excludeTarget

public @NonNull Transition excludeTarget(@NonNull Class<Object> type, boolean exclude)

Whether to add the given type to the list of types to exclude from this transition. The exclude parameter specifies whether the target type should be added to or removed from the excluded list.

Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, Spinner).

Parameters
@NonNull Class<Object> type

The type to ignore when running this transition.

boolean exclude

Whether to add the target type to or remove it from the current list of excluded target types.

Returns
@NonNull Transition

This transition object.

getOrdering

Added in 1.0.0
public int getOrdering()

Returns the ordering of this TransitionSet. By default, the value is ORDERING_TOGETHER.

Returns
int

ORDERING_TOGETHER if child transitions will play at the same time, ORDERING_SEQUENTIAL if they will play in sequence.

See also
setOrdering

getTransitionAt

Added in 1.0.0
public @Nullable Transition getTransitionAt(int index)

Returns the child Transition at the specified position in the TransitionSet.

Parameters
int index

The position of the Transition to retrieve.

getTransitionCount

Added in 1.0.0
public int getTransitionCount()

Returns the number of child transitions in the TransitionSet.

Returns
int

The number of child transitions in the TransitionSet.

isSeekingSupported

public boolean isSeekingSupported()

Returns true if the Transition can be used by controlDelayedTransition. This means that any the state must be ready before any Animator returned by createAnimator has started and if the Animator has ended, it must be able to restore the state when starting in reverse. If a Transition must know when the entire transition has ended, a TransitionListener can be added to getRootTransition and it can listen for onTransitionEnd.

removeListener

Added in 1.5.0-alpha06
public @NonNull TransitionSet removeListener(@NonNull Transition.TransitionListener listener)

Removes a listener from the set listening to this animation.

Parameters
@NonNull Transition.TransitionListener listener

the listener to be removed from the current set of listeners for this transition.

Returns
@NonNull TransitionSet

This transition object.

removeTarget

Added in 1.5.0-alpha06
public @NonNull TransitionSet removeTarget(@NonNull Class<Object> target)

Removes the given target from the list of targets that this Transition is interested in animating.

Parameters
@NonNull Class<Object> target

The type of the target view, must be non-null.

Returns
@NonNull TransitionSet

Transition The Transition from which the target is removed. Returning the same object makes it easier to chain calls during construction, such as transitionSet.addTransitions(new Fade()).removeTarget(someType);

removeTarget

Added in 1.5.0-alpha06
public @NonNull TransitionSet removeTarget(@IdRes int targetId)

Removes the given targetId from the list of ids that this Transition is interested in animating.

Parameters
@IdRes int targetId

The id of a target view, must be a positive number.

Returns
@NonNull TransitionSet

The Transition from which the targetId is removed. Returning the same object makes it easier to chain calls during construction, such as transitionSet.addTransitions(new Fade()).removeTargetId(someId);

removeTarget

Added in 1.5.0-alpha06
public @NonNull TransitionSet removeTarget(@NonNull String targetName)

Removes the given targetName from the list of transitionNames that this Transition is interested in animating.

Parameters
@NonNull String targetName

The transitionName of a target view, must not be null.

Returns
@NonNull TransitionSet

The Transition from which the targetName is removed. Returning the same object makes it easier to chain calls during construction, such as transitionSet.addTransitions(new Fade()).removeTargetName(someName);

removeTarget

Added in 1.5.0-alpha06
public @NonNull TransitionSet removeTarget(@NonNull View target)

Removes the given target from the list of targets that this Transition is interested in animating.

Parameters
@NonNull View target

The target view, must be non-null.

Returns
@NonNull TransitionSet

Transition The Transition from which the target is removed. Returning the same object makes it easier to chain calls during construction, such as transitionSet.addTransitions(new Fade()).removeTarget(someView);

removeTransition

Added in 1.0.0
public @NonNull TransitionSet removeTransition(@NonNull Transition transition)

Removes the specified child transition from this set.

Parameters
@NonNull Transition transition

The transition to be removed.

Returns
@NonNull TransitionSet

This transitionSet object.

setDuration

Added in 1.5.0-alpha06
public @NonNull TransitionSet setDuration(long duration)

Setting a non-negative duration on a TransitionSet causes all of the child transitions (current and future) to inherit this duration.

Parameters
long duration

The length of the animation, in milliseconds.

Returns
@NonNull TransitionSet

This transitionSet object.

setEpicenterCallback

public void setEpicenterCallback(
    @Nullable Transition.EpicenterCallback epicenterCallback
)

Sets the callback to use to find the epicenter of a Transition. A null value indicates that there is no epicenter in the Transition and onGetEpicenter() will return null. Transitions like android.transition.Explode use a point or Rect to orient the direction of travel. This is called the epicenter of the Transition and is typically centered on a touched View. The android.transition.Transition.EpicenterCallback allows a Transition to dynamically retrieve the epicenter during a Transition.

Parameters
@Nullable Transition.EpicenterCallback epicenterCallback

The callback to use to find the epicenter of the Transition.

setInterpolator

Added in 1.5.0-alpha06
public @NonNull TransitionSet setInterpolator(@Nullable TimeInterpolator interpolator)

Sets the interpolator of this transition. By default, the interpolator is null, which means that the Animator created by the transition will have its own specified interpolator. If the interpolator of a Transition is set, that interpolator will override the Animator interpolator.

Parameters
@Nullable TimeInterpolator interpolator

The time interpolator used by the transition

Returns
@NonNull TransitionSet

This transition object.

setOrdering

Added in 1.0.0
public @NonNull TransitionSet setOrdering(int ordering)

Sets the play order of this set's child transitions.

Parameters
int ordering

ORDERING_TOGETHER to play this set's child transitions together, ORDERING_SEQUENTIAL to play the child transitions in sequence.

Returns
@NonNull TransitionSet

This transitionSet object.

setPathMotion

public void setPathMotion(@Nullable PathMotion pathMotion)

Sets the algorithm used to calculate two-dimensional interpolation.

Transitions such as android.transition.ChangeBounds move Views, typically in a straight path between the start and end positions. Applications that desire to have these motions move in a curve can change how Views interpolate in two dimensions by extending PathMotion and implementing getPath.

Parameters
@Nullable PathMotion pathMotion

Algorithm object to use for determining how to interpolate in two dimensions. If null, a straight-path algorithm will be used.

setPropagation

public void setPropagation(@Nullable TransitionPropagation transitionPropagation)

Sets the method for determining Animator start delays. When a Transition affects several Views like android.transition.Explode or android.transition.Slide, there may be a desire to have a "wave-front" effect such that the Animator start delay depends on position of the View. The TransitionPropagation specifies how the start delays are calculated.

Parameters
@Nullable TransitionPropagation transitionPropagation

The class used to determine the start delay of Animators created by this Transition. A null value indicates that no delay should be used.

setStartDelay

Added in 1.5.0-alpha06
public @NonNull TransitionSet setStartDelay(long startDelay)

Sets the startDelay of this transition. By default, there is no delay (indicated by a negative number), which means that the Animator created by the transition will have its own specified startDelay. If the delay of a Transition is set, that delay will override the Animator delay.

Parameters
long startDelay

The length of the delay, in milliseconds.

Returns
@NonNull TransitionSet

This transition object.