universum.studios.android.transition

Class BaseNavigationalTransition<T extends BaseNavigationalTransition>

java.lang.Object

universum.studios.android.transition.BaseNavigationalTransition<T>

Direct Known Subclasses:

NavigationalTransition, NavigationalTransitionCompat

public abstract class BaseNavigationalTransition<T extends BaseNavigationalTransition>
extends Object

BaseNavigationalTransition represents a simple wrapper around window Transitions framework to simplify and also to made transitioning between two Activities independent from the current Android version, that is, to hide such transitions implementation from the context where it is used.

A specific navigational transition implementation may be associated with its corresponding activity class that can be supplied to BaseNavigationalTransition(Class) constructor. This class is used to create an instance of Intent that will be by default started whenever start(Activity) is invoked. Both onStart(Activity) and onFinish(Activity) methods cen be overridden by a specific transition implementations to match theirs specific needs.

Sample

 public abstract class DetailTransition extends BaseNavigationalTransition {

     DetailTransition() {
         super(DetailActivity.class);
     }

     @NonNull
     public static DetailTransition get() {
          return UiConfig.MATERIAL_SUPPORT ? new MaterialTransition() : new DefaultTransition();
     }

     @Override
     public Intent createIntent(@NonNull Activity caller) {
         final Intent intent = super.createIntent(caller);
         // ... put here any extras that need to be delivered to the called activity
         return intent;
     }

     static final class DefaultTransition extends DetailTransition {

          @Override
          protected void onStart(@NonNull Activity caller) {
              super.onStart(caller);
              // ... change activities with custom window animation
              WindowTransition.overrideStart(caller);
          }

          @Override
          protected void onFinish(@NonNull Activity caller) {
              super.onFinish(caller);
              // ... change activities without animation
              caller.overridePendingTransition(0, 0);
          }
     }

     // ... other implementations specific for a different platform versions

     static final class MaterialTransition extends DetailTransition {

          @Override
          protected void onStart(@NonNull Activity caller) {
              // ... made some modifications to the caller's UI (if necessary) before the transitions
              // ... are triggered.
              super.onStart(caller);
          }

          @Override
          protected void onFinish(@NonNull Activity caller) {
              super.onFinish(caller);
              // ... no need to override in most cases
          }
     }
 }
 

Author:

