Added in API level 21

public class

Slide

extends Visibility

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

Known Direct Subclasses

SlideNoPropagation

Class Overview

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
Attribute Name	Related Method	Description
android:slideEdge	setSlideEdge(int)

[Expand]

Inherited XML Attributes

From class android.transition.Visibility

From class android.transition.Transition

[Expand]

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.

[Expand]

Inherited Methods

From class android.transition.Visibility

From class android.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(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(View target) Sets the target view instances 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.
boolean	canRemoveViews()
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() Creates and returns a copy of this `Object`.
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(View target, boolean exclude) Whether to add the children of given target to the list of target children 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(int targetId, boolean exclude) Whether to add the children of the given id to the list of targets 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.
Transition	excludeTarget(Class type, boolean exclude) Whether to add the given type to the list of types 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.
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 list 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 list of target views that this transition limits itself to tracking and animating.
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.
TransitionValues	getTransitionValues(View view, boolean start) This method can be called by transitions to get the TransitionValues for any particular view during the transition-playing process.
Transition	removeListener(Transition.TransitionListener listener) Removes a listener from the set listening to this animation.
Transition	removeTarget(int targetId) Removes the given targetId from the list of ids that this Transition is interested in animating.
Transition	removeTarget(View target) Removes the given target from the list of targets that this Transition is interested in animating.
Transition	removeTarget(String targetName) Removes the given targetName from the list of transitionNames that this Transition is interested in animating.
Transition	removeTarget(Class target) Removes the given target from the list of targets that this Transition is interested in animating.
Transition	setDuration(long duration) Sets the duration of this transition.
void	setEpicenterCallback(Transition.EpicenterCallback epicenterCallback) Sets the callback to use to find the epicenter of a Transition.
Transition	setInterpolator(TimeInterpolator interpolator) Sets the interpolator of this transition.
void	setMatchOrder(int... matches) Sets the order in which Transition matches View start and end values.
void	setPathMotion(PathMotion pathMotion) Sets the algorithm used to calculate two-dimensional interpolation.
void	setPropagation(TransitionPropagation transitionPropagation) Sets the method for determining Animator start delays.
Transition	setStartDelay(long startDelay) Sets the startDelay of this transition.
String	toString() Returns a string containing a concise, human-readable description of this object.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

XML Attributes

android:slideEdge

Related Methods

setSlideEdge(int)

Public Constructors

public Slide ()

Added in API level 21

Constructor using the default BOTTOM slide edge direction.

public Slide (int slideEdge)

Added in API level 21

Constructor using the provided slide edge direction.

public Slide (Context context, AttributeSet attrs)

Added in API level 21

Public Methods

public void captureEndValues (TransitionValues transitionValues)

Added in API level 21

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

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.

public void captureStartValues (TransitionValues transitionValues)

Added in API level 21

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

public int getSlideEdge ()

Added in API level 21

Returns the edge that Views appear and disappear from.

Related XML Attributes

android:slideEdge

Returns

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

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

Added in API level 21

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

Returns

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.

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

Added in API level 21

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	The root of the transition hierarchy
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	The target values in the start scene
endValues	The target values in the end scene

Returns

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.

public void setSlideEdge (int slideEdge)

Added in API level 21

Change the edge that Views appear and disappear from.

Related XML Attributes

android:slideEdge

Parameters

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

Results

Interfaces

Classes

Slide

Class Overview

Summary

XML Attributes

android:slideEdge

Related Methods

Public Constructors

public Slide ()

public Slide (int slideEdge)

public Slide (Context context, AttributeSet attrs)

Public Methods

public void captureEndValues (TransitionValues transitionValues)

Parameters

public void captureStartValues (TransitionValues transitionValues)

Parameters

public int getSlideEdge ()

Related XML Attributes

Returns

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

Parameters

Returns

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

Parameters

Returns

public void setSlideEdge (int slideEdge)

Related XML Attributes

Parameters