java.lang.Object | ||
↳ | android.transition.Transition | |
↳ | android.transition.TransitionSet |
Known Direct Subclasses |
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 TransitionSet
and
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:ordering="sequential"> <fade/> <changeBounds/> </transitionSet>
[Expand]
Inherited XML Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.transition.Transition
|
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. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.transition.Transition
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs an empty transition set.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds a listener to the set of listeners that are sent events through the
life of an animation, such as start, repeat, and end.
| |||||||||||
Adds the id of a target view that this Transition is interested in
animating.
| |||||||||||
Sets the target view instances that this Transition is interested in
animating.
| |||||||||||
Adds child transition to this set.
| |||||||||||
Captures the values in the end scene for the properties that this
transition monitors.
| |||||||||||
Captures the values in the start scene for the properties that this
transition monitors.
| |||||||||||
Creates and returns a copy of this
Object . | |||||||||||
Returns the ordering of this TransitionSet.
| |||||||||||
Removes a listener from the set listening to this animation.
| |||||||||||
Removes the given targetId from the list of ids that this Transition
is interested in animating.
| |||||||||||
Removes the given target from the list of targets that this Transition
is interested in animating.
| |||||||||||
Removes the specified child transition from this set.
| |||||||||||
Setting a non-negative duration on a TransitionSet causes all of the child
transitions (current and future) to inherit this duration.
| |||||||||||
Sets the callback to use to find the epicenter of a Transition.
| |||||||||||
Sets the interpolator of this transition.
| |||||||||||
Sets the play order of this set's child transitions.
| |||||||||||
Sets the method for determining Animator start delays.
| |||||||||||
Sets the startDelay of this transition.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.transition.Transition
| |||||||||||
From class
java.lang.Object
|
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.
A flag used to indicate that the child transitions of this set should all start at the same time.
Constructs an empty transition set. Add child transitions to the
set by calling addTransition(Transition)
)}. By default,
child transitions will play together
.
Adds a listener to the set of listeners that are sent events through the life of an animation, such as start, repeat, and end.
listener | the listener to be added to the current set of listeners for this animation. |
---|
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 underneat the scene root.
targetId | The id of a target view, must be a positive number. |
---|
transitionSet.addTransitions(new Fade()).addTarget(someId);
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(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.
target | A View on which the Transition will act, must be non-null. |
---|
transitionSet.addTransitions(new Fade()).addTarget(someView);
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.
transition | A non-null child transition to be added to this set. |
---|
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.
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. |
---|
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.
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. |
---|
Creates and returns a copy of this Object
. The default
implementation returns a so-called "shallow" copy: It creates a new
instance of the same class and then copies the field values (including
object references) from this instance to the new instance. A "deep" copy,
in contrast, would also recursively clone nested objects. A subclass that
needs to implement this kind of cloning should call super.clone()
to create the new instance and then create deep copies of the nested,
mutable objects.
Returns the ordering of this TransitionSet. By default, the value is
ORDERING_TOGETHER
.
ORDERING_TOGETHER
if child transitions will play at the same
time, ORDERING_SEQUENTIAL
if they will play in sequence.Removes a listener from the set listening to this animation.
listener | the listener to be removed from the current set of listeners for this transition. |
---|
Removes the given targetId from the list of ids that this Transition is interested in animating.
targetId | The id of a target view, must be a positive number. |
---|
transitionSet.addTransitions(new Fade()).removeTargetId(someId);
Removes the given target from the list of targets that this Transition is interested in animating.
target | The target view, must be non-null. |
---|
transitionSet.addTransitions(new Fade()).removeTarget(someView);
Removes the specified child transition from this set.
transition | The transition to be removed. |
---|
Setting a non-negative duration on a TransitionSet causes all of the child transitions (current and future) to inherit this duration.
duration | The length of the animation, in milliseconds. |
---|
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.
epicenterCallback | The callback to use to find the epicenter of the Transition. |
---|
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.
interpolator | The time interpolator used by the transition |
---|
Sets the play order of this set's child transitions.
ordering | ORDERING_TOGETHER to play this set's child
transitions together, ORDERING_SEQUENTIAL to play the child
transitions in sequence. |
---|
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.
propagation | The class used to determine the start delay of Animators created by this Transition. A null value indicates that no delay should be used. |
---|
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.
startDelay | The length of the delay, in milliseconds. |
---|