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()
ID	getRequestedId()
AnimatorView	getToView()
boolean	isReady()
protected void	onFromViewChanged(android.view.View fromView, ViewPosition fromPos)
protected void	onToViewChanged(AnimatorView old, AnimatorView view)
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	setFromNone(ID id) Notifies that 'from' view is ready even if there is no such view.
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(@NonNull
                            ViewsCoordinator.OnRequestViewListener<ID> listener)

setToListener

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

setReadyListener

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

request

public void request(@NonNull
                    ID id)

getRequestedId

public ID getRequestedId()

getFromView

public android.view.View getFromView()

Returns:

'From' view, if set.
Note, that once onViewsReady(Object) is called both this method and getFromPos() may still return null, see setFromNone(Object).

getFromPos

public ViewPosition getFromPos()

Returns:

'From' position, if set.
Note, that once onViewsReady(Object) is called, both this method and getFromView() may still return null, see setFromNone(Object).

getToView

public AnimatorView getToView()

Returns:

'To' view, if set. Will not be null once onViewsReady(Object) is called, but before new request (request(Object)).

setFromView

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

setFromPos

public void setFromPos(@NonNull
                       ID id,
                       @NonNull
                       ViewPosition fromPos)

setFromNone

public void setFromNone(@NonNull
                        ID id)

Notifies that 'from' view is ready even if there is no such view. Can be used in cases when we know that there will be no 'from' view, but animation should be started anyway.

Parameters:

id - Item ID for related 'to' view

onFromViewChanged

protected void onFromViewChanged(@Nullable
                                 android.view.View fromView,
                                 @Nullable
                                 ViewPosition fromPos)

setToView

public void setToView(@NonNull
                      ID id,
                      @NonNull
                      AnimatorView toView)

onToViewChanged

protected void onToViewChanged(@Nullable
                               AnimatorView old,
                               @NonNull
                               AnimatorView view)

isReady

public boolean isReady()

onViewsReady

protected void onViewsReady(@NonNull
                            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.

Parameters:

id - Item ID used for views lookup

See Also:

getFromView(), getFromPos(), getToView()

cleanupRequest

protected void cleanupRequest()