public abstract class Transition extends Object implements Cloneable
TransitionSet
or they may
perform custom animations themselves. Any Transition has two main jobs:
(1) capture property values, and (2) play animations based on changes to
captured property values. A custom transition knows what property values
on View objects are of interest to it, and also knows how to animate
changes to those values. For example, the Fade
transition tracks
changes to visibility-related properties and is able to construct and run
animations that fade items in or out based on changes to those properties.
Note: Transitions may not work correctly with either SurfaceView
or TextureView
, due to the way that these views are displayed
on the screen. For SurfaceView, the problem is that the view is updated from
a non-UI thread, so changes to the view due to transitions (such as moving
and resizing the view) may be out of sync with the display inside those bounds.
TextureView is more compatible with transitions in general, but some
specific transitions (such as Fade
) may not be compatible
with TextureView because they rely on ViewOverlay
functionality,
which does not currently work with TextureView.
Transitions can be declared in XML resource files inside the res/transition
directory. Transition resources consist of a tag name for one of the Transition
subclasses along with attributes to define some of the attributes of that transition.
For example, here is a minimal resource file that declares a ChangeBounds
transition:
This TransitionSet contains Explode
for visibility,
ChangeBounds
, ChangeTransform
,
and ChangeClipBounds
and
ChangeImageTransform
:
Custom transition classes may be instantiated with a transition
tag:
<transition class="my.app.transition.CustomTransition"/>
Custom transition classes loaded from XML should have a public constructor taking
a Context
and AttributeSet
.
Note that attributes for the transition are not required, just as they are
optional when declared in code; Transitions created from XML resources will use
the same defaults as their code-created equivalents. Here is a slightly more
elaborate example which declares a TransitionSet
transition with
ChangeBounds
and Fade
child transitions:
In this example, the transitionOrdering attribute is used on the TransitionSet
object to change from the default TransitionSet.ORDERING_TOGETHER
behavior
to be TransitionSet.ORDERING_SEQUENTIAL
instead. Also, the Fade
transition uses a fadingMode of Fade.OUT
instead of the default
out-in behavior. Finally, note the use of the targets
sub-tag, which
takes a set of target
tags, each
of which lists a specific targetId
, targetClass
,
targetName
, excludeId
, excludeClass
, or
excludeName
, which this transition acts upon.
Use of targets is optional, but can be used to either limit the time spent checking
attributes on unchanging views, or limiting the types of animations run on specific views.
In this case, we know that only the grayscaleContainer
will be
disappearing, so we choose to limit the Fade
transition to only that view.
android.R.styleable#Transition
, android.R.styleable#TransitionSet
,
android.R.styleable#TransitionTarget
, android.R.styleable#Fade
,
android.R.styleable#Slide
, and android.R.styleable#ChangeTransform
.Modifier and Type | Class and Description |
---|---|
static class |
Transition.AnimationInfo
Holds information about each animator used when a new transition starts
while other transitions are still running to determine whether a running
animation should be canceled or a new animation noop'd.
|
static class |
Transition.EpicenterCallback
Class to get the epicenter of Transition.
|
static interface |
Transition.TransitionListener
A transition listener receives notifications from a transition.
|
static class |
Transition.TransitionListenerAdapter
Utility adapter class to avoid having to override all three methods
whenever someone just wants to listen for a single event.
|
Modifier and Type | Field and Description |
---|---|
static int |
MATCH_ID
With
setMatchOrder(int...) , chooses to match by
View.getId() . |
static int |
MATCH_INSTANCE
With
setMatchOrder(int...) , chooses to match by View instance. |
static int |
MATCH_ITEM_ID
With
setMatchOrder(int...) , chooses to match by the Adapter
item id. |
static int |
MATCH_NAME
With
setMatchOrder(int...) , chooses to match by
View.getTransitionName() . |
Constructor and Description |
---|
Transition()
Constructs a Transition object with no target objects.
|
Transition(Context context,
AttributeSet attrs)
Perform inflation from XML and apply a class-specific base style from a
theme attribute or style resource.
|
Modifier and Type | Method and Description |
---|---|
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(Class targetType)
Adds the Class of a target view 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.
|
Transition |
addTarget(String targetName)
Adds the transitionName 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.
|
protected void |
animate(Animator animator)
This is a utility method used by subclasses to handle standard parts of
setting up and running an Animator: it sets the
duration and the startDelay , starts the
animation, and, when the animator ends, calls end() . |
protected void |
cancel()
This method cancels a transition that is currently running.
|
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.
|
protected void |
createAnimators(ViewGroup sceneRoot,
android.transition.TransitionValuesMaps startValues,
android.transition.TransitionValuesMaps endValues,
ArrayList<TransitionValues> startValuesList,
ArrayList<TransitionValues> endValuesList)
This method, essentially a wrapper around all calls to createAnimator for all
possible target views, is called with the entire set of start/end
values.
|
protected void |
end()
This method is called automatically by the Transition and
TransitionSet classes when a transition finishes, either because
a transition did nothing (returned a null Animator from
createAnimator(ViewGroup, TransitionValues,
TransitionValues) ) or because the transition returned a valid
Animator and end() was called in the onAnimationEnd()
callback of the AnimatorListener. |
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 |
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(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.
|
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(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.
|
ArrayMap<String,String> |
getNameOverrides() |
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<View> |
getTargets()
Returns the list of target views 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<String> |
getTargetViewNames()
To be removed before L release.
|
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.
|
boolean |
isTransitionRequired(TransitionValues startValues,
TransitionValues endValues)
Returns whether or not the transition should create an Animator, based on the values
captured during
captureStartValues(TransitionValues) and
captureEndValues(TransitionValues) . |
void |
pause(View sceneRoot)
Pauses this transition, sending out calls to
Transition.TransitionListener.onTransitionPause(Transition) to all listeners
and pausing all running animators started by this transition. |
Transition |
removeListener(Transition.TransitionListener listener)
Removes a listener from the set listening to this animation.
|
Transition |
removeTarget(Class target)
Removes the given target from the list of targets that this Transition
is interested in animating.
|
Transition |
removeTarget(int targetId)
Removes the given targetId from the list of ids 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(View target)
Removes the given target from the list of targets that this Transition
is interested in animating.
|
void |
resume(View sceneRoot)
Resumes this transition, sending out calls to
Transition.TransitionListener.onTransitionPause(Transition) to all listeners
and pausing all running animators started by this transition. |
protected void |
runAnimators()
This is called internally once all animations have been set up by the
transition hierarchy.
|
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 |
setNameOverrides(ArrayMap<String,String> overrides)
Sets the shared element names -- a mapping from a name at the start state to
a different name at the end state.
|
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.
|
protected void |
start()
This method is called automatically by the transition and
TransitionSet classes prior to a Transition subclass starting;
subclasses should not need to call it directly.
|
String |
toString()
Returns a string representation of the object.
|
public static final int MATCH_INSTANCE
setMatchOrder(int...)
, chooses to match by View instance.public static final int MATCH_NAME
setMatchOrder(int...)
, chooses to match by
View.getTransitionName()
. Null names will not be matched.public static final int MATCH_ID
setMatchOrder(int...)
, chooses to match by
View.getId()
. Negative IDs will not be matched.public static final int MATCH_ITEM_ID
setMatchOrder(int...)
, chooses to match by the Adapter
item id. When Adapter.hasStableIds()
returns false, no match
will be made for items.public Transition()
public Transition(Context context, AttributeSet attrs)
context
- The Context the transition is running in, through which it can
access the current theme, resources, etc.attrs
- The attributes of the XML tag that is inflating the transition.public Transition setDuration(long duration)
duration
- The length of the animation, in milliseconds.public long getDuration()
public Transition setStartDelay(long startDelay)
startDelay
- The length of the delay, in milliseconds.public long getStartDelay()
public Transition setInterpolator(TimeInterpolator interpolator)
interpolator
- The time interpolator used by the transitionpublic TimeInterpolator getInterpolator()
public String[] getTransitionProperties()
TransitionValues
object passed into captureStartValues(TransitionValues)
that
this transition cares about for the purposes of canceling overlapping animations.
When any transition is started on a given scene root, all transitions
currently running on that same scene root are checked to see whether the
properties on which they based their animations agree with the end values of
the same properties in the new transition. If the end values are not equal,
then the old animation is canceled since the new transition will start a new
animation to these new values. If the values are equal, the old animation is
allowed to continue and no new animation is started for that transition.
A transition does not need to override this method. However, not doing so will mean that the cancellation logic outlined in the previous paragraph will be skipped for that transition, possibly leading to artifacts as old transitions and new transitions on the same targets run in parallel, animating views toward potentially different end values.
TransitionValues
. The default implementation returns null
.public Animator createAnimator(ViewGroup sceneRoot, TransitionValues startValues, TransitionValues endValues)
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 TransitionValues.view
field.
sceneRoot
- The root of the transition hierarchy.startValues
- The values for a specific target in the start scene.endValues
- The values for the target in the end scene.public void setMatchOrder(int... matches)
The default behavior is to match first by View.getTransitionName()
,
then by View instance, then by View.getId()
and finally
by its item ID if it is in a direct child of ListView. The caller can
choose to have only some or all of the values of MATCH_INSTANCE
,
MATCH_NAME
, MATCH_ITEM_ID
, and MATCH_ID
. Only
the match algorithms supplied will be used to determine whether Views are the
the same in both the start and end Scene. Views that do not match will be considered
as entering or leaving the Scene.
matches
- A list of zero or more of MATCH_INSTANCE
,
MATCH_NAME
, MATCH_ITEM_ID
, and MATCH_ID
.
If none are provided, then the default match order will be set.protected void createAnimators(ViewGroup sceneRoot, android.transition.TransitionValuesMaps startValues, android.transition.TransitionValuesMaps endValues, ArrayList<TransitionValues> startValuesList, ArrayList<TransitionValues> endValuesList)
createAnimator(ViewGroup, TransitionValues, TransitionValues)
with each set of start/end values on this transition. The
TransitionSet subclass overrides this method and delegates it to
each of its children in succession.protected void runAnimators()
public abstract void captureStartValues(TransitionValues transitionValues)
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.captureEndValues(TransitionValues)
,
createAnimator(ViewGroup, TransitionValues, TransitionValues)
public abstract void captureEndValues(TransitionValues transitionValues)
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.captureStartValues(TransitionValues)
,
createAnimator(ViewGroup, TransitionValues, TransitionValues)
public Transition addTarget(int targetId)
Note that using ids to specify targets implies that ids should be unique within the view hierarchy underneath the scene root.
targetId
- The id of a target view, must be a positive number.transitionSet.addTransitions(new Fade()).addTarget(someId);
View.getId()
public Transition addTarget(String targetName)
Note that transitionNames should be unique within the view hierarchy.
targetName
- The transitionName of a target view, must be non-null.transitionSet.addTransitions(new Fade()).addTarget(someName);
View.getTransitionName()
public Transition addTarget(Class targetType)
Note that any View that can be cast to targetType will be included, so
if targetType is View.class
, all Views will be included.
targetType
- The type to include when running this transition.transitionSet.addTransitions(new Fade()).addTarget(ImageView.class);
addTarget(int)
,
addTarget(android.view.View)
,
excludeTarget(Class, boolean)
,
excludeChildren(Class, boolean)
public Transition removeTarget(int targetId)
targetId
- The id of a target view, must be a positive number.transitionSet.addTransitions(new Fade()).removeTargetId(someId);
public Transition removeTarget(String targetName)
targetName
- The transitionName of a target view, must not be null.transitionSet.addTransitions(new Fade()).removeTargetName(someName);
public Transition excludeTarget(int targetId, boolean exclude)
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
).
targetId
- The id of a target to ignore when running this transition.exclude
- Whether to add the target to or remove the target from the
current list of excluded targets.excludeChildren(int, boolean)
,
excludeTarget(View, boolean)
,
excludeTarget(Class, boolean)
public Transition excludeTarget(String targetName, boolean exclude)
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
).
targetName
- The name of a target to ignore when running this transition.exclude
- Whether to add the target to or remove the target from the
current list of excluded targets.excludeTarget(View, boolean)
,
excludeTarget(int, boolean)
,
excludeTarget(Class, boolean)
public Transition excludeChildren(int targetId, boolean exclude)
exclude
parameter specifies whether
the children of the target should be added to or removed from the excluded list.
Excluding children in this way provides a simple mechanism for excluding all
children of specific targets, rather than individually excluding each
child individually.
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
).
targetId
- The id of a target whose children should be ignored when running
this transition.exclude
- Whether to add the target to or remove the target from the
current list of excluded-child targets.excludeTarget(int, boolean)
,
excludeChildren(View, boolean)
,
excludeChildren(Class, boolean)
public Transition excludeTarget(View target, boolean exclude)
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
).
target
- The target to ignore when running this transition.exclude
- Whether to add the target to or remove the target from the
current list of excluded targets.excludeChildren(View, boolean)
,
excludeTarget(int, boolean)
,
excludeTarget(Class, boolean)
public Transition excludeChildren(View target, boolean exclude)
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
).
target
- The target to ignore when running this transition.exclude
- Whether to add the target to or remove the target from the
current list of excluded targets.excludeTarget(View, boolean)
,
excludeChildren(int, boolean)
,
excludeChildren(Class, boolean)
public Transition excludeTarget(Class type, boolean exclude)
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
).
type
- The type to ignore when running this transition.exclude
- Whether to add the target type to or remove it from the
current list of excluded target types.excludeChildren(Class, boolean)
,
excludeTarget(int, boolean)
,
excludeTarget(View, boolean)
public Transition excludeChildren(Class type, boolean exclude)
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
).
type
- The type to ignore when running this transition.exclude
- Whether to add the target type to or remove it from the
current list of excluded target types.excludeTarget(Class, boolean)
,
excludeChildren(int, boolean)
,
excludeChildren(View, boolean)
public Transition addTarget(View target)
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);
addTarget(int)
public Transition removeTarget(View target)
target
- The target view, must be non-null.transitionSet.addTransitions(new Fade()).removeTarget(someView);
public Transition removeTarget(Class target)
target
- The type of the target view, must be non-null.transitionSet.addTransitions(new Fade()).removeTarget(someType);
public List<Integer> getTargetIds()
getTargetIds()
, getTargets()
, getTargetNames()
, and
getTargetTypes()
then this transition is
not limited to specific views, and will handle changes to any views
in the hierarchy of a scene change.public List<View> getTargets()
getTargetIds()
, getTargets()
, getTargetNames()
, and
getTargetTypes()
then this transition is
not limited to specific views, and will handle changes to any views
in the hierarchy of a scene change.public List<String> getTargetNames()
getTargetIds()
, getTargets()
, getTargetNames()
, and
getTargetTypes()
then this transition is
not limited to specific views, and will handle changes to any views
in the hierarchy of a scene change.public List<Class> getTargetTypes()
getTargetIds()
, getTargets()
, getTargetNames()
, and
getTargetTypes()
then this transition is
not limited to specific views, and will handle changes to any views
in the hierarchy of a scene change.public TransitionValues getTransitionValues(View view, boolean start)
public void pause(View sceneRoot)
Transition.TransitionListener.onTransitionPause(Transition)
to all listeners
and pausing all running animators started by this transition.public void resume(View sceneRoot)
Transition.TransitionListener.onTransitionPause(Transition)
to all listeners
and pausing all running animators started by this transition.public boolean isTransitionRequired(TransitionValues startValues, TransitionValues endValues)
captureStartValues(TransitionValues)
and
captureEndValues(TransitionValues)
. The default implementation compares the
property values returned from getTransitionProperties()
, or all property values if
getTransitionProperties()
returns null. Subclasses may override this method to
provide logic more specific to the transition implementation.startValues
- the values from captureStartValues, This may be null
if the
View did not exist in the start state.endValues
- the values from captureEndValues. This may be null
if the View
did not exist in the end state.protected void animate(Animator animator)
duration
and the startDelay
, starts the
animation, and, when the animator ends, calls end()
.animator
- The Animator to be run during this transition.protected void start()
protected void end()
createAnimator(ViewGroup, TransitionValues,
TransitionValues)
) or because the transition returned a valid
Animator and end() was called in the onAnimationEnd()
callback of the AnimatorListener.protected void cancel()
public Transition addListener(Transition.TransitionListener listener)
listener
- the listener to be added to the current set of listeners
for this animation.public Transition removeListener(Transition.TransitionListener listener)
listener
- the listener to be removed from the current set of
listeners for this transition.public void setEpicenterCallback(Transition.EpicenterCallback epicenterCallback)
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.public Transition.EpicenterCallback getEpicenterCallback()
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.public Rect getEpicenter()
Transition.EpicenterCallback
or null if no callback exists.Transition.EpicenterCallback
or null if no callback exists.setEpicenterCallback(android.transition.Transition.EpicenterCallback)
public void setPathMotion(PathMotion pathMotion)
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>
pathMotion
- Algorithm object to use for determining how to interpolate in two
dimensions. If null, a straight-path algorithm will be used.ArcMotion
,
PatternPathMotion
,
PathMotion
public PathMotion getPathMotion()
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>
ArcMotion
,
PatternPathMotion
,
PathMotion
public void setPropagation(TransitionPropagation transitionPropagation)
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.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.public TransitionPropagation getPropagation()
TransitionPropagation
used to calculate 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.TransitionPropagation
used to calculate Animator start
delays. This is null by default.public boolean canRemoveViews()
public void setNameOverrides(ArrayMap<String,String> overrides)
public String toString()
Object
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
public Transition clone()
Object
x
, the expression:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true
, but these are not absolute requirements.
While it is typically the case that:
will bex.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.
The method clone
for class Object
performs a
specific cloning operation. First, if the class of this object does
not implement the interface Cloneable
, then a
CloneNotSupportedException
is thrown. Note that all arrays
are considered to implement the interface Cloneable
and that
the return type of the clone
method of an array type T[]
is T[]
where T is any reference or primitive type.
Otherwise, this method creates a new instance of the class of this
object and initializes all its fields with exactly the contents of
the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method
performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object
does not itself implement the interface
Cloneable
, so calling the clone
method on an object
whose class is Object
will result in throwing an
exception at run time.
public String getName()
By default, a Transition's name is simply the value of Class.getName()
,
but subclasses are free to override and return something different.