com.bluelinelabs.conductor.changehandler

Class AnimatorChangeHandler

java.lang.Object

com.bluelinelabs.conductor.ControllerChangeHandler

com.bluelinelabs.conductor.changehandler.AnimatorChangeHandler

Direct Known Subclasses:

FadeChangeHandler, HorizontalChangeHandler, VerticalChangeHandler

public abstract class AnimatorChangeHandler
extends ControllerChangeHandler

A base ControllerChangeHandler that facilitates using Animators to replace Controller Views

Nested Class Summary

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

ControllerChangeHandler.ControllerChangeCompletedListener, ControllerChangeHandler.ControllerChangeListener

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_ANIMATION_DURATION

Constructor Summary

Constructors

Constructor and Description
AnimatorChangeHandler()
AnimatorChangeHandler(boolean removesFromViewOnPush)
AnimatorChangeHandler(long duration)
AnimatorChangeHandler(long duration, boolean removesFromViewOnPush)

Method Summary

Modifier and Type	Method and Description
void	completeImmediately() Will be called on change handlers that push a controller if the controller being pushed is needs to be attached immediately, without any animations or transitions.
long	getAnimationDuration()
protected abstract android.animation.Animator	getAnimator(android.view.ViewGroup container, android.view.View from, android.view.View to, boolean isPush, boolean toAddedToContainer) Should be overridden to return the Animator 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	performChange(android.view.ViewGroup container, android.view.View from, android.view.View to, boolean isPush, ControllerChangeHandler.ControllerChangeCompletedListener changeListener) Responsible for swapping Views from one Controller to another.
boolean	removesFromViewOnPush()
protected abstract void	resetFromView(android.view.View from) Will be called after the animation is complete to reset the View that was removed to its pre-animation state.
void	restoreFromBundle(android.os.Bundle bundle) Restores data that was saved in the ControllerChangeHandler.saveToBundle(Bundle bundle) method.
void	saveToBundle(android.os.Bundle bundle) Saves any data about this handler to a Bundle in case the application is killed.

Methods inherited from class com.bluelinelabs.conductor.ControllerChangeHandler

copy, fromBundle, isReusable, setForceRemoveViewOnPush

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ANIMATION_DURATION

public static final long DEFAULT_ANIMATION_DURATION

See Also:

Constant Field Values

Constructor Detail

AnimatorChangeHandler

public AnimatorChangeHandler()

AnimatorChangeHandler

public AnimatorChangeHandler(boolean removesFromViewOnPush)

AnimatorChangeHandler

public AnimatorChangeHandler(long duration)

AnimatorChangeHandler

public AnimatorChangeHandler(long duration,
                             boolean removesFromViewOnPush)

Method Detail

saveToBundle

public void saveToBundle(android.os.Bundle bundle)

Description copied from class: ControllerChangeHandler

Saves any data about this handler to a Bundle in case the application is killed.

Overrides:

saveToBundle in class ControllerChangeHandler

Parameters:

bundle - The Bundle into which data should be stored.

restoreFromBundle

public void restoreFromBundle(android.os.Bundle bundle)

Description copied from class: ControllerChangeHandler

Restores data that was saved in the ControllerChangeHandler.saveToBundle(Bundle bundle) method.

Overrides:

restoreFromBundle in class ControllerChangeHandler

Parameters:

bundle - The bundle that has data to be restored

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 ControllerChangeHandler

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

completeImmediately

public void completeImmediately()

Description copied from class: ControllerChangeHandler

Will be called on change handlers that push a controller if the controller being pushed is needs to be attached immediately, without any animations or transitions.

Overrides:

completeImmediately in class ControllerChangeHandler

getAnimationDuration

public long getAnimationDuration()

removesFromViewOnPush

public boolean removesFromViewOnPush()

Overrides:

removesFromViewOnPush in class ControllerChangeHandler

getAnimator

protected abstract android.animation.Animator getAnimator(android.view.ViewGroup container,
                                                          android.view.View from,
                                                          android.view.View to,
                                                          boolean isPush,
                                                          boolean toAddedToContainer)

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

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.

toAddedToContainer - True if the "to" view was added to the container as a part of this ChangeHandler. False if it was already in the hierarchy.

resetFromView

protected abstract void resetFromView(android.view.View from)

Will be called after the animation is complete to reset the View that was removed to its pre-animation state.

performChange

public final void performChange(android.view.ViewGroup container,
                                android.view.View from,
                                android.view.View to,
                                boolean isPush,
                                ControllerChangeHandler.ControllerChangeCompletedListener changeListener)

Description copied from class: ControllerChangeHandler

Responsible for swapping Views from one Controller to another.

Specified by:

performChange in class ControllerChangeHandler

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.

changeListener - This listener must be called when any transitions or animations are completed.