Transition

Kotlin |Java

abstract class Transition : Cloneable

kotlin.Any
↳	android.transition.Transition

Known Direct Subclasses

ChangeBounds, ChangeClipBounds, ChangeImageTransform, ChangeScroll, ChangeTransform, TransitionSet, Visibility

ChangeBounds	This transition captures the layout bounds of target views before and after the scene change and animates those changes during the transition.
ChangeClipBounds	ChangeClipBounds captures the `android.view.View#getClipBounds()` before and after the scene change and animates those changes during the transition.
ChangeImageTransform	This Transition captures an ImageView's matrix before and after the scene change and animates it during the transition.
ChangeScroll	This transition captures the scroll properties of targets before and after the scene change and animates any changes.
ChangeTransform	This Transition captures scale and rotation for Views before and after the scene change and animates those changes during the transition.
TransitionSet	A TransitionSet is a parent of child transitions (including other TransitionSets).
Visibility	This transition tracks changes to the visibility of target views in the start and end scenes.

Known Indirect Subclasses

AutoTransition, Explode, Fade, Slide

AutoTransition	Utility class for creating a default transition that automatically fades, moves, and resizes views during a scene change.
Explode	This transition tracks changes to the visibility of target views in the start and end scenes and moves views in or out from the edges of the scene.
Fade	This transition tracks changes to the visibility of target views in the start and end scenes and fades views in or out when they become visible or non-visible.
Slide	This transition tracks changes to the visibility of target views in the start and end scenes and moves views in or out from one of the edges of the scene.

