FullWidthDetailsOverviewSharedElementHelper

class FullWidthDetailsOverviewSharedElementHelper : FullWidthDetailsOverviewRowPresenter.Listener

kotlin.Any
   ↳ 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 during activity onCreate() and call setListener. The helper implements FullWidthDetailsOverviewRowPresenter.Listener and starts delayed activity transition once onBindLogo is called.

Summary

Public constructors

Public functions
Boolean

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

notifyOnBindLogo is called.
Unit

Enable or disable auto startPostponedEnterTransition() when bound to logo.
Unit
setSharedElementEnterTransition(
    activity: Activity!,
    sharedElementName: String!
)
Unit
setSharedElementEnterTransition(
    activity: Activity!,
    sharedElementName: String!,
    timeoutMs: Long
)
Unit

Manually start postponed enter transition.

Public constructors

FullWidthDetailsOverviewSharedElementHelper

Added in 1.1.0
FullWidthDetailsOverviewSharedElementHelper()

Public functions

getAutoStartSharedElementTransition

Added in 1.1.0
fun getAutoStartSharedElementTransition(): Boolean

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.

onBindLogo

fun onBindLogo(vh: FullWidthDetailsOverviewRowPresenter.ViewHolder!): Unit

notifyOnBindLogo is called.

Parameters
vh: FullWidthDetailsOverviewRowPresenter.ViewHolder!

The ViewHolder that has bound logo view.

setAutoStartSharedElementTransition

Added in 1.1.0
fun setAutoStartSharedElementTransition(enabled: Boolean): Unit

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.

setSharedElementEnterTransition

Added in 1.1.0
fun setSharedElementEnterTransition(
    activity: Activity!,
    sharedElementName: String!
): Unit

setSharedElementEnterTransition

Added in 1.1.0
fun setSharedElementEnterTransition(
    activity: Activity!,
    sharedElementName: String!,
    timeoutMs: Long
): Unit

startPostponedEnterTransition

Added in 1.1.0
fun startPostponedEnterTransition(): Unit

Manually start postponed enter transition.