Keyboard

public class Keyboard
extends Object

This class was deprecated in API level 29.
This class is deprecated because this is just a convenient UI widget class that application developers can re-implement on top of existing public APIs. If you have already depended on this class, consider copying the implementation from AOSP into your project or re-implementing a similar widget by yourselves

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

XML attributes

android:horizontalGap

Default horizontal gap between keys.

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

Default height of a key, in pixels or percentage of display width.

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:keyWidth

Default width of a key, in pixels or percentage of display width.

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:verticalGap

Default vertical gap between rows of keys.

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.

Constants

public static final int EDGE_BOTTOM

public static final int EDGE_LEFT

public static final int EDGE_RIGHT

public static final int EDGE_TOP

public static final int KEYCODE_ALT

public static final int KEYCODE_CANCEL

public static final int KEYCODE_DELETE

public static final int KEYCODE_DONE

public static final int KEYCODE_MODE_CHANGE

public static final int KEYCODE_SHIFT

Public constructors

public Keyboard (Context context, 
                int xmlLayoutResId)

public Keyboard (Context context, 
                int xmlLayoutResId, 
                int modeId)

public Keyboard (Context context, 
                int xmlLayoutResId, 
                int modeId, 
                int width, 
                int height)

public Keyboard (Context context, 
                int layoutTemplateResId, 
                CharSequence characters, 
                int columns, 
                int horizontalPadding)

Public methods

public int getHeight ()

public List<Keyboard.Key> getKeys ()

public int getMinWidth ()

public List<Keyboard.Key> getModifierKeys ()

public int[] getNearestKeys (int x, 
                int y)

public int getShiftKeyIndex ()

public boolean isShifted ()

public boolean setShifted (boolean shiftState)

Protected methods

protected Keyboard.Key createKeyFromXml (Resources res, 
                Keyboard.Row parent, 
                int x, 
                int y, 
                XmlResourceParser parser)

protected Keyboard.Row createRowFromXml (Resources res, 
                XmlResourceParser parser)

protected int getHorizontalGap ()

protected int getKeyHeight ()

protected int getKeyWidth ()

protected int getVerticalGap ()

protected void setHorizontalGap (int gap)

protected void setKeyHeight (int height)

protected void setKeyWidth (int width)

protected void setVerticalGap (int gap)