universum.studios.android.transition

Interface WindowTransition

All Superinterfaces:

Parcelable

All Known Implementing Classes:

BasicWindowTransition

public interface WindowTransition
extends Parcelable

WindowTransition provides a foursome of animation resources that may be used to override default activity window transitions via overrideStart(Activity) and overrideFinish(Activity).

Intended usage

 // Activity A implementation.
 public class ActivityA extends Activity {

     public void startActivityB() {
         startActivity(new Intent(this, ActivityB.class));
         WindowTransition.overrideStart(this);
     }
 }

 // Activity B implementation.
 public class ActivityB extends Activity {

     @Override
     public void finish() {
         super.finish();
         WindowTransition.overrideFinish(this);
     }
 }
 

Author:

Martin Albedinsky

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_ANIMATION Constant used to identify no animation resource provided by window transition.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	getFinishEnterAnimation() Returns the animation resource for an old entering/resuming window used in overrideFinish(Activity) as enter animation.
int	getFinishExitAnimation() Returns the animation resource for the current exiting/finishing window used in overrideFinish(Activity) as exit animation.
String	getName() Returns the name of this window transition.
int	getStartEnterAnimation() Returns the animation resource for a new entering/starting window used in overrideStart(Activity) as enter animation.
int	getStartExitAnimation() Returns the animation resource for the current exiting/pausing window used in overrideStart(Activity) as exit animation.
void	overrideFinish(Activity activity) Overrides pending transitions of the specified activity using getFinishEnterAnimation() and getFinishExitAnimation() animations specified for this window transition.
void	overrideStart(Activity activity) Overrides pending transitions of the specified activity using getStartEnterAnimation() and getStartExitAnimation() animations specified for this window transition.

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

NO_ANIMATION

static final int NO_ANIMATION

Constant used to identify no animation resource provided by window transition.

See Also:

Constant Field Values

Method Detail

getStartEnterAnimation

@AnimRes
int getStartEnterAnimation()

Returns the animation resource for a new entering/starting window used in overrideStart(Activity) as enter animation.

Returns:

Animation resource or NO_ANIMATION if no animation should be played for entering activity window.

getStartExitAnimation

@AnimRes
int getStartExitAnimation()

Returns the animation resource for the current exiting/pausing window used in overrideStart(Activity) as exit animation.

Returns:

Animation resource or NO_ANIMATION if no animation should be played for exiting activity window.

getFinishEnterAnimation

@AnimRes
int getFinishEnterAnimation()

Returns the animation resource for an old entering/resuming window used in overrideFinish(Activity) as enter animation.

Returns:

Animation resource or NO_ANIMATION if no animation should be played for entering back-stacked activity window.

getFinishExitAnimation

@AnimRes
int getFinishExitAnimation()

Returns the animation resource for the current exiting/finishing window used in overrideFinish(Activity) as exit animation.

Returns:

Animation resource or NO_ANIMATION if no animation should be played for exiting back-stacked activity window.

getName

@NonNull
String getName()

Returns the name of this window transition.

Returns:

Name of this transition.

overrideStart

void overrideStart(@NonNull
                   Activity activity)

Overrides pending transitions of the specified activity using getStartEnterAnimation() and getStartExitAnimation() animations specified for this window transition.

This method may be called to override default start animations when starting a new activity. The specified activity can be either a caller activity that starts a new activity via Intent or the started activity. In the first case this should be called immediately after Activity.startActivity(Intent) has been called. In the second case this method should be called from within Activity.onStart() of the started activity.

Parameters:

activity - The caller or starting activity of which pending transition to override.

See Also:

overrideFinish(Activity)

overrideFinish

void overrideFinish(@NonNull
                    Activity activity)

Overrides pending transitions of the specified activity using getFinishEnterAnimation() and getFinishExitAnimation() animations specified for this window transition.

This method may be called to override default finish animations when finishing currently visible activity from within Activity.finish() method.

Parameters:

activity - The finishing activity of which pending transition to override.

See Also:

overrideStart(Activity)