BrandedSupportFragment

Kotlin |Java

open class BrandedSupportFragment : Fragment

kotlin.Any
↳	androidx.fragment.app.Fragment
	↳	androidx.leanback.app.BrandedSupportFragment

Known Direct Subclasses BaseSupportFragment, ErrorSupportFragment BaseSupportFragment Base class for leanback Fragments. ErrorSupportFragment A fragment for displaying an error indication.

Known Indirect 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.

Fragment class for managing search and branding using a view that implements TitleViewAdapter.Provider.

Summary

Public constructors
<init>() Fragment class for managing search and branding using a view that implements TitleViewAdapter.Provider.

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

Inherited functions

From class Fragment Unit dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<String!>?) Print the Fragments's state into the given stream. Boolean equals(@Nullable other: Any?) Subclasses can not override equals(). FragmentActivity? getActivity() Return the FragmentActivity this fragment is currently associated with. May return null if the fragment is associated with a Context instead. Boolean getAllowEnterTransitionOverlap() Returns whether the the exit transition and enter transition overlap or not. When true, the enter transition will start as soon as possible. When false, the enter transition will wait until the exit transition completes before starting. Boolean getAllowReturnTransitionOverlap() Returns whether the the return transition and reenter transition overlap or not. When true, the reenter transition will start as soon as possible. When false, the reenter transition will wait until the return transition completes before starting. Bundle? getArguments() Return the arguments supplied when the fragment was instantiated, if any. 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. ViewModelProvider.Factory getDefaultViewModelProviderFactory() Returns the default ViewModelProvider.Factory that should be used when no custom Factory is provided to the ViewModelProvider constructors. The Fragment's arguments when this is first called will be used as the defaults to any androidx.lifecycle.SavedStateHandle passed to a view model created using this factory. Any? getEnterTransition() Returns the Transition that will be used to move Views into the initial scene. The entering Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as entering is governed by changing visibility from View#INVISIBLE to View#VISIBLE. Any? 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. The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, the views will remain unaffected. FragmentManager? getFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will be non-null slightly before getActivity(), during the time from when the fragment is placed in a FragmentTransaction until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's getChildFragmentManager(). Any? getHost() Return the host object of this fragment. May return null if the fragment isn't currently being hosted. Int getId() Return the identifier this fragment is known by. This is either the android:id value supplied in a layout or the container view ID supplied when adding the fragment. LayoutInflater getLayoutInflater() Returns the cached LayoutInflater used to inflate Views of this Fragment. If onGetLayoutInflater(Bundle) has not been called onGetLayoutInflater(Bundle) will be called with a null argument and that value will be cached. The cached LayoutInflater will be replaced immediately prior to onCreateView(LayoutInflater, ViewGroup, Bundle) and cleared immediately after onDetach(). Lifecycle getLifecycle() Returns the Lifecycle of the provider. Overriding this method is no longer supported and this method will be made final in a future version of Fragment. LoaderManager getLoaderManager() Return the LoaderManager for this fragment. Fragment? getParentFragment() Returns the parent Fragment containing this Fragment. If this Fragment is attached directly to an Activity, returns null. FragmentManager getParentFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will available slightly before getActivity(), during the time from when the fragment is placed in a FragmentTransaction until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's getChildFragmentManager(). Any? getReenterTransition() Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If nothing is set, the default will be to use the same transition as getExitTransition(). Resources getResources() Return requireActivity().getResources(). Boolean getRetainInstance() Returns true if this fragment instance's state will be retained across configuration changes, and false if it will not. Any? 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. The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as entering is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If nothing is set, the default will be to use the same transition as getEnterTransition(). SavedStateRegistry getSavedStateRegistry() Any? getSharedElementEnterTransition() Returns the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as android.transition.ChangeBounds. A null value will cause transferred shared elements to blink to the final position. Any? getSharedElementReturnTransition() Return the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as android.transition.ChangeBounds. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as setSharedElementEnterTransition(Object). String getString(@StringRes resId: Int) Return a localized string from the application's package's default string table. String getString(@StringRes resId: Int, @Nullable vararg formatArgs: Any!) Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in java.util.Formatter and java.lang.String#format. String? getTag() Get the tag name of the fragment, if specified. Fragment? getTargetFragment() Return the target fragment set by setTargetFragment. Int getTargetRequestCode() Return the target request code set by setTargetFragment. CharSequence getText(@StringRes resId: Int) 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), if provided. LifecycleOwner getViewLifecycleOwner() Get a LifecycleOwner that represents the Fragment's View lifecycle. In most cases, this mirrors the lifecycle of the Fragment itself, but in cases of detached Fragments, the lifecycle of the Fragment can be considerably longer than the lifecycle of the View itself. Namely, the lifecycle of the Fragment's View is: created after onViewStateRestored(Bundle) started after onStart() resumed after onResume() paused before onPause() stopped before onStop() destroyed before onDestroyView() The first method where it is safe to access the view lifecycle is onCreateView(LayoutInflater, ViewGroup, Bundle) under the condition that you must return a non-null view (an IllegalStateException will be thrown if you access the view lifecycle but don't return a non-null view). The view lifecycle remains valid through the call to onDestroyView(), after which getView() will return null, the view lifecycle will be destroyed, and this method will throw an IllegalStateException. Consider using getViewLifecycleOwnerLiveData() or FragmentTransaction#runOnCommit(Runnable) to receive a callback for when the Fragment's view lifecycle is available. This should only be called on the main thread. Overriding this method is no longer supported and this method will be made final in a future version of Fragment. LiveData<LifecycleOwner!> getViewLifecycleOwnerLiveData() Retrieve a LiveData which allows you to observe the lifecycle of the Fragment's View. This will be set to the new LifecycleOwner after onCreateView returns a non-null View and will set to null after onDestroyView(). Overriding this method is no longer supported and this method will be made final in a future version of Fragment. ViewModelStore getViewModelStore() Returns the ViewModelStore associated with this Fragment Overriding this method is no longer supported and this method will be made final in a future version of Fragment. Int hashCode() Subclasses can not override hashCode(). Fragment instantiate(@NonNull context: Context, @NonNull fname: String) Like instantiate(Context, String, Bundle) but with a null argument Bundle. Fragment instantiate(@NonNull context: Context, @NonNull fname: String, @Nullable args: Bundle?) Create a new instance of a Fragment with the given class name. This is the same as calling its empty constructor, setting the ClassLoader on the supplied arguments, then calling setArguments(Bundle). Boolean isAdded() Return true if the fragment is currently added to its activity. Boolean isDetached() Return true if the fragment has been explicitly detached from the UI. That is, FragmentTransaction.detach(Fragment) has been used on it. Boolean isHidden() Return true if the fragment has been hidden. By default fragments are shown. You can find out about changes to this state with onHiddenChanged. Note that the hidden state is orthogonal to other states -- that is, to be visible to the user, a fragment must be both started and not hidden. Boolean isInLayout() Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag. This will always be true when fragments are created through the <fragment> tag, except in the case where an old fragment is restored from a previous state and it does not appear in the layout of the current state. Boolean isRemoving() Return true if this fragment is currently being removed from its activity. This is not whether its activity is finishing, but rather whether it is in the process of being removed from its activity. Boolean isResumed() Return true if the fragment is in the resumed state. This is true for the duration of onResume() and onPause() as well. Boolean isStateSaved() Returns true if this fragment is added and its state has already been saved by its host. Any operations that would change saved state should not be performed if this method returns true, and some operations such as setArguments(Bundle) will fail. Boolean isVisible() Return true if the fragment is currently visible to the user. This means it: (1) has been added, (2) has its view attached to the window, and (3) is not hidden. Unit onActivityCreated(@Nullable savedInstanceState: Bundle?) Called when the fragment's activity has been created and this fragment's view hierarchy instantiated. It can be used to do final initialization once these pieces are in place, such as retrieving views or restoring state. It is also useful for fragments that use setRetainInstance(boolean) to retain their instance, as this callback tells the fragment when it is fully associated with the new activity instance. This is called after onCreateView and before onViewStateRestored(Bundle). Unit onActivityResult(requestCode: Int, resultCode: Int, @Nullable data: Intent?) Receive the result from a previous call to startActivityForResult(Intent, int). This follows the related Activity API as described there in Activity#onActivityResult(int, int, Intent). Unit onAttach(@NonNull context: Context) Called when a fragment is first attached to its context. onCreate(Bundle) will be called after this. Unit onAttach(@NonNull activity: Activity) Called when a fragment is first attached to its activity. onCreate(Bundle) will be called after this. Unit onAttachFragment(@NonNull childFragment: Fragment) Called when a fragment is attached as a child of this fragment. This is called after the attached fragment's onAttach and before the attached fragment's onCreate if the fragment has not yet had a previous call to onCreate. Unit onConfigurationChanged(@NonNull newConfig: Configuration)