Key

open class Key

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

Constructors

Key

open fun Key(parent: Keyboard.Row)

Create an empty key with no attributes.

Key

open fun Key(res: Resources, parent: Keyboard.Row, x: Int, y: Int, parser: XmlResourceParser)

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

Functions

getCurrentDrawableState

open fun getCurrentDrawableState(): Array<Int>

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

isInside

open fun isInside(x: Int, y: Int): Boolean

Detects if a point falls inside this key.

onPressed

open fun onPressed()

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

onReleased

open fun onReleased(inside: Boolean)

Changes the pressed state of the key.

squaredDistanceFrom

open fun squaredDistanceFrom(x: Int, y: Int): Int

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

Properties

codes

open val codes: Array<Int>

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

edgeFlags

open val edgeFlags: Int

Flags that specify the anchoring to edges of the keyboard for detecting touch events that are just out of the boundary of the key.

gap

open val gap: Int

The horizontal gap before this key

height

open val height: Int

Height of the key, not including the gap

icon

open val icon: Drawable

Icon to display instead of a label.

iconPreview

open val iconPreview: Drawable

Preview version of the icon, for the preview popup

label

open val label: CharSequence

Label to display

modifier

open val modifier: Boolean

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

open val on: Boolean

If this is a sticky key, is it on?

popupCharacters

open val popupCharacters: CharSequence

Popup characters

popupResId

open val popupResId: Int

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

pressed

open val pressed: Boolean

The current pressed state of this key

repeatable

open val repeatable: Boolean

Whether this key repeats itself when held down

sticky

open val sticky: Boolean

Whether this key is sticky, i.e.

text

open val text: CharSequence

Text to output when pressed.

width

open val width: Int

Width of the key, not including the gap

open val x: Int

X coordinate of the key in the keyboard layout

open val y: Int

Y coordinate of the key in the keyboard layout