Summary: Constants | Ctors | Methods | Inherited Methods | [Expand All]

TransitionSet

public class TransitionSet
extends Transition

java.lang.Object
↳	android.support.transition.Transition
	↳	android.support.transition.TransitionSet

Known Direct Subclasses

AutoTransition

A TransitionSet is a parent of child transitions (including other TransitionSets). Using TransitionSets enables more complex choreography of transitions, where some sets play ORDERING_TOGETHER and others play ORDERING_SEQUENTIAL. For example, AutoTransition uses a TransitionSet to sequentially play a Fade(Fade.OUT), followed by a ChangeBounds, followed by a Fade(Fade.OUT) transition.

Unlike the platform version, this does not support declaration by XML resources.

Summary

Constants
`int`	`ORDERING_SEQUENTIAL` A flag used to indicate that the child transitions of this set should play in sequence; when one child transition ends, the next child transition begins.
`int`	`ORDERING_TOGETHER` A flag used to indicate that the child transitions of this set should all start at the same time.

Public constructors
`TransitionSet()` Constructs an empty transition set.

Public methods
`TransitionSet`	`addTransition(Transition transition)` Adds child transition to this set.
`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.
`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.
`int`	`getOrdering()` Returns the ordering of this TransitionSet.
`TransitionSet`	`removeTransition(Transition transition)` Removes the specified child transition from this set.
`TransitionSet`	`setOrdering(int ordering)` Sets the play order of this set's child transitions.

Inherited methods

From class


  
    android.support.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(View target)` Sets the target view instances that this Transition is interested in animating.
`Transition`	`addTarget(int targetId)` Adds the id of a target view that this Transition is interested in animating.
`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.
`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(int targetId, boolean exclude)` Whether to add the children of the given id to the list of targets 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(View target, boolean exclude)` Whether to add the children of given target to the list of target children 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.
`Transition`	`excludeTarget(Class type, boolean exclude)` Whether to add the given type to the list of types 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.
`long`	`getDuration()` Returns the duration set on this transition.
`TimeInterpolator`	`getInterpolator()` Returns the interpolator set on this transition.
`String`	`getName()` Returns the name of this Transition.
`long`	`getStartDelay()` Returns the startDelay set on this transition.
`List<Integer>`	`getTargetIds()` Returns the array of target IDs that this transition limits itself to tracking and animating.
`List<View>`	`getTargets()` Returns the array 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`	`setDuration(long duration)` Sets the duration of this transition.
`Transition`	`setInterpolator(TimeInterpolator interpolator)` Sets the interpolator of this transition.
`Transition`	`setStartDelay(long startDelay)` Sets the startDelay of this transition.
`String`	`toString()` Returns a string representation of the object.

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

ORDERING_SEQUENTIAL

int ORDERING_SEQUENTIAL

A flag used to indicate that the child transitions of this set should play in sequence; when one child transition ends, the next child transition begins. Note that a transition does not end until all instances of it (which are playing on all applicable targets of the transition) end.

Constant Value: 1 (0x00000001)

ORDERING_TOGETHER

int ORDERING_TOGETHER

A flag used to indicate that the child transitions of this set should all start at the same time.

Constant Value: 0 (0x00000000)

Public constructors

TransitionSet

TransitionSet ()

Constructs an empty transition set. Add child transitions to the set by calling addTransition(Transition) )}. By default, child transitions will play together.

Public methods

addTransition

TransitionSet addTransition (Transition transition)

Adds child transition to this set. The order in which this child transition is added relative to other child transitions that are added, in addition to the ordering property, determines the order in which the transitions are started.

If this transitionSet has a duration set on it, the child transition will inherit that duration. Transitions are assumed to have a maximum of one transitionSet parent.

Parameters
`transition`	`Transition`: A non-null child transition to be added to this set.

Returns
`TransitionSet`	This transitionSet object.

captureEndValues

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

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

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

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.

createAnimator

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. Subclasses of Transition should override this method. The method should only be called by the transition system; it is not intended to be called from external classes.

This method is called by the transition's parent (all the way up to the topmost Transition in the hierarchy) with the sceneRoot and start/end values that the transition may need to set up initial target values and construct an appropriate animation. For example, if an overall Transition is a TransitionSet consisting of several child transitions in sequence, then some of the child transitions may want to set initial values on target views prior to the overall Transition commencing, to put them in an appropriate state for the delay between that start and the child Transition start time. For example, a transition that fades an item in may wish to set the starting alpha value to 0, to avoid it blinking in prior to the transition actually starting the animation. This is necessary because the scene change that triggers the Transition will automatically set the end-scene on all target views, so a Transition that wants to animate from a different value should set that value prior to returning from this method.

Additionally, a Transition can perform logic to determine whether the transition needs to run on the given target and start/end values. For example, a transition that resizes objects on the screen may wish to avoid running for views which are not present in either the start or end scenes.

If there is an animator created and returned from this method, the transition mechanism will apply any applicable duration, startDelay, and interpolator to that animation and start it. A return value of null indicates that no animation should run. The default implementation returns null.

The method is called for every applicable target object, which is stored in the view field.

Parameters
`sceneRoot`	`ViewGroup`: The root of the transition hierarchy.
`startValues`	`TransitionValues`: The values for a specific target in the start scene.
`endValues`	`TransitionValues`: The values for the target in the end scene.

Returns
`Animator`	A 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.

getOrdering

int getOrdering ()

Returns the ordering of this TransitionSet. By default, the value is ORDERING_TOGETHER.

Returns
`int`	`ORDERING_TOGETHER` if child transitions will play at the same time, `ORDERING_SEQUENTIAL` if they will play in sequence.

See also:

setOrdering(int)

removeTransition

TransitionSet removeTransition (Transition transition)

Removes the specified child transition from this set.

Parameters
`transition`	`Transition`: The transition to be removed.

Returns
`TransitionSet`	This transitionSet object.

setOrdering

TransitionSet setOrdering (int ordering)

Sets the play order of this set's child transitions.

Parameters
`ordering`	`int`: `ORDERING_TOGETHER` to play this set's child transitions together, `ORDERING_SEQUENTIAL` to play the child transitions in sequence.

Returns
`TransitionSet`	This transitionSet object.

Interfaces
- Transition.TransitionListener
Classes
- AutoTransition
- ChangeBounds
- Fade
- R
- R.id
- Scene
- Transition
- TransitionManager
- TransitionSet
- TransitionValues
- Visibility

Nov	DEC	Jan
	21
2015	2016	2017

Most visited

Recently visited

Results for

TransitionSet

Summary

Constants

Public constructors

Public methods

Inherited methods

Constants

ORDERING_SEQUENTIAL

ORDERING_TOGETHER

Public constructors

TransitionSet

Public methods

addTransition

captureEndValues

captureStartValues

createAnimator

getOrdering

removeTransition

setOrdering

Interfaces

Classes