universum.studios.android.transition

Class BasicWindowTransition

java.lang.Object

universum.studios.android.transition.BasicWindowTransition

All Implemented Interfaces:

Parcelable, WindowTransition

public class BasicWindowTransition
extends Object
implements WindowTransition

Basic implementation of WindowTransition that may be used to create basic instances of window transitions to animate window changes.

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 Parcelable.Creator<BasicWindowTransition>	CREATOR Creator used to create an instance or array of instances of BasicWindowTransition from Parcel.

Fields inherited from interface universum.studios.android.transition.WindowTransition

NO_ANIMATION

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	BasicWindowTransition(int enterAnim, int exitAnim) Same as BasicWindowTransition(int, int, int, int) finish animations set to WindowTransition.NO_ANIMATION.
	BasicWindowTransition(int startEnterAnim, int startExitAnim, int finishEnterAnim, int finishExitAnim) Same as BasicWindowTransition(int, int, int, int, String) with name specified as "UNKNOWN".
	BasicWindowTransition(int startEnterAnim, int startExitAnim, int finishEnterAnim, int finishExitAnim, String name) Creates a new instance of BasicWindowTransition with the specified animations and name.
protected	BasicWindowTransition(Parcel source) Called form CREATOR to create an instance of WindowTransition form the given parcel source.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
int	getFinishEnterAnimation() Returns the animation resource for an old entering/resuming window used in WindowTransition.overrideFinish(Activity) as enter animation.
int	getFinishExitAnimation() Returns the animation resource for the current exiting/finishing window used in WindowTransition.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 WindowTransition.overrideStart(Activity) as enter animation.
int	getStartExitAnimation() Returns the animation resource for the current exiting/pausing window used in WindowTransition.overrideStart(Activity) as exit animation.
void	overrideFinish(Activity activity) Overrides pending transitions of the specified activity using WindowTransition.getFinishEnterAnimation() and WindowTransition.getFinishExitAnimation() animations specified for this window transition.
void	overrideStart(Activity activity) Overrides pending transitions of the specified activity using WindowTransition.getStartEnterAnimation() and WindowTransition.getStartExitAnimation() animations specified for this window transition.
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<BasicWindowTransition> CREATOR

Creator used to create an instance or array of instances of BasicWindowTransition from Parcel.

Constructor Detail

BasicWindowTransition

public BasicWindowTransition(@AnimRes
                             int enterAnim,
                             @AnimRes
                             int exitAnim)

Same as BasicWindowTransition(int, int, int, int) finish animations set to WindowTransition.NO_ANIMATION.

BasicWindowTransition

public BasicWindowTransition(@AnimRes
                             int startEnterAnim,
                             @AnimRes
                             int startExitAnim,
                             @AnimRes
                             int finishEnterAnim,
                             @AnimRes
                             int finishExitAnim)

Same as BasicWindowTransition(int, int, int, int, String) with name specified as "UNKNOWN".

BasicWindowTransition

public BasicWindowTransition(@AnimRes
                             int startEnterAnim,
                             @AnimRes
                             int startExitAnim,
                             @AnimRes
                             int finishEnterAnim,
                             @AnimRes
                             int finishExitAnim,
                             @NonNull
                             String name)

Creates a new instance of BasicWindowTransition with the specified animations and name.

Parameters:

startEnterAnim - A resource id of the animation for an entering window.

startExitAnim - A resource id of the animation for an exiting window to be added to the back stack (if).

finishEnterAnim - A resource id of the animation for an entering window to be showed from the back stack.

finishExitAnim - A resource id of the animation for an exiting window to be destroyed and replaced by the entering one.

name - Name for the new transition.

See Also:

overrideStart(Activity), overrideFinish(Activity)

BasicWindowTransition

protected BasicWindowTransition(@NonNull
                                Parcel source)

Called form CREATOR to create an instance of WindowTransition form the given parcel source.

Parameters:

source - Parcel with data for the new instance.

Method Detail

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

getStartEnterAnimation

@AnimRes
public int getStartEnterAnimation()

Description copied from interface: WindowTransition

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

Specified by:

getStartEnterAnimation in interface WindowTransition

Returns:

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

getStartExitAnimation

@AnimRes
public int getStartExitAnimation()

Description copied from interface: WindowTransition

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

Specified by:

getStartExitAnimation in interface WindowTransition

Returns:

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

getFinishEnterAnimation

@AnimRes
public int getFinishEnterAnimation()

Description copied from interface: WindowTransition

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

Specified by:

getFinishEnterAnimation in interface WindowTransition

Returns:

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

getFinishExitAnimation

@AnimRes
public int getFinishExitAnimation()

Description copied from interface: WindowTransition

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

Specified by:

getFinishExitAnimation in interface WindowTransition

Returns:

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

getName

@NonNull
public String getName()

Description copied from interface: WindowTransition

Returns the name of this window transition.

Specified by:

getName in interface WindowTransition

Returns:

Name of this transition.

overrideStart

public void overrideStart(@NonNull
                          Activity activity)

Description copied from interface: WindowTransition

Overrides pending transitions of the specified activity using WindowTransition.getStartEnterAnimation() and WindowTransition.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.

Specified by:

overrideStart in interface WindowTransition

Parameters:

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

See Also:

WindowTransition.overrideFinish(Activity)

overrideFinish

public void overrideFinish(@NonNull
                           Activity activity)

Description copied from interface: WindowTransition

Overrides pending transitions of the specified activity using WindowTransition.getFinishEnterAnimation() and WindowTransition.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.

Specified by:

overrideFinish in interface WindowTransition

Parameters:

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

See Also:

WindowTransition.overrideStart(Activity)