MaterialFadeThrough

public final class MaterialFadeThrough
extends Visibility

java.lang.Object
   ↳ android.transition.Transition
     ↳ android.transition.Visibility
       ↳ com.google.android.material.transition.platform.MaterialFadeThrough


A Visibility transition that, by default, provides a fade in and scale out when appearing and a fade out and scale out when disappearing.

MaterialFadeThrough supports theme-based easing and duration. The transition will load theme values from the SceneRoot's context before it runs, and only use them if the corresponding properties weren't already set on the transition instance.

Summary

Inherited constants

int MODE_IN

int MODE_OUT

int MATCH_ID

int MATCH_INSTANCE

int MATCH_ITEM_ID

int MATCH_NAME

Public constructors

MaterialFadeThrough()

Public methods

void addAdditionalAnimatorProvider(VisibilityAnimatorProvider additionalAnimatorProvider)

Adds an additional VisibilityAnimatorProvider, which provides animators be played together with the primary and secondary VisibilityAnimatorProviders.

void clearAdditionalAnimatorProvider()

Clears all additional VisibilityAnimatorProviders that were previously added.

P extends VisibilityAnimatorProvider getPrimaryAnimatorProvider()

Returns the primary VisibilityAnimatorProvider for this transition, which can be modified but not swapped out completely.

VisibilityAnimatorProvider getSecondaryAnimatorProvider()

Returns the secondary VisibilityAnimatorProvider for this transition or null, which can be modified or swapped out completely for a different VisibilityAnimatorProvider.

Animator onAppear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)
Animator onDisappear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)
boolean removeAdditionalAnimatorProvider(VisibilityAnimatorProvider additionalAnimatorProvider)

Removes an additional VisibilityAnimatorProvider that was previously added.

void setSecondaryAnimatorProvider(VisibilityAnimatorProvider secondaryAnimatorProvider)

Sets the secondary VisibilityAnimatorProvider, which provides animators to be played together with the primary VisibilityAnimatorProvider.

Inherited methods

void captureEndValues(TransitionValues arg0)
void captureStartValues(TransitionValues arg0)
Animator createAnimator(ViewGroup arg0, TransitionValues arg1, TransitionValues arg2)
int getMode()
String[] getTransitionProperties()
boolean isTransitionRequired(TransitionValues arg0, TransitionValues arg1)
boolean isVisible(TransitionValues arg0)
Animator onAppear(ViewGroup arg0, View arg1, TransitionValues arg2, TransitionValues arg3)
Animator onAppear(ViewGroup arg0, TransitionValues arg1, int arg2, TransitionValues arg3, int arg4)
Animator onDisappear(ViewGroup arg0, View arg1, TransitionValues arg2, TransitionValues arg3)
Animator onDisappear(ViewGroup arg0, TransitionValues arg1, int arg2, TransitionValues arg3, int arg4)
void setMode(int arg0)
Transition addListener(Transition.TransitionListener arg0)
Transition addTarget(View arg0)
Transition addTarget(int arg0)
Transition addTarget(Class arg0)
Transition addTarget(String arg0)
boolean canRemoveViews()
abstract void captureEndValues(TransitionValues arg0)
abstract void captureStartValues(TransitionValues arg0)
Object clone()
Animator createAnimator(ViewGroup arg0, TransitionValues arg1, TransitionValues arg2)
Transition excludeChildren(int arg0, boolean arg1)
Transition excludeChildren(Class arg0, boolean arg1)
Transition excludeChildren(View arg0, boolean arg1)
Transition excludeTarget(View arg0, boolean arg1)
Transition excludeTarget(Class arg0, boolean arg1)
Transition excludeTarget(String arg0, boolean arg1)
Transition excludeTarget(int arg0, boolean arg1)
long getDuration()
Rect getEpicenter()
Transition.EpicenterCallback getEpicenterCallback()
TimeInterpolator getInterpolator()
String getName()
PathMotion getPathMotion()
TransitionPropagation getPropagation()
long getStartDelay()
List<Integer> getTargetIds()
List<String> getTargetNames()
List<Class> getTargetTypes()
List<View> getTargets()
String[] getTransitionProperties()
TransitionValues getTransitionValues(View arg0, boolean arg1)
boolean isTransitionRequired(TransitionValues arg0, TransitionValues arg1)
Transition removeListener(Transition.TransitionListener arg0)
Transition removeTarget(int arg0)
Transition removeTarget(View arg0)
Transition removeTarget(String arg0)
Transition removeTarget(Class arg0)
Transition setDuration(long arg0)
void setEpicenterCallback(Transition.EpicenterCallback arg0)
Transition setInterpolator(TimeInterpolator arg0)
void setMatchOrder(int... arg0)
void setPathMotion(PathMotion arg0)
void setPropagation(TransitionPropagation arg0)
Transition setStartDelay(long arg0)
String toString()
Object clone()
boolean equals(Object arg0)
void finalize()
final Class<?> getClass()
int hashCode()
final void notify()
final void notifyAll()
String toString()
final void wait(long arg0, int arg1)
final void wait(long arg0)
final void wait()

Public constructors

MaterialFadeThrough

public MaterialFadeThrough ()

Public methods

addAdditionalAnimatorProvider

public void addAdditionalAnimatorProvider (VisibilityAnimatorProvider additionalAnimatorProvider)

Adds an additional VisibilityAnimatorProvider, which provides animators be played together with the primary and secondary VisibilityAnimatorProviders.

Parameters
additionalAnimatorProvider VisibilityAnimatorProvider

clearAdditionalAnimatorProvider

public void clearAdditionalAnimatorProvider ()

Clears all additional VisibilityAnimatorProviders that were previously added.

getPrimaryAnimatorProvider

public P extends VisibilityAnimatorProvider getPrimaryAnimatorProvider ()

Returns the primary VisibilityAnimatorProvider for this transition, which can be modified but not swapped out completely.

Returns
P extends VisibilityAnimatorProvider

getSecondaryAnimatorProvider

public VisibilityAnimatorProvider getSecondaryAnimatorProvider ()

Returns the secondary VisibilityAnimatorProvider for this transition or null, which can be modified or swapped out completely for a different VisibilityAnimatorProvider.

onAppear

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

Parameters
sceneRoot ViewGroup

view View

startValues TransitionValues

endValues TransitionValues

Returns
Animator

onDisappear

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

Parameters
sceneRoot ViewGroup

view View

startValues TransitionValues

endValues TransitionValues

Returns
Animator

removeAdditionalAnimatorProvider

public boolean removeAdditionalAnimatorProvider (VisibilityAnimatorProvider additionalAnimatorProvider)

Removes an additional VisibilityAnimatorProvider that was previously added.

Parameters
additionalAnimatorProvider VisibilityAnimatorProvider

Returns
boolean

setSecondaryAnimatorProvider

public void setSecondaryAnimatorProvider (VisibilityAnimatorProvider secondaryAnimatorProvider)

Sets the secondary VisibilityAnimatorProvider, which provides animators to be played together with the primary VisibilityAnimatorProvider.

Parameters
secondaryAnimatorProvider VisibilityAnimatorProvider