com.bluelinelabs.conductor

Class ControllerChangeHandler

java.lang.Object

com.bluelinelabs.conductor.ControllerChangeHandler

Direct Known Subclasses:

AnimatorChangeHandler, NoOpControllerChangeHandler, SimpleSwapChangeHandler, TransitionChangeHandler, TransitionChangeHandlerCompat

public abstract class ControllerChangeHandler
extends java.lang.Object

ControllerChangeHandlers are responsible for swapping the View for one Controller to the View of another. They can be useful for performing animations and transitions between Controllers. Several default ControllerChangeHandlers are included.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ControllerChangeHandler.ControllerChangeCompletedListener A simplified listener for being notified when the change is complete.
static interface	ControllerChangeHandler.ControllerChangeListener A listener interface useful for allowing external classes to be notified of change events.

Constructor Summary

Constructors

Constructor and Description
ControllerChangeHandler()

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.
ControllerChangeHandler	copy() Returns a copy of this ControllerChangeHandler.
static ControllerChangeHandler	fromBundle(android.os.Bundle bundle)
boolean	isReusable() Returns whether or not this is a reusable ControllerChangeHandler.
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.
abstract 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()
void	restoreFromBundle(android.os.Bundle bundle) Restores data that was saved in the 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.
void	setForceRemoveViewOnPush(boolean force)

Methods inherited from class java.lang.Object

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

Constructor Detail

ControllerChangeHandler

public ControllerChangeHandler()

Method Detail

performChange

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

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.

saveToBundle

public void saveToBundle(android.os.Bundle bundle)

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

Parameters:

bundle - The Bundle into which data should be stored.

restoreFromBundle

public void restoreFromBundle(android.os.Bundle bundle)

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

Parameters:

bundle - The bundle that has data to be restored

onAbortPush

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

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()

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.

copy

public ControllerChangeHandler copy()

Returns a copy of this ControllerChangeHandler. This method is internally used by the library, so ensure it will return an exact copy of your handler if overriding. If not overriding, the handler will be saved and restored from the Bundle format.

isReusable

public boolean isReusable()

Returns whether or not this is a reusable ControllerChangeHandler. Defaults to false and should ONLY be overridden if there are absolutely no side effects to using this handler more than once. In the case that a handler is not reusable, it will be copied using the copy() method prior to use.

fromBundle

public static ControllerChangeHandler fromBundle(android.os.Bundle bundle)

removesFromViewOnPush

public boolean removesFromViewOnPush()

setForceRemoveViewOnPush

public void setForceRemoveViewOnPush(boolean force)