Android APIs
public class

Fade

extends Visibility
java.lang.Object
   ↳ android.transition.Transition
     ↳ android.transition.Visibility
       ↳ android.transition.Fade

Class Overview

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 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 GONE or INVISIBLE, then the visibility will be changed to 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 Fade and Transition.

Summary

[Expand]
Inherited XML Attributes
From class android.transition.Visibility
From class android.transition.Transition
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.
[Expand]
Inherited Constants
From class android.transition.Visibility
From class android.transition.Transition
Public Constructors
Fade()
Constructs a Fade transition that will fade targets in and out.
Fade(int fadingMode)
Constructs a Fade transition that will fade targets in and/or out, according to the value of fadingMode.
Fade(Context context, AttributeSet attrs)
Public Methods
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.
[Expand]
Inherited Methods
From class android.transition.Visibility
From class android.transition.Transition
From class java.lang.Object

Constants

public static final int IN

Added in API level 19

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

Constant Value: 1 (0x00000001)

public static final int OUT

Added in API level 19

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

Constant Value: 2 (0x00000002)

Public Constructors

public Fade ()

Added in API level 19

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

public Fade (int fadingMode)

Added in API level 19

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.

public Fade (Context context, AttributeSet attrs)

Added in API level 21

Parameters
context Context
attrs AttributeSet

Public Methods

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

Added in API level 21

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(ViewGroup, TransitionValues, int, 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.

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

Added in API level 21

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(ViewGroup, TransitionValues, int, 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.