TransitionSet

Kotlin |Java

open 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
static 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.
static 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 Transition Int MATCH_ID With setMatchOrder(int...), chooses to match by android.view.View#getId(). Negative IDs will not be matched. Int MATCH_INSTANCE With setMatchOrder(int...), chooses to match by View instance. Int MATCH_ITEM_ID With setMatchOrder(int...), chooses to match by the android.widget.Adapter item id. When android.widget.Adapter#hasStableIds() returns false, no match will be made for items. Int MATCH_NAME With setMatchOrder(int...), chooses to match by android.view.View#getTransitionName(). Null names will not be matched.

Public constructors
<init>() Constructs an empty transition set.
<init>(@NonNull context: Context, @NonNull attrs: AttributeSet)

Public methods
open TransitionSet	addListener(@NonNull listener: Transition.TransitionListener)
open TransitionSet	addTarget(@NonNull target: View)
open TransitionSet	addTarget(@IdRes targetId: Int)
open TransitionSet	addTarget(@NonNull targetName: String)
open TransitionSet	addTarget(@NonNull targetType: Class<*>)
open TransitionSet	addTransition(@NonNull transition: Transition) Adds child transition to this set.
open Unit	captureEndValues(@NonNull transitionValues: TransitionValues)
open Unit	captureStartValues(@NonNull transitionValues: TransitionValues)
open Transition	clone()
open Transition	excludeTarget(@NonNull target: View, exclude: Boolean)
open Transition	excludeTarget(@NonNull targetName: String, exclude: Boolean)
open Transition	excludeTarget(targetId: Int, exclude: Boolean)
open Transition	excludeTarget(@NonNull type: Class<*>, exclude: Boolean)
open Int	getOrdering() Returns the ordering of this TransitionSet.
open Transition?	getTransitionAt(index: Int) Returns the child Transition at the specified position in the TransitionSet.
open Int	getTransitionCount() Returns the number of child transitions in the TransitionSet.
open TransitionSet	removeListener(@NonNull listener: Transition.TransitionListener)
open TransitionSet	removeTarget(@IdRes targetId: Int)
open TransitionSet	removeTarget(@NonNull target: View)
open TransitionSet	removeTarget(@NonNull target: Class<*>)
open TransitionSet	removeTarget(@NonNull target: String)
open TransitionSet	removeTransition(@NonNull transition: Transition) Removes the specified child transition from this set.
open 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.
open Unit	setEpicenterCallback(epicenterCallback: Transition.EpicenterCallback?)
open TransitionSet	setInterpolator(@Nullable interpolator: TimeInterpolator?)
open TransitionSet	setOrdering(ordering: Int) Sets the play order of this set's child transitions.
open Unit	setPathMotion(pathMotion: PathMotion?)
open Unit	setPropagation(propagation: TransitionPropagation?)
open TransitionSet	setStartDelay(startDelay: Long)

Inherited functions

From class Transition Animator? createAnimator(@NonNull sceneRoot: ViewGroup, @Nullable startValues: TransitionValues?, @Nullable 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. Subclasses of Transition should override this method. The method should only be called by the transition system; it is not intended to be called from external classes. This method is called by the transition's parent (all the way up to the topmost Transition in the hierarchy) with the sceneRoot and start/end values that the transition may need to set up initial target values and construct an appropriate animation. For example, if an overall Transition is a TransitionSet consisting of several child transitions in sequence, then some of the child transitions may want to set initial values on target views prior to the overall Transition commencing, to put them in an appropriate state for the delay between that start and the child Transition start time. For example, a transition that fades an item in may wish to set the starting alpha value to 0, to avoid it blinking in prior to the transition actually starting the animation. This is necessary because the scene change that triggers the Transition will automatically set the end-scene on all target views, so a Transition that wants to animate from a different value should set that value prior to returning from this method. Additionally, a Transition can perform logic to determine whether the transition needs to run on the given target and start/end values. For example, a transition that resizes objects on the screen may wish to avoid running for views which are not present in either the start or end scenes. If there is an animator created and returned from this method, the transition mechanism will apply any applicable duration, startDelay, and interpolator to that animation and start it. A return value of null indicates that no animation should run. The default implementation returns null. The method is called for every applicable target object, which is stored in the TransitionValues#view field. Transition excludeChildren(@NonNull target: View, exclude: Boolean) Whether to add the children of given target to the list of target children 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). Transition excludeChildren(@IdRes targetId: Int, exclude: Boolean) Whether to add the children of the given id to the list of targets to exclude from this transition. The exclude parameter specifies whether the children of the target should be added to or removed from the excluded list. Excluding children in this way provides a simple mechanism for excluding all children of specific targets, rather than individually excluding each child individually. 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). Transition excludeChildren(@NonNull type: Class<*>, exclude: Boolean) Whether to add the given type to the list of types whose children should be excluded 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 h