BrowseFragment

public static final int HEADERS_DISABLED = 3

The headers fragment is disabled and will never be shown.

public static final int HEADERS_ENABLED = 1

The headers fragment is enabled and shown by default.

public static final int HEADERS_HIDDEN = 2

The headers fragment is enabled and hidden by default.

public BrowseFragment()

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

Creates arguments for a browse fragment.

public 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.

public void enableRowScaling(boolean enable)

public ObjectAdapter getAdapter()

Returns the adapter containing the rows for the fragment.

public @ColorInt int getBrandColor()

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

public HeadersFragment getHeadersFragment()

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

public int getHeadersState()

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

public Fragment getMainFragment()

public final BrowseFragment.MainFragmentAdapterRegistry getMainFragmentRegistry()

public OnItemViewClickedListener getOnItemViewClickedListener()

Returns the item Clicked listener.

public OnItemViewSelectedListener getOnItemViewSelectedListener()

Returns an item selection listener.

public 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.

public int getSelectedPosition()

Gets position of currently selected row.

public RowPresenter.ViewHolder getSelectedRowViewHolder()

public final boolean isHeadersTransitionOnBackEnabled()

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

public boolean isInHeadersTransition()

Returns true if the headers transition is currently running.

public boolean isShowingHeaders()

Returns true if headers are shown.

public void onCreate(Bundle savedInstanceState)

public 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.

public @Nullable View onCreateView(
    LayoutInflater inflater,
    @Nullable ViewGroup container,
    Bundle savedInstanceState
)

public void onDestroy()

public void onDestroyView()

public void onSaveInstanceState(Bundle outState)

public void onStart()

public void onStop()

public 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.

public void setBrandColor(@ColorInt 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.

public void setBrowseTransitionListener(
    BrowseFragment.BrowseTransitionListener listener
)

Sets a listener for browse fragment transitions.

public void setHeaderPresenterSelector(PresenterSelector headerPresenterSelector)

Sets the PresenterSelector used to render the row headers.

public 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.

public final 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 and BrowseTransitionListener in your own back stack handling.

public void setOnItemViewClickedListener(OnItemViewClickedListener listener)

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

public void setOnItemViewSelectedListener(OnItemViewSelectedListener listener)

Sets an item selection listener.

public void setSelectedPosition(int position)

Sets the selected row position with smooth animation.

public void setSelectedPosition(int position, boolean smooth)

Sets the selected row position.

public 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).

public 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.

protected 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.

protected void onEntranceTransitionEnd()

Callback when entrance transition is ended.

protected void onEntranceTransitionPrepare()

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

protected void onEntranceTransitionStart()

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

protected 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.