added in version 26.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1

Summary: Methods | Protected Methods | Inherited Methods | [Expand All]

BaseSupportFragment

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public class BaseSupportFragment
extends BrandedSupportFragment

java.lang.Object
↳	android.support.v4.app.Fragment
	↳	android.support.v17.leanback.app.BrandedSupportFragment
		↳	android.support.v17.leanback.app.BaseSupportFragment

Known Direct Subclasses BrowseSupportFragment,DetailsSupportFragment,VerticalGridSupportFragment BrowseSupportFragment A fragment for creating Leanback browse screens.  DetailsSupportFragment A fragment for creating Leanback details screens.  VerticalGridSupportFragment A fragment for creating leanback vertical grids.

---

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) Called to do initial creation of a fragment.
void	onViewCreated(View view, Bundle savedInstanceState) Called immediately after onCreateView(LayoutInflater, ViewGroup, Bundle) has returned, but before any saved state has been restored in to the view.
void	prepareEntranceTransition() Enables entrance transition.
void	startEntranceTransition() When fragment finishes loading data, it should call startEntranceTransition() to execute the entrance transition.

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 methods
From class android.support.v17.leanback.app.BrandedSupportFragment Drawable getBadgeDrawable() Returns the badge drawable used in the fragment title. int getSearchAffordanceColor() Returns the color used to draw the search affordance. SearchOrbView.Colors getSearchAffordanceColors() Returns the SearchOrbView.Colors used to draw the search affordance. CharSequence getTitle() Returns the title text for the fragment. View getTitleView() Returns the view that implements TitleViewAdapter.Provider. TitleViewAdapter getTitleViewAdapter() Returns the TitleViewAdapter implemented by title view. void installTitleView(LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState) Inflate title view and add to parent. final boolean isShowingTitle() Returns true/false to indicate the visibility of TitleView. void onDestroyView() Called when the view previously created by onCreateView(LayoutInflater, ViewGroup, Bundle) has been detached from the fragment. View onInflateTitleView(LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState) Called by installTitleView(LayoutInflater, ViewGroup, Bundle) to inflate title view. void onPause() Called when the Fragment is no longer resumed. void onResume() Called when the fragment is visible to the user and actively running. void onSaveInstanceState(Bundle outState) Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted. void onStart() Called when the Fragment is visible to the user. void onViewCreated(View view, Bundle savedInstanceState) Called immediately after onCreateView(LayoutInflater, ViewGroup, Bundle) has returned, but before any saved state has been restored in to the view. void setBadgeDrawable(Drawable drawable) Sets the drawable displayed in the fragment title. void setOnSearchClickedListener(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(SearchOrbView.Colors colors) Sets the SearchOrbView.Colors used to draw the search affordance. void setTitle(CharSequence title) Sets title text for the fragment. void setTitleView(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 class android.support.v4.app.Fragment void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) Print the Fragments's state into the given stream. final boolean equals(Object o) Subclasses can not override equals(). final FragmentActivity getActivity() Return the FragmentActivity this fragment is currently associated with. boolean getAllowEnterTransitionOverlap() Returns whether the the exit transition and enter transition overlap or not. boolean getAllowReturnTransitionOverlap() Returns whether the the return transition and reenter transition overlap or not. final Bundle getArguments() Return the arguments supplied when the fragment was instantiated, if any. final FragmentManager getChildFragmentManager() Return a private FragmentManager for placing and managing Fragments inside of this Fragment. Context getContext() Return the Context this fragment is currently associated with. Object getEnterTransition() Returns the Transition that will be used to move Views into the initial scene. Object getExitTransition() Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. final FragmentManager getFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity. final Object getHost() Return the host object of this fragment. final int getId() Return the identifier this fragment is known by. final LayoutInflater getLayoutInflater() Returns the cached LayoutInflater used to inflate Views of this Fragment. Lifecycle getLifecycle() LoaderManager getLoaderManager() Return the LoaderManager for this fragment. final Fragment getParentFragment() Returns the parent Fragment containing this Fragment. Object getReenterTransition() Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack. final Resources getResources() Return requireActivity().getResources(). final boolean getRetainInstance() Object getReturnTransition() Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. Object getSharedElementEnterTransition() Returns the Transition that will be used for shared elements transferred into the content Scene. Object getSharedElementReturnTransition() Return the Transition that will be used for shared elements transferred back during a pop of the back stack. final String getString(int resId, Object... formatArgs) Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in Formatter and format(String, Object...). final String getString(int resId) Return a localized string from the application's package's default string table. final String getTag() Get the tag name of the fragment, if specified. final Fragment getTargetFragment() Return the target fragment set by setTargetFragment(Fragment, int). final int getTargetRequestCode() Return the target request code set by setTargetFragment(Fragment, int). final CharSequence getText(int resId) Return a localized, styled CharSequence from the application's package's default string table. boolean getUserVisibleHint() View getView() Get the root view for the fragment's layout (the one returned by onCreateView(LayoutInflater, ViewGroup, Bundle)), if provided. ViewModelStore getViewModelStore() final int hashCode() Subclasses can not override hashCode(). static Fragment instantiate(Context context, String fname) Like instantiate(Context, String, Bundle) but with a null argument Bundle. static Fragment instantiate(Context context, String fname, Bundle args) Create a new instance of a Fragment with the given class name. final boolean isAdded() Return true if the fragment is currently added to its activity. final boolean isDetached() Return true if the fragment has been explicitly detached from the UI. final boolean isHidden() Return true if the fragment has been hidden. final boolean isInLayout() Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag. final boolean isRemoving() Return true if this fragment is currently being removed from its activity. final boolean isResumed() Return true if the fragment is in the resumed state. final boolean isStateSaved() Returns true if this fragment is added and its state has already been saved by its host. final boolean isVisible() Return true if the fragment is currently visible to the user. void onActivityCreated(Bundle savedInstanceState) Called when the fragment's activity has been created and this fragment's view hierarchy instantiated. void onActivityResult(int requestCode, int resultCode, Intent data) Receive the result from a previous call to startActivityForResult(Intent, int). void onAttach(Activity activity) This method was deprecated in API level 24.1.0. See onAttach(Context). void onAttach(Context context) Called when a fragment is first attached to its context. void onAttachFragment(Fragment childFragment) Called when a fragment is attached as a child of this fragment. void onConfigurationChanged(Configuration newConfig) boolean onContextItemSelected(MenuItem item) This hook is called whenever an item in a context menu is selected. void onCreate(Bundle savedInstanceState) Called to do initial creation of a fragment. Animation onCreateAnimation(int transit, boolean enter, int nextAnim) Called when a fragment loads an animation. Animator onCreateAnimator(int transit, boolean enter, int nextAnim) Called when a fragment loads an animator. void onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo) Called when a context menu for the view is about to be shown. void onCreateOptionsMenu(Menu menu, MenuInflater inflater) Initialize the contents of the Fragment host's standard options menu. View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) Called to have the fragment instantiate its user interface view. void onDestroy() Called when the fragment is no longer in use. void onDestroyOptionsMenu() Called when this fragment's option menu items are no longer being included in the overall options menu. void onDestroyView() Called when the view previously created by onCreateView(LayoutInflater, ViewGroup, Bundle) has been detached from the fragment. void onDetach() Called when the fragment is no longer attached to its activity. LayoutInflater onGetLayoutInflater(Bundle savedInstanceState) Returns the LayoutInflater used to inflate Views of this Fragment. void onHiddenChanged(boolean hidden) Called when the hidden state (as returned by isHidden() of the fragment has changed. void onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) This method was deprecated in API level 24.1.0. See onInflate(Context, AttributeSet, Bundle). void onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState) Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity. void onLowMemory() void onMultiWindowModeChanged(boolean isInMultiWindowMode) Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. boolean onOptionsItemSelected(MenuItem item) This hook is called whenever an item in your options menu is selected. void onOptionsMenuClosed(Menu menu) This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected). void onPause() Called when the Fragment is no longer resumed. void onPictureInPictureModeChanged(boolean isInPictureInPictureMode) Called by the system when the activity changes to and from picture-in-picture mode. void onPrepareOptionsMenu(Menu menu) Prepare the Fragment host's standard options menu to be displayed. void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) Callback for the result from requesting permissions. void onResume() Called when the fragment is visible to the user and actively running. void onSaveInstanceState(Bundle outState) Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted. void onStart() Called when the Fragment is visible to the user. void onStop() Called when the Fragment is no longer started. void onViewCreated(View view, Bundle savedInstanceState) Called immediately after onCreateView(LayoutInflater, ViewGroup, Bundle) has returned, but before any saved state has been restored in to the view. void onViewStateRestored(Bundle savedInstanceState) Called when all saved state has been restored into the view hierarchy of the fragment. void postponeEnterTransition() Postpone the entering Fragment transition until startPostponedEnterTransition() or executePendingTransactions() has been called. void registerForContextMenu(View view) Registers a context menu to be shown for the given view (multiple views can show the context menu). final void requestPermissions(String[] permissions, int requestCode) Requests permissions to be granted to this application. final FragmentActivity requireActivity() Return the FragmentActivity this fragment is currently associated with. final Context requireContext() Return the Context this fragment is currently associated with. final FragmentManager requireFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity. final Object requireHost() Return the host object of this fragment. void setAllowEnterTransitionOverlap(boolean allow) Sets whether the the exit transition and enter transition overlap or not. void setAllowReturnTransitionOverlap(boolean allow) Sets whether the the return transition and reenter transition overlap or not. void setArguments(Bundle args) Supply the construction arguments for this fragment. void setEnterSharedElementCallback(SharedElementCallback callback) When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack. void setEnterTransition(Object transition) Sets the Transition that will be used to move Views into the initial scene. void setExitSharedElementCallback(SharedElementCallback callback) When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack. void setExitTransition(Object transition) Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. void setHasOptionsMenu(boolean hasMenu) Report that this fragment would like to participate in populating the options menu by receiving a call to onCreateOptionsMenu(Menu, MenuInflater) and related methods. void setInitialSavedState(Fragment.SavedState state) Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by FragmentManager.saveFragmentInstanceState. void setMenuVisibility(boolean menuVisible) Set a hint for whether this fragment's menu should be visible. void setReenterTransition(Object transition) Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack. void setRetainInstance(boolean retain) Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change). void setReturnTransition(Object transition) Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. void setSharedElementEnterTransition(Object transition) Sets the Transition that will be used for shared elements transferred into the content Scene. void setSharedElementReturnTransition(Object transition) Sets the Transition that will be used for shared elements transferred back during a pop of the back stack. void setTargetFragment(Fragment fragment, int requestCode) Optional target for this fragment. void setUserVisibleHint(boolean isVisibleToUser) Set a hint to the system about whether this fragment's UI is currently visible to the user. boolean shouldShowRequestPermissionRationale(String permission) Gets whether you should show UI with rationale for requesting a permission. void startActivity(Intent intent) Call startActivity(Intent) from the fragment's containing Activity. void startActivity(Intent intent, Bundle options) Call startActivity(Intent, Bundle) from the fragment's containing Activity. void startActivityForResult(Intent intent, int requestCode) Call startActivityForResult(Intent, int) from the fragment's containing Activity. void startActivityForResult(Intent intent, int requestCode, Bundle options) Call startActivityForResult(Intent, int, Bundle) from the fragment's containing Activity. void startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options) Call startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle) from the fragment's containing Activity. void startPostponedEnterTransition() Begin postponed transitions after postponeEnterTransition() was called. String toString() void unregisterForContextMenu(View view) Prevents a context menu to be shown for the given view.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface android.content.ComponentCallbacks abstract void onConfigurationChanged(Configuration arg0) abstract void onLowMemory()
From interface android.view.View.OnCreateContextMenuListener abstract void onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)
From interface android.arch.lifecycle.LifecycleOwner abstract Lifecycle getLifecycle()
From interface android.arch.lifecycle.ViewModelStoreOwner abstract ViewModelStore getViewModelStore()