Martin Albedinsky

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	MATERIAL_SUPPORT Boolean flag indicating whether the current Android device can run Material Design like navigational transition (i.
protected Class<? extends Activity>	mClassOfTransitionActivity Class of activity that should be started as new Intent whenever this navigational transition is started via start(Activity).
static int	RC_NONE Flag determining that no request code has been specified for a specific navigational transition.

Constructor Summary

Constructors

Constructor and Description
BaseNavigationalTransition() Creates a new instance of NavigationalTransition without transition activity class.
BaseNavigationalTransition(Class<? extends Activity> classOfTransitionActivity) Creates a new instance of NavigationalTransition with the specified class of transition activity.

Method Summary

Modifier and Type	Method and Description
boolean	allowEnterTransitionOverlap()
T	allowEnterTransitionOverlap(boolean allow) Specifies a boolean flag to be set to a window of the caller activity whenever start(Activity) is invoked.
boolean	allowReturnTransitionOverlap()
T	allowReturnTransitionOverlap(boolean allow) Specifies a boolean flag to be set to a window of the caller activity whenever start(Activity) is invoked.
void	configureTransitions(Activity activity) Attaches all transitions, including those for shared elements, specified for this navigational transition to a window of the specified activity via one of Window#set...Transition(...) methods.
void	configureTransitionsOverlapping(Activity activity) Specifies a boolean flags for a window of the specified activity determining whether an enter or return transition can overlap or not based on the requested values for this navigational transition.
Intent	createIntent(Activity caller) Creates an intent that can be used to start activity for which is this transition created.
Transition	enterTransition()
T	enterTransition(Transition transition) Specifies a transition to be attached to a window of the caller activity whenever start(Activity) is invoked.
Transition	exitTransition()
T	exitTransition(Transition transition) Specifies a transition to be attached to a window of the caller activity whenever start(Activity) is invoked.
void	finish(Activity caller) Finishes the given caller activity in order to run its exit transitions.
protected void	finishCaller(Activity caller) Finishes the specified caller activity either via Activity.finishAfterTransition() or via Activity.finish() depending on the current API capabilities.
protected void	finishCallerDelayed(Activity caller, long delay) Like finishCaller(Activity) but this will postpone the finishing by the requested delay.
Transition	inflateTransition(Context context, int resource) Inflates a new instance of Transition from the specified resource.
TransitionManager	inflateTransitionManager(Context context, int resource, ViewGroup sceneRoot) Inflates a new instance of TransitionManager from the specified resource.
ActivityOptions	makeSceneTransitionAnimation(Activity caller) Creates a new instance of ActivityOptions for the specified caller activity.
protected void	onFinish(Activity caller) Invoked whenever finish(Activity) is called.
protected void	onFinishCaller(Activity caller) Invoked whenever finishCaller(Activity) or finishCallerDelayed(Activity, long) is called.
protected void	onStart(Activity caller) Invoked whenever start(Activity) is called.
Transition	reenterTransition()
T	reenterTransition(Transition transition) Specifies a transition to be attached to a window of the caller activity whenever start(Activity) is invoked.
int	requestCode() Returns the request code specified via requestCode(int).
T	requestCode(int requestCode) Specifies a request code that should be used to start activity specific for this navigational transition for result.
Transition	returnTransition()
T	returnTransition(Transition transition) Specifies a transition to be attached to a window of the caller activity whenever start(Activity) is invoked.
T	sharedElement(View element, String elementName) Adds shared element that should be transferred to the transitioning (called) activity via ActivityOptions as Bundle.
Transition	sharedElementEnterTransition()
T	sharedElementEnterTransition(Transition transition) Specifies a transition for shared element to be attached to a window of the caller activity whenever start(Activity) is invoked.
Transition	sharedElementExitTransition()
T	sharedElementExitTransition(Transition transition) Specifies a transition for shared element to be attached to a window of the caller activity whenever start(Activity) is invoked.
Transition	sharedElementReenterTransition()
T	sharedElementReenterTransition(Transition transition) Specifies a transition for shared element to be attached to a window of the caller activity whenever start(Activity) is invoked.
Transition	sharedElementReturnTransition()
T	sharedElementReturnTransition(Transition transition) Specifies a transition for shared element to be attached to a window of the caller activity whenever start(Activity) is invoked.
List<Pair<View,String>>	sharedElements() Returns a list of all shared elements specified for this navigational transition.
T	sharedElements(Pair<View,String>... elements) Bulk method for adding shared element pairs into this navigational transition.
Pair<View,String>	singleSharedElement() Returns the single shared element at the 0 position among the current shared elements.
void	start(Activity caller) Starts this navigational transition using the given caller activity with all transitions and shared elements specified for this navigational transition.

Methods inherited from class java.lang.Object

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

Field Detail

MATERIAL_SUPPORT

public static final boolean MATERIAL_SUPPORT

Boolean flag indicating whether the current Android device can run Material Design like navigational transition (i. e. with shared elements, ...) or not.

RC_NONE

public static final int RC_NONE

Flag determining that no request code has been specified for a specific navigational transition.

See Also:

Constant Field Values

mClassOfTransitionActivity

protected final Class<? extends Activity> mClassOfTransitionActivity

Class of activity that should be started as new Intent whenever this navigational transition is started via start(Activity).

Constructor Detail

BaseNavigationalTransition

public BaseNavigationalTransition()

Creates a new instance of NavigationalTransition without transition activity class.

BaseNavigationalTransition

public BaseNavigationalTransition(@NonNull
                                  Class<? extends Activity> classOfTransitionActivity)

Creates a new instance of NavigationalTransition with the specified class of transition activity.

Parameters:

classOfTransitionActivity - The activity class that should be used to create a new Intent that to be started whenever start(Activity) is called upon this navigational transition.

Method Detail

requestCode

public T requestCode(int requestCode)

Specifies a request code that should be used to start activity specific for this navigational transition for result.

Default value: RC_NONE

Parameters:

requestCode - The desired request code. Can be RC_NONE to not start activity for result.

Returns:

This transition to allow methods chaining.

See Also:

Activity.startActivityForResult(Intent, int), Activity.startActivityForResult(Intent, int, Bundle), Fragment.startActivityForResult(Intent, int)

requestCode

public int requestCode()

Returns the request code specified via requestCode(int).

Returns:

Specified request code or RC_NONE by default.

enterTransition

public T enterTransition(@Nullable
                         Transition transition)

Specifies a transition to be attached to a window of the caller activity whenever start(Activity) is invoked.

Returns:

This transition to allow methods chaining.

See Also:

Window.setEnterTransition(Transition), inflateTransition(Context, int)

enterTransition

@Nullable
public Transition enterTransition()

Returns:

Transition specified via enterTransition(Transition) or null by default.

reenterTransition

public T reenterTransition(@Nullable
                           Transition transition)

Specifies a transition to be attached to a window of the caller activity whenever start(Activity) is invoked.

Returns:

This transition to allow methods chaining.

See Also:

Window.setReenterTransition(Transition), inflateTransition(Context, int)

reenterTransition

@Nullable
public Transition reenterTransition()

Returns:

Transition specified via reenterTransition(Transition) or null by default.

returnTransition

public T returnTransition(@Nullable
                          Transition transition)

Specifies a transition to be attached to a window of the caller activity whenever start(Activity) is invoked.

Returns:

This transition to allow methods chaining.

See Also:

Window.setReturnTransition(Transition), inflateTransition(Context, int)

returnTransition

@Nullable
public Transition returnTransition()

Returns:

Transition specified via returnTransition(Transition) or null by default.

exitTransition

public T exitTransition(@Nullable
                        Transition transition)

Specifies a transition to be attached to a window of the caller activity whenever start(Activity) is invoked.

Returns:

This transition to allow methods chaining.

See Also:

Window.setExitTransition(Transition), inflateTransition(Context, int)

exitTransition

@Nullable
public Transition exitTransition()

Returns:

Transition specified via exitTransition(Transition) or null by default.

allowEnterTransitionOverlap

public T allowEnterTransitionOverlap(boolean allow)

Specifies a boolean flag to be set to a window of the caller activity whenever start(Activity) is invoked.

Returns:

This transition to allow methods chaining.

See Also:

Window.setAllowEnterTransitionOverlap(boolean)

allowEnterTransitionOverlap

public boolean allowEnterTransitionOverlap()

Returns:

True if overlapping of enter transition is enabled, false otherwise.

allowReturnTransitionOverlap

public T allowReturnTransitionOverlap(boolean allow)

Specifies a boolean flag to be set to a window of the caller activity whenever start(Activity) is invoked.

Returns:

This transition to allow methods chaining.

See Also:

Window.setAllowReturnTransitionOverlap(boolean)

allowReturnTransitionOverlap

public boolean allowReturnTransitionOverlap()

Returns:

True if overlapping of return transition is enabled, false otherwise.

sharedElementEnterTransition

public T sharedElementEnterTransition(@Nullable
                                      Transition transition)

Specifies a transition for shared element to be attached to a window of the caller activity whenever start(Activity) is invoked.

Returns:

This transition to allow methods chaining.

See Also:

Window.setSharedElementEnterTransition(Transition), inflateTransition(Context, int)

sharedElementEnterTransition

@Nullable
public Transition sharedElementEnterTransition()

Returns:

Transition for shared element specified via sharedElementEnterTransition(Transition) or null by default.

sharedElementReenterTransition

public T sharedElementReenterTransition(@Nullable
                                        Transition transition)

Specifies a transition for shared element to be attached to a window of the caller activity whenever start(Activity) is invoked.

Returns:

This transition to allow methods chaining.

See Also:

Window.setSharedElementReenterTransition(Transition), inflateTransition(Context, int)

sharedElementReenterTransition

@Nullable
public Transition sharedElementReenterTransition()

Returns:

Transition for shared element specified via sharedElementReenterTransition(Transition) or null by default.

sharedElementReturnTransition

public T sharedElementReturnTransition(@Nullable
                                       Transition transition)

Specifies a transition for shared element to be attached to a window of the caller activity whenever start(Activity) is invoked.

Returns:

This transition to allow methods chaining.

See Also:

Window.setSharedElementReturnTransition(Transition), inflateTransition(Context, int)

sharedElementReturnTransition

@Nullable
public Transition sharedElementReturnTransition()

Returns:

Transition for shared element specified via sharedElementReturnTransition(Transition) or null by default.

sharedElementExitTransition

public T sharedElementExitTransition(@Nullable
                                     Transition transition)

Specifies a transition for shared element to be attached to a window of the caller activity whenever start(Activity) is invoked.

Returns:

This transition to allow methods chaining.

See Also:

Window.setSharedElementExitTransition(Transition), inflateTransition(Context, int)

sharedElementExitTransition

@Nullable
public Transition sharedElementExitTransition()

Returns:

Transition for shared element specified via sharedElementExitTransition(Transition) or null by default.

inflateTransition

@Nullable
public Transition inflateTransition(@NonNull
                                               Context context,
                                               int resource)

Inflates a new instance of Transition from the specified resource.

Note, that for pre LOLLIPOP Android versions this method does nothing and returns null.

Parameters:

context - Context used to inflate the desired transition.

resource - Resource id of the desired transition to inflate.

Returns:

Inflated transition.

See Also:

inflateTransitionManager(Context, int, ViewGroup)

inflateTransitionManager

@Nullable
public TransitionManager inflateTransitionManager(@NonNull
                                                             Context context,
                                                             int resource,
                                                             @NonNull
                                                             ViewGroup sceneRoot)

Inflates a new instance of TransitionManager from the specified resource.

Note, that for pre LOLLIPOP Android versions this method does nothing and returns null.

Parameters:

context - Context used to inflate the desired transition.

resource - Resource id of the desired transition manager to inflater.

sceneRoot - Root view for the scene with which will the manager operate.

Returns:

Inflated transition manager.

See Also:

inflateTransition(Context, int)

sharedElements

@SafeVarargs
public final T sharedElements(@NonNull
                                            Pair<View,String>... elements)

Bulk method for adding shared element pairs into this navigational transition.

Parameters:

elements - The desired shared elements pairs.

Returns:

This transition to allow methods chaining.

See Also:

sharedElement(View, String)

sharedElement

public T sharedElement(@NonNull
                       View element,
                       @NonNull
                       String elementName)

Adds shared element that should be transferred to the transitioning (called) activity via ActivityOptions as Bundle.

All shared elements and their names added into this navigational transition will be bundled from ActivityOptions created via makeSceneTransitionAnimation(Activity) and transferred to the called activity whenever start(Activity) is called.

Note, that each shared element must have a unique name.

Parameters:

element - The view to be shared via transition.

elementName - The name of the shared element.

Returns:

This transition to allow methods chaining.

See Also:

sharedElements(Pair[]), makeSceneTransitionAnimation(Activity)

sharedElements

@Nullable
public List<Pair<View,String>> sharedElements()

Returns a list of all shared elements specified for this navigational transition.

Returns:

List of shared elements or null if there are no shared elements specified.

See Also:

sharedElements(Pair[]), sharedElement(View, String), singleSharedElement()

singleSharedElement

@Nullable
public Pair<View,String> singleSharedElement()

Returns the single shared element at the 0 position among the current shared elements.

This method may be used to obtain a single shared element when there is specified only one for this navigational transition.

Returns:

Single shared element or null if there are no shared elements specified.

See Also:

sharedElements(), sharedElement(View, String)

start

public void start(@NonNull
                  Activity caller)

Starts this navigational transition using the given caller activity with all transitions and shared elements specified for this navigational transition.

Parameters:

caller - The activity that will be used to create and start an Intent created via createIntent(Activity).

See Also:

configureTransitionsOverlapping(Activity), configureTransitions(Activity)

onStart

protected void onStart(@NonNull
                       Activity caller)

Invoked whenever start(Activity) is called.

Default implementation starts an Intent created via createIntent(Activity) using the given caller activity via Activity.startActivity(Intent) for the pre LOLLIPOP Android versions and for the post LOLLIPOP via Activity.startActivity(Intent, Bundle) where will be passed Bundle created from ActivityOptions that has been requested via makeSceneTransitionAnimation(Activity).

If there was specified some requestCode() the intent will be started via Activity.startActivityForResult(Intent, int) for the pre LOLLIPOP Android versions and for the post LOLLIPOP via Activity.startActivityForResult(Intent, int, Bundle).

Note, that the specified caller activity has already attached transitions to its window, that has been specified for this navigational transition via one of set...Transition(...) methods.

Parameters:

caller - The caller activity that requested start of this navigational transition.

See Also:

attachTransitions(Window), attachSharedElementTransitions(Window), onFinish(Activity)

finishCallerDelayed

protected void finishCallerDelayed(@NonNull
                                   Activity caller,
                                   long delay)

Like finishCaller(Activity) but this will postpone the finishing by the requested delay.

Parameters:

caller - The caller activity to finish.

delay - The desired delay after which to finish the caller activity.

finishCaller

protected void finishCaller(@NonNull
                            Activity caller)

Finishes the specified caller activity either via Activity.finishAfterTransition() or via Activity.finish() depending on the current API capabilities.

Parameters:

caller - The caller activity to finish.

onFinishCaller

protected void onFinishCaller(@NonNull
                              Activity caller)

Invoked whenever finishCaller(Activity) or finishCallerDelayed(Activity, long) is called.

Default implementation finishes the caller activity either via Activity.finishAfterTransition() or via Activity.finish() depending on the current API capabilities.

Parameters:

caller - The caller activity to finish.

configureTransitionsOverlapping

public void configureTransitionsOverlapping(@NonNull
                                            Activity activity)

Specifies a boolean flags for a window of the specified activity determining whether an enter or return transition can overlap or not based on the requested values for this navigational transition.

Note, that for pre LOLLIPOP Android versions this method does nothing.

Parameters:

activity - The activity for which window to specify whether an enter or return transition can overlap or not.

See Also:

Window.setAllowEnterTransitionOverlap(boolean), Window.setAllowReturnTransitionOverlap(boolean)

configureTransitions

public void configureTransitions(@NonNull
                                 Activity activity)

Attaches all transitions, including those for shared elements, specified for this navigational transition to a window of the specified activity via one of Window#set...Transition(...) methods.

Note, that for pre LOLLIPOP Android versions this method does nothing.

Parameters:

activity - The activity to which window should be transitions attached.

See Also:

Window.setEnterTransition(Transition), Window.setReturnTransition(Transition), Window.setReenterTransition(Transition), Window.setExitTransition(Transition), Window.setSharedElementEnterTransition(Transition), Window.setSharedElementReturnTransition(Transition), Window.setSharedElementReenterTransition(Transition), Window.setSharedElementExitTransition(Transition)

makeSceneTransitionAnimation

@Nullable
public ActivityOptions makeSceneTransitionAnimation(@NonNull
                                                               Activity caller)

Creates a new instance of ActivityOptions for the specified caller activity.

Note, that for pre LOLLIPOP Android versions this method does nothing and returns null.

Parameters:

caller - The activity for which to create the ActivityOptions.

Returns:

Activity options with or without attached shared elements that has been added into this navigational transition (if any).

createIntent

@NonNull
public Intent createIntent(@NonNull
                                     Activity caller)

Creates an intent that can be used to start activity for which is this transition created.

Parameters:

caller - Activity to be used as context when creating the requested intent.

Returns:

New Intent or null it this navigational transition has no class of transition activity specified.

finish

public void finish(@NonNull
                   Activity caller)

Finishes the given caller activity in order to run its exit transitions.

Parameters:

caller - The activity that should be finished and of which exit transitions should be started.

See Also:

start(Activity)

onFinish

protected void onFinish(@NonNull
                        Activity caller)

Invoked whenever finish(Activity) is called.

Default implementation finishes the given caller activity for the pre LOLLIPOP Android versions via Activity.finish() and for the post LOLLIPOP via Activity.finishAfterTransition().

Derived classes can override this method in order to run custom window transitions for the pre LOLLIPOP Android versions via Activity.overridePendingTransition(int, int).

Parameters:

caller - The activity that requested its finish via this navigational transition.

See Also:

onStart(Activity)