TransitionSet

ORDERING_SEQUENTIAL

public static final 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

public static final 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)

TransitionSet

public TransitionSet ()

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

TransitionSet

public TransitionSet (Context context, 
                AttributeSet attrs)

addListener

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

addTarget

public TransitionSet addTarget (View target)

Sets the target view instances that this Transition is interested in animating. By default, there are no targets, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targets constrains the Transition to only listen for, and act on, these views. All other views will be ignored.

The target list is like the targetId list except this list specifies the actual View instances, not the ids of the views. This is an important distinction when scene changes involve view hierarchies which have been inflated separately; different views may share the same id but not actually be the same instance. If the transition should treat those views as the same, then addTarget(int) should be used instead of addTarget(android.view.View). If, on the other hand, scene changes involve changes all within the same view hierarchy, among views which do not necessarily have ids set on them, then the target list of views may be more convenient.

addTarget

public TransitionSet addTarget (int targetId)

Adds the id of a target view that this Transition is interested in animating. By default, there are no targetIds, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targetIds constrains the Transition to only listen for, and act on, views with these IDs. Views with different IDs, or no IDs whatsoever, will be ignored.

Note that using ids to specify targets implies that ids should be unique within the view hierarchy underneath the scene root.

addTarget

public TransitionSet addTarget (Class<T> targetType)

Adds the Class of a target view that this Transition is interested in animating. By default, there are no targetTypes, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targetTypes constrains the Transition to only listen for, and act on, views with these classes. Views with different classes will be ignored.

Note that any View that can be cast to targetType will be included, so if targetType is View.class, all Views will be included.

addTarget

public TransitionSet addTarget (String targetName)

Adds the transitionName of a target view that this Transition is interested in animating. By default, there are no targetNames, and a Transition will listen for changes on every view in the hierarchy below the sceneRoot of the Scene being transitioned into. Setting targetNames constrains the Transition to only listen for, and act on, views with these transitionNames. Views with different transitionNames, or no transitionName whatsoever, will be ignored.

Note that transitionNames should be unique within the view hierarchy.

addTransition

public 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, interpolator, propagation delay, path motion, or epicenter callback set on it, the child transition will inherit the values that are set. Transitions are assumed to have a maximum of one transitionSet parent.

captureEndValues

public 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(android.view.ViewGroup, android.transition.TransitionValues, android.transition.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, android.transition.TransitionValues, android.transition.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.

captureStartValues

public 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(android.view.ViewGroup, android.transition.TransitionValues, android.transition.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, android.transition.TransitionValues, android.transition.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.

clone

public TransitionSet clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

 x.clone().getClass() == x.getClass()

 x.clone().equals(x)

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

excludeTarget

public Transition excludeTarget (View target, 
                boolean exclude)

Whether to add the given target to the list of targets to exclude from this transition. The exclude parameter specifies whether the target should be added to or removed from the excluded list.

Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, Spinner).

excludeTarget

public Transition excludeTarget (Class<T> type, 
                boolean exclude)

Whether to add the given type to the list of types to exclude from this transition. The exclude parameter specifies whether the target type should be added to or removed from the excluded list.

Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, Spinner).

excludeTarget

public Transition excludeTarget (String targetName, 
                boolean exclude)

Whether to add the given transitionName to the list of target transitionNames to exclude from this transition. The exclude parameter specifies whether the target should be added to or removed from the excluded list.

Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded by their id, their instance reference, their transitionName, or by the Class of that view (eg, Spinner).

excludeTarget

public Transition excludeTarget (int targetId, 
                boolean exclude)

Whether to add the given id to the list of target ids to exclude from this transition. The exclude parameter specifies whether the target should be added to or removed from the excluded list.

Excluding targets is a general mechanism for allowing transitions to run on a view hierarchy while skipping target views that should not be part of the transition. For example, you may want to avoid animating children of a specific ListView or Spinner. Views can be excluded either by their id, or by their instance reference, or by the Class of that view (eg, Spinner).

getOrdering

public int getOrdering ()

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

getTransitionAt

public Transition getTransitionAt (int index)

Returns the child Transition at the specified position in the TransitionSet.

getTransitionCount

public int getTransitionCount ()

Returns the number of child transitions in the TransitionSet.

removeListener

public TransitionSet removeListener (Transition.TransitionListener listener)

Removes a listener from the set listening to this animation.

removeTarget

public TransitionSet removeTarget (int targetId)

Removes the given targetId from the list of ids that this Transition is interested in animating.

removeTarget

public TransitionSet removeTarget (View target)

Removes the given target from the list of targets that this Transition is interested in animating.

removeTarget

public TransitionSet removeTarget (String target)

Removes the given targetName from the list of transitionNames that this Transition is interested in animating.

removeTarget

public TransitionSet removeTarget (Class<T> target)

Removes the given target from the list of targets that this Transition is interested in animating.

removeTransition

public TransitionSet removeTransition (Transition transition)

Removes the specified child transition from this set.

setDuration

public TransitionSet setDuration (long duration)

Setting a non-negative duration on a TransitionSet causes all of the child transitions (current and future) to inherit this duration.

setEpicenterCallback

public void setEpicenterCallback (Transition.EpicenterCallback epicenterCallback)

Sets the callback to use to find the epicenter of a Transition. A null value indicates that there is no epicenter in the Transition and onGetEpicenter() will return null. Transitions like Explode use a point or Rect to orient the direction of travel. This is called the epicenter of the Transition and is typically centered on a touched View. The Transition.EpicenterCallback allows a Transition to dynamically retrieve the epicenter during a Transition.

setInterpolator

public TransitionSet setInterpolator (TimeInterpolator interpolator)

Sets the interpolator of this transition. By default, the interpolator is null, which means that the Animator created by the transition will have its own specified interpolator. If the interpolator of a Transition is set, that interpolator will override the Animator interpolator.

setOrdering

public TransitionSet setOrdering (int ordering)

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

setPathMotion

public void setPathMotion (PathMotion pathMotion)

Sets the algorithm used to calculate two-dimensional interpolation.

Transitions such as ChangeBounds move Views, typically in a straight path between the start and end positions. Applications that desire to have these motions move in a curve can change how Views interpolate in two dimensions by extending PathMotion and implementing PathMotion.getPath(float, float, float, float).

When describing in XML, use a nested XML tag for the path motion. It can be one of the built-in tags arcMotion or patternPathMotion or it can be a custom PathMotion using pathMotion with the class attributed with the fully-described class name. For example:

 <changeBounds>
     <pathMotion class="my.app.transition.MyPathMotion"/>
 </changeBounds>
 
 

or

 <changeBounds>
   <arcMotion android:minimumHorizontalAngle="15"
     android:minimumVerticalAngle="0" android:maximumAngle="90"/>
 </changeBounds>
 
 

setPropagation

public void setPropagation (TransitionPropagation propagation)

Sets the method for determining Animator start delays. When a Transition affects several Views like Explode or Slide, there may be a desire to have a "wave-front" effect such that the Animator start delay depends on position of the View. The TransitionPropagation specifies how the start delays are calculated.

setStartDelay

public TransitionSet setStartDelay (long startDelay)

Sets the startDelay of this transition. By default, there is no delay (indicated by a negative number), which means that the Animator created by the transition will have its own specified startDelay. If the delay of a Transition is set, that delay will override the Animator delay.