Public methods

getProgressBarManager

added in version 26.1.0

ProgressBarManager getProgressBarManager ()

Returns the ProgressBarManager.

Returns
ProgressBarManager	The ProgressBarManager.

onCreate

added in version 22.1.0

void onCreate (Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after onAttach(Activity) and before onCreateView(LayoutInflater, ViewGroup, Bundle).

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, see onActivityCreated(Bundle).

Any restored child fragments will be created before the base Fragment.onCreate method returns.

Parameters
savedInstanceState	Bundle: If the fragment is being re-created from a previous saved state, this is the state.

onViewCreated

added in version 22.1.0

void onViewCreated (View view, 
                Bundle savedInstanceState)

Called immediately after onCreateView(LayoutInflater, ViewGroup, Bundle) has returned, but before any saved state has been restored in to the view. This gives subclasses a chance to initialize themselves once they know their view hierarchy has been completely created. The fragment's view hierarchy is not however attached to its parent at this point.

Parameters
view	View: The View returned by onCreateView(LayoutInflater, ViewGroup, Bundle).
savedInstanceState	Bundle: If non-null, this fragment is being re-constructed from a previous saved state as given here.

prepareEntranceTransition

added in version 26.1.0

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 version 26.1.0

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 version 26.1.0

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.

Returns
Object

onEntranceTransitionEnd

added in version 26.1.0

void onEntranceTransitionEnd ()

Callback when entrance transition is ended.

onEntranceTransitionPrepare

added in version 26.1.0

void onEntranceTransitionPrepare ()

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

onEntranceTransitionStart

added in version 26.1.0

void onEntranceTransitionStart ()

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

runEntranceTransition

added in version 26.1.0

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.

Parameters
entranceTransition	Object

• Interfaces

  • BrowseFragment.FragmentHost
  • BrowseFragment.MainFragmentAdapterProvider
  • BrowseFragment.MainFragmentRowsAdapterProvider
  • BrowseSupportFragment.FragmentHost
  • BrowseSupportFragment.MainFragmentAdapterProvider
  • BrowseSupportFragment.MainFragmentRowsAdapterProvider
  • HeadersFragment.OnHeaderClickedListener
  • HeadersFragment.OnHeaderViewSelectedListener
  • HeadersSupportFragment.OnHeaderClickedListener
  • HeadersSupportFragment.OnHeaderViewSelectedListener
  • SearchFragment.SearchResultProvider
  • SearchSupportFragment.SearchResultProvider

• Classes

  • BackgroundManager
  • BaseFragment
  • BaseSupportFragment
  • BrandedFragment
  • BrandedSupportFragment
  • BrowseFragment
  • BrowseFragment.BrowseTransitionListener
  • BrowseFragment.FragmentFactory
  • BrowseFragment.ListRowFragmentFactory
  • BrowseFragment.MainFragmentAdapter
  • BrowseFragment.MainFragmentAdapterRegistry
  • BrowseFragment.MainFragmentRowsAdapter
  • BrowseSupportFragment
  • BrowseSupportFragment.BrowseTransitionListener
  • BrowseSupportFragment.FragmentFactory
  • BrowseSupportFragment.ListRowFragmentFactory
  • BrowseSupportFragment.MainFragmentAdapter
  • BrowseSupportFragment.MainFragmentAdapterRegistry
  • BrowseSupportFragment.MainFragmentRowsAdapter
  • DetailsFragment
  • DetailsFragmentBackgroundController
  • DetailsSupportFragment
  • DetailsSupportFragmentBackgroundController
  • ErrorFragment
  • ErrorSupportFragment
  • GuidedStepFragment
  • GuidedStepSupportFragment
  • HeadersFragment
  • HeadersSupportFragment
  • OnboardingFragment
  • OnboardingSupportFragment
  • PlaybackFragment
  • PlaybackFragmentGlueHost
  • PlaybackSupportFragment
  • PlaybackSupportFragmentGlueHost
  • ProgressBarManager
  • RowsFragment
  • RowsFragment.MainFragmentAdapter
  • RowsFragment.MainFragmentRowsAdapter
  • RowsSupportFragment
  • RowsSupportFragment.MainFragmentAdapter
  • RowsSupportFragment.MainFragmentRowsAdapter
  • SearchFragment
  • SearchSupportFragment
  • VerticalGridFragment
  • VerticalGridSupportFragment
  • VideoFragment
  • VideoFragmentGlueHost
  • VideoSupportFragment
  • VideoSupportFragmentGlueHost