Fade
This package is part of the
Android support library which
is no longer maintained.
The support library has been superseded by AndroidX
which is part of Jetpack .
We recommend using the AndroidX libraries in all new projects. You should also consider
migrating existing projects to AndroidX.
To find the AndroidX class that maps to this deprecated class, see the AndroidX
support library class
mappings .
public
class
Fade
extends Visibility
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
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 (int fadingMode)
Constructs a Fade transition that will fade targets in
and/or out, according to the value of fadingMode.
Fade ()
Constructs a Fade transition that will fade targets in and out.
Fade (Context context, AttributeSet attrs)
Inherited methods
From
class
android.support.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(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(TransitionValues)
and
captureEndValues(TransitionValues)
.
boolean
isVisible (TransitionValues values)
Returns whether the view is 'visible' according to the given values
object.
Animator
onAppear (ViewGroup sceneRoot, TransitionValues startValues, int startVisibility, TransitionValues endValues, int endVisibility)
The default implementation of this method does nothing.
Animator
onAppear (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)
The default implementation of this method does nothing.
Animator
onDisappear (ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)
The default implementation of this method returns a null Animator.
void
setMode (int mode)
Changes the transition to support appearing and/or disappearing Views, depending
on mode
.
From
class
android.support.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 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.
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 ()
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 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 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 array 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>
getTargetTypes ()
Returns the list of target transitionNames 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