A Transition holds information about animations that will be run on its targets during a scene change. Subclasses of this abstract class may choreograph several child transitions (TransitionSet or they may perform custom animations themselves. Any Transition has two main jobs: (1) capture property values, and (2) play animations based on changes to captured property values. A custom transition knows what property values on View objects are of interest to it, and also knows how to animate changes to those values. For example, the Fade transition tracks changes to visibility-related properties and is able to construct and run animations that fade items in or out based on changes to those properties.

Note: Transitions may not work correctly with either SurfaceView or TextureView, due to the way that these views are displayed on the screen. For SurfaceView, the problem is that the view is updated from a non-UI thread, so changes to the view due to transitions (such as moving and resizing the view) may be out of sync with the display inside those bounds. TextureView is more compatible with transitions in general, but some specific transitions (such as Fade) may not be compatible with TextureView because they rely on ViewOverlay functionality, which does not currently work with TextureView.

Transitions can be declared in XML resource files inside the res/transition directory. Transition resources consist of a tag name for one of the Transition subclasses along with attributes to define some of the attributes of that transition. For example, here is a minimal resource file that declares a ChangeBounds transition:

This TransitionSet contains android.transition.Explode for visibility, android.transition.ChangeBounds, android.transition.ChangeTransform, and android.transition.ChangeClipBounds and android.transition.ChangeImageTransform:

Custom transition classes may be instantiated with a transition tag:

<transition class="my.app.transition.CustomTransition"/>

Custom transition classes loaded from XML should have a public constructor taking a android.content.Context and android.util.AttributeSet.

Note that attributes for the transition are not required, just as they are optional when declared in code; Transitions created from XML resources will use the same defaults as their code-created equivalents. Here is a slightly more elaborate example which declares a TransitionSet transition with ChangeBounds and Fade child transitions:

In this example, the transitionOrdering attribute is used on the TransitionSet object to change from the default TransitionSet.ORDERING_TOGETHER behavior to be TransitionSet.ORDERING_SEQUENTIAL instead. Also, the Fade transition uses a fadingMode of Fade.OUT instead of the default out-in behavior. Finally, note the use of the targets sub-tag, which takes a set of target tags, each of which lists a specific targetId, targetClass, targetName, excludeId, excludeClass, or excludeName, which this transition acts upon. Use of targets is optional, but can be used to either limit the time spent checking attributes on unchanging views, or limiting the types of animations run on specific views. In this case, we know that only the grayscaleContainer will be disappearing, so we choose to limit the Fade transition to only that view.

Further information on XML resource descriptions for transitions can be found for android.R.styleable#Transition, android.R.styleable#TransitionSet, android.R.styleable#TransitionTarget, android.R.styleable#Fade, android.R.styleable#Slide, and android.R.styleable#ChangeTransform.

Summary

Nested classes
abstract	`EpicenterCallback` Class to get the epicenter of Transition.
abstract	`TransitionListener` A transition listener receives notifications from a transition.

Constants
static Int	`MATCH_ID` With `setMatchOrder(int...)`, chooses to match by `android.view.View#getId()`.
static Int	`MATCH_INSTANCE` With `setMatchOrder(int...)`, chooses to match by View instance.
static Int	`MATCH_ITEM_ID` With `setMatchOrder(int...)`, chooses to match by the `android.widget.Adapter` item id.
static Int	`MATCH_NAME` With `setMatchOrder(int...)`, chooses to match by `android.view.View#getTransitionName()`.

Public constructors
`Transition()` Constructs a Transition object with no target objects.
`Transition(context: Context!, attrs: AttributeSet!)` Perform inflation from XML and apply a class-specific base style from a theme attribute or style resource.

Public methods
open Transition!	`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.
open Transition!	`addTarget(target: View!)` Sets the target view instances that this Transition is interested in animating.
open Transition!	`addTarget(targetId: Int)` Adds the id of a target view that this Transition is interested in animating.
open Transition!	`addTarget(targetType: Class<Any!>!)` Adds the Class of a target view that this Transition is interested in animating.
open Transition!	`addTarget(targetName: String!)` Adds the transitionName of a target view that this Transition is interested in animating.
open Boolean	`canRemoveViews()`
abstract Unit	`captureEndValues(transitionValues: TransitionValues!)` Captures the values in the end scene for the properties that this transition monitors.
abstract Unit	`captureStartValues(transitionValues: TransitionValues!)` Captures the values in the start scene for the properties that this transition monitors.
open Transition	`clone()` Creates and returns a copy of this object.
open 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.
open 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.
open Transition!	`excludeChildren(targetId: Int, exclude: Boolean)` Whether to add the children of the given id to the list of targets to exclude from this transition.
open 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.
open Transition!	`excludeTarget(target: View!, exclude: Boolean)` Whether to add the given target to the list of targets to exclude from this transition.
open Transition!	`excludeTarget(targetId: Int, exclude: Boolean)` Whether to add the given id to the list of target ids to exclude from this transition.
open Transition!	`excludeTarget(type: Class<Any!>!, exclude: Boolean)` Whether to add the given type to the list of types to exclude from this transition.
open Transition!	`excludeTarget(targetName: String!, exclude: Boolean)` Whether to add the given transitionName to the list of target transitionNames to exclude from this transition.
open Long	`getDuration()` Returns the duration set on this transition.
open Rect!	`getEpicenter()` Returns the epicenter as specified by the `android.transition.Transition.EpicenterCallback` or null if no callback exists.
open Transition.EpicenterCallback!	`getEpicenterCallback()` Returns the callback used to find the epicenter of the Transition.
open TimeInterpolator!	`getInterpolator()` Returns the interpolator set on this transition.
open String!	`getName()` Returns the name of this Transition.
open PathMotion!	`getPathMotion()` Returns the algorithm object used to interpolate along two dimensions.
open TransitionPropagation!	`getPropagation()` Returns the `android.transition.TransitionPropagation` used to calculate Animator start delays.
open Long	`getStartDelay()` Returns the startDelay set on this transition.
open MutableList<Int!>!	`getTargetIds()` Returns the list of target IDs that this transition limits itself to tracking and animating.
open MutableList<String!>!	`getTargetNames()` Returns the list of target transitionNames that this transition limits itself to tracking and animating.
open MutableList<Class<Any!>!>!	`getTargetTypes()` Returns the list of target transitionNames that this transition limits itself to tracking and animating.
open MutableList<View!>!	`getTargets()` Returns the list of target views that this transition limits itself to tracking and animating.
open Array<String!>!	`getTransitionProperties()` Returns the set of property names used stored in the `TransitionValues` object passed into `captureStartValues(TransitionValues)` that this transition cares about for the purposes of canceling overlapping animations.
open 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.
open Boolean	`isTransitionRequired(startValues: TransitionValues?, endValues: TransitionValues?)` Returns whether or not the transition should create an Animator, based on the values captured during `captureStartValues(TransitionValues)` and `captureEndValues(TransitionValues)`.
open Transition!	`removeListener(listener: Transition.TransitionListener!)` Removes a listener from the set listening to this animation.
open Transition!	`removeTarget(target: View!)` Removes the given target from the list of targets that this Transition is interested in animating.
open Transition!	`removeTarget(targetId: Int)` Removes the given targetId from the list of ids that this Transition is interested in animating.
open Transition!	`removeTarget(target: Class<Any!>!)` Removes the given target from the list of targets that this Transition is interested in animating.
open Transition!	`removeTarget(targetName: String!)` Removes the given targetName from the list of transitionNames that this Transition is interested in animating.
open Transition!	`setDuration(duration: Long)` Sets the duration of this transition.
open Unit	`setEpicenterCallback(epicenterCallback: Transition.EpicenterCallback!)` Sets the callback to use to find the epicenter of a Transition.
open Transition!	`setInterpolator(interpolator: TimeInterpolator!)` Sets the interpolator of this transition.
open Unit	`setMatchOrder(vararg matches: Int)` Sets the order in which Transition matches View start and end values.
open Unit	`setPathMotion(pathMotion: PathMotion!)` Sets the algorithm used to calculate two-dimensional interpolation.
open Unit	`setPropagation(transitionPropagation: TransitionPropagation!)` Sets the method for determining Animator start delays.
open Transition!	`setStartDelay(startDelay: Long)` Sets the startDelay of this transition.
open String	`toString()` Returns a string representation of the object.

Constants

MATCH_ID

Added in API level 21

static val MATCH_ID: Int

With setMatchOrder(int...), chooses to match by android.view.View#getId(). Negative IDs will not be matched.

Value: 3

MATCH_INSTANCE

Added in API level 21

static val MATCH_INSTANCE: Int

With setMatchOrder(int...), chooses to match by View instance.

Value: 1

MATCH_ITEM_ID

Added in API level 21

static val MATCH_ITEM_ID: Int

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.

Value: 4

MATCH_NAME

Added in API level 21

static val MATCH_NAME: Int

With setMatchOrder(int...), chooses to match by android.view.View#getTransitionName(). Null names will not be matched.

Value: 2

Public constructors

Transition

Added in API level 19

Transition()

Constructs a Transition object with no target objects. A transition with no targets defaults to running on all target objects in the scene hierarchy (if the transition is not contained in a TransitionSet), or all target objects passed down from its parent (if it is in a TransitionSet).

Transition

Added in API level 21

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

Perform inflation from XML and apply a class-specific base style from a theme attribute or style resource. This constructor of Transition allows subclasses to use their own base style when they are inflating.

Parameters
`context`	Context!: The Context the transition is running in, through which it can access the current theme, resources, etc.
`attrs`	AttributeSet!: The attributes of the XML tag that is inflating the transition.

Public methods

addListener

Added in API level 19

open fun addListener(listener: Transition.TransitionListener!): Transition!

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.

Return
`Transition!`	This transition object.

addTarget

Added in API level 19

open fun addTarget(target: View!): Transition!

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 in