de.mrapp.android.preference.activity.animation

Class HideViewOnScrollAnimation

java.lang.Object

RecyclerView.OnScrollListener

de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation

public class HideViewOnScrollAnimation
extends RecyclerView.OnScrollListener

A scroll listener, which allows to animate a view to become hidden or shown depending on the observed list view's scrolling direction.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HideViewOnScrollAnimation.Direction Contains all possible directions, which can be used to translate the animated view in order hide it.

Constructor Summary

Constructors

Constructor and Description
HideViewOnScrollAnimation(android.view.View view, HideViewOnScrollAnimation.Direction direction) Creates a new scroll listener, which allows to animate a view to become hidden or shown depending on the observed list view's scrolling direction.
HideViewOnScrollAnimation(android.view.View view, HideViewOnScrollAnimation.Direction direction, long animationDuration) Creates a new scroll listener, which allows to animate a view to become hidden or shown depending on the observed list view's scrolling direction.

Method Summary

Modifier and Type	Method and Description
void	addListener(HideViewOnScrollAnimationListener listener) Adds a new listener, which should be notified about the animation's internal state, to the animation.
long	getAnimationDuration() Returns the duration of the animation, which is used to show or hide the view.
HideViewOnScrollAnimation.Direction	getDirection() Returns the direction, which should be be used to translate the view in order to hide it.
android.view.View	getView() Returns the view, which is animated by the listener.
void	hideView() Hides the view.
void	onScrolled(RecyclerView recyclerView, int dx, int dy)
void	removeListener(HideViewOnScrollAnimationListener listener) Removes a specific listener, which should not be notified about the animation's internal state, from the animation.
void	showView() Shows the view.

Methods inherited from class java.lang.Object

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

Constructor Detail

HideViewOnScrollAnimation

public HideViewOnScrollAnimation(android.view.View view,
                                 HideViewOnScrollAnimation.Direction direction)

Creates a new scroll listener, which allows to animate a view to become hidden or shown depending on the observed list view's scrolling direction.

Parameters:

view - The view, which should be animated by the listener, as an instance of the class View. The view may not be null

direction - The direction, which should be be used to translate the view in order to hide it, as a value of the enum HideViewOnScrollAnimation.Direction. The direction may either be UP or DOWN

HideViewOnScrollAnimation

public HideViewOnScrollAnimation(android.view.View view,
                                 HideViewOnScrollAnimation.Direction direction,
                                 long animationDuration)

Creates a new scroll listener, which allows to animate a view to become hidden or shown depending on the observed list view's scrolling direction.

Parameters:

view - The view, which should be animated by the listener, as an instance of the class View. The view may not be null

direction - The direction, which should be be used to translate the view in order to hide it, as a value of the enum HideViewOnScrollAnimation.Direction. The direction may either be UP or DOWN

animationDuration - The duration of the animation, which is used to show or hide the view, in milliseconds as a Long value. The duration must be greater than 0

Method Detail

showView

public final void showView()

Shows the view.

hideView

public final void hideView()

Hides the view.

getView

public final android.view.View getView()

Returns the view, which is animated by the listener.

Returns:

The view, which is animated by the listener as an instance of the class View

getDirection

public final HideViewOnScrollAnimation.Direction getDirection()

Returns the direction, which should be be used to translate the view in order to hide it.

Returns:

The direction, which should be be used to translate the view in order to hide it, as a value of the enum HideViewOnScrollAnimation.Direction. The direction may either be UP or DOWN

getAnimationDuration

public final long getAnimationDuration()

Returns the duration of the animation, which is used to show or hide the view.

Returns:

The duration of the animation, which is used to show or hide the view, in milliseconds as a Long value

addListener

public final void addListener(HideViewOnScrollAnimationListener listener)

Adds a new listener, which should be notified about the animation's internal state, to the animation.

Parameters:

listener - The listener, which should be added, as an instance of the type HideViewOnScrollAnimationListener. The listener may not be null

removeListener

public final void removeListener(HideViewOnScrollAnimationListener listener)

Removes a specific listener, which should not be notified about the animation's internal state, from the animation.

Parameters:

listener - The listener, which should be removed, as an instance of the tpye HideViewOnScrollAnimationListener. The listener may not be null

onScrolled

public final void onScrolled(RecyclerView recyclerView,
                             int dx,
                             int dy)