Added in API level 3
Deprecated in API level 29

Keyboard

Kotlin |Java

open class Keyboard

kotlin.Any
↳	android.inputmethodservice.Keyboard

Loads an XML description of a keyboard and stores the attributes of the keys. A keyboard consists of rows of keys.

The layout file for a keyboard contains XML that looks like the following snippet:

<Keyboard
          android:keyWidth="%10p"
          android:keyHeight="50px"
          android:horizontalGap="2px"
          android:verticalGap="2px" >
      <Row android:keyWidth="32px" >
          <Key android:keyLabel="A" />
          ...
      </Row>
      ...
  </Keyboard>

Summary

Nested classes
open	`Key` Class for describing the position and characteristics of a single key in the keyboard.
open	`Row` Container for keys in the keyboard.

XML attributes
`android:horizontalGap`	Default horizontal gap between keys.
`android:keyHeight`	Default height of a key, in pixels or percentage of display width.
`android:keyWidth`	Default width of a key, in pixels or percentage of display width.
`android:verticalGap`	Default vertical gap between rows of keys.

Constants
static Int	`EDGE_BOTTOM`
static Int	`EDGE_LEFT`
static Int	`EDGE_RIGHT`
static Int	`EDGE_TOP`
static Int	`KEYCODE_ALT`
static Int	`KEYCODE_CANCEL`
static Int	`KEYCODE_DELETE`
static Int	`KEYCODE_DONE`
static Int	`KEYCODE_MODE_CHANGE`
static Int	`KEYCODE_SHIFT`

Public constructors
`Keyboard(context: Context!, xmlLayoutResId: Int)` Creates a keyboard from the given xml key layout file.
`Keyboard(context: Context!, xmlLayoutResId: Int, modeId: Int)` Creates a keyboard from the given xml key layout file.
`Keyboard(context: Context!, xmlLayoutResId: Int, modeId: Int, width: Int, height: Int)` Creates a keyboard from the given xml key layout file.
`Keyboard(context: Context!, layoutTemplateResId: Int, characters: CharSequence!, columns: Int, horizontalPadding: Int)` Creates a blank keyboard from the given resource file and populates it with the specified characters in left-to-right, top-to-bottom fashion, using the specified number of columns.

Public methods
open Int	`getHeight()` Returns the total height of the keyboard
open MutableList<Keyboard.Key!>!	`getKeys()`
open Int	`getMinWidth()`
open MutableList<Keyboard.Key!>!	`getModifierKeys()`
open IntArray!	`getNearestKeys(x: Int, y: Int)` Returns the indices of the keys that are closest to the given point.
open Int	`getShiftKeyIndex()`
open Boolean	`isShifted()`
open Boolean	`setShifted(shiftState: Boolean)`

Protected methods
open Keyboard.Key!	`createKeyFromXml(res: Resources!, parent: Keyboard.Row!, x: Int, y: Int, parser: XmlResourceParser!)`
open Keyboard.Row!	`createRowFromXml(res: Resources!, parser: XmlResourceParser!)`
open Int	`getHorizontalGap()`
open Int	`getKeyHeight()`
open Int	`getKeyWidth()`
open Int	`getVerticalGap()`
open Unit	`setHorizontalGap(gap: Int)`
open Unit	`setKeyHeight(height: Int)`
open Unit	`setKeyWidth(width: Int)`
open Unit	`setVerticalGap(gap: Int)`

XML attributes

android:horizontalGap

android:horizontalGap

Default horizontal gap between keys. {@deprecated Copy this definition into your own application project.}

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

May be a fractional value, which is a floating point number appended with either % or %p, such as "14.5%". The % suffix always means a percentage of the base size; the optional %p suffix provides a size relative to some parent container.

android:keyHeight

android:keyHeight

Default height of a key, in pixels or percentage of display width. {@deprecated Copy this definition into your own application project.}

android:keyWidth

android:keyWidth

Default width of a key, in pixels or percentage of display width. {@deprecated Copy this definition into your own application project.}

android:verticalGap

android:verticalGap

Default vertical gap between rows of keys. {@deprecated Copy this definition into your own application project.}

Parameters
`context`	Context!: the application or service context
`xmlLayoutResId`	Int: the resource file that contains the keyboard layout and keys.

Parameters
`context`	Context!: the application or service context
`layoutTemplateResId`	Int: the layout template file, containing no keys.
`characters`	CharSequence!: the list of characters to display on the keyboard. One key will be created for each character.
`columns`	Int: the number of columns of keys to display. If this number is greater than the number of keys that can fit in a row, it will be ignored. If this number is -1, the keyboard will fit as many keys as possible in each row.

Parameters
`x`	Int: the x-coordinate of the point
`y`	Int: the y-coordinate of the point

Keyboard

Summary

XML attributes

android:horizontalGap

android:keyHeight

android:keyWidth

android:verticalGap

Constants

EDGE_BOTTOM

EDGE_LEFT

EDGE_RIGHT

EDGE_TOP

KEYCODE_ALT

KEYCODE_CANCEL

KEYCODE_DELETE

KEYCODE_DONE

KEYCODE_MODE_CHANGE

KEYCODE_SHIFT

Public constructors

Keyboard

Keyboard

Keyboard

Keyboard

Public methods

getHeight

getKeys

getMinWidth

getModifierKeys

getNearestKeys

getShiftKeyIndex

isShifted

setShifted

Protected methods

createKeyFromXml

createRowFromXml

getHorizontalGap

getKeyHeight

getKeyWidth

getVerticalGap

setHorizontalGap

setKeyHeight

setKeyWidth

setVerticalGap