Stay organized with collections
Save and categorize content based on your preferences.
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 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
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
SlideDistanceProvider
public SlideDistanceProvider (int slideEdge)
Public methods
createAppear
public 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
|
createDisappear
public 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
|
getSlideDistance
public int getSlideDistance ()
Get the distance this animator will translate its target. If set to -1, the default slide
distance will be used.
getSlideEdge
public int getSlideEdge ()
setSlideDistance
public 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
public void setSlideEdge (int slideEdge)
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# SlideDistanceProvider\n\nSummary: [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nSlideDistanceProvider\n=====================\n\n\n`\npublic\n\nfinal\n\nclass\nSlideDistanceProvider\n`\n\n\n`\n\nextends Object\n\n\n`\n\n`\n\n\nimplements\n\n`[VisibilityAnimatorProvider](/reference/com/google/android/material/transition/VisibilityAnimatorProvider)`\n\n\n`\n\n|---|--------------------------------------------------------------|\n| java.lang.Object ||\n| ↳ | com.google.android.material.transition.SlideDistanceProvider |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nA class that can configure and create an [Animator](/reference/android/animation/Animator) that slides a view vertically or\nhorizontally slide over a specific distance.\n\nSummary\n-------\n\n| ### Public constructors ||\n|--------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ` `[SlideDistanceProvider](/reference/com/google/android/material/transition/SlideDistanceProvider#SlideDistanceProvider(int))`(int slideEdge) ` |\n\n| ### Public methods ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` Animator` | ` `[createAppear](/reference/com/google/android/material/transition/SlideDistanceProvider#createAppear(android.view.ViewGroup,%20android.view.View))`(ViewGroup sceneRoot, View view) ` Should return an Animator that animates in the appearing target `view`. |\n| ` Animator` | ` `[createDisappear](/reference/com/google/android/material/transition/SlideDistanceProvider#createDisappear(android.view.ViewGroup,%20android.view.View))`(ViewGroup sceneRoot, View view) ` Should return an Animator that animates out the disappearing target `view`. |\n| ` int` | ` `[getSlideDistance](/reference/com/google/android/material/transition/SlideDistanceProvider#getSlideDistance())`() ` Get the distance this animator will translate its target. |\n| ` int` | ` `[getSlideEdge](/reference/com/google/android/material/transition/SlideDistanceProvider#getSlideEdge())`() ` |\n| ` void` | ` `[setSlideDistance](/reference/com/google/android/material/transition/SlideDistanceProvider#setSlideDistance(int))`(int slideDistance) ` Set the distance this animator will translate its target. |\n| ` void` | ` `[setSlideEdge](/reference/com/google/android/material/transition/SlideDistanceProvider#setSlideEdge(int))`(int slideEdge) ` |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class\u003c?\u003e` | ` 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() ` | ||\n| From interface ` `[com.google.android.material.transition.VisibilityAnimatorProvider](/reference/com/google/android/material/transition/VisibilityAnimatorProvider)` ` |----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract Animator` | ` `[createAppear](/reference/com/google/android/material/transition/VisibilityAnimatorProvider#createAppear(android.view.ViewGroup,%20android.view.View))`(ViewGroup sceneRoot, View view) ` Should return an Animator that animates in the appearing target `view`. | | ` abstract Animator` | ` `[createDisappear](/reference/com/google/android/material/transition/VisibilityAnimatorProvider#createDisappear(android.view.ViewGroup,%20android.view.View))`(ViewGroup sceneRoot, View view) ` Should return an Animator that animates out the disappearing target `view`. | ||\n\nPublic constructors\n-------------------\n\n### SlideDistanceProvider\n\n```\npublic SlideDistanceProvider (int slideEdge)\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------------|--------------|\n| `slideEdge` | `int` \u003cbr /\u003e |\n\nPublic methods\n--------------\n\n### createAppear\n\n```\npublic Animator createAppear (ViewGroup sceneRoot, \n View view)\n```\n\nShould return an Animator that animates in the appearing target `view`.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------|\n| `sceneRoot` | `ViewGroup`: The root of the transition hierarchy, which can be useful for checking configurations such as RTL \u003cbr /\u003e |\n| `view` | `View`: The view that is appearing \u003cbr /\u003e |\n\n| Returns ||\n|------------|--------|\n| `Animator` | \u003cbr /\u003e |\n\n### createDisappear\n\n```\npublic Animator createDisappear (ViewGroup sceneRoot, \n View view)\n```\n\nShould return an Animator that animates out the disappearing target `view`.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------|\n| `sceneRoot` | `ViewGroup`: The root of the transition hierarchy, which can be useful for checking configurations such as RTL \u003cbr /\u003e |\n| `view` | `View`: The view that is disappearing \u003cbr /\u003e |\n\n| Returns ||\n|------------|--------|\n| `Animator` | \u003cbr /\u003e |\n\n### getSlideDistance\n\n```\npublic int getSlideDistance ()\n```\n\nGet the distance this animator will translate its target. If set to -1, the default slide\ndistance will be used.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------|--------|\n| `int` | \u003cbr /\u003e |\n\n**See also:**\n\n- [setSlideDistance(int)](/reference/com/google/android/material/transition/SlideDistanceProvider#setSlideDistance(int)) \n\n### getSlideEdge\n\n```\npublic int getSlideEdge ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------|--------|\n| `int` | \u003cbr /\u003e |\n\n### setSlideDistance\n\n```\npublic void setSlideDistance (int slideDistance)\n```\n\nSet the distance this animator will translate its target.\n\nBy default, this value is set to -1 which indicates that the default slide distance,\nR.dimen.mtrl_transition_shared_axis_slide_distance will be used. Setting the slide distance to\nany other value will override this default.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-----------------|--------------|\n| `slideDistance` | `int` \u003cbr /\u003e |\n\n| Throws ||\n|----------------------------|---------------------------------|\n| `IllegalArgumentException` | If `slideDistance` is negative. |\n\n### setSlideEdge\n\n```\npublic void setSlideEdge (int slideEdge)\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------------|--------------|\n| `slideEdge` | `int` \u003cbr /\u003e |"]]
