universum.studios.android.transition.util

Class AnimatorWrapper

java.lang.Object

android.animation.Animator

universum.studios.android.transition.util.AnimatorWrapper

All Implemented Interfaces:

Cloneable

public class AnimatorWrapper
extends Animator

A Animator implementation that may be used to wrap an instance of animator in order to 'suppress' some of its features like pausing and resuming for instance.

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AnimatorWrapper.WrapperFeatures Defines an annotation for determining set of allowed features for AnimatorWrapper.

Nested classes/interfaces inherited from class android.animation.Animator

Animator.AnimatorListener, Animator.AnimatorPauseListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL Flag grouping all wrapper features in one.
static int	CANCEL Flag for indicating to the animator wrapper that it should support CANCEL feature for its wrapped animator.
static int	END Flag for indicating to the animator wrapper that it should support END feature for its wrapped animator.
static int	PAUSE Flag for indicating to the animator wrapper that it should support PAUSE feature for its wrapped animator.
static int	RESUME Flag for indicating to the animator wrapper that it should support RESUME feature for its wrapped animator.
static int	START Flag for indicating to the animator wrapper that it should support START feature for its wrapped animator.

Fields inherited from class android.animation.Animator

DURATION_INFINITE

Constructor Summary

Constructors

Constructor and Description
AnimatorWrapper(Animator animator) Creates a new instance of AnimatorWrapper to wrap the given instance of animator.

Method Summary

Modifier and Type	Method and Description
void	addListener(Animator.AnimatorListener listener)
void	addPauseListener(Animator.AnimatorPauseListener listener) Ignored if there are no PAUSE and RESUME features requested.
void	cancel() Ignored if there are no START and CANCEL features requested.
void	end() Ignored if there are no START and END features requested.
long	getDuration()
TimeInterpolator	getInterpolator()
ArrayList<Animator.AnimatorListener>	getListeners()
long	getStartDelay()
Animator	getWrappedAnimator() Returns the animator wrapped by this wrapper.
boolean	hasFeature(int feature) Checks whether the specified feature has been requested for this wrapper or not.
boolean	isPaused()
boolean	isRunning()
boolean	isStarted()
void	pause() Ignored if there is no PAUSE feature requested.
void	removeAllListeners()
void	removeFeature(int feature) Removes the specified feature from the registered ones.
void	removeListener(Animator.AnimatorListener listener)
void	removePauseListener(Animator.AnimatorPauseListener listener)
void	requestFeature(int feature) Adds the specified feature to the registered ones.
void	requestFeatures(int features) Specifies set of features for this wrapper.
void	resume() Ignored if there are no PAUSE and RESUME features requested.
Animator	setDuration(long duration)
void	setInterpolator(TimeInterpolator interpolator)
void	setStartDelay(long startDelay)
void	setTarget(Object target)
void	start() Ignored if there is no START feature requested.

Methods inherited from class android.animation.Animator

clone, getTotalDuration, setupEndValues, setupStartValues

Methods inherited from class java.lang.Object

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

Field Detail

START

public static final int START

Flag for indicating to the animator wrapper that it should support START feature for its wrapped animator.

See Also:

start(), Constant Field Values

PAUSE

public static final int PAUSE

Flag for indicating to the animator wrapper that it should support PAUSE feature for its wrapped animator.

See Also:

RESUME, pause(), Constant Field Values

RESUME

public static final int RESUME

Flag for indicating to the animator wrapper that it should support RESUME feature for its wrapped animator.

Note, that if there is no PAUSE feature requested, this feature flag is ignored.

See Also:

resume(), Constant Field Values

END

public static final int END

Flag for indicating to the animator wrapper that it should support END feature for its wrapped animator.

Note, that if there is no START feature requested, this feature flag is ignored.

See Also:

end(), Constant Field Values

CANCEL

public static final int CANCEL

Flag for indicating to the animator wrapper that it should support CANCEL feature for its wrapped animator.

Note, that if there is no START feature requested, this feature flag is ignored.

See Also:

cancel(), Constant Field Values

