Keyboard.Key

public static class Keyboard.Key
extends Object

Class for describing the position and characteristics of a single key in the keyboard.

Summary

XML attributes

android:codes

The unicode value or comma-separated values that this key outputs.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

May be an integer value, such as "100".

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

The icon to show in the popup preview.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:isModifier

Whether this is a modifier key such as Alt or Shift.

May be a boolean value, such as "true" or "false".

android:isRepeatable

Whether long-pressing on this key will make it repeat.

May be a boolean value, such as "true" or "false".

android:isSticky

Whether this is a toggle key.

May be a boolean value, such as "true" or "false".

android:keyEdgeFlags

Key edge flags.

Must be one or more (separated by '|') of the following constant values.

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

The icon to display on the key instead of the label.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:keyLabel

The label to display on the key.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:keyOutputText

The string of characters to output when this key is pressed.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

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

The characters to display in the popup keyboard.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:popupKeyboard

The XML keyboard layout of any popup keyboard.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

Fields

public int[] codes

public int edgeFlags

public int gap

public int height

public Drawable icon

public Drawable iconPreview

public CharSequence label

public boolean modifier

public boolean on

public CharSequence popupCharacters

public int popupResId

public boolean pressed

public boolean repeatable

public boolean sticky

public CharSequence text

public int width

public int x

public int y

Public constructors

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

public Key (Keyboard.Row parent)

Public methods

public int[] getCurrentDrawableState ()

public boolean isInside (int x, 
                int y)

public void onPressed ()

public void onReleased (boolean inside)

public int squaredDistanceFrom (int x, 
                int y)