kingkeyboard/com.king.keyboard/KingKeyboard

KingKeyboard

open class KingKeyboard : LifecycleEventObserver

KingKeyboard一个自定义键盘。内置了满足各种场景的键盘需求：包括但不限于混合、字母、数字、电话、身份证、车牌号等可 输入场景。还支持自定义。集成简单，键盘可定制化。

Author

Jenly

Follow me

Constructors

Link copied to clipboard
@JvmOverloads
constructor(dialog: Dialog, keyboardParentView: ViewGroup? = null)

构造

@JvmOverloads
constructor(activity: ComponentActivity, keyboardParentView: ViewGroup? = null)

构造

@JvmOverloads
constructor(window: Window, keyboardParentView: ViewGroup? = null)

构造

constructor(context: Context, rootView: ViewGroup, keyboardParentView: ViewGroup?)

构造

constructor(context: Context, rootView: ViewGroup, keyboardParentView: ViewGroup?, keyboardContainer: View, @IdRes keyboardViewId: Int)

构造

Types

Link copied to clipboard
object Companion
Link copied to clipboard
object KeyboardType

键盘类型

Link copied to clipboard
interface OnKeyListener

监听“完成”按键接口

Functions

Link copied to clipboard
fun getKeyboardType(): Int

获取当前键盘输入法类型 return 返回当前键盘输入法类型

Link copied to clipboard
fun getKeyboardView(): KingKeyboardView

对外提供获取KingKeyboardView

Link copied to clipboard
fun getKeyboardViewConfig(): KingKeyboardView.Config

对外提供获取KingKeyboardView的配置

Link copied to clipboard
open fun hide()

隐藏键盘输入法

Link copied to clipboard
fun isAddObserver(): Boolean

是否添加了观察； KingKeyboard已默认实现了LifecycleEventObserver，当通过ComponentActivity实例化KingKeyboard后，会默认由Lifecycle来管理KingKeyboard的生命周期。

Link copied to clipboard
fun isBringToFront(): Boolean

是否将键盘布局置于最顶层（通过改变 View 的 Z 轴层级 将键盘布局最后再添加）

Link copied to clipboard
fun isShow(): Boolean

键盘输入法是否显示

Link copied to clipboard
fun isVibrationEffectEnabled(): Boolean

是否开启震动

Link copied to clipboard
fun onDestroy()
Link copied to clipboard
fun onResume()
Link copied to clipboard
open override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event)
Link copied to clipboard
fun register(editText: EditText, keyboardType: Int)

注册

Link copied to clipboard
fun sendKey(primaryCode: Int)

根据 primaryCode 发送按键事件，可通过调用触发去执行按键值对应的功能（仅限功能键） 特别说明：之所以仅限功能键，是因为如果对外支持输入相关的按键值，会破坏输入内容的限制。

Link copied to clipboard
fun setAddObserver(addObserver: Boolean)

设置是否添加了观察； 添加观察后则意味着已通过Lifecycle管理来生命周期；主动调用 onResume 和 onDestroy 将不再起作用。

Link copied to clipboard
fun setBackground(drawable: Drawable?)

设置背景

Link copied to clipboard
fun setBackgroundResource(drawableId: Int)

设置背景

Link copied to clipboard
fun setBringToFront(bringToFront: Boolean)

设置是否将键盘布局置于最顶层（通过改变 View 的 Z 轴层级 将键盘布局最后再添加）

Link copied to clipboard
fun setKeyboardCustom(keyboard: Keyboard)
fun setKeyboardCustom(@XmlRes xmlLayoutResId: Int)

自定义键盘Custom，键盘类型为{@link KeyboardType#CUSTOM}

Link copied to clipboard
fun setKeyboardCustomModeChange(keyboard: Keyboard)
fun setKeyboardCustomModeChange(@XmlRes xmlLayoutResId: Int)

自定义键盘CustomModeChange，键盘类型为{@link KeyboardType#CUSTOM_MODE_CHANGE}

Link copied to clipboard
fun setKeyboardCustomMore(keyboard: Keyboard)
fun setKeyboardCustomMore(@XmlRes xmlLayoutResId: Int)

自定义键盘CustomMore，键盘类型为{@link KeyboardType#CUSTOM_MORE}

Link copied to clipboard
fun setKeyboardViewConfig(config: KingKeyboardView.Config)

对外提供设置KingKeyboardView的配置

Link copied to clipboard
fun setOnKeyboardActionListener(listener: KeyboardView.OnKeyboardActionListener?)

对外提供监听键盘相关动作

Link copied to clipboard
fun setOnKeyCancelListener(listener: KingKeyboard.OnKeyListener?)

对外提供监听“关闭键盘”按键

Link copied to clipboard
fun setOnKeyDoneListener(listener: KingKeyboard.OnKeyListener?)

对外提供监听“完成”按键

Link copied to clipboard
fun setOnKeyExtraListener(listener: KingKeyboard.OnKeyListener?)

对外提供监听扩展自定义的按键

Link copied to clipboard
fun setVibrationEffectEnabled(vibrationEffectEnabled: Boolean)

设置是否开启震动

Link copied to clipboard
fun unregister(editText: EditText)

取消注册