Android APIs
public class

TransitionSet

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

Class Overview

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:ordering="sequential">
         <fade/>
         <changeBounds/>
     </transitionSet>
 

Summary

[Expand]
Inherited XML Attributes
From class android.transition.Transition
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.
[Expand]
Inherited Constants
From class android.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(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(View target)
Sets the target view instances 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.
TransitionSet clone()
Creates and returns a copy of this Object.
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.
Transition excludeTarget(Class type, boolean exclude)
Whether to add the given type to the list of types to exclude from this transition.
Transition excludeTarget(View target, boolean exclude)
Whether to add the given target to the list of targets 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.
[Expand]
Inherited Methods
From class android.transition.Transition
From class java.lang.Object

Constants

public static final int ORDERING_SEQUENTIAL

Added in API level 19

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)

public static final int ORDERING_TOGETHER

Added in API level 19

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

public TransitionSet ()

Added in API level 19

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

public TransitionSet (Context context, AttributeSet attrs)

Added in API level 21

Public Methods

public TransitionSet addListener (Transition.TransitionListener listener)

Added in API level 19

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 the listener to be added to the current set of listeners for this animation.
Returns
  • This transition object.

public TransitionSet addTarget (int targetId)

Added in API level 19

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 underneat the scene root.

Parameters
targetId The id of a target view, must be a positive number.
Returns
  • 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);

public TransitionSet addTarget (Class targetType)

Added in API level 21

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 The type to include when running this transition.
Returns
  • 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);

public TransitionSet addTarget (View target)

Added in API level 19

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 A View on which the Transition will act, must be non-null.
Returns
  • 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);

public TransitionSet addTarget (String targetName)

Added in API level 21

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 The transitionName of a target view, must be non-null.
Returns
  • 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);

public TransitionSet addTransition (Transition transition)

Added in API level 19

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 set on it, the child transition will inherit that duration. Transitions are assumed to have a maximum of one transitionSet parent.

Parameters
transition A non-null child transition to be added to this set.
Returns
  • This transitionSet object.

public void captureEndValues (TransitionValues transitionValues)

Added in API level 19

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(ViewGroup, TransitionValues, TransitionValues). 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(android.view.ViewGroup, TransitionValues, TransitionValues) 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
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.

public void captureStartValues (TransitionValues transitionValues)

Added in API level 19

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(ViewGroup, TransitionValues, TransitionValues). 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(android.view.ViewGroup, TransitionValues, TransitionValues) 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
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.

public TransitionSet clone ()

Added in API level 19

Creates and returns a copy of this Object. The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects.

Returns
  • a copy of this object.

public Transition excludeTarget (String targetName, boolean exclude)

Added in API level 21

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
targetName The name of a target to ignore when running this transition.
exclude Whether to add the target to or remove the target from the current list of excluded targets.
Returns
  • This transition object.

public Transition excludeTarget (int targetId, boolean exclude)

Added in API level 19

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
targetId The id of a target to ignore when running this transition.
exclude Whether to add the target to or remove the target from the current list of excluded targets.
Returns
  • This transition object.

public Transition excludeTarget (Class type, boolean exclude)

Added in API level 19

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
type The type to ignore when running this transition.
exclude Whether to add the target type to or remove it from the current list of excluded target types.
Returns
  • This transition object.

public Transition excludeTarget (View target, boolean exclude)

Added in API level 19

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
target The target to ignore when running this transition.
exclude Whether to add the target to or remove the target from the current list of excluded targets.
Returns
  • This transition object.

public int getOrdering ()

Added in API level 19

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

Returns
See Also

public Transition getTransitionAt (int index)

Added in API level 21

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

Parameters
index The position of the Transition to retrieve.

public int getTransitionCount ()

Added in API level 21

Returns the number of child transitions in the TransitionSet.

Returns
  • The number of child transitions in the TransitionSet.

public TransitionSet removeListener (Transition.TransitionListener listener)

Added in API level 19

Removes a listener from the set listening to this animation.

Parameters
listener the listener to be removed from the current set of listeners for this transition.
Returns
  • This transition object.

public TransitionSet removeTarget (int targetId)

Added in API level 19

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

Parameters
targetId The id of a target view, must be a positive number.
Returns
  • 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);

public TransitionSet removeTarget (View target)

Added in API level 19

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

Parameters
target The target view, must be non-null.
Returns
  • 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);

public TransitionSet removeTarget (String target)

Added in API level 21

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

Parameters
target The transitionName of a target view, must not be null.
Returns
  • 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);

public TransitionSet removeTarget (Class target)

Added in API level 21

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

Parameters
target The type of the target view, must be non-null.
Returns
  • 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);

public TransitionSet removeTransition (Transition transition)

Added in API level 19

Removes the specified child transition from this set.

Parameters
transition The transition to be removed.
Returns
  • This transitionSet object.

public TransitionSet setDuration (long duration)

Added in API level 19

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

Parameters
duration The length of the animation, in milliseconds.
Returns
  • This transitionSet object.

public void setEpicenterCallback (Transition.EpicenterCallback epicenterCallback)

Added in API level 21

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 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 Transition.EpicenterCallback allows a Transition to dynamically retrieve the epicenter during a Transition.

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

public TransitionSet setInterpolator (TimeInterpolator interpolator)

Added in API level 19

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
interpolator The time interpolator used by the transition
Returns
  • This transition object.

public TransitionSet setOrdering (int ordering)

Added in API level 19

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

Parameters
ordering ORDERING_TOGETHER to play this set's child transitions together, ORDERING_SEQUENTIAL to play the child transitions in sequence.
Returns
  • This transitionSet object.

public void setPathMotion (PathMotion pathMotion)

Added in API level 21

Sets the algorithm used to calculate two-dimensional interpolation.

Transitions such as 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(float, float, float, float).

When describing in XML, use a nested XML tag for the path motion. It can be one of the built-in tags arcMotion or patternPathMotion or it can be a custom PathMotion using pathMotion with the class attributed with the fully-described class name. For example:

 <changeBounds>
     <pathMotion class="my.app.transition.MyPathMotion"/>
 </changeBounds>
 
 

or

 <changeBounds>
   <arcMotion android:minimumHorizontalAngle="15"
     android:minimumVerticalAngle="0" android:maximumAngle="90"/>
 </changeBounds>
 
 

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

public void setPropagation (TransitionPropagation propagation)

Added in API level 21

Sets the method for determining Animator start delays. When a Transition affects several Views like Explode or 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
propagation The class used to determine the start delay of Animators created by this Transition. A null value indicates that no delay should be used.

public TransitionSet setStartDelay (long startDelay)

Added in API level 19

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
startDelay The length of the delay, in milliseconds.
Returns
  • This transition object.