BaseFragment

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

public class BaseFragment extends BrandedFragment

java.lang.Object
↳	android.app.Fragment
	↳	androidx.leanback.app.BrandedFragment
		↳	androidx.leanback.app.BaseFragment

Known direct subclasses

BrowseFragment, DetailsFragment, VerticalGridFragment

BrowseFragment

This class is deprecated.

use BrowseSupportFragment

DetailsFragment

This class is deprecated.

use DetailsSupportFragment

VerticalGridFragment

This class is deprecated.

use VerticalGridSupportFragment

Base class for leanback Fragments. This class is not intended to be subclassed by apps.

Summary

Public methods
`final ProgressBarManager`	`getProgressBarManager()` Returns the `ProgressBarManager`.
`void`	`onCreate(Bundle savedInstanceState)` This method is deprecated.
`void`	`onDestroyView()` This method is deprecated.
`void`	`onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState)` This method is deprecated.
`void`	`prepareEntranceTransition()` Enables entrance transition.
`void`	`startEntranceTransition()` When fragment finishes loading data, it should call startEntranceTransition() to execute the entrance transition. startEntranceTransition() will start transition only if both two conditions are satisfied:

Protected methods
`Object`	`createEntranceTransition()` Create entrance transition.
`void`	`onEntranceTransitionEnd()` Callback when entrance transition is ended.
`void`	`onEntranceTransitionPrepare()` Callback when entrance transition is prepared.
`void`	`onEntranceTransitionStart()` Callback when entrance transition is started.
`void`	`runEntranceTransition(Object entranceTransition)` Run entrance transition.

Inherited Constants

From android.content.ComponentCallbacks2

`static final int`	`TRIM_MEMORY_BACKGROUND = 40`
`static final int`	`TRIM_MEMORY_COMPLETE = 80` This field is deprecated.
`static final int`	`TRIM_MEMORY_MODERATE = 60` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_LOW = 10` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_MODERATE = 5` This field is deprecated.
`static final int`	`TRIM_MEMORY_UI_HIDDEN = 20`

Inherited methods

From androidx.leanback.app.BrandedFragment

`@Nullable Drawable`	`getBadgeDrawable()` Returns the badge drawable used in the fragment title.
`int`	`getSearchAffordanceColor()` Returns the color used to draw the search affordance.
`@Nullable SearchOrbView.Colors`	`getSearchAffordanceColors()` Returns the `androidx.leanback.widget.SearchOrbView.Colors` used to draw the search affordance.
`@Nullable CharSequence`	`getTitle()` Returns the title text for the fragment.
`@Nullable View`	`getTitleView()` Returns the view that implements `TitleViewAdapter.Provider`.
`@Nullable TitleViewAdapter`	`getTitleViewAdapter()` Returns the `TitleViewAdapter` implemented by title view.
`void`	`installTitleView( @NonNull LayoutInflater inflater, @NonNull ViewGroup parent, @Nullable Bundle savedInstanceState )` Inflate title view and add to parent.
`final boolean`	`isShowingTitle()` Returns true/false to indicate the visibility of TitleView.
`@NonNull View`	`onInflateTitleView( @NonNull LayoutInflater inflater, @Nullable ViewGroup parent, @Nullable Bundle savedInstanceState )` Called by `installTitleView` to inflate title view.
`void`	`onPause()` This method is deprecated.
`void`	`onResume()` This method is deprecated.
`void`	`onSaveInstanceState(Bundle outState)` This method is deprecated.
`void`	`onStart()` This method is deprecated.
`void`	`setBadgeDrawable(@Nullable Drawable drawable)` Sets the drawable displayed in the fragment title.
`void`	`setOnSearchClickedListener(@Nullable View.OnClickListener listener)` Sets a click listener for the search affordance.
`void`	`setSearchAffordanceColor(int color)` Sets the color used to draw the search affordance.
`void`	`setSearchAffordanceColors(@NonNull SearchOrbView.Colors colors)` Sets the `androidx.leanback.widget.SearchOrbView.Colors` used to draw the search affordance.
`void`	`setTitle(@Nullable CharSequence title)` Sets title text for the fragment.
`void`	`setTitleView(@Nullable View titleView)` Sets the view that implemented `TitleViewAdapter`.
`void`	`showTitle(int flags)` Changes title view's components visibility and shows title.
`void`	`showTitle(boolean show)` Shows or hides the title view.

From android.app.Fragment

