BrowseSupportFragment.MainFragmentAdapter

public class BrowseSupportFragment.MainFragmentAdapter<T extends Fragment>


Interface that defines the interaction between BrowseSupportFragment and its main content fragment. The key method is getFragment, it will be used to get the fragment to be shown in the content section. Clients can provide any implementation of fragment and customize its interaction with BrowseSupportFragment by overriding the necessary methods.

Clients are expected to provide an instance of MainFragmentAdapterRegistry which will be responsible for providing implementations of MainFragmentAdapter for given content types. Currently we support different types of content - ListRow, PageRow or any subtype of Row. We provide an out of the box adapter implementation for any rows other than PageRow - androidx.leanback.app.RowsSupportFragment.MainFragmentAdapter.

PageRow is intended to give full flexibility to developers in terms of Fragment design. Users will have to provide an implementation of MainFragmentAdapter and provide that through MainFragmentAdapterRegistry. MainFragmentAdapter implementation can supply any fragment and override just those interactions that makes sense.

Summary

Public constructors

MainFragmentAdapter(T fragment)

Public methods

final T
final BrowseSupportFragment.FragmentHost

Returns the current host interface so that main fragment can interact with BrowseSupportFragment.

boolean

Returns whether row scaling is enabled.

boolean

Returns whether its scrolling.

void

Callback indicating transition end.

boolean

Callback indicating transition prepare start.

void

Callback indicating transition start.

void
setAlignment(int windowAlignOffsetFromTop)

Sets the window alignment and also the pivots for scale operation.

void

For rows that willing to participate entrance transition, this function hide views if afterTransition is true, show views if afterTransition is false.

void
setExpand(boolean expand)

Set the visibility of titles/hover card of browse rows.

void
setScalingEnabled(boolean scalingEnabled)

Sets the row scaling property.

Public constructors

MainFragmentAdapter

Added in 1.1.0
public MainFragmentAdapter(T fragment)

Public methods

getFragment

Added in 1.1.0
public final T getFragment()

getFragmentHost

Added in 1.1.0
public final BrowseSupportFragment.FragmentHost getFragmentHost()

Returns the current host interface so that main fragment can interact with BrowseSupportFragment.

isScalingEnabled

Added in 1.1.0
public boolean isScalingEnabled()

Returns whether row scaling is enabled.

isScrolling

Added in 1.1.0
public boolean isScrolling()

Returns whether its scrolling.

onTransitionEnd

Added in 1.1.0
public void onTransitionEnd()

Callback indicating transition end.

onTransitionPrepare

Added in 1.1.0
public boolean onTransitionPrepare()

Callback indicating transition prepare start.

onTransitionStart

Added in 1.1.0
public void onTransitionStart()

Callback indicating transition start.

setAlignment

Added in 1.1.0
public void setAlignment(int windowAlignOffsetFromTop)

Sets the window alignment and also the pivots for scale operation.

setEntranceTransitionState

Added in 1.1.0
public void setEntranceTransitionState(boolean state)

For rows that willing to participate entrance transition, this function hide views if afterTransition is true, show views if afterTransition is false.

setExpand

Added in 1.1.0
public void setExpand(boolean expand)

Set the visibility of titles/hover card of browse rows.

setScalingEnabled

Added in 1.1.0
public void setScalingEnabled(boolean scalingEnabled)

Sets the row scaling property.