added in version 1.0.0
belongs to Maven artifact androidx.leanback:leanback:1.0.0-beta01

FullWidthDetailsOverviewSharedElementHelper

public class FullWidthDetailsOverviewSharedElementHelper
extends FullWidthDetailsOverviewRowPresenter.Listener

java.lang.Object
   ↳ androidx.leanback.widget.FullWidthDetailsOverviewRowPresenter.Listener
     ↳ androidx.leanback.widget.FullWidthDetailsOverviewSharedElementHelper


Helper class to assist delayed shared element activity transition for view created by FullWidthDetailsOverviewRowPresenter. User must call setSharedElementEnterTransition(Activity, String, long) during activity onCreate() and call FullWidthDetailsOverviewRowPresenter.setListener(FullWidthDetailsOverviewRowPresenter.Listener). The helper implements FullWidthDetailsOverviewRowPresenter.Listener and starts delayed activity transition once FullWidthDetailsOverviewRowPresenter.Listener.onBindLogo(ViewHolder) is called.

Summary

Public constructors

FullWidthDetailsOverviewSharedElementHelper()

Public methods

boolean getAutoStartSharedElementTransition()

Returns true if auto startPostponedEnterTransition() when bound to logo.

void onBindLogo(FullWidthDetailsOverviewRowPresenter.ViewHolder vh)

FullWidthDetailsOverviewRowPresenter.notifyOnBindLogo(ViewHolder) is called.

void setAutoStartSharedElementTransition(boolean enabled)

Enable or disable auto startPostponedEnterTransition() when bound to logo.

void setSharedElementEnterTransition(Activity activity, String sharedElementName)
void setSharedElementEnterTransition(Activity activity, String sharedElementName, long timeoutMs)
void startPostponedEnterTransition()

Manually start postponed enter transition.

Inherited methods

Public constructors

FullWidthDetailsOverviewSharedElementHelper

added in version 1.0.0
public FullWidthDetailsOverviewSharedElementHelper ()

Public methods

getAutoStartSharedElementTransition

added in version 1.0.0
public boolean getAutoStartSharedElementTransition ()

Returns true if auto startPostponedEnterTransition() when bound to logo. When it's disabled, app must call startPostponedEnterTransition() to kick off windowEnterTransition. By default, it is disabled when there is no windowEnterSharedElementTransition set on the activity.

Returns
boolean

onBindLogo

added in version 1.0.0
public void onBindLogo (FullWidthDetailsOverviewRowPresenter.ViewHolder vh)

FullWidthDetailsOverviewRowPresenter.notifyOnBindLogo(ViewHolder) is called.

Parameters
vh FullWidthDetailsOverviewRowPresenter.ViewHolder: The ViewHolder that has bound logo view.

setAutoStartSharedElementTransition

added in version 1.0.0
public void setAutoStartSharedElementTransition (boolean enabled)

Enable or disable auto startPostponedEnterTransition() when bound to logo. When it's disabled, app must call startPostponedEnterTransition() to kick off windowEnterTransition. By default, it is disabled when there is no windowEnterSharedElementTransition set on the activity.

Parameters
enabled boolean

setSharedElementEnterTransition

added in version 1.0.0
public void setSharedElementEnterTransition (Activity activity, 
                String sharedElementName)

Parameters
activity Activity

sharedElementName String

setSharedElementEnterTransition

added in version 1.0.0
public void setSharedElementEnterTransition (Activity activity, 
                String sharedElementName, 
                long timeoutMs)

Parameters
activity Activity

sharedElementName String

timeoutMs long

startPostponedEnterTransition

added in version 1.0.0
public void startPostponedEnterTransition ()

Manually start postponed enter transition.