Added in API level 19

TransitionSet


open class TransitionSet : Transition
kotlin.Any
   ↳ android.transition.Transition
   ↳ android.transition.TransitionSet

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 android.R.styleable#TransitionSet and android.R.styleable#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

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

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

Inherited constants
Public constructors

Constructs an empty transition set.

TransitionSet(context: Context!, attrs: AttributeSet!)

Public methods
open TransitionSet!

open TransitionSet!
addTarget(target: View!)

open TransitionSet!
addTarget(targetId: Int)

open TransitionSet!
addTarget(targetName: String!)

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

open TransitionSet!
addTransition(transition: Transition!)

Adds child transition to this set.

open Unit
captureEndValues(transitionValues: TransitionValues!)

open Unit

open TransitionSet

open Transition!
excludeTarget(target: View!, exclude: Boolean)

open Transition!
excludeTarget(targetName: String!, exclude: Boolean)

open Transition!
excludeTarget(targetId: Int, exclude: Boolean)

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

open Int

Returns the ordering of this TransitionSet.

open Transition!

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

open Int

Returns the number of child transitions in the TransitionSet.

open TransitionSet!

open TransitionSet!
removeTarget(targetId: Int)

open TransitionSet!
removeTarget(target: View!)

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

open TransitionSet!
removeTarget(target: String!)

open TransitionSet!

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

open TransitionSet!

open TransitionSet!
setOrdering(ordering: Int)

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

open Unit
setPathMotion(pathMotion: PathMotion!)

open Unit

open TransitionSet!
setStartDelay(startDelay: Long)

Inherited functions

Constants

ORDERING_SEQUENTIAL

Added in API level 19
static val ORDERING_SEQUENTIAL: 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.

Value: 1

ORDERING_TOGETHER

Added in API level 19
static val ORDERING_TOGETHER: Int

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

Value: 0

Public constructors

TransitionSet

Added in API level 19
TransitionSet()

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

TransitionSet

Added in API level 21
TransitionSet(
    context: Context!,
    attrs: AttributeSet!)

Public methods

addListener

Added in API level 19
open fun addListener(listener: Transition.TransitionListener!): TransitionSet!
Parameters
listener Transition.TransitionListener!: the listener to be added to the current set of listeners for this animation.
Return
TransitionSet! This transition object.

addTarget

Added in API level 19
open fun addTarget(target: View!): TransitionSet!
Parameters
target View!: A View on which the Transition will act, must be non-null.
Return
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 API level 19
open fun addTarget(targetId: Int): TransitionSet!
Parameters
targetId Int: The id of a target view, must be a positive number.
Return
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 API level 21
open fun addTarget(targetName: String!): TransitionSet!
Parameters
targetName String!: The transitionName of a target view, must be non-null.
Return
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 API level 21
open fun addTarget(targetType: Class<Any!>!): TransitionSet!
Parameters
targetType Class<Any!>!: The type to include when running this transition.
Return
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);

addTransition

Added in API level 19
open 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.
Return
TransitionSet! This transitionSet object.

captureEndValues

Added in API level 19
open fun captureEndValues(transitionValues: TransitionValues!): Unit
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.

captureStartValues

Added in API level 19
open fun captureStartValues(transitionValues: TransitionValues!): Unit
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.

clone

Added in API level 19
open fun clone(): TransitionSet
Return
TransitionSet a clone of this instance.
Exceptions
java.lang.CloneNotSupportedException if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

excludeTarget

Added in API level 19
open fun excludeTarget(
    target: View!,
    exclude: Boolean
): Transition!
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.
Return
Transition! This transition object.

excludeTarget

Added in API level 21
open fun excludeTarget(
    targetName: String!,
    exclude: Boolean
): Transition!
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.
Return
Transition! This transition object.

excludeTarget

Added in API level 19
open fun excludeTarget(
    targetId: Int,
    exclude: Boolean
): Transition!
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.
Return
Transition! This transition object.

excludeTarget

Added in API level 19
open fun excludeTarget(
    type: Class<Any!>!,
    exclude: Boolean
): Transition!
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.
Return
Transition! This transition object.

getOrdering

Added in API level 19
open fun getOrdering(): Int

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

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

getTransitionAt

Added in API level 21
open 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.

getTransitionCount

Added in API level 21
open fun getTransitionCount(): Int

Returns the number of child transitions in the TransitionSet.

Return
Int The number of child transitions in the TransitionSet.

removeListener

Added in API level 19
open fun removeListener(listener: Transition.TransitionListener!): TransitionSet!
Parameters
listener Transition.TransitionListener!: the listener to be removed from the current set of listeners for this transition.
Return
TransitionSet! This transition object.

removeTarget

Added in API level 19
open fun removeTarget(targetId: Int): TransitionSet!
Parameters
targetId Int: The id of a target view, must be a positive number.
Return
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 API level 19
open fun removeTarget(target: View!): TransitionSet!
Parameters
target View!: The target view, must be non-null.
Return
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);

removeTarget

Added in API level 21
open fun removeTarget(target: Class<Any!>!): TransitionSet!
Parameters
target Class<Any!>!: The type of the target view, must be non-null.
Return
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 API level 21
open fun removeTarget(target: String!): TransitionSet!
Parameters
targetName The transitionName of a target view, must not be null.
Return
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);

removeTransition

Added in API level 19
open fun removeTransition(transition: Transition!): TransitionSet!

Removes the specified child transition from this set.

Parameters
transition Transition!: The transition to be removed.
Return
TransitionSet! This transitionSet object.

setDuration

Added in API level 19
open 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.
Return
TransitionSet! This transitionSet object.

setEpicenterCallback

Added in API level 21
open fun setEpicenterCallback(epicenterCallback: Transition.EpicenterCallback!): Unit
Parameters
epicenterCallback Transition.EpicenterCallback!: The callback to use to find the epicenter of the Transition.

setInterpolator

Added in API level 19
open fun setInterpolator(interpolator: TimeInterpolator!): TransitionSet!
Parameters
interpolator TimeInterpolator!: The time interpolator used by the transition
Return
TransitionSet! This transition object.

setOrdering

Added in API level 19
open 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.
Return
TransitionSet! This transitionSet object.

setPathMotion

Added in API level 21
open fun setPathMotion(pathMotion: PathMotion!): Unit
Parameters
pathMotion PathMotion!: Algorithm object to use for determining how to interpolate in two dimensions. If null, a straight-path algorithm will be used.

setPropagation

Added in API level 21
open fun setPropagation(propagation: TransitionPropagation!): Unit
Parameters
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 API level 19
open fun setStartDelay(startDelay: Long): TransitionSet!
Parameters
startDelay Long: The length of the delay, in milliseconds.
Return
TransitionSet! This transition object.