Explode


public class Explode
extends Visibility

java.lang.Object
   ↳ android.transition.Transition
     ↳ android.transition.Visibility
       ↳ android.transition.Explode


This transition tracks changes to the visibility of target views in the start and end scenes and moves views in or out from the edges of the scene. Visibility is determined by both the View.setVisibility(int) state of the view as well as whether it is parented in the current view hierarchy. Disappearing Views are limited as described in Visibility.onDisappear(android.view.ViewGroup, TransitionValues, int, TransitionValues, int).

Views move away from the focal View or the center of the Scene if no epicenter was provided.

Summary

Inherited XML attributes

android:transitionVisibilityMode Changes whether the transition supports appearing and/or disappearing Views. 
android:duration Amount of time (in milliseconds) that the transition should run. 
android:interpolator Interpolator to be used in the animations spawned by this transition. 
android:startDelay Delay in milliseconds before the transition starts. 

Inherited constants

int MODE_IN

Mode used in setMode(int) to make the transition operate on targets that are appearing.

int MODE_OUT

Mode used in setMode(int) to make the transition operate on targets that are disappearing.

int MATCH_ID

With setMatchOrder(int), chooses to match by View.getId().

int MATCH_INSTANCE

With setMatchOrder(int), chooses to match by View instance.

int MATCH_ITEM_ID

With setMatchOrder(int), chooses to match by the Adapter item id.

int MATCH_NAME

With setMatchOrder(int), chooses to match by View.getTransitionName().

Public constructors

Explode()
Explode(Context context, AttributeSet attrs)

Public methods

void captureEndValues(TransitionValues transitionValues)

Captures the values in the end scene for the properties that this transition monitors.

void captureStartValues(TransitionValues transitionValues)

Captures the values in the start scene for the properties that this transition monitors.

Animator onAppear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)

The default implementation of this method returns a null Animator.

Animator onDisappear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)

The default implementation of this method returns a null Animator.

Inherited methods

void captureEndValues(TransitionValues transitionValues)

Captures the values in the end scene for the properties that this transition monitors.

void captureStartValues(TransitionValues transitionValues)

Captures the values in the start scene for the properties that this transition monitors.

Animator createAnimator(ViewGroup sceneRoot, TransitionValues startValues, TransitionValues endValues)

This method creates an animation that will be run for this transition given the information in the startValues and endValues structures captured earlier for the start and end scenes.

int getMode()

Returns whether appearing and/or disappearing Views are supported.

String[] getTransitionProperties()

Returns the set of property names used stored in the TransitionValues object passed into captureStartValues(android.transition.TransitionValues) that this transition cares about for the purposes of canceling overlapping animations.

boolean isTransitionRequired(TransitionValues startValues, TransitionValues newValues)

Returns whether or not the transition should create an Animator, based on the values captured during captureStartValues(android.transition.TransitionValues) and captureEndValues(android.transition.TransitionValues).

boolean isVisible(TransitionValues values)

Returns whether the view is 'visible' according to the given values object.

Animator onAppear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)

The default implementation of this method returns a null Animator.

Animator onAppear(ViewGroup sceneRoot, TransitionValues startValues, int startVisibility, TransitionValues endValues, int endVisibility)

The default implementation of this method calls onAppear(android.view.ViewGroup, android.view.View, android.transition.TransitionValues, android.transition.TransitionValues).

Animator onDisappear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)

The default implementation of this method returns a null Animator.

Animator onDisappear(ViewGroup sceneRoot, TransitionValues startValues, int startVisibility, TransitionValues endValues, int endVisibility)

Subclasses should override this method or onDisappear(android.view.ViewGroup, android.view.View, android.transition.TransitionValues, android.transition.TransitionValues) if they need to create an Animator when targets disappear.

void setMode(int mode)

Changes the transition to support appearing and/or disappearing Views, depending on mode.

Transition addListener(Transition.TransitionListener listener)

Adds a listener to the set of listeners that are sent events through the life of an animation, such as start, repeat, and end.

Transition addTarget(View target)

Sets the target view instances that this Transition is interested in animating.

Transition addTarget(int targetId)

Adds the id of a target view that this Transition is interested in animating.

Transition addTarget(Class<T> targetType)

Adds the Class 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.

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.

Transition excludeChildren(int targetId, boolean exclude)

Whether to add the children of the given id to the list of targets to exclude from this transition.

Transition excludeChildren(Class<T> type, boolean exclude)

Whether to add the given type to the list of types whose children should be excluded from this transition.

Transition excludeChildren(View target, boolean exclude)

Whether to add the children of given target to the list of target children to exclude from this transition.

Transition excludeTarget(View target, boolean exclude)

Whether to add the given target to the list of targets to exclude from this transition.

Transition excludeTarget(Class<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.

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.

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<Class<T>> getTargetTypes()

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.

String[] getTransitionProperties()

Returns the set of property names used stored in the TransitionValues object passed into captureStartValues(android.transition.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(android.transition.TransitionValues) and captureEndValues(android.transition.TransitionValues).

Transition removeListener(Transition.TransitionListener listener)

Removes a listener from the set listening to this animation.

Transition removeTarget(int targetId)

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

Transition removeTarget(View target)

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

Transition removeTarget(String targetName)

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

Transition removeTarget(Class<T> target)

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

Transition setDuration(long duration)

Sets the duration of this transition.

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

String toString()

Returns a string representation of the object.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Explode

Added in API level 21
public Explode ()

Explode

Added in API level 21
public Explode (Context context, 
                AttributeSet attrs)

Parameters
context Context

attrs AttributeSet

Public methods

captureEndValues

Added in API level 21
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

Added in API level 21
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.

onAppear

Added in API level 21
public Animator onAppear (ViewGroup sceneRoot, 
                View view, 
                TransitionValues startValues, 
                TransitionValues endValues)

The default implementation of this method returns a null Animator. Subclasses should override this method to make targets appear with the desired transition. The method should only be called from onAppear(android.view.ViewGroup, android.transition.TransitionValues, int, android.transition.TransitionValues, int).

Parameters
sceneRoot ViewGroup: The root of the transition hierarchy

view View: The View to make appear. This will be in the target scene's View hierarchy and will be VISIBLE.

startValues TransitionValues: The target values in the start scene

endValues TransitionValues: The target values in the end scene

Returns
Animator An Animator to be started at the appropriate time in the overall transition for this scene change. A null value means no animation should be run.

onDisappear

Added in API level 21
public Animator onDisappear (ViewGroup sceneRoot, 
                View view, 
                TransitionValues startValues, 
                TransitionValues endValues)

The default implementation of this method returns a null Animator. Subclasses should override this method to make targets disappear with the desired transition. The method should only be called from onDisappear(android.view.ViewGroup, android.transition.TransitionValues, int, android.transition.TransitionValues, int).

Parameters
sceneRoot ViewGroup: The root of the transition hierarchy

view View: The View to make disappear. This will be in the target scene's View hierarchy or in an ViewGroupOverlay and will be VISIBLE.

startValues TransitionValues: The target values in the start scene

endValues TransitionValues: The target values in the end scene

Returns
Animator An Animator to be started at the appropriate time in the overall transition for this scene change. A null value means no animation should be run.