# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: XML Attrs | Fields | Ctors | Methods | Inherited Methods

# Keyboard.Key

`public static class Keyboard.Key`
`extends Object` ``

java.lang.Object
↳ | android.inputmethodservice.Keyboard.Key

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.
`android:horizontalGap` | Default horizontal gap between keys.
`android:iconPreview` | The icon to show in the popup preview.
`android:isModifier` | Whether this is a modifier key such as Alt or Shift.
`android:isRepeatable` | Whether long-pressing on this key will make it repeat.
`android:isSticky` | Whether this is a toggle key.
`android:keyEdgeFlags` | Key edge flags.
`android:keyHeight` | Default height of a key, in pixels or percentage of display width.
`android:keyIcon` | The icon to display on the key instead of the label.
`android:keyLabel` | The label to display on the key.
`android:keyOutputText` | The string of characters to output when this key is pressed.
`android:keyWidth` | Default width of a key, in pixels or percentage of display width.
`android:popupCharacters` | The characters to display in the popup keyboard.
`android:popupKeyboard` | The XML keyboard layout of any popup keyboard.

### Fields
`public int[]` | `codes` All the key codes (unicode or custom code) that this key could generate, zero'th being the most important.
`public int` | `edgeFlags` Flags that specify the anchoring to edges of the keyboard for detecting touch events that are just out of the boundary of the key.
`public int` | `gap` The horizontal gap before this key
`public int` | `height` Height of the key, not including the gap
`public Drawable` | `icon` Icon to display instead of a label.
`public Drawable` | `iconPreview` Preview version of the icon, for the preview popup
`public CharSequence` | `label` Label to display
`public boolean` | `modifier` Whether this is a modifier key, such as Shift or Alt
`public boolean` | `on` If this is a sticky key, is it on?
`public CharSequence` | `popupCharacters` Popup characters
`public int` | `popupResId` If this key pops up a mini keyboard, this is the resource id for the XML layout for that keyboard.
`public boolean` | `pressed` The current pressed state of this key
`public boolean` | `repeatable` Whether this key repeats itself when held down
`public boolean` | `sticky` Whether this key is sticky, i.e., a toggle key
`public CharSequence` | `text` Text to output when pressed.
`public int` | `width` Width of the key, not including the gap
`public int` | `x` X coordinate of the key in the keyboard layout
`public int` | `y` Y coordinate of the key in the keyboard layout

### Public constructors
`Key(Keyboard.Row parent)` Create an empty key with no attributes.
`Key(Resources res, Keyboard.Row parent, int x, int y, XmlResourceParser parser)` Create a key with the given top-left coordinate and extract its attributes from the XML parser.

### Public methods
`int[]` | `getCurrentDrawableState()` Returns the drawable state for the key, based on the current state and type of the key.
`boolean` | `isInside(int x, int y)` Detects if a point falls inside this key.
`void` | `onPressed()` Informs the key that it has been pressed, in case it needs to change its appearance or state.
`void` | `onReleased(boolean inside)` Changes the pressed state of the key.
`int` | `squaredDistanceFrom(int x, int y)` Returns the square of the distance between the center of the key and the given point.

### Inherited methods
From class `java.lang.Object`
`Object` | `clone()` Creates and returns a copy of this object.
`boolean` | `equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void` | `finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>` | `getClass()` Returns the runtime class of this `Object`.
`int` | `hashCode()` Returns a hash code value for the object.
`final void` | `notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void` | `notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String` | `toString()` Returns a string representation of the object.
`final void` | `wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

## 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.

Constant | Value | Description
--- | --- | ---
left | 1 | Key is anchored to the left of the keyboard.
right | 2 | Key is anchored to the right of the keyboard.

### 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

### codes

    public int[] codes

All the key codes (unicode or custom code) that this key could generate, zero'th being the most important.

### edgeFlags

    public int edgeFlags

Flags that specify the anchoring to edges of the keyboard for detecting touch events that are just out of the boundary of the key. This is a bit mask of `Keyboard#EDGE_LEFT`, `Keyboard#EDGE_RIGHT`, `Keyboard#EDGE_TOP` and `Keyboard#EDGE_BOTTOM`.

### gap

    public int gap

The horizontal gap before this key

### height

    public int height

Height of the key, not including the gap

### icon

    public Drawable icon

Icon to display instead of a label. Icon takes precedence over a label

### iconPreview

    public Drawable iconPreview

Preview version of the icon, for the preview popup

### label

    public CharSequence label

Label to display

### modifier

    public boolean modifier

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

### on

    public boolean on

If this is a sticky key, is it on?

### popupCharacters

    public CharSequence popupCharacters

Popup characters

### popupResId

    public int popupResId

If this key pops up a mini keyboard, this is the resource id for the XML layout for that keyboard.

### pressed

    public boolean pressed

The current pressed state of this key

### repeatable

    public boolean repeatable

Whether this key repeats itself when held down

### sticky

    public boolean sticky

Whether this key is sticky, i.e., a toggle key

### text

    public CharSequence text

Text to output when pressed. This can be multiple characters, like ".com"

### width

    public int width

Width of the key, not including the gap

### x

    public int x

X coordinate of the key in the keyboard layout

### y

    public int y

Y coordinate of the key in the keyboard layout

## Public constructors

### Key

    public Key (Keyboard.Row parent)

Create an empty key with no attributes.

Parameters
`parent` | `Keyboard.Row`

### Key

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

Create a key with the given top-left coordinate and extract its attributes from the XML parser.

Parameters
`res` | `Resources`: resources associated with the caller's context
`parent` | `Keyboard.Row`: the row that this key belongs to. The row must already be attached to a `Keyboard`.
`x` | `int`: the x coordinate of the top-left
`y` | `int`: the y coordinate of the top-left
`parser` | `XmlResourceParser`: the XML parser containing the attributes for this key

## Public methods

### getCurrentDrawableState

    public int[] getCurrentDrawableState ()

Returns the drawable state for the key, based on the current state and type of the key.

Returns
`int[]` | the drawable state of the key.

See also:

- `Drawable.setState(int[])`

### isInside

    public boolean isInside (int x,
                    int y)

Detects if a point falls inside this key.

Parameters
`x` | `int`: the x-coordinate of the point
`y` | `int`: the y-coordinate of the point

Returns
`boolean` | whether or not the point falls inside the key. If the key is attached to an edge, it will assume that all points between the key and the edge are considered to be inside the key.

### onPressed

    public void onPressed ()

Informs the key that it has been pressed, in case it needs to change its appearance or state.

See also:

- `onReleased(boolean)`

### onReleased

    public void onReleased (boolean inside)

Changes the pressed state of the key.

Toggled state of the key will be flipped when all the following conditions are fulfilled:

- This is a sticky key, that is, `sticky` is `true`.
- The parameter `inside` is `true`.
- `Build.VERSION.SDK_INT` is greater than `Build.VERSION_CODES.LOLLIPOP_MR1`.

Parameters
`inside` | `boolean`: whether the finger was released inside the key. Works only on Android M and later. See the method document for details.

See also:

- `onPressed()`

### squaredDistanceFrom

    public int squaredDistanceFrom (int x,
                    int y)

Returns the square of the distance between the center of the key and the given point.

Parameters
`x` | `int`: the x-coordinate of the point
`y` | `int`: the y-coordinate of the point

Returns
`int` | the square of the distance of the point from the center of the key

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*