ALL

public static final int ALL

Flag grouping all wrapper features in one.

See Also:

Constant Field Values

Constructor Detail

AnimatorWrapper

public AnimatorWrapper(@NonNull
                       Animator animator)

Creates a new instance of AnimatorWrapper to wrap the given instance of animator.

Parameters:

animator - The animator to be wrapped.

Method Detail

getWrappedAnimator

@NonNull
public final Animator getWrappedAnimator()

Returns the animator wrapped by this wrapper.

Returns:

The wrapped animator.

See Also:

AnimatorWrapper(Animator)

requestFeatures

public void requestFeatures(int features)

Specifies set of features for this wrapper.

Note, that this will override all current features to the specified ones.

Parameters:

features - The desired features to be set for this wrapper.

See Also:

requestFeature(int), hasFeature(int), removeFeature(int)

requestFeature

public void requestFeature(int feature)

Adds the specified feature to the registered ones.

Parameters:

feature - The desired feature to add.

See Also:

requestFeatures(int), hasFeature(int), removeFeature(int)

removeFeature

public void removeFeature(int feature)

Removes the specified feature from the registered ones.

Parameters:

feature - The desired feature to remove.

See Also:

requestFeature(int), hasFeature(int)

hasFeature

public boolean hasFeature(int feature)

Checks whether the specified feature has been requested for this wrapper or not.

Parameters:

feature - The desired feature to check for.

Returns:

True if the feature has been requested via requestFeature(int) or specified by default, false otherwise.

See Also:

requestFeature(int)

addListener

public void addListener(Animator.AnimatorListener listener)

Overrides:

addListener in class Animator

removeListener

public void removeListener(Animator.AnimatorListener listener)

Overrides:

removeListener in class Animator

addPauseListener

public void addPauseListener(Animator.AnimatorPauseListener listener)

Ignored if there are no PAUSE and RESUME features requested.

Overrides:

addPauseListener in class Animator

See Also:

requestFeature(int), removeFeature(int)

removePauseListener

public void removePauseListener(Animator.AnimatorPauseListener listener)

Overrides:

removePauseListener in class Animator

getListeners

@NonNull
public ArrayList<Animator.AnimatorListener> getListeners()

Overrides:

getListeners in class Animator

removeAllListeners

public void removeAllListeners()

Overrides:

removeAllListeners in class Animator

setStartDelay

public void setStartDelay(long startDelay)

Specified by:

setStartDelay in class Animator

getStartDelay

public long getStartDelay()

Specified by:

getStartDelay in class Animator

setDuration

public Animator setDuration(long duration)

Specified by:

setDuration in class Animator

getDuration

public long getDuration()

Specified by:

getDuration in class Animator

setInterpolator

public void setInterpolator(TimeInterpolator interpolator)

Specified by:

setInterpolator in class Animator

getInterpolator

public TimeInterpolator getInterpolator()

Overrides:

getInterpolator in class Animator

setTarget

public void setTarget(Object target)

Overrides:

setTarget in class Animator

start

public void start()

Ignored if there is no START feature requested.

Overrides:

start in class Animator

See Also:

requestFeature(int), removeFeature(int)

isStarted

public boolean isStarted()

Overrides:

isStarted in class Animator

pause

public void pause()

Ignored if there is no PAUSE feature requested.

Overrides:

pause in class Animator

See Also:

requestFeature(int), removeFeature(int)

isPaused

public boolean isPaused()

Overrides:

isPaused in class Animator

resume

public void resume()

Ignored if there are no PAUSE and RESUME features requested.

Overrides:

resume in class Animator

See Also:

requestFeature(int), removeFeature(int)

end

public void end()

Ignored if there are no START and END features requested.

Overrides:

end in class Animator

See Also:

requestFeature(int), removeFeature(int)

cancel

public void cancel()

Ignored if there are no START and CANCEL features requested.

Overrides:

cancel in class Animator

See Also:

requestFeature(int), removeFeature(int)

isRunning

public boolean isRunning()

Specified by:

isRunning in class Animator