Added in API level 19

Fade


open class Fade : Visibility
kotlin.Any
   ↳ 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 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 android.R.styleable#Fade and android.R.styleable#Transition.

Summary

Constants
static Int

Fading mode used in Fade(int) to make the transition operate on targets that are appearing.

static Int

Fading mode used in Fade(int) to make the transition operate on targets that are disappearing.

Inherited constants
Public constructors

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

Fade(fadingMode: Int)

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

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

Public methods
open Unit

open Animator!
onAppear(sceneRoot: ViewGroup!, view: View!, startValues: TransitionValues!, endValues: TransitionValues!)

open Animator!
onDisappear(sceneRoot: ViewGroup!, view: View!, startValues: TransitionValues!, endValues: TransitionValues!)

Inherited functions

Constants

IN

Added in API level 19
static val IN: Int

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.

Value: 1

OUT

Added in API level 19
static val OUT: Int

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.

Value: 2

Public constructors

Fade

Added in API level 19
Fade()

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

Fade

Added in API level 19
Fade(fadingMode: Int)

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 android.transition.Visibility#MODE_IN, android.transition.Visibility#MODE_OUT, android.transition.Fade#IN, and android.transition.Fade#OUT

Fade

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

Public methods

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.

onAppear

Added in API level 21
open fun onAppear(
    sceneRoot: ViewGroup!,
    view: View!,
    startValues: TransitionValues!,
    endValues: TransitionValues!
): Animator!
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
Return
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
open fun onDisappear(
    sceneRoot: ViewGroup!,
    view: View!,
    startValues: TransitionValues!,
    endValues: TransitionValues!
): Animator!
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 android.view.ViewGroupOverlay and will be VISIBLE.
startValues TransitionValues!: The target values in the start scene
endValues TransitionValues!: The target values in the end scene
Return
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.