SearchOrbView
class SearchOrbView : FrameLayout, View.OnClickListener
| kotlin.Any | ||||
| ↳ | android.view.View | |||
| ↳ | android.view.ViewGroup | |||
| ↳ | android.widget.FrameLayout | |||
| ↳ | androidx.leanback.widget.SearchOrbView |
SpeechOrbView |
A subclass of |
A widget that draws a search affordance, represented by a round background and an icon.
The background color and icon can be customized.Summary
Nested types |
|---|
class SearchOrbView.ColorsA set of colors used to display the search orb. |
Public constructors |
|---|
SearchOrbView(context: Context) |
SearchOrbView(context: Context, attrs: AttributeSet?) |
SearchOrbView(context: Context, attrs: AttributeSet?, defStyleAttr: Int) |
Public functions |
|
|---|---|
Unit |
enableOrbColorAnimation(enable: Boolean)Enables or disables the orb color animation. |
@ColorInt Int |
Returns the orb color |
SearchOrbView.Colors? |
Returns the |
Drawable? |
Returns the orb icon |
Unit |
|
Unit |
setOnOrbClickedListener(listener: View.OnClickListener?)Sets the on click listener for the orb. |
Unit |
setOrbColor(color: Int)Sets the background color of the search orb. |
Unit |
This function is deprecated. Use |
Unit |
setOrbColors(colors: SearchOrbView.Colors)Sets the |
Unit |
setOrbIcon(icon: Drawable)Sets the orb icon. |
Protected functions |
|
|---|---|
Unit |
|
Unit |
|
Unit |
onFocusChanged( |
Inherited Constants |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Public constructors
SearchOrbView
SearchOrbView(context: Context, attrs: AttributeSet?, defStyleAttr: Int)
Public functions
enableOrbColorAnimation
fun enableOrbColorAnimation(enable: Boolean): Unit
Enables or disables the orb color animation.
Orb color animation is handled automatically when the orb is focused/unfocused, however, an app may choose to override the current animation state, for example when an activity is paused.
getOrbColors
fun getOrbColors(): SearchOrbView.Colors?
Returns the Colors used to display the search orb.
getOrbIcon
fun getOrbIcon(): Drawable?
Returns the orb icon
| Returns | |
|---|---|
Drawable? |
the drawable used as the icon |
setOnOrbClickedListener
fun setOnOrbClickedListener(listener: View.OnClickListener?): Unit
Sets the on click listener for the orb.
| Parameters | |
|---|---|
listener: View.OnClickListener? |
The listener. |
setOrbColor
fun setOrbColor(color: Int): Unit
Sets the background color of the search orb. Other colors will be provided by the framework.
| Parameters | |
|---|---|
color: Int |
the RGBA color |
funsetOrbColor(color: @ColorInt Int, brightColor: @ColorInt Int): Unit
Sets the search orb colors. Other colors are provided by the framework.
setOrbColors
fun setOrbColors(colors: SearchOrbView.Colors): Unit
Sets the Colors used to display the search orb.
setOrbIcon
fun setOrbIcon(icon: Drawable): Unit
Sets the orb icon.
| Parameters | |
|---|---|
icon: Drawable |
the drawable to be used as the icon |
Protected functions
onFocusChanged
protected fun onFocusChanged(
gainFocus: Boolean,
direction: Int,
previouslyFocusedRect: Rect?
): Unit