com.bluelinelabs.conductor.changehandler

Class SharedElementTransitionChangeHandler

java.lang.Object

com.bluelinelabs.conductor.ControllerChangeHandler

com.bluelinelabs.conductor.changehandler.TransitionChangeHandler

com.bluelinelabs.conductor.changehandler.SharedElementTransitionChangeHandler

public abstract class SharedElementTransitionChangeHandler
extends TransitionChangeHandler

A TransitionChangeHandler that facilitates using different Transitions for the entering view, the exiting view, and shared elements between the two.

Nested Class Summary

Nested classes/interfaces inherited from class com.bluelinelabs.conductor.changehandler.TransitionChangeHandler

TransitionChangeHandler.OnTransitionPreparedListener

Nested classes/interfaces inherited from class com.bluelinelabs.conductor.ControllerChangeHandler

ControllerChangeHandler.ControllerChangeCompletedListener, ControllerChangeHandler.ControllerChangeListener

Constructor Summary

Constructors

Constructor and Description
SharedElementTransitionChangeHandler()

Method Summary

Modifier and Type	Method and Description
protected void	addSharedElement(java.lang.String name) Used to register an element that will take part in the shared element transition.
protected void	addSharedElement(java.lang.String fromName, java.lang.String toName) Used to register an element that will take part in the shared element transition.
protected void	addSharedElement(android.view.View sharedElement, java.lang.String toName) Used to register an element that will take part in the shared element transition.
boolean	allowTransitionOverlap(boolean isPush) Should return whether or not the the exit transition and enter transition should overlap.
abstract void	configureSharedElements(android.view.ViewGroup container, android.view.View from, android.view.View to, boolean isPush) Will be called when views are ready to have their shared elements configured.
void	executePropertyChanges(android.view.ViewGroup container, android.view.View from, android.view.View to, android.transition.Transition transition, boolean isPush) This should set all view properties needed for the transition to work properly.
abstract android.transition.Transition	getEnterTransition(android.view.ViewGroup container, android.view.View from, android.view.View to, boolean isPush) Should return the transition that will be used on the entering ("to") view, if one is desired.
android.app.SharedElementCallback	getEnterTransitionCallback(android.view.ViewGroup container, android.view.View from, android.view.View to, boolean isPush) Should return a callback that can be used to customize transition behavior of the shared element transition for the "to" view.
abstract android.transition.Transition	getExitTransition(android.view.ViewGroup container, android.view.View from, android.view.View to, boolean isPush) Should return the transition that will be used on the exiting ("from") view, if one is desired.
android.app.SharedElementCallback	getExitTransitionCallback(android.view.ViewGroup container, android.view.View from, android.view.View to, boolean isPush) Should return a callback that can be used to customize transition behavior of the shared element transition for the "from" view.
abstract android.transition.Transition	getSharedElementTransition(android.view.ViewGroup container, android.view.View from, android.view.View to, boolean isPush) Should return the transition that will be used on shared elements between the from and to views.
protected android.transition.Transition	getTransition(android.view.ViewGroup container, android.view.View from, android.view.View to, boolean isPush) Should be overridden to return the Transition to use while replacing Views.
void	onAbortPush(ControllerChangeHandler newHandler, Controller newTop) Will be called on change handlers that push a controller if the controller being pushed is popped before it has completed.
void	prepareForTransition(android.view.ViewGroup container, android.view.View from, android.view.View to, android.transition.Transition transition, boolean isPush, TransitionChangeHandler.OnTransitionPreparedListener onTransitionPreparedListener) Called before a transition occurs.
protected void	waitOnSharedElementNamed(java.lang.String name) The transition will be delayed until the view with the name passed in is available in the "to" hierarchy.

Methods inherited from class com.bluelinelabs.conductor.changehandler.TransitionChangeHandler

completeImmediately, performChange, removesFromViewOnPush

Methods inherited from class com.bluelinelabs.conductor.ControllerChangeHandler

copy, fromBundle, isReusable, restoreFromBundle, saveToBundle, setForceRemoveViewOnPush

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SharedElementTransitionChangeHandler

public SharedElementTransitionChangeHandler()

Method Detail

getTransition

protected final android.transition.Transition getTransition(android.view.ViewGroup container,
                                                            android.view.View from,
                                                            android.view.View to,
                                                            boolean isPush)

Description copied from class: TransitionChangeHandler

Should be overridden to return the Transition to use while replacing Views.

Specified by:

getTransition in class TransitionChangeHandler

Parameters:

container - The container these Views are hosted in

from - The previous View in the container or null if there was no Controller before this transition

to - The next View that should be put in the container or null if no Controller is being transitioned to

isPush - True if this is a push transaction, false if it's a pop

prepareForTransition

public void prepareForTransition(android.view.ViewGroup container,
                                 android.view.View from,
                                 android.view.View to,
                                 android.transition.Transition transition,
                                 boolean isPush,
                                 TransitionChangeHandler.OnTransitionPreparedListener onTransitionPreparedListener)

