Added in API level 19

Fade

Kotlin |Java

public class Fade
extends Visibility

java.lang.Object
↳	android.transition.Transition
	↳	android.transition.Visibility
		↳	android.transition.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. Visibility is determined by both the View.setVisibility(int) state of the view as well as whether it is parented in the current view hierarchy.

The ability of this transition to fade out a particular view, and the way that that fading operation takes place, is based on the situation of the view in the view hierarchy. For example, if a view was simply removed from its parent, then the view will be added into a ViewGroupOverlay while fading. If a visible view is changed to be View.GONE or View.INVISIBLE, then the visibility will be changed to View.VISIBLE for the duration of the animation. However, if a view is in a hierarchy which is also altering its visibility, the situation can be more complicated. In general, if a view that is no longer in the hierarchy in the end scene still has a parent (so its parent hierarchy was removed, but it was not removed from its parent), then it will be left alone to avoid side-effects from improperly removing it from its parent. The only exception to this is if the previous Scene was created from a layout resource file, then it is considered safe to un-parent the starting scene view in order to fade it out.

A Fade transition can be described in a resource file by using the tag fade, along with the standard attributes of R.styleable.Fade and R.styleable.Transition.

Summary

Inherited XML attributes

From class android.transition.Visibility

android:transitionVisibilityMode Changes whether the transition supports appearing and/or disappearing Views.

From class android.transition.Transition

`android:duration`	Amount of time (in milliseconds) that the transition should run.
`android:interpolator`	Interpolator to be used in the animations spawned by this transition.
`android:startDelay`	Delay in milliseconds before the transition starts.

Constants
`int`	`IN` Fading mode used in `Fade(int)` to make the transition operate on targets that are appearing.
`int`	`OUT` Fading mode used in `Fade(int)` to make the transition operate on targets that are disappearing.

Inherited constants

From class android.transition.Visibility

`int`	`MODE_IN` Mode used in `setMode(int)` to make the transition operate on targets that are appearing.
`int`	`MODE_OUT` Mode used in `setMode(int)` to make the transition operate on targets that are disappearing.

From class android.transition.Transition

`int`	`MATCH_ID` With `setMatchOrder(int)`, chooses to match by `View.getId()`.
`int`	`MATCH_INSTANCE` With `setMatchOrder(int)`, chooses to match by View instance.
`int`	`MATCH_ITEM_ID` With `setMatchOrder(int)`, chooses to match by the `Adapter` item id.
`int`	`MATCH_NAME` With `setMatchOrder(int)`, chooses to match by `View.getTransitionName()`.

Public constructors
`Fade()` Constructs a Fade transition that will fade targets in and out.
`Fade(Context context, AttributeSet attrs)`
`Fade(int fadingMode)` Constructs a Fade transition that will fade targets in and/or out, according to the value of fadingMode.

Public methods
`void`	`captureStartValues(TransitionValues transitionValues)` Captures the values in the start scene for the properties that this transition monitors.
`Animator`	`onAppear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)` The default implementation of this method returns a null Animator.
`Animator`	`onDisappear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)` The default implementation of this method returns a null Animator.

Inherited methods

From class


        
          android.transition.Visibility

