com.alexvasilkov.gestures.transition

Class ViewsCoordinator<ID>

java.lang.Object

com.alexvasilkov.gestures.transition.ViewsCoordinator<ID>

Direct Known Subclasses:

ViewsTransitionAnimator

public class ViewsCoordinator<ID>
extends java.lang.Object

Main purpose of this class is to synchronize views of same item in two different sources to correctly start or update view transition animation.

I.e. we need to have both 'to' and 'from' views which represent same item in RecyclerView and ViewPager to start transition between them. But when ViewPager is scrolled we may also need to scroll RecyclerView to reveal corresponding item's view.

Method request(Object) should be called when particular item needs to be synced. This method will trigger methods ViewsCoordinator.OnRequestViewListener.onRequestView(Object) of listeners set by setFromListener and setToListener methods.

When views were requested this class starts waiting for 'from' and 'to' views to be provided with setFromView(Object, View) (or setFromPos(Object, ViewPosition)) and setToView(Object, AnimatorView) methods. When both views are ready method ViewsCoordinator.OnViewsReadyListener.onViewsReady(Object) will be triggered.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ViewsCoordinator.OnRequestViewListener<ID>
static interface	ViewsCoordinator.OnViewsReadyListener<ID>

Constructor Summary

Constructors

Constructor and Description
ViewsCoordinator()

Method Summary

Modifier and Type	Method and Description
protected void	cleanupRequest()
ViewPosition	getFromPos()
android.view.View	getFromView()
AnimatorView	getToView()
protected void	onViewsReady(ID id) Called when both 'from' and 'to' views are ready for given index.
void	request(ID id)
void	setFromListener(ViewsCoordinator.OnRequestViewListener<ID> listener)
void	setFromPos(ID id, ViewPosition fromPos)
void	setFromView(ID id, android.view.View fromView)
void	setReadyListener(ViewsCoordinator.OnViewsReadyListener<ID> listener)
void	setToListener(ViewsCoordinator.OnRequestViewListener<ID> listener)
void	setToView(ID id, AnimatorView toView)

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewsCoordinator

public ViewsCoordinator()

Method Detail

setFromListener

public void setFromListener(ViewsCoordinator.OnRequestViewListener<ID> listener)

setToListener

public void setToListener(ViewsCoordinator.OnRequestViewListener<ID> listener)

setReadyListener

public void setReadyListener(ViewsCoordinator.OnViewsReadyListener<ID> listener)

request

public void request(ID id)

getFromView

public android.view.View getFromView()

getFromPos

public ViewPosition getFromPos()

setFromView

public void setFromView(ID id,
                        android.view.View fromView)

setFromPos

public void setFromPos(ID id,
                       ViewPosition fromPos)

getToView

public AnimatorView getToView()

setToView

public void setToView(ID id,
                      AnimatorView toView)

cleanupRequest

protected void cleanupRequest()

onViewsReady

protected void onViewsReady(ID id)

Called when both 'from' and 'to' views are ready for given index. At this point transition is ready to be started.

Note, that this method will be called each time 'from' or 'to' views are changed.

See Also:

getFromView(), getFromPos(), getToView()