ImeKeyMonitor

interface ImeKeyMonitor

Known direct subclasses
GuidedActionAppCompatEditText

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

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 types

Listener interface for key events intercepted pre-IME by edit text objects.

Public functions

Unit

Set the listener for this edit text object.

Public functions

setImeKeyListener

Added in 1.1.0
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.