Description copied from class: TransitionChangeHandler

Called before a transition occurs. This can be used to reorder views, set their transition names, etc. The transition will begin when onTransitionPreparedListener is called.

Overrides:

prepareForTransition in class TransitionChangeHandler

Parameters:

container - The container these Views are hosted in

from - The previous View in the container or null if there was no Controller before this transition

to - The next View that should be put in the container or null if no Controller is being transitioned to

transition - The transition that is being prepared for

isPush - True if this is a push transaction, false if it's a pop

executePropertyChanges

public final void executePropertyChanges(android.view.ViewGroup container,
                                         android.view.View from,
                                         android.view.View to,
                                         android.transition.Transition transition,
                                         boolean isPush)

Description copied from class: TransitionChangeHandler

This should set all view properties needed for the transition to work properly. By default it removes the "from" view and adds the "to" view.

Overrides:

executePropertyChanges in class TransitionChangeHandler

Parameters:

container - The container these Views are hosted in

from - The previous View in the container or null if there was no Controller before this transition

to - The next View that should be put in the container or null if no Controller is being transitioned to

transition - The transition with which TransitionManager.beginDelayedTransition has been called. This will be null only if another ControllerChangeHandler immediately overrides this one.

isPush - True if this is a push transaction, false if it's a pop

onAbortPush

public void onAbortPush(ControllerChangeHandler newHandler,
                        Controller newTop)

Description copied from class: ControllerChangeHandler

Will be called on change handlers that push a controller if the controller being pushed is popped before it has completed.

Overrides:

onAbortPush in class TransitionChangeHandler

Parameters:

newHandler - The change handler that has caused this push to be aborted

newTop - The Controller that will now be at the top of the backstack or null if there will be no new Controller at the top

configureSharedElements

public abstract void configureSharedElements(android.view.ViewGroup container,
                                             android.view.View from,
                                             android.view.View to,
                                             boolean isPush)

Will be called when views are ready to have their shared elements configured. Within this method one of the addSharedElement methods should be called for each shared element that will be used. If one or more of these shared elements will not instantly be available in the incoming view (for ex, in a RecyclerView), waitOnSharedElementNamed can be called to delay the transition until everything is available.

getExitTransition

public abstract android.transition.Transition getExitTransition(android.view.ViewGroup container,
                                                                android.view.View from,
                                                                android.view.View to,
                                                                boolean isPush)

Should return the transition that will be used on the exiting ("from") view, if one is desired.

getSharedElementTransition

public abstract android.transition.Transition getSharedElementTransition(android.view.ViewGroup container,
                                                                         android.view.View from,
                                                                         android.view.View to,
                                                                         boolean isPush)

Should return the transition that will be used on shared elements between the from and to views.

getEnterTransition

public abstract android.transition.Transition getEnterTransition(android.view.ViewGroup container,
                                                                 android.view.View from,
                                                                 android.view.View to,
                                                                 boolean isPush)

Should return the transition that will be used on the entering ("to") view, if one is desired.

getExitTransitionCallback

public android.app.SharedElementCallback getExitTransitionCallback(android.view.ViewGroup container,
                                                                   android.view.View from,
                                                                   android.view.View to,
                                                                   boolean isPush)

Should return a callback that can be used to customize transition behavior of the shared element transition for the "from" view.

getEnterTransitionCallback

public android.app.SharedElementCallback getEnterTransitionCallback(android.view.ViewGroup container,
                                                                    android.view.View from,
                                                                    android.view.View to,
                                                                    boolean isPush)

Should return a callback that can be used to customize transition behavior of the shared element transition for the "to" view.

allowTransitionOverlap

public boolean allowTransitionOverlap(boolean isPush)

Should return whether or not the the exit transition and enter transition should overlap. If true, the enter transition will start as soon as possible. Otherwise, the enter transition will wait until the completion of the exit transition. Defaults to true.

addSharedElement

protected final void addSharedElement(java.lang.String name)

Used to register an element that will take part in the shared element transition.

Parameters:

name - The transition name that is used for both the entering and exiting views.

addSharedElement

protected final void addSharedElement(java.lang.String fromName,
                                      java.lang.String toName)

Used to register an element that will take part in the shared element transition. Maps the name used in the "from" view to the name used in the "to" view if they are not the same.

Parameters:

fromName - The transition name used in the "from" view

toName - The transition name used in the "to" view

addSharedElement

protected final void addSharedElement(android.view.View sharedElement,
                                      java.lang.String toName)

Used to register an element that will take part in the shared element transition. Maps the name used in the "from" view to the name used in the "to" view if they are not the same.

Parameters:

sharedElement - The view from the "from" view that will take part in the shared element transition

toName - The transition name used in the "to" view

waitOnSharedElementNamed

protected final void waitOnSharedElementNamed(java.lang.String name)

The transition will be delayed until the view with the name passed in is available in the "to" hierarchy. This is particularly useful for views that don't load instantly, like RecyclerViews. Note that using this method can potentially lock up your app indefinitely if the view never loads!