`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.
`Animator`	`createAnimator(ViewGroup sceneRoot, TransitionValues startValues, TransitionValues endValues)` 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.
`int`	`getMode()` Returns whether appearing and/or disappearing Views are supported.
`String[]`	`getTransitionProperties()` Returns the set of property names used stored in the `TransitionValues` object passed into `captureStartValues(android.transition.TransitionValues)` that this transition cares about for the purposes of canceling overlapping animations.
`boolean`	`isTransitionRequired(TransitionValues startValues, TransitionValues newValues)` Returns whether or not the transition should create an Animator, based on the values captured during `captureStartValues(android.transition.TransitionValues)` and `captureEndValues(android.transition.TransitionValues)`.
`boolean`	`isVisible(TransitionValues values)` Returns whether the view is 'visible' according to the given values object.
`Animator`	`onAppear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)` The default implementation of this method returns a null Animator.
`Animator`	`onAppear(ViewGroup sceneRoot, TransitionValues startValues, int startVisibility, TransitionValues endValues, int endVisibility)` The default implementation of this method calls `onAppear(android.view.ViewGroup, android.view.View, android.transition.TransitionValues, android.transition.TransitionValues)`.
`Animator`	`onDisappear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)` The default implementation of this method returns a null Animator.
`Animator`	`onDisappear(ViewGroup sceneRoot, TransitionValues startValues, int startVisibility, TransitionValues endValues, int endVisibility)` Subclasses should override this method or `onDisappear(android.view.ViewGroup, android.view.View, android.transition.TransitionValues, android.transition.TransitionValues)` if they need to create an Animator when targets disappear.
`void`	`setMode(int mode)` Changes the transition to support appearing and/or disappearing Views, depending on `mode`.

From class


        
          android.transition.Transition

`Transition`	`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.
`Transition`	`addTarget(View target)` Sets the target view instances that this Transition is interested in animating.
`Transition`	`addTarget(int targetId)` Adds the id of a target view that this Transition is interested in animating.
`Transition`	`addTarget(Class<T> targetType)` Adds the Class of a target view that this Transition is interested in animating.
`Transition`	`addTarget(String targetName)` Adds the transitionName of a target view that this Transition is interested in animating.
`boolean`	`canRemoveViews()`
`abstract void`	`captureEndValues(TransitionValues transitionValues)` Captures the values in the end scene for the properties that this transition monitors.
`abstract void`	`captureStartValues(TransitionValues transitionValues)` Captures the values in the start scene for the properties that this transition monitors.
`Transition`	`clone()` Creates and returns a copy of this object.
`Animator`	`createAnimator(ViewGroup sceneRoot, TransitionValues startValues, TransitionValues endValues)` 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(int targetId, boolean exclude)` Whether to add the children of the given id to the list of targets to exclude from this transition.
`Transition`	`excludeChildren(Class<T> type, boolean exclude)` Whether to add the given type to the list of types whose children should be excluded from this transition.
`Transition`	`excludeChildren(View target, boolean exclude)` Whether to add the children of given target to the list of target children 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.
`Transition`	`excludeTarget(Class<T> type, boolean exclude)` Whether to add the given type to the list of types to exclude from this transition.
`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.
`long`	`getDuration()` Returns the duration set on this transition.
`Rect`	`getEpicenter()` Returns the epicenter as specified by the `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 `TransitionPropagation` used to calculate Animator start delays.
`long`	`getStartDelay()` Returns the startDelay set on this transition.
`List<Integer>`	`getTargetIds()` Returns the list of target IDs that this transition limits itself to tracking and animating.
`List<String>`	`getTargetNames()` Returns the list of target transitionNames that this transition limits itself to tracking and animating.
`List<Class<T>>`	`getTargetTypes()` Returns the list of target transitionNames that this transition limits itself to tracking and animating.
`List<View>`	`getTargets()` Returns the list of target views that this transition limits itself to tracking and animating.
`String[]`	`getTransitionProperties()` Returns the set of property names used stored in the `TransitionValues` object passed into `captureStartValues(android.transition.TransitionValues)` that this transition cares about for the purposes of canceling overlapping animations.
`TransitionValues`	`getTransitionValues(View view, boolean start)` This method can be called by transitions to get the TransitionValues for any particular view during the transition-playing process.
`boolean`	`isTransitionRequired(TransitionValues startValues, TransitionValues endValues)` Returns whether or not the transition should create an Animator, based on the values captured during `captureStartValues(android.transition.TransitionValues)` and `captureEndValues(android.transition.TransitionValues)`.
`Transition`	`removeListener(Transition.TransitionListener listener)` Removes a listener from the set listening to this animation.
`Transition`	`removeTarget(int targetId)` Removes the given targetId from the list of ids that this Transition is interested in animating.
`Transition`	`removeTarget(View target)` Removes the given target from the list of targets that this Transition is interested in animating.
`Transition`	`removeTarget(String targetName)` Removes the given targetName from the list of transitionNames that this Transition is interested in animating.
`Transition`	`removeTarget(Class<T> target)` Removes the given target from the list of targets that this Transition is interested in animating.
`Transition`	`setDuration(long duration)` Sets the duration of this transition.
`void`	`setEpicenterCallback(Transition.EpicenterCallback epicenterCallback)` Sets the callback to use to find the epicenter of a Transition.
`Transition`	`setInterpolator(TimeInterpolator interpolator)` Sets the interpolator of this transition.
`void`	`setMatchOrder(int... matches)` Sets the order in which Transition matches View start and end values.
`void`	`setPathMotion(PathMotion pathMotion)` Sets the algorithm used to calculate two-dimensional interpolation.
`void`	`setPropagation(TransitionPropagation transitionPropagation)` Sets the method for determining Animator start delays.
`Transition`	`setStartDelay(long startDelay)` Sets the startDelay of this transition.
`String`	`toString()` Returns a string representation of the object.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

IN

Added in API level 19

public static final int IN

Fading mode used in Fade(int) to make the transition operate on targets that are appearing. Maybe be combined with OUT to fade both in and out. Equivalent to Visibility.MODE_IN.

Constant Value: 1 (0x00000001)

OUT

Added in API level 19

public static final int OUT

Fading mode used in Fade(int) to make the transition operate on targets that are disappearing. Maybe be combined with IN to fade both in and out. Equivalent to Visibility.MODE_OUT.

Constant Value: 2 (0x00000002)

Public constructors

Fade

Added in API level 19

public Fade ()

Constructs a Fade transition that will fade targets in and out.

Fade

Added in API level 21

public Fade (Context context, 
                AttributeSet attrs)

Parameters
`context`	`Context`
`attrs`	`AttributeSet`

Fade

Added in API level 19

public Fade (int fadingMode)

Constructs a Fade transition that will fade targets in and/or out, according to the value of fadingMode.

Parameters
`fadingMode`	`int`: The behavior of this transition, a combination of `IN` and `OUT`. Value is either `0` or a combination of `Visibility.MODE_IN`, `Visibility.MODE_OUT`, `IN`, and `OUT`

Public methods

captureStartValues

Added in API level 19

public void captureStartValues (TransitionValues transitionValues)

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

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.

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.

onAppear

Added in API level 21

public Animator onAppear (ViewGroup sceneRoot, 
                View view, 
                TransitionValues startValues, 
                TransitionValues endValues)

The default implementation of this method returns a null Animator. Subclasses should override this method to make targets appear with the desired transition. The method should only be called from onAppear(android.view.ViewGroup, android.transition.TransitionValues, int, android.transition.TransitionValues, int).

Parameters
`sceneRoot`	`ViewGroup`: The root of the transition hierarchy
`view`	`View`: The View to make appear. This will be in the target scene's View hierarchy and will be VISIBLE.
`startValues`	`TransitionValues`: The target values in the start scene
`endValues`	`TransitionValues`: The target values in the end scene

Returns
`Animator`	An Animator to be started at the appropriate time in the overall transition for this scene change. A null value means no animation should be run.

onDisappear

Added in API level 21

public Animator onDisappear (ViewGroup sceneRoot, 
                View view, 
                TransitionValues startValues, 
                TransitionValues endValues)

The default implementation of this method returns a null Animator. Subclasses should override this method to make targets disappear with the desired transition. The method should only be called from onDisappear(android.view.ViewGroup, android.transition.TransitionValues, int, android.transition.TransitionValues, int).

Parameters
`sceneRoot`	`ViewGroup`: The root of the transition hierarchy
`view`	`View`: The View to make disappear. This will be in the target scene's View hierarchy or in an `ViewGroupOverlay` and will be VISIBLE.
`startValues`	`TransitionValues`: The target values in the start scene
`endValues`	`TransitionValues`: The target values in the end scene

Returns
`Animator`	An Animator to be started at the appropriate time in the overall transition for this scene change. A null value means no animation should be run.