TransitionSet

Artifact: androidx.transition:transition

View Source

Added in 1.0.0

---

Kotlin |Java

class TransitionSet : Transition

kotlin.Any
↳	androidx.transition.Transition
	↳	androidx.transition.TransitionSet

Known direct subclasses

AutoTransition

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
const 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.
const 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() Constructs an empty transition set.
TransitionSet(context: Context, attrs: AttributeSet)

Public functions
TransitionSet	addListener(listener: Transition.TransitionListener) 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(targetId: @IdRes Int) Adds the id of a target view that this Transition is interested in animating.
TransitionSet	addTarget(targetName: String) Adds the transitionName of a target view that this Transition is interested in animating.
TransitionSet	addTarget(targetType: Class<Any!>) Adds the Class of a target view that this Transition is interested in animating.
TransitionSet	addTarget(target: View) Sets the target view instances that this Transition is interested in animating.
TransitionSet	addTransition(transition: Transition) Adds child transition to this set.
Unit	captureEndValues(transitionValues: TransitionValues) Captures the values in the end scene for the properties that this transition monitors.
Unit	captureStartValues(transitionValues: TransitionValues) Captures the values in the start scene for the properties that this transition monitors.
Transition	clone()
Transition	excludeTarget(targetId: Int, exclude: Boolean) Whether to add the given id to the list of target ids to exclude from this transition.
Transition	excludeTarget(targetName: String, exclude: Boolean) Whether to add the given transitionName to the list of target transitionNames to exclude from this transition.
Transition	excludeTarget(target: View, exclude: Boolean) Whether to add the given target to the list of targets to exclude from this transition.
Transition	excludeTarget(type: Class<Any!>, exclude: Boolean) Whether to add the given type to the list of types to exclude from this transition.
Int	getOrdering() Returns the ordering of this TransitionSet.
Transition?	getTransitionAt(index: Int) Returns the child Transition at the specified position in the TransitionSet.
Int	getTransitionCount() Returns the number of child transitions in the TransitionSet.
Boolean	isSeekingSupported() Returns true if the Transition can be used by controlDelayedTransition.
TransitionSet	removeListener(listener: Transition.TransitionListener) Removes a listener from the set listening to this animation.
TransitionSet	removeTarget(target: Class<Any!>) Removes the given target from the list of targets that this Transition is interested in animating.
TransitionSet	removeTarget(targetId: @IdRes Int) Removes the given targetId from the list of ids that this Transition is interested in animating.
TransitionSet	removeTarget(targetName: String) Removes the given targetName from the list of transitionNames that this Transition is interested in animating.
TransitionSet	removeTarget(target: View) 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(duration: Long) Setting a non-negative duration on a TransitionSet causes all of the child transitions (current and future) to inherit this duration.
Unit	setEpicenterCallback(epicenterCallback: Transition.EpicenterCallback?) Sets the callback to use to find the epicenter of a Transition.
TransitionSet	setInterpolator(interpolator: TimeInterpolator?) Sets the interpolator of this transition.
TransitionSet	setOrdering(ordering: Int) Sets the play order of this set's child transitions.
Unit	setPathMotion(pathMotion: PathMotion?) Sets the algorithm used to calculate two-dimensional interpolation.
Unit	setPropagation(transitionPropagation: TransitionPropagation?) Sets the method for determining Animator start delays.
TransitionSet	setStartDelay(startDelay: Long) Sets the startDelay of this transition.

Inherited Constants
From androidx.transition.Transition const Int MATCH_ID = 3 With setMatchOrder, chooses to match by getId. const Int MATCH_INSTANCE = 1 With setMatchOrder, chooses to match by View instance. const Int MATCH_ITEM_ID = 4 With setMatchOrder, chooses to match by the android.widget.Adapter item id. const Int MATCH_NAME = 2 With setMatchOrder, chooses to match by getTransitionName.

Inherited functions

