ErrorFragment

Kotlin |Java

open class ErrorFragment : BrandedFragment

kotlin.Any
↳	android.app.Fragment
	↳	androidx.leanback.app.BrandedFragment
		↳	androidx.leanback.app.ErrorFragment

A fragment for displaying an error indication.

Summary

Public constructors
`<init>()` A fragment for displaying an error indication.

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

Inherited functions

From class BrandedFragment

`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 `androidx.leanback.widget.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.
`Unit`	`installTitleView(inflater: LayoutInflater!, parent: ViewGroup!, savedInstanceState: Bundle!)` Inflate title view and add to parent. This method should be called in `Fragment#onCreateView(LayoutInflater, ViewGroup, Bundle)`.
`Boolean`	`isShowingTitle()` Returns true/false to indicate the visibility of TitleView.
`Unit`	`onDestroyView()`
`View!`	`onInflateTitleView(inflater: LayoutInflater!, parent: ViewGroup!, savedInstanceState: Bundle!)` Called by `installTitleView(LayoutInflater, ViewGroup, Bundle)` to inflate title view. Default implementation uses layout file lb_browse_title. Subclass may override and use its own layout, the layout must have a descendant with id browse_title_group that implements `TitleViewAdapter.Provider`. Subclass may return null if no title is needed.
`Unit`	`onPause()`
`Unit`	`onResume()`
`Unit`	`onSaveInstanceState(outState: Bundle!)`
`Unit`	`onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?)`
`Unit`	`setBadgeDrawable(drawable: Drawable!)` Sets the drawable displayed in the fragment title.
`Unit`	`setOnSearchClickedListener(listener: OnClickListener!)` Sets a click listener for the search affordance. The presence of a listener will change the visibility of the search affordance in the fragment title. When set to non-null, the title will contain an element that a user may click to begin a search. The listener's `onClick` method will be invoked when the user clicks on the search element.
`Unit`	`setSearchAffordanceColor(color: Int)` Sets the color used to draw the search affordance. A default brighter color will be set by the framework.
`Unit`	`setSearchAffordanceColors(colors: SearchOrbView.Colors!)` Sets the `androidx.leanback.widget.SearchOrbView.Colors` used to draw the search affordance.
`Unit`	`setTitle(title: CharSequence!)` Sets title text for the fragment.
`Unit`	`setTitleView(titleView: View!)` Sets the view that implemented `TitleViewAdapter`.
`Unit`	`showTitle(show: Boolean)` Shows or hides the title view.
`Unit`	`showTitle(flags: Int)` Changes title view's components visibility and shows title.

Public constructors

<init>

ErrorFragment()

Deprecated: use ErrorSupportFragment

A fragment for displaying an error indication.

Public methods

getBackgroundDrawable

open fun getBackgroundDrawable(): Drawable!

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

getButtonClickListener

open fun getButtonClickListener(): OnClickListener!

Returns the button click listener.

getButtonText

open fun getButtonText(): String!

Returns the button text.

getImageDrawable

open fun getImageDrawable(): Drawable!

Returns the drawable used for the error image.

getMessage

open fun getMessage(): CharSequence!

Returns the error message.

isBackgroundTranslucent

open fun isBackgroundTranslucent(): Boolean

Returns true if the background is translucent.

onCreateView

open fun onCreateView(
    inflater: LayoutInflater!, 
    container: ViewGroup!, 
    savedInstanceState: Bundle!
): View!

onStart

open fun onStart(): Unit

setBackgroundDrawable

open fun setBackgroundDrawable(drawable: Drawable!): Unit

Sets a drawable for the fragment background.

Parameters
`drawable`	Drawable!: The drawable used for the background.

setButtonClickListener

open fun setButtonClickListener(clickListener: OnClickListener!): Unit

Set the button click listener.

Parameters
`clickListener`	OnClickListener!: The click listener for the button.

setButtonText

open fun setButtonText(text: String!): Unit

Sets the button text.

Parameters
`text`	String!: The button text.

setDefaultBackground

open fun setDefaultBackground(translucent: Boolean): Unit

Sets the default background.

Parameters
`translucent`	Boolean: True to set a translucent background.

setImageDrawable

open fun setImageDrawable(drawable: Drawable!): Unit

Sets the drawable to be used for the error image.

Parameters
`drawable`	Drawable!: The drawable used for the error image.

setMessage

open fun setMessage(message: CharSequence!): Unit

Sets the error message.

Parameters
`message`	CharSequence!: The error message.