Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
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.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.
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.
Public Methods
void captureStartValues ( TransitionValues transitionValues)
Captures the values in the start scene for the properties that this transition monitors.
Animator onAppear ( ViewGroup sceneRoot, TransitionValues startValues, int startVisibility, TransitionValues endValues, int endVisibility)
The default implementation of this method does nothing.
Animator onDisappear ( ViewGroup sceneRoot, TransitionValues startValues, int startVisibility, TransitionValues endValues, int endVisibility)
The default implementation of this method does nothing.
[Expand]
Inherited Methods
From class android.transition.Visibility
From class android.transition.Transition
From class java.lang.Object

Constants

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.

Constant Value: 1 (0x00000001)

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.

Constant Value: 2 (0x00000002)

Public Constructors

public Fade ()

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

public Fade (int fadingMode)

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

Parameters
fadingMode The behavior of this transition, a combination of IN and OUT .

Public Methods

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

public Animator onAppear ( ViewGroup sceneRoot, TransitionValues startValues, int startVisibility, TransitionValues endValues, int endVisibility)

The default implementation of this method does nothing. Subclasses should override if they need to create an Animator when targets appear. The method should only be called by the Visibility class; it is not intended to be called from external classes.

Parameters
sceneRoot The root of the transition hierarchy
startValues The target values in the start scene
startVisibility The target visibility in the start scene
endValues The target values in the end scene
endVisibility The target visibility in the end scene
Returns
  • 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, TransitionValues startValues, int startVisibility, TransitionValues endValues, int endVisibility)

The default implementation of this method does nothing. Subclasses should override if they need to create an Animator when targets disappear. The method should only be called by the Visibility class; it is not intended to be called from external classes.

Parameters
sceneRoot The root of the transition hierarchy
startValues The target values in the start scene
startVisibility The target visibility in the start scene
endValues The target values in the end scene
endVisibility The target visibility in the end scene
Returns
  • 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.