`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` This method is deprecated.
`final boolean`	`equals(Object o)` This method is deprecated.
`final Activity`	`getActivity()` This method is deprecated.
`boolean`	`getAllowEnterTransitionOverlap()` This method is deprecated.
`boolean`	`getAllowReturnTransitionOverlap()` This method is deprecated.
`final Bundle`	`getArguments()` This method is deprecated.
`final FragmentManager`	`getChildFragmentManager()` This method is deprecated.
`Context`	`getContext()` This method is deprecated.
`Transition`	`getEnterTransition()` This method is deprecated.
`Transition`	`getExitTransition()` This method is deprecated.
`final FragmentManager`	`getFragmentManager()` This method is deprecated.
`final Object`	`getHost()` This method is deprecated.
`final int`	`getId()` This method is deprecated.
`final LayoutInflater`	`getLayoutInflater()` This method is deprecated.
`LoaderManager`	`getLoaderManager()` This method is deprecated.
`final Fragment`	`getParentFragment()` This method is deprecated.
`Transition`	`getReenterTransition()` This method is deprecated.
`final Resources`	`getResources()` This method is deprecated.
`final boolean`	`getRetainInstance()` This method is deprecated.
`Transition`	`getReturnTransition()` This method is deprecated.
`Transition`	`getSharedElementEnterTransition()` This method is deprecated.
`Transition`	`getSharedElementReturnTransition()` This method is deprecated.
`final String`	`getString(int resId)` This method is deprecated.
`final String`	`getTag()` This method is deprecated.
`final Fragment`	`getTargetFragment()` This method is deprecated.
`final int`	`getTargetRequestCode()` This method is deprecated.
`final CharSequence`	`getText(int resId)` This method is deprecated.
`boolean`	`getUserVisibleHint()` This method is deprecated.
`View`	`getView()` This method is deprecated.
`final int`	`hashCode()` This method is deprecated.
`static Fragment`	`instantiate(Context context, String fname)` This method is deprecated.
`final boolean`	`isAdded()` This method is deprecated.
`final boolean`	`isDetached()` This method is deprecated.
`final boolean`	`isHidden()` This method is deprecated.
`final boolean`	`isInLayout()` This method is deprecated.
`final boolean`	`isRemoving()` This method is deprecated.
`final boolean`	`isResumed()` This method is deprecated.
`final boolean`	`isStateSaved()` This method is deprecated.
`final boolean`	`isVisible()` This method is deprecated.
`void`	`onActivityCreated(Bundle savedInstanceState)` This method is deprecated.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` This method is deprecated.
`void`	`onAttach(Activity activity)` This method is deprecated.
`void`	`onAttachFragment(Fragment childFragment)` This method is deprecated.
`void`	`onConfigurationChanged(Configuration newConfig)` This method is deprecated.
`boolean`	`onContextItemSelected(MenuItem item)` This method is deprecated.
`Animator`	`onCreateAnimator(int transit, boolean enter, int nextAnim)` This method is deprecated.
`void`	`onCreateContextMenu( ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo )` This method is deprecated.
`void`	`onCreateOptionsMenu(Menu menu, MenuInflater inflater)` This method is deprecated.
`View`	`onCreateView( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState )` This method is deprecated.
`void`	`onDestroy()` This method is deprecated.
`void`	`onDestroyOptionsMenu()` This method is deprecated.
`void`	`onDestroyView()` This method is deprecated.
`void`	`onDetach()` This method is deprecated.
`LayoutInflater`	`onGetLayoutInflater(Bundle savedInstanceState)` This method is deprecated.
`void`	`onHiddenChanged(boolean hidden)` This method is deprecated.
`void`	`onInflate( Activity activity, AttributeSet attrs, Bundle savedInstanceState )` This method is deprecated.
`void`	`onLowMemory()` This method is deprecated.
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` This method is deprecated.
`boolean`	`onOptionsItemSelected(MenuItem item)` This method is deprecated.
`void`	`onOptionsMenuClosed(Menu menu)` This method is deprecated.
`void`	`onPause()` This method is deprecated.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` This method is deprecated.
`void`	`onPrepareOptionsMenu(Menu menu)` This method is deprecated.
`void`	`onRequestPermissionsResult( int requestCode, String[] permissions, int[] grantResults )` This method is deprecated.
`void`	`onResume()` This method is deprecated.
`void`	`onSaveInstanceState(Bundle outState)` This method is deprecated.
`void`	`onStart()` This method is deprecated.
`void`	`onStop()` This method is deprecated.
`void`	`onTrimMemory(int level)` This method is deprecated.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` This method is deprecated.
`void`	`onViewStateRestored(Bundle savedInstanceState)` This method is deprecated.
`void`	`postponeEnterTransition()` This method is deprecated.
`void`	`registerForContextMenu(View view)` This method is deprecated.
`final void`	`requestPermissions(String[] permissions, int requestCode)` This method is deprecated.
`void`	`setAllowEnterTransitionOverlap(boolean allow)` This method is deprecated.
`void`	`setAllowReturnTransitionOverlap(boolean allow)` This method is deprecated.
`void`	`setArguments(Bundle args)` This method is deprecated.
`void`	`setEnterSharedElementCallback(SharedElementCallback callback)` This method is deprecated.
`void`	`setEnterTransition(Transition transition)` This method is deprecated.
`void`	`setExitSharedElementCallback(SharedElementCallback callback)` This method is deprecated.
`void`	`setExitTransition(Transition transition)` This method is deprecated.
`void`	`setHasOptionsMenu(boolean hasMenu)` This method is deprecated.
`void`	`setInitialSavedState(Fragment.SavedState state)` This method is deprecated.
`void`	`setMenuVisibility(boolean menuVisible)` This method is deprecated.
`void`	`setReenterTransition(Transition transition)` This method is deprecated.
`void`	`setRetainInstance(boolean retain)` This method is deprecated.
`void`	`setReturnTransition(Transition transition)` This method is deprecated.
`void`	`setSharedElementEnterTransition(Transition transition)` This method is deprecated.
`void`	`setSharedElementReturnTransition(Transition transition)` This method is deprecated.
`void`	`setTargetFragment(Fragment fragment, int requestCode)` This method is deprecated.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` This method is deprecated.
`boolean`	`shouldShowRequestPermissionRationale(String permission)` This method is deprecated.
`void`	`startActivity(Intent intent)` This method is deprecated.
`void`	`startActivityForResult(Intent intent, int requestCode)` This method is deprecated.
`void`	`startIntentSenderForResult( IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options )` This method is deprecated.
`void`	`startPostponedEnterTransition()` This method is deprecated.
`String`	`toString()` This method is deprecated.
`void`	`unregisterForContextMenu(View view)` This method is deprecated.

Public methods

getProgressBarManager

Added in 1.1.0

Deprecated in 1.1.0

public final ProgressBarManager getProgressBarManager()

Returns the ProgressBarManager.

Returns
`ProgressBarManager`	The `ProgressBarManager`.

onCreate

Added in 1.1.0

Deprecated in 1.1.0

public void onCreate(Bundle savedInstanceState)

onDestroyView

public void onDestroyView()

onViewCreated

public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState)

prepareEntranceTransition

Added in 1.1.0

Deprecated in 1.1.0

public void prepareEntranceTransition()

Enables entrance transition.

Entrance transition is the standard slide-in transition that shows rows of data in browse screen and details screen.

The method is ignored before LOLLIPOP (API21).

This method must be called in or before onCreate(). Typically entrance transition should be enabled when savedInstance is null so that fragment restored from instanceState does not run an extra entrance transition. When the entrance transition is enabled, the fragment will make headers and content hidden initially. When data of rows are ready, app must call startEntranceTransition to kick off the transition, otherwise the rows will be invisible forever.

It is similar to android:windowsEnterTransition and can be considered a late-executed android:windowsEnterTransition controlled by app. There are two reasons that app needs it:

Workaround the problem that activity transition is not available between launcher and app. Browse activity must programmatically start the slide-in transition.
Separates DetailsOverviewRow transition from other rows transition. So that the DetailsOverviewRow transition can be executed earlier without waiting for all rows to be loaded.

Transition object is returned by createEntranceTransition(). Typically the app does not need override the default transition that browse and details provides.

startEntranceTransition

Added in 1.1.0

Deprecated in 1.1.0

public void startEntranceTransition()

When fragment finishes loading data, it should call startEntranceTransition() to execute the entrance transition. startEntranceTransition() will start transition only if both two conditions are satisfied:

prepareEntranceTransition() was called.
has not executed entrance transition yet.

If startEntranceTransition() is called before onViewCreated(), it will be pending and executed when view is created.

Protected methods

createEntranceTransition

Added in 1.1.0

Deprecated in 1.1.0

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.

onEntranceTransitionEnd

Added in 1.1.0

Deprecated in 1.1.0

protected void onEntranceTransitionEnd()

Callback when entrance transition is ended.

onEntranceTransitionPrepare

Added in 1.1.0

Deprecated in 1.1.0

protected void onEntranceTransitionPrepare()

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

onEntranceTransitionStart

Added in 1.1.0

Deprecated in 1.1.0

protected void onEntranceTransitionStart()

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

runEntranceTransition

Added in 1.1.0

Deprecated in 1.1.0

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.