LeanbackViewPager
class LeanbackViewPager : ViewPager
| kotlin.Any | ||||
| ↳ | android.view.View | |||
| ↳ | android.view.ViewGroup | |||
| ↳ | androidx.viewpager.widget.ViewPager | |||
| ↳ | androidx.leanback.tab.LeanbackViewPager |
A viewpager with touch and key event handling disabled by default.
Key events handling is disabled by default as with the behaviour of viewpager the fragments can change when DPAD keys are pressed and focus is on the content inside the ViewPager. This is not desirable for a top navigation bar. The fragments should preferably change only when the focused tab changes.
Summary
Public constructors |
|---|
LeanbackViewPager(context: Context)Constructs LeanbackViewPager |
LeanbackViewPager(context: Context, attrs: AttributeSet?)Constructs LeanbackViewPager |
Public functions |
|
|---|---|
Boolean |
executeKeyEvent(event: KeyEvent)You can call this function yourself to have the scroll view perform scrolling from a key event, just as if the event had been dispatched to it by the view hierarchy. |
Boolean |
onInterceptTouchEvent(event: MotionEvent) |
Boolean |
onTouchEvent(event: MotionEvent) |
Unit |
setKeyEventsEnabled(enableKeyEvent: Boolean)Setter for enabling/disabling key events |
Unit |
setTouchEnabled(enableTouch: Boolean)Setter for enabling/disabling touch events |
Inherited Constants |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Public constructors
LeanbackViewPager
LeanbackViewPager(context: Context)
Constructs LeanbackViewPager
| Parameters | |
|---|---|
context: Context |
LeanbackViewPager
LeanbackViewPager(context: Context, attrs: AttributeSet?)
Constructs LeanbackViewPager
| Parameters | |
|---|---|
context: Context |
|
attrs: AttributeSet? |
Public functions
executeKeyEvent
fun executeKeyEvent(event: KeyEvent): Boolean
You can call this function yourself to have the scroll view perform scrolling from a key event, just as if the event had been dispatched to it by the view hierarchy.
| Parameters | |
|---|---|
event: KeyEvent |
The key event to execute. |
| Returns | |
|---|---|
Boolean |
Return true if the event was handled, else false. |
setKeyEventsEnabled
fun setKeyEventsEnabled(enableKeyEvent: Boolean): Unit
Setter for enabling/disabling key events
| Parameters | |
|---|---|
enableKeyEvent: Boolean |
setTouchEnabled
fun setTouchEnabled(enableTouch: Boolean): Unit
Setter for enabling/disabling touch events
| Parameters | |
|---|---|
enableTouch: Boolean |