Google is committed to advancing racial equity for Black communities. See how.

SlideDistanceProvider

public final class SlideDistanceProvider
extends Object implements VisibilityAnimatorProvider

java.lang.Object
   ↳ com.google.android.material.transition.SlideDistanceProvider


A class that can configure and create an Animator that slides a view vertically or horizontally slide over a specific distance.

Summary

Public constructors

SlideDistanceProvider(int slideEdge)

Public methods

Animator createAppear(ViewGroup sceneRoot, View view)

Should return an Animator that animates in the appearing target view.

Animator createDisappear(ViewGroup sceneRoot, View view)

Should return an Animator that animates out the disappearing target view.

int getSlideDistance()

Get the distance this animator will translate its target.

int getSlideEdge()
void setSlideDistance(int slideDistance)

Set the distance this animator will translate its target.

void setSlideEdge(int slideEdge)

Inherited methods

From class java.lang.Object
From interface com.google.android.material.transition.VisibilityAnimatorProvider

Public constructors

SlideDistanceProvider

SlideDistanceProvider (int slideEdge)

Parameters
slideEdge int

Public methods

createAppear

Animator createAppear (ViewGroup sceneRoot, 
                View view)

Should return an Animator that animates in the appearing target view.

Parameters
sceneRoot ViewGroup: The root of the transition hierarchy, which can be useful for checking configurations such as RTL

view View: The view that is appearing

Returns
Animator

createDisappear

Animator createDisappear (ViewGroup sceneRoot, 
                View view)

Should return an Animator that animates out the disappearing target view.

Parameters
sceneRoot ViewGroup: The root of the transition hierarchy, which can be useful for checking configurations such as RTL

view View: The view that is disappearing

Returns
Animator

getSlideDistance

int getSlideDistance ()

Get the distance this animator will translate its target. If set to -1, the default slide distance will be used.

Returns
int

getSlideEdge

int getSlideEdge ()

Returns
int

setSlideDistance

void setSlideDistance (int slideDistance)

Set the distance this animator will translate its target.

By default, this value is set to -1 which indicates that the default slide distance, R.dimen.mtrl_transition_shared_axis_slide_distance will be used. Setting the slide distance to any other value will override this default.

Parameters
slideDistance int

Throws
IllegalArgumentException If slideDistance is negative.

setSlideEdge

void setSlideEdge (int slideEdge)

Parameters
slideEdge int