Stay organized with collections Save and categorize content based on your preferences.
added in version 25.1.0
belongs to Maven artifact com.android.support:transition:28.0.0-alpha1

TransitionSet

public class TransitionSet
extends Transition

java.lang.Object
   ↳ android.support.transition.Transition
     ↳ android.support.transition.TransitionSet
Known Direct Subclasses


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

int ORDERING_SEQUENTIAL

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.

int ORDERING_TOGETHER

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

Inherited constants

From class android.support.transition.Transition

Public constructors

TransitionSet()

Constructs an empty transition set.

TransitionSet(Context context, AttributeSet attrs)

Public methods

TransitionSet addListener(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.

TransitionSet addTarget(View target)

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

TransitionSet addTarget(int targetId)

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

TransitionSet addTarget(Class targetType)

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

TransitionSet addTarget(String targetName)

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

TransitionSet addTransition(Transition transition)

Adds child transition to this set.

void captureEndValues(TransitionValues transitionValues)

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

void captureStartValues(TransitionValues transitionValues)

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

Transition clone()
Transition excludeTarget(View target, boolean exclude)

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

Transition excludeTarget(Class type, boolean exclude)

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

Transition excludeTarget(String targetName, boolean exclude)

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

Transition excludeTarget(int targetId, boolean exclude)

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

int getOrdering()

Returns the ordering of this TransitionSet.

Transition getTransitionAt(int index)

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

int getTransitionCount()

Returns the number of child transitions in the TransitionSet.

TransitionSet removeListener(Transition.TransitionListener listener)

Removes a listener from the set listening to this animation.

TransitionSet removeTarget(int targetId)

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

TransitionSet removeTarget(View target)

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

TransitionSet removeTarget(String target)

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

TransitionSet removeTarget(Class target)

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

TransitionSet removeTransition(Transition transition)

Removes the specified child transition from this set.

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 setEpicenterCallback(Transition.EpicenterCallback epicenterCallback)

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

TransitionSet setInterpolator(TimeInterpolator interpolator)

Sets the interpolator of this transition.

TransitionSet setOrdering(int ordering)

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

void setPathMotion(PathMotion pathMotion)

Sets the algorithm used to calculate two-dimensional interpolation.

void setPropagation(TransitionPropagation propagation)

Sets the method for determining Animator start delays.

TransitionSet setStartDelay(long startDelay)

Sets the startDelay of this transition.

Inherited methods

From class android.support.transition.Transition
From class java.lang.Object

Constants

ORDERING_SEQUENTIAL

added in version 25.1.0
int ORDERING_SEQUENTIAL

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.

Constant Value: 1 (0x00000001)

ORDERING_TOGETHER

added in version 25.1.0
int ORDERING_TOGETHER

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

Constant Value: 0 (0x00000000)

Public constructors

TransitionSet

added in version 25.1.0
TransitionSet ()

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

TransitionSet

added in version 26.1.0
TransitionSet (Context context, 
                AttributeSet attrs)

Parameters
context Context

attrs AttributeSet

Public methods

addListener

added in version 25.1.0
TransitionSet addListener (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
listener Transition.TransitionListener: the listener to be added to the current set of listeners for this animation.

Returns
TransitionSet This transition object.

addTarget

added in version 25.1.0
TransitionSet addTarget (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(int) should be used instead of addTarget(View). 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
target View: A View on which the Transition will act, must be non-null.

Returns
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);

addTarget

added in version 25.1.0
TransitionSet addTarget (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
targetId int: The id of a target view, must be a positive number.

Returns
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);

addTarget

added in version 26.1.0
TransitionSet addTarget (Class 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
targetType Class: The type to include when running this transition.

Returns
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 version 26.1.0
TransitionSet addTarget (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
targetName String: The transitionName of a target view, must be non-null.

Returns
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);

addTransition