From androidx.transition.Transition Animator? createAnimator(     sceneRoot: ViewGroup,     startValues: TransitionValues?,     endValues: TransitionValues? ) 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. Transition excludeChildren(targetId: @IdRes Int, exclude: Boolean) Whether to add the children of the given id to the list of targets to exclude from this transition. Transition excludeChildren(target: View, exclude: Boolean) Whether to add the children of given target to the list of target children to exclude from this transition. Transition excludeChildren(type: Class<Any!>, exclude: Boolean) Whether to add the given type to the list of types whose children should be excluded from this transition. Long getDuration() Returns the duration set on this transition. Rect? getEpicenter() Returns the epicenter as specified by the android.transition.Transition.EpicenterCallback or null if no callback exists. Transition.EpicenterCallback? getEpicenterCallback() Returns the callback used to find the epicenter of the Transition. TimeInterpolator? getInterpolator() Returns the interpolator set on this transition. String getName() Returns the name of this Transition. PathMotion getPathMotion() Returns the algorithm object used to interpolate along two dimensions. TransitionPropagation? getPropagation() Returns the android.transition.TransitionPropagation used to calculate Animator start delays. Transition getRootTransition() If this Transition is not part of a TransitionSet, this is returned. Long getStartDelay() Returns the startDelay set on this transition. (Mutable)List<Int!> getTargetIds() Returns the array of target IDs that this transition limits itself to tracking and animating. (Mutable)List<String!>? getTargetNames() Returns the list of target transitionNames that this transition limits itself to tracking and animating. (Mutable)List<Class<Any!>!>? getTargetTypes() Returns the list of target transitionNames that this transition limits itself to tracking and animating. (Mutable)List<View!> getTargets() Returns the array of target views that this transition limits itself to tracking and animating. Array<String!>? getTransitionProperties() 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. TransitionValues? getTransitionValues(view: View, start: Boolean) This method can be called by transitions to get the TransitionValues for any particular view during the transition-playing process. Boolean isTransitionRequired(     startValues: TransitionValues?,     endValues: TransitionValues? ) Returns whether or not the transition should create an Animator, based on the values captured during captureStartValues and captureEndValues. Unit setMatchOrder(matches: IntArray?) Sets the order in which Transition matches View start and end values. String toString()

Constants

ORDERING_SEQUENTIAL

Added in 1.0.0

const val ORDERING_SEQUENTIAL = 1: 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. 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

const val ORDERING_TOGETHER = 0: Int

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

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

TransitionSet(context: Context, attrs: AttributeSet)

Public functions

addListener

fun addListener(listener: Transition.TransitionListener): 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.

Parameters
listener: Transition.TransitionListener	the listener to be added to the current set of listeners for this animation.

Returns
TransitionSet	This transition object.

addTarget

fun addTarget(targetId: @IdRes Int): TransitionSet

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: @IdRes 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);

See also
getId

addTarget

fun addTarget(targetName: String): TransitionSet

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

See also
getTransitionName

addTarget

fun addTarget(targetType: Class<Any!>): TransitionSet

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<Any!>	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);

See also
addTarget
addTarget
excludeTarget
excludeChildren

addTarget

fun addTarget(target: View): TransitionSet

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

See also
addTarget

addTransition

Added in 1.0.0

fun addTransition(transition: Transition): TransitionSet

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
transition: Transition	A non-null child transition to be added to this set.

Returns
TransitionSet	This transitionSet object.

captureEndValues

fun captureEndValues(transitionValues: TransitionValues): Unit

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

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.

See also
captureStartValues
createAnimator

captureStartValues

fun captureStartValues(transitionValues: TransitionValues): Unit

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

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.

See also
captureEndValues
createAnimator

clone

fun clone(): Transition

excludeTarget

fun excludeTarget(targetId: Int, exclude: Boolean): Transition

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: Int	The id of a target to ignore when running this transition.
exclude: Boolean	Whether to add the target to or remove the target from the current list of excluded targets.

Returns
Transition	This transition object.

See also
excludeChildren
excludeTarget
excludeTarget

excludeTarget

fun excludeTarget(targetName: String, exclude: Boolean): Transition

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: String	The name of a target to ignore when running this transition.
exclude: Boolean	Whether to add the target to or remove the target from the current list of excluded targets.

Returns
Transition	This transition object.

See also
excludeTarget
excludeTarget
excludeTarget

excludeTarget

fun excludeTarget(target: View, exclude: Boolean): Transition

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

Returns
Transition	This transition object.

See also
excludeChildren
excludeTarget
excludeTarget

excludeTarget

fun excludeTarget(type: Class<Any!>, exclude: Boolean): Transition

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: Class<Any!>	The type to ignore when running this transition.
exclude: Boolean	Whether to add the target type to or remove it from the current list of excluded target types.

Returns
Transition	This transition object.

See also
excludeChildren
excludeTarget
excludeTarget

getOrdering

Added in 1.0.0

fun getOrdering(): Int

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

fun getTransitionAt(index: Int): Transition?

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

Parameters
index: Int	The position of the Transition to retrieve.

See also
addTransition
getTransitionCount

getTransitionCount

Added in 1.0.0

fun getTransitionCount(): Int

Returns the number of child transitions in the TransitionSet.

Returns
Int	The number of child transitions in the TransitionSet.

See also
addTransition
getTransitionAt

isSeekingSupported

fun isSeekingSupported(): Boolean

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

fun removeListener(listener: Transition.TransitionListener): TransitionSet

Removes a listener from the set listening to this animation.

Parameters
listener: Transition.TransitionListener	the listener to be removed from the current set of listeners for this transition.

Returns
TransitionSet	This transition object.

removeTarget

fun removeTarget(target: Class<Any!>): TransitionSet

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

Parameters
target: Class<Any!>	The type of the target view, must be non-null.

Returns
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

fun removeTarget(targetId: @IdRes Int): TransitionSet

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

Parameters
targetId: @IdRes Int	The id of a target view, must be a positive number.

Returns
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

fun removeTarget(targetName: String): TransitionSet

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

Parameters
targetName: String	The transitionName of a target view, must not be null.

Returns
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

fun removeTarget(target: View): TransitionSet

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

Parameters
target: View	The target view, must be non-null.

Returns
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

fun removeTransition(transition: Transition): TransitionSet

Removes the specified child transition from this set.

Parameters
transition: Transition	The transition to be removed.

Returns
TransitionSet	This transitionSet object.

setDuration

fun setDuration(duration: Long): TransitionSet

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

Parameters
duration: Long	The length of the animation, in milliseconds.

Returns
TransitionSet	This transitionSet object.

setEpicenterCallback

fun setEpicenterCallback(epicenterCallback: Transition.EpicenterCallback?): Unit

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
epicenterCallback: Transition.EpicenterCallback?	The callback to use to find the epicenter of the Transition.

setInterpolator

fun setInterpolator(interpolator: TimeInterpolator?): TransitionSet

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: TimeInterpolator?	The time interpolator used by the transition

Returns
TransitionSet	This transition object.

setOrdering

Added in 1.0.0

fun setOrdering(ordering: Int): TransitionSet

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

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

Returns
TransitionSet	This transitionSet object.

setPathMotion

fun setPathMotion(pathMotion: PathMotion?): Unit

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
pathMotion: PathMotion?	Algorithm object to use for determining how to interpolate in two dimensions. If null, a straight-path algorithm will be used.

See also
ArcMotion
PatternPathMotion
PathMotion

setPropagation

fun setPropagation(transitionPropagation: TransitionPropagation?): Unit

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

fun setStartDelay(startDelay: Long): TransitionSet

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: Long	The length of the delay, in milliseconds.

Returns
TransitionSet	This transition object.