ErrorFragment

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

public class ErrorFragment extends BrandedFragment

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

A fragment for displaying an error indication.

Summary

Public constructors
`ErrorFragment()`

Public methods
`@Nullable Drawable`	`getBackgroundDrawable()` Returns the background drawable.
`@Nullable View.OnClickListener`	`getButtonClickListener()` Returns the button click listener.
`@Nullable String`	`getButtonText()` Returns the button text.
`@Nullable Drawable`	`getImageDrawable()` Returns the drawable used for the error image.
`@Nullable CharSequence`	`getMessage()` Returns the error message.
`boolean`	`isBackgroundTranslucent()` Returns true if the background is translucent.
`@Nullable View`	`onCreateView( LayoutInflater inflater, @Nullable ViewGroup container, Bundle savedInstanceState )` This method is deprecated.
`void`	`onStart()` This method is deprecated.
`void`	`setBackgroundDrawable(@Nullable Drawable drawable)` Sets a drawable for the fragment background.
`void`	`setButtonClickListener(@Nullable View.OnClickListener clickListener)` Set the button click listener.
`void`	`setButtonText(@Nullable String text)` Sets the button text.
`void`	`setDefaultBackground(boolean translucent)` Sets the default background.
`void`	`setImageDrawable(@Nullable Drawable drawable)` Sets the drawable to be used for the error image.
`void`	`setMessage(@Nullable CharSequence message)` Sets the error message.

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.
`void`	`onDestroyView()` This method is deprecated.
`@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`	`onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState)` 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.
`void`	`onCreate(Bundle savedInstanceState)` 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.
`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 constructors

ErrorFragment

Added in 1.1.0

Deprecated in 1.1.0

public ErrorFragment()

Public methods

getBackgroundDrawable

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable Drawable getBackgroundDrawable()

Returns the background drawable. May be null if a default is used.

getButtonClickListener

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable View.OnClickListener getButtonClickListener()

Returns the button click listener.

getButtonText

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable String getButtonText()

Returns the button text.

getImageDrawable

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable Drawable getImageDrawable()

Returns the drawable used for the error image.

getMessage

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable CharSequence getMessage()

Returns the error message.

isBackgroundTranslucent

Added in 1.1.0

Deprecated in 1.1.0

public boolean isBackgroundTranslucent()

Returns true if the background is translucent.

onCreateView

Added in 1.1.0

Deprecated in 1.1.0

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

onStart

public void onStart()

setBackgroundDrawable

Added in 1.1.0

Deprecated in 1.1.0

public void setBackgroundDrawable(@Nullable Drawable drawable)

Sets a drawable for the fragment background.

Parameters
`@Nullable Drawable drawable`	The drawable used for the background.

setButtonClickListener

Added in 1.1.0

Deprecated in 1.1.0

public void setButtonClickListener(@Nullable View.OnClickListener clickListener)

Set the button click listener.

Parameters
`@Nullable View.OnClickListener clickListener`	The click listener for the button.

setButtonText

Added in 1.1.0

Deprecated in 1.1.0

public void setButtonText(@Nullable String text)

Sets the button text.

Parameters
`@Nullable String text`	The button text.

setDefaultBackground

Added in 1.1.0

Deprecated in 1.1.0

public void setDefaultBackground(boolean translucent)

Sets the default background.

Parameters
`boolean translucent`	True to set a translucent background.

setImageDrawable

Added in 1.1.0

Deprecated in 1.1.0

public void setImageDrawable(@Nullable Drawable drawable)

Sets the drawable to be used for the error image.

Parameters
`@Nullable Drawable drawable`	The drawable used for the error image.

setMessage

Added in 1.1.0

Deprecated in 1.1.0

public void setMessage(@Nullable CharSequence message)

Sets the error message.

Parameters
`@Nullable CharSequence message`	The error message.