Skip to content

Most visited

Recently visited

navigation

Slide

public class Slide
extends Visibility

java.lang.Object
   ↳ android.transition.Transition
     ↳ android.transition.Visibility
       ↳ android.transition.Slide


This transition tracks changes to the visibility of target views in the start and end scenes and moves views in or out from one of the edges of the scene. Visibility is determined by both the setVisibility(int) state of the view as well as whether it is parented in the current view hierarchy. Disappearing Views are limited as described in onDisappear(android.view.ViewGroup, TransitionValues, int, TransitionValues, int).

Summary

XML attributes

android:slideEdge  

Inherited XML attributes

From class android.transition.Visibility
From class android.transition.Transition

Inherited constants

From class android.transition.Visibility
From class android.transition.Transition

Public constructors

Slide()

Constructor using the default BOTTOM slide edge direction.

Slide(int slideEdge)

Constructor using the provided slide edge direction.

Slide(Context context, AttributeSet attrs)

Public methods

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.

int getSlideEdge()

Returns the edge that Views appear and disappear from.

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

The default implementation of this method returns a null Animator.

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

The default implementation of this method returns a null Animator.

void setSlideEdge(int slideEdge)

Change the edge that Views appear and disappear from.

Inherited methods

From class android.transition.Visibility
From class android.transition.Transition
From class java.lang.Object

XML attributes

android:slideEdge

Related methods:

Public constructors

Slide

added in API level 21
Slide ()

Constructor using the default BOTTOM slide edge direction.

Slide

added in API level 21
Slide (int slideEdge)

Constructor using the provided slide edge direction.

Parameters
slideEdge int

Slide

added in API level 21
Slide (Context context, 
                AttributeSet attrs)

Parameters
context Context
attrs AttributeSet

Public methods

captureEndValues

added in API level 21
void captureEndValues (TransitionValues transitionValues)

Captures the values in the end scene for the properties that this transition monitors. These values are then passed as the endValues 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 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.

captureStartValues

added in API level 21
void captureStartValues (TransitionValues transitionValues)

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 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.

getSlideEdge

added in API level 21
int getSlideEdge ()

Returns the edge that Views appear and disappear from.

Related XML Attributes:

Returns
int the edge of the scene to use for Views appearing and disappearing. One of LEFT, TOP, RIGHT, BOTTOM, START, END.

onAppear

added in API level 21
Animator onAppear (ViewGroup sceneRoot, 
                View view, 
                TransitionValues startValues, 
                TransitionValues endValues)

The default implementation of this method returns a null Animator. Subclasses should override this method to make targets appear with the desired transition. The method should only be called from onAppear(ViewGroup, TransitionValues, int, TransitionValues, int).

Parameters
sceneRoot ViewGroup: The root of the transition hierarchy
view View: The View to make appear. This will be in the target scene's View hierarchy and will be VISIBLE.
startValues TransitionValues: The target values in the start scene
endValues TransitionValues: The target values in the end scene
Returns
Animator 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.

onDisappear

added in API level 21
Animator onDisappear (ViewGroup sceneRoot, 
                View view, 
                TransitionValues startValues, 
                TransitionValues endValues)

The default implementation of this method returns a null Animator. Subclasses should override this method to make targets disappear with the desired transition. The method should only be called from onDisappear(ViewGroup, TransitionValues, int, TransitionValues, int).

Parameters
sceneRoot ViewGroup: The root of the transition hierarchy
view View: The View to make disappear. This will be in the target scene's View hierarchy or in an ViewGroupOverlay and will be VISIBLE.
startValues TransitionValues: The target values in the start scene
endValues TransitionValues: The target values in the end scene
Returns
Animator 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.

setSlideEdge

added in API level 21
void setSlideEdge (int slideEdge)

Change the edge that Views appear and disappear from.

Related XML Attributes:

Parameters
slideEdge int: The edge of the scene to use for Views appearing and disappearing. One of LEFT, TOP, RIGHT, BOTTOM, START, END.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.