to top

Added in API level 19

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

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(int targetId) Adds the id of a target view that this Transition is interested in animating.
Transition	addTarget(View target) Sets the target view instances that this Transition is interested in animating.
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(View target, boolean exclude) Whether to add the children of given target to the list of target children to exclude from this transition.
Transition	excludeChildren(Class type, boolean exclude) Whether to add the given type to the list of types whose children should be excluded from this transition.
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	excludeTarget(int targetId, boolean exclude) Whether to add the given id to the list of target ids to exclude from this transition.
Transition	excludeTarget(Class type, boolean exclude) Whether to add the given type to the list of types 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.
long	getDuration() Returns the duration set on this transition.
TimeInterpolator	getInterpolator() Returns the interpolator set on this transition.
String	getName() Returns the name of this Transition.
long	getStartDelay() Returns the startDelay set on this transition.
List<Integer>	getTargetIds() Returns the array of target IDs that this transition limits itself to tracking and animating.
List<View>	getTargets() Returns the array 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(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.
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	setDuration(long duration) Sets the duration of this transition.
Transition	setInterpolator(TimeInterpolator interpolator) Sets the interpolator of this transition.
Transition	setStartDelay(long startDelay) Sets the startDelay of this transition.
String	toString() Returns a string containing a concise, human-readable description of this object.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

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.

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.

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	The behavior of this transition, a combination of `IN` and `OUT`.

Public Methods

public void captureStartValues (TransitionValues transitionValues)

Added in API level 19

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.

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)

Added in API level 19

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)

Added in API level 19

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.

Results

Interfaces

Classes

Fade

Class Overview

Summary

Constants

public static final int IN

public static final int OUT

Public Constructors

public Fade ()

public Fade (int fadingMode)

Parameters

Public Methods

public void captureStartValues (TransitionValues transitionValues)

Parameters

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

Parameters

Returns

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

Parameters

Returns