TransitionSet
public
class
TransitionSet
extends Transition
java.lang.Object | ||
↳ | android.transition.Transition | |
↳ | android.transition.TransitionSet |
|
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.
A TransitionSet can be described in a resource file by using the
tag transitionSet
, along with the standard
attributes of R.styleable.TransitionSet
and
R.styleable.Transition
. Child transitions of the
TransitionSet object can be loaded by adding those child tags inside the
enclosing transitionSet
tag. For example, the following xml
describes a TransitionSet that plays a Fade and then a ChangeBounds
transition on the affected view targets:
<transitionSet xmlns:android="http://schemas.android.com/apk/res/android" android:transitionOrdering="sequential"> <fade/> <changeBounds/> </transitionSet>
Summary
Inherited XML attributes | |||||||
---|---|---|---|---|---|---|---|
|
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. |
Inherited constants | ||||||||
---|---|---|---|---|---|---|---|---|
|
Public constructors | |
---|---|
TransitionSet()
Constructs an empty transition set. |
|
TransitionSet(Context context, AttributeSet attrs)
|
Public methods | |
---|---|
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. |
TransitionSet
|
addTarget(View target)
Sets the target view instances that this Transition is interested in animating. |
TransitionSet
|
addTarget(int targetId)
Adds the id of a target view that this Transition is interested in animating. |
TransitionSet
|
addTarget(Class<T> targetType)
Adds the Class of a target view that this Transition is interested in animating. |
TransitionSet
|
addTarget(String targetName)
Adds the transitionName of a target view that this Transition is interested in animating. |
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. |
TransitionSet
|
clone()
Creates and returns a copy of this object. |
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<T> type, boolean exclude)
Whether to add the given type to the list of types 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. |
int
|
getOrdering()
Returns the ordering of this TransitionSet. |
Transition
|
getTransitionAt(int index)
Returns the child Transition at the specified position in the TransitionSet. |
int
|
getTransitionCount()
Returns the number of child transitions in the TransitionSet. |
TransitionSet
|
removeListener(Transition.TransitionListener listener)
Removes a listener from the set listening to this animation. |
TransitionSet
|
removeTarget(int targetId)
Removes the given targetId from the list of ids that this Transition is interested in animating. |
TransitionSet
|
removeTarget(View target)
Removes the given target from the list of targets that this Transition is interested in animating. |
TransitionSet
|
removeTarget(String target)
Removes the given targetName from the list of transitionNames that this Transition is interested in animating. |
TransitionSet
|
removeTarget(Class<T> target)
Removes the given target from the list of targets that this Transition is interested in animating. |
TransitionSet
|
removeTransition(Transition transition)
Removes the specified child transition from this set. |
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. |
void
|
setEpicenterCallback(Transition.EpicenterCallback epicenterCallback)
Sets the callback to use to find the epicenter of a Transition. |
TransitionSet
|
setInterpolator(TimeInterpolator interpolator)
Sets the interpolator of this transition. |
TransitionSet
|
setOrdering(int ordering)
Sets the play order of this set's child transitions. |
void
|
setPathMotion(PathMotion pathMotion)
Sets the algorithm used to calculate two-dimensional interpolation. |
void
|
setPropagation(TransitionPropagation propagation)
Sets the method for determining Animator start delays. |
TransitionSet
|
setStartDelay(long startDelay)
Sets the startDelay of this transition. |
Inherited methods | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Constants
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)
Public constructors
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)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
Public methods
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.
Parameters | |
---|---|
listener |
Transition.TransitionListener : the listener to be added to the current set of listeners
for this animation. |
Returns | |
---|---|
TransitionSet |
This transition object. |
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.
Parameters | |
---|---|
target |
View : A View on which the Transition will act, must be non-null. |
Returns | |
---|---|
TransitionSet |
The Transition to which the target is added.
Returning the same object makes it easier to chain calls during
construction, such as
transitionSet.addTransitions(new Fade()).addTarget(someView); |
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.
Parameters | |
---|---|
targetId |
int : The id of a target view, must be a positive number. |
Returns | |
---|---|
TransitionSet |
The Transition to which the targetId is added.
Returning the same object makes it easier to chain calls during
construction, such as
transitionSet.addTransitions(new Fade()).addTarget(someId); |
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.
Parameters | |
---|---|
targetType |
Class : The type to include when running this transition. |
Returns | |
---|---|
TransitionSet |
The Transition to which the target class was added.
Returning the same object makes it easier to chain calls during
construction, such as
transitionSet.addTransitions(new Fade()).addTarget(ImageView.class); |
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.
Parameters | |
---|---|
targetName |
String : The transitionName of a target view, must be non-null. |
Returns | |
---|---|
TransitionSet |
The Transition to which the target transitionName is added.
Returning the same object makes it easier to chain calls during
construction, such as
transitionSet.addTransitions(new Fade()).addTarget(someName); |
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.
Parameters | |
---|---|
transition |
Transition : A non-null child transition to be added to this set. |
Returns | |
---|---|
TransitionSet |
This transitionSet object. |
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.
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
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.
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. |
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:
will be true, and that the expression: x.clone() != x
will be x.clone().getClass() == x.getClass()
true
, but these are not absolute requirements.
While it is typically the case that:
will be x.clone().equals(x)
true
, this is not an absolute requirement.
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.
Returns | |
---|---|
TransitionSet |
a clone of this instance. |
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
).
Parameters | |
---|---|
target |
View : The target to ignore when running this transition. |
exclude |
boolean : Whether to add the target to or remove the target from the
current list of excluded targets. |
Returns | |
---|---|
Transition |
This transition object. |
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
).
Parameters | |
---|---|
type |
Class : The type to ignore when running this transition. |
exclude |
boolean : Whether to add the target type to or remove it from the
current list of excluded target types. |
Returns | |
---|---|
Transition |
This transition object. |
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
).
Parameters | |
---|---|
targetName |
String : The name of a target to ignore when running this transition. |
exclude |
boolean : Whether to add the target to or remove the target from the
current list of excluded targets. |
Returns | |
---|---|
Transition |
This transition object. |
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
).
Parameters | |
---|---|
targetId |
int : The id of a target to ignore when running this transition. |
exclude |
boolean : Whether to add the target to or remove the target from the
current list of excluded targets. |
Returns | |
---|---|
Transition |
This transition object. |
getOrdering
public 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:
getTransitionAt
public Transition getTransitionAt (int index)
Returns the child Transition at the specified position in the TransitionSet.
Parameters | |
---|---|
index |
int : The position of the Transition to retrieve. |
Returns | |
---|---|
Transition |
getTransitionCount
public int getTransitionCount ()
Returns the number of child transitions in the TransitionSet.
Returns | |
---|---|
int |
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.
Parameters | |
---|---|
listener |
Transition.TransitionListener : the listener to be removed from the current set of
listeners for this transition. |
Returns | |
---|---|
TransitionSet |
This transition object. |
removeTarget
public TransitionSet removeTarget (int targetId)
Removes the given targetId from the list of ids that this Transition is interested in animating.
Parameters | |
---|---|
targetId |
int : The id of a target view, must be a positive number. |
Returns | |
---|---|
TransitionSet |
The Transition from which the targetId is removed.
Returning the same object makes it easier to chain calls during
construction, such as
transitionSet.addTransitions(new Fade()).removeTargetId(someId); |
removeTarget
public TransitionSet removeTarget (View target)
Removes the given target from the list of targets that this Transition is interested in animating.
Parameters | |
---|---|
target |
View : The target view, must be non-null. |
Returns | |
---|---|
TransitionSet |
Transition The Transition from which the target is removed.
Returning the same object makes it easier to chain calls during
construction, such as
transitionSet.addTransitions(new Fade()).removeTarget(someView); |
removeTarget
public TransitionSet removeTarget (String target)
Removes the given targetName from the list of transitionNames that this Transition is interested in animating.
Parameters | |
---|---|
target |
String : The transitionName of a target view, must not be null. |
Returns | |
---|---|
TransitionSet |
The Transition from which the targetName is removed.
Returning the same object makes it easier to chain calls during
construction, such as
transitionSet.addTransitions(new Fade()).removeTargetName(someName); |
removeTarget
public TransitionSet removeTarget (Class<T> target)
Removes the given target from the list of targets that this Transition is interested in animating.
Parameters | |
---|---|
target |
Class : The type of the target view, must be non-null. |
Returns | |
---|---|
TransitionSet |
Transition The Transition from which the target is removed.
Returning the same object makes it easier to chain calls during
construction, such as
transitionSet.addTransitions(new Fade()).removeTarget(someType); |
removeTransition
public 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. |
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.
Parameters | |
---|---|
duration |
long : The length of the animation, in milliseconds. |
Returns | |
---|---|
TransitionSet |
This transitionSet object. |
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.
Parameters | |
---|---|
epicenterCallback |
Transition.EpicenterCallback : The callback to use to find the epicenter of the 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.
Parameters | |
---|---|
interpolator |
TimeInterpolator : The time interpolator used by the transition |
Returns | |
---|---|
TransitionSet |
This transition object. |
setOrdering
public 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. |
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>
Parameters | |
---|---|
pathMotion |
PathMotion : Algorithm object to use for determining how to interpolate in two
dimensions. If null, a straight-path algorithm will be used. |
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.
Parameters | |
---|---|
propagation |
TransitionPropagation : The class used to determine the start delay of
Animators created by this Transition. A null value
indicates that no delay should be used. |
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.
Parameters | |
---|---|
startDelay |
long : The length of the delay, in milliseconds. |
Returns | |
---|---|
TransitionSet |
This transition object. |