Timob 10232: Android: Capturing onKeyPress from the hardware keyboard

android/titanium/src/java/org/appcelerator/titanium/TiC.java

@@ -138,6 +138,10 @@ public class TiC
 	 */
 	public static final String EVENT_FOCUSED = "focused";
 
+	/**
+	 * @module.api
+	 */
+	public static final String EVENT_KEY_PRESSED = "keypressed";
 	/**
 	 * @module.api
 	 */
@@ -248,6 +252,11 @@ public class TiC
 	 */
 	public static final String EVENT_PROPERTY_IS_USER_GESTURE = "isUserGesture";
 
+	/**
+	 * @module.api
+	 */
+	public static final String EVENT_PROPERTY_KEYCODE = "keyCode";
+
 	/**
 	 * @module.api
 	 */

android/titanium/src/java/org/appcelerator/titanium/proxy/TiViewProxy.java

@@ -434,6 +434,7 @@ protected TiUIView handleGetView()
 			}
 			realizeViews(view);
 			view.registerForTouch();
+			view.registerForKeyPress();
 		}
 		return view;
 	}

android/titanium/src/java/org/appcelerator/titanium/view/TiUIView.java

@@ -517,13 +517,9 @@ public void propertyChanged(String key, Object oldValue, Object newValue, KrollP
 				setzIndexChanged(true);
 			}
 		} else if (key.equals(TiC.PROPERTY_FOCUSABLE)) {
-			boolean focusable = TiConvert.toBoolean(proxy.getProperty(TiC.PROPERTY_FOCUSABLE));
-			nativeView.setFocusable(focusable);
-			if (focusable) {
-				registerForKeyClick(nativeView);
-			} else {
-				//nativeView.setOnClickListener(null); // ? mistake? I assume OnKeyListener was meant
-				nativeView.setOnKeyListener(null);
+			if (newValue != null) {
+				boolean focusable = TiConvert.toBoolean(newValue);
+				registerForKeyPress(nativeView, focusable);
 			}
 		} else if (key.equals(TiC.PROPERTY_TOUCH_ENABLED)) {
 			doSetClickable(TiConvert.toBoolean(newValue));
@@ -696,17 +692,6 @@ public void processProperties(KrollDict d)
 			nativeView.setEnabled(TiConvert.toBoolean(d, TiC.PROPERTY_ENABLED));
 		}
 
-		if (d.containsKey(TiC.PROPERTY_FOCUSABLE) && !nativeViewNull) {
-			boolean focusable = TiConvert.toBoolean(d, TiC.PROPERTY_FOCUSABLE);
-			nativeView.setFocusable(focusable);
-			if (focusable) {
-				registerForKeyClick(nativeView);
-			} else {
-				//nativeView.setOnClickListener(null); // ? mistake? I assume OnKeyListener was meant
-				nativeView.setOnKeyListener(null);
-			}
-		}
-
 		initializeBorder(d, bgColor);
 
 		if (d.containsKey(TiC.PROPERTY_OPACITY) && !nativeViewNull) {
@@ -1041,6 +1026,11 @@ protected boolean allowRegisterForTouch()
 		return true;
 	}
 
+	protected boolean allowRegisterForKeyPress()
+	{
+		return true;
+	}
+
 	public View getOuterView()
 	{
 		if (borderView == null) {
@@ -1218,6 +1208,7 @@ public boolean onTouch(View view, MotionEvent event)
 		});
 
 	}
+
 	protected void registerForTouch(final View touchable)
 	{
 		if (touchable == null) {
@@ -1238,6 +1229,80 @@ protected void registerForTouch(final View touchable)
 		doSetClickable(touchable);
 	}
 
+
+	public void registerForKeyPress()
+	{
+		if (allowRegisterForKeyPress()) {
+			registerForKeyPress(getNativeView());
+		}
+	}
+
+	protected void registerForKeyPress(final View v)
+	{
+		if (v == null) {
+			return;
+		}
+
+		boolean focusable = false;
+		Object prop = proxy.getProperty(TiC.PROPERTY_FOCUSABLE);
+		if (prop != null) {
+			focusable = TiConvert.toBoolean(prop);
+		}
+		registerForKeyPress(v, focusable);
+	}
+
+	protected void registerForKeyPress(final View v, boolean focusable)
+	{
+		if (v == null) {
+			return;
+		}
+
+		v.setFocusable(focusable);
+
+		// The listener for the "keypressed" event is only triggered when the view has focus. So we only register the
+		// "keypressed" event when the view is focusable.
+		if (focusable) {
+			registerForKeyPressEvents(v);
+		} else {
+			v.setOnKeyListener(null);
+		}
+	}
+
+	/**
+	 * Registers a callback to be invoked when a hardware key is pressed in this view.
+	 *
+	 * @param v The view to have the key listener to attach to.
+	 */
+	protected void registerForKeyPressEvents(final View v)
+	{
+		if (v == null) {
+			return;
+		}
+
+		v.setOnKeyListener(new OnKeyListener()
+		{
+			public boolean onKey(View view, int keyCode, KeyEvent event)
+			{
+				if (event.getAction() == KeyEvent.ACTION_UP) {
+					KrollDict data = new KrollDict();
+					data.put(TiC.EVENT_PROPERTY_KEYCODE, keyCode);
+					proxy.fireEvent(TiC.EVENT_KEY_PRESSED, data);
+
+					switch (keyCode) {
+						case KeyEvent.KEYCODE_ENTER:
+						case KeyEvent.KEYCODE_DPAD_CENTER:
+							if (proxy.hasListeners(TiC.EVENT_CLICK)) {
+								proxy.fireEvent(TiC.EVENT_CLICK, null);
+							}
+					}
+					return true;
+				}
+				return false;
+			}
+		});
+	}
+
+
 	/**
 	 * Sets the nativeView's opacity.
 	 * @param opacity the opacity to set.

apidoc/Titanium/UI/View.yml

@@ -224,6 +224,18 @@ events:
         summary: Y coordinate of the event from the `source` view's coordinate system.
         type: Number
 
+  - name: keypressed
+    summary: Fired when a hardware key is pressed in the view.
+    description: |
+        A keypressed event is generated by pressing a hardware key. On Android, this event can only be
+        fired when the property [focusable](Titanium.UI.View.focusable) is set to true.
+    platforms: [android]
+    since: {android: 3.0.0}
+    properties:
+      - name: keyCode
+        type: Number
+        summary: The code for the physical key that was pressed. For more details see [KeyEvent](http://developer.android.com/reference/android/view/KeyEvent.html).
+
   - name: longclick
     summary: Fired when the device detects a long click.
     description: |