ImeKeyMonitor

Kotlin |Java

interface ImeKeyMonitor

androidx.leanback.widget.ImeKeyMonitor

Known Direct Subclasses

GuidedActionEditText

A custom EditText that satisfies the IME key monitoring requirements of GuidedStepFragment.

Interface for an EditText subclass that can delegate calls to onKeyPreIme up to a registered listener.

Used in editable actions within androidx.leanback.app.GuidedStepFragment to allow for custom back key handling. Specifically, this is used to implement the behavior that dismissing the IME also clears edit text focus. Clients who need to supply custom layouts for GuidedActionsStylist with their own EditText classes should satisfy this interface in order to inherit this behavior.

Summary

Nested classes
abstract	`ImeKeyListener` Listener interface for key events intercepted pre-IME by edit text objects.

Public methods
abstract Unit	`setImeKeyListener(listener: ImeKeyMonitor.ImeKeyListener!)` Set the listener for this edit text object.

Public methods

setImeKeyListener

abstract fun setImeKeyListener(listener: ImeKeyMonitor.ImeKeyListener!): Unit

Set the listener for this edit text object. The listener's onKeyPreIme method will be invoked from the host edit text's onKeyPreIme method.