BrowseFragment

HEADERS_DISABLED

int HEADERS_DISABLED

The headers fragment is disabled and will never be shown.

Constant Value: 3 (0x00000003)

HEADERS_ENABLED

int HEADERS_ENABLED

The headers fragment is enabled and shown by default.

Constant Value: 1 (0x00000001)

HEADERS_HIDDEN

int HEADERS_HIDDEN

The headers fragment is enabled and hidden by default.

Constant Value: 2 (0x00000002)

BrowseFragment

BrowseFragment ()

createArgs

Bundle createArgs (Bundle args, 
                String title, 
                int headersState)

Creates arguments for a browse fragment.

enableMainFragmentScaling

void enableMainFragmentScaling (boolean enable)

Enables scaling of main fragment when headers are present. For the page/row fragment, scaling is enabled only when both this method and isScalingEnabled() are enabled.

enableRowScaling

void enableRowScaling (boolean enable)

This method was deprecated in API level 24.1.0.
use enableMainFragmentScaling(boolean) instead.

getAdapter

ObjectAdapter getAdapter ()

Returns the adapter containing the rows for the fragment.

getBrandColor

int getBrandColor ()

Returns the brand color for the browse fragment. The default is transparent.

getHeadersFragment

HeadersFragment getHeadersFragment ()

Get currently bound HeadersFragment or null if HeadersFragment has not been created yet.

getHeadersState

int getHeadersState ()

Returns the state of the headers column in the browse fragment.

getMainFragment

Fragment getMainFragment ()

getMainFragmentRegistry

BrowseFragment.MainFragmentAdapterRegistry getMainFragmentRegistry ()

getOnItemViewClickedListener

OnItemViewClickedListener getOnItemViewClickedListener ()

Returns the item Clicked listener.

getOnItemViewSelectedListener

OnItemViewSelectedListener getOnItemViewSelectedListener ()

Returns an item selection listener.

getRowsFragment

RowsFragment getRowsFragment ()

Get RowsFragment if it's bound to BrowseFragment or null if either BrowseFragment has not been created yet or a different fragment is bound to it.

getSelectedPosition

int getSelectedPosition ()

Gets position of currently selected row.

getSelectedRowViewHolder

RowPresenter.ViewHolder getSelectedRowViewHolder ()

isHeadersTransitionOnBackEnabled

boolean isHeadersTransitionOnBackEnabled ()

Returns true if headers transition on back key support is enabled.

isInHeadersTransition

boolean isInHeadersTransition ()

Returns true if the headers transition is currently running.

isShowingHeaders

boolean isShowingHeaders ()

Returns true if headers are shown.

onCreateHeadersFragment

HeadersFragment onCreateHeadersFragment ()

Creates a new HeadersFragment instance. Subclass of BrowseFragment may override and return an instance of subclass of HeadersFragment, e.g. when app wants to replace presenter to render HeaderItem.

onSaveInstanceState

void onSaveInstanceState (Bundle outState)

onStart

void onStart ()

setAdapter

void setAdapter (ObjectAdapter adapter)

Sets the adapter containing the rows for the fragment.

The items referenced by the adapter must be be derived from Row. These rows will be used by the rows fragment and the headers fragment (if not disabled) to render the browse rows.

setBrandColor

void setBrandColor (int color)

Sets the brand color for the browse fragment. The brand color is used as the primary color for UI elements in the browse fragment. For example, the background color of the headers fragment uses the brand color.

setBrowseTransitionListener

void setBrowseTransitionListener (BrowseFragment.BrowseTransitionListener listener)

Sets a listener for browse fragment transitions.

setHeaderPresenterSelector

void setHeaderPresenterSelector (PresenterSelector headerPresenterSelector)

Sets the PresenterSelector used to render the row headers.

setHeadersState

void setHeadersState (int headersState)

Sets the state for the headers column in the browse fragment. Must be one of HEADERS_ENABLED, HEADERS_HIDDEN, or HEADERS_DISABLED.

setHeadersTransitionOnBackEnabled

void setHeadersTransitionOnBackEnabled (boolean headersBackStackEnabled)

Enables/disables headers transition on back key support. This is enabled by default. The BrowseFragment will add a back stack entry when headers are showing. Running a headers transition when the back key is pressed only works when the headers state is HEADERS_ENABLED or HEADERS_HIDDEN.

NOTE: If an Activity has its own onBackPressed() handling, you must disable this feature. You may use startHeadersTransition(boolean) and BrowseFragment.BrowseTransitionListener in your own back stack handling.

setOnItemViewClickedListener

void setOnItemViewClickedListener (OnItemViewClickedListener listener)

Sets an item clicked listener on the fragment. OnItemViewClickedListener will override View.OnClickListener that item presenter sets during onCreateViewHolder(ViewGroup). So in general, developer should choose one of the listeners but not both.

setOnItemViewSelectedListener

void setOnItemViewSelectedListener (OnItemViewSelectedListener listener)

Sets an item selection listener.

setSelectedPosition

void setSelectedPosition (int position)

Sets the selected row position with smooth animation.

setSelectedPosition

void setSelectedPosition (int rowPosition, 
                boolean smooth, 
                Presenter.ViewHolderTask rowHolderTask)

Selects a Row and perform an optional task on the Row. For example setSelectedPosition(10, true, new ListRowPresenterSelectItemViewHolderTask(5)) scrolls to 11th row and selects 6th item on that row. The method will be ignored if RowsFragment has not been created (i.e. before onCreateView(LayoutInflater, ViewGroup, Bundle)).

setSelectedPosition

void setSelectedPosition (int position, 
                boolean smooth)

Sets the selected row position.

startHeadersTransition

void startHeadersTransition (boolean withHeaders)

Starts a headers transition.

This method will begin a transition to either show or hide the headers, depending on the value of withHeaders. If headers are disabled for this browse fragment, this method will throw an exception.

createEntranceTransition

Object createEntranceTransition ()

Create entrance transition. Subclass can override to load transition from resource or construct manually. Typically app does not need to override the default transition that browse and details provides.

onEntranceTransitionEnd

void onEntranceTransitionEnd ()

Callback when entrance transition is ended.

onEntranceTransitionPrepare

void onEntranceTransitionPrepare ()

Callback when entrance transition is prepared. This is when fragment should stop user input and animations.

onEntranceTransitionStart

void onEntranceTransitionStart ()

Callback when entrance transition is started. This is when fragment should stop processing layout.

runEntranceTransition

void runEntranceTransition (Object entranceTransition)

Run entrance transition. Subclass may use TransitionManager to perform go(Scene) or beginDelayedTransition(). App should not override the default implementation of browse and details fragment.