feat(android): Pass longpress delay to KeymanWeb #12185

darcywong00 · 2024-08-14T11:55:08Z

Follows #12170 and fixes #877

This adds KMManager APIs to get/set the longpress duration between 300 ms and 1500 ms. Default KeymanWeb longpress delay is 500ms.

Since the keyboard needs to be loaded for the setting to take effect, I put the initialization in MainActivity.onKeyboardLoaded

User Testing

Setup - Install the PR build of Keyman for Android on a device/emulator
Note: the reported issue on flick gestures is handled on a separate PR #12187

TEST_LONGPRESS - Verifies longpress delay changes with the menu

Launch Keyman for Android and dismiss the "Get Started" menu
On the default SIL EuroLatin keyboard, longpress a key and observe the long press delay
Verify long press appears after about 0.5 seconds.
From Keyman Settings --> Adjust longpress delay
From the "Adjust longpress delay" menu, increase the delay to 1.5 seconds and exit the menu
On the Keyman keyboard, longpress a key and observe the long press delay
Verify long press appears after about 1.5 seconds.
From Keyman Settings --> Adjust longpress delay
From the "Adjust longpress delay" menu, decrease the delay to 0.3 seconds and exit the menu
On the Keyman keyboard, longpress a key and observe the long press delay
Verify long press appears after about 0.3 seconds

keymanapp-test-bot · 2024-08-14T11:55:14Z

User Test Results

Test specification and instructions

✅ TEST_LONGPRESS (PASSED) (notes)

Test Artifacts

Android

dinakaranr · 2024-08-14T14:39:03Z

Test Results

I tested this issue with the attached "Keyman 18.0.89-alpha-test-12185" build on the Android 14 physical device and Android 9(emulator) Here is my observation.

TEST_LONGPRESS (failed):

Installed the "Keyman-18.0.89.apk" file and gave all permissions to the application.
Checked the "Enable Keyman as system-wide keyboard" and set the keyboard as the default keyboard box on the settings page.
Selected the "SIL EuroLatin" default keyboard.
Open the Keyman app. Enable the "Predictions" to install the "Dictionary."
Added a sentence to the notepad and Chrome (search).
"Adjust long-press delay" appears under the settings.
Changed the delay as 03s or 1.5s
Press the key and then the sub-menu appears based on the delay set in the "Adjust long-press delay"
The delay works after pressing the keys.
Press the "q,w,e,r,t" key and pull down to select the number. here, The number does not appear after the pull-down. Hence, unable to select the numbers & special characters by pressing the key and pull down. So, I failed this test case. Thank you.
Please refer to the attached video below.
https://github.com/user-attachments/assets/5b4694d9-134e-409d-9f63-d47389b093b3
Thanks.

darcywong00 · 2024-08-15T00:42:24Z

@jahorton - Dina and I have seen changing the longpress delay from the default 0.5 seconds to 0.3 seconds seems to prevent the flick down gesture from activating. Is this a side effect in KeymanWeb?

From my testing, immediately trying to flick down is triggering a longpress from the row below (e.g. flick down from f is triggering longpresses on the c key)

When I set longpress delay to 0.7 seconds, flick gestures are still disabled. Gonna retest on master...

darcywong00 · 2024-08-15T01:06:38Z

... so I can't get the down flick gestures to work on master branch either. Maybe a side effect from #12176?

jahorton · 2024-08-15T02:16:38Z

... so I can't get the down flick gestures to work on master branch either. Maybe a side effect from #12176?

That it was. See #12187, which will fix it.

darcywong00 · 2024-08-15T03:30:50Z

While I started to update the KMManager API on help.keyman.com, I realized I needed to do a slight refactor to separate setLongpressDelay (store the new preference, then calls applyLongpressDelay) and applyLongpressDelay (sends the updated value to KeymanWeb)

The flick issue will resolve after merging #12187
@keymanapp-test-bot retest

Added some refactoring

mcdurdin · 2024-08-15T05:46:55Z

While I started to update the KMManager API on help.keyman.com, I realized I needed to do a slight refactor to separate setLongpressDelay (store the new preference, then calls applyLongpressDelay) and applyLongpressDelay (sends the updated value to KeymanWeb)

That was going to be my first comment on the PR 😁 -

mcdurdin

Basically LGTM, just want to move ownership of the longpressDelay value entirely into KMManager.

mcdurdin · 2024-08-14T12:05:39Z

android/KMAPro/kMAPro/src/main/java/com/keyman/android/SystemKeyboard.java

+    int longpressDelay = KMManager.getLongpressDelay(this);
+    KMManager.setLongpressDelay(longpressDelay);


This is a bit of an anti-pattern. We shouldn't be reading from KMManager's longPressDelay property and then writing back to it -- that looks like a no-op. Instead if we need to tell it to refresh we should be doing that with something like KMManager.sendLongpressDelay() (or perhaps better, KMManager.sendOptionsToKeyboard())

mcdurdin · 2024-08-15T08:12:23Z

android/KMAPro/kMAPro/src/main/java/com/keyman/android/SystemKeyboard.java

+    // Initialize the longpress delay
+    int longpressDelay = KMManager.getLongpressDelay();
+    KMManager.applyLongpressDelay(longpressDelay);


I am not very comfortable with this. KMManager should be able to manage the value internally, and we shouldn't be passing the value back and forth. If we need to ask KMManager to re-apply the longpressDelay that it already knows, it should be just something like:

Suggested change

// Initialize the longpress delay

int longpressDelay = KMManager.getLongpressDelay();

KMManager.applyLongpressDelay(longpressDelay);

KMManager.applyLongpressDelay();

mcdurdin · 2024-08-15T08:13:23Z

android/KMAPro/kMAPro/src/main/java/com/tavultesoft/kmapro/MainActivity.java

@@ -472,7 +472,7 @@ public boolean onKeyUp(int keycode, KeyEvent e) {

  @Override
  public void onKeyboardLoaded(KeyboardType keyboardType) {
-    // Do nothing
+    checkLongpressDelay();


Suggested change

checkLongpressDelay();

KMManager.applyLongpressDelay();

mcdurdin · 2024-08-15T08:14:06Z

android/KMAPro/kMAPro/src/main/java/com/tavultesoft/kmapro/MainActivity.java

+  private void checkLongpressDelay() {
+    // Initialize the longpress delay
+    int longpressDelay = KMManager.getLongpressDelay();
+    KMManager.applyLongpressDelay(longpressDelay);
+  }
+


Suggested change

private void checkLongpressDelay() {

// Initialize the longpress delay

int longpressDelay = KMManager.getLongpressDelay();

KMManager.applyLongpressDelay(longpressDelay);

}

This should not be needed if KMManager.applyLongpressDelay() does the work

mcdurdin · 2024-08-15T08:14:36Z

android/KMEA/app/src/main/assets/android-host.js

+  if (keyman.osk) {
+    keyman.osk.gestureParams.longpress.waitLength = delay;
+    console.debug('setLongpressDelay('+delay+')');
+  }


If keyman.osk is not assigned, we may need to log that?

mcdurdin · 2024-08-15T08:15:10Z

android/KMEA/app/src/main/java/com/keyman/engine/KMManager.java

   */
-  public static void setLongpressDelay(int longpressDelay) {
+  public static void applyLongpressDelay(int longpressDelay) {


Suggested change

public static void applyLongpressDelay(int longpressDelay) {

public static void applyLongpressDelay() {

int longpressDelay = getLongpressDelay();

mcdurdin · 2024-08-15T08:15:23Z

android/KMEA/app/src/main/java/com/keyman/engine/KMManager.java

+    editor.putInt(KMKey_LongpressDelay, longpressDelay);
+    editor.commit();
+
+    applyLongpressDelay(longpressDelay);


Suggested change

applyLongpressDelay(longpressDelay);

applyLongpressDelay();

dinakaranr · 2024-08-16T07:46:47Z

Test Results

TEST_LONGPRESS (Passed):
I tested this issue with the attached "Keyman 18.0.89-alpha-test-12185" build on the Android 14 physical device and Android 12(emulator) Here is my observation.

Installed the "Keyman-18.0.89.apk" file and gave all permissions to the application.
Checked the "Enable Keyman as system-wide keyboard" and set the keyboard as the default keyboard box on the settings page.
Selected the "SIL EuroLatin" default keyboard.
Open the Keyman app. Enable the "Predictions" to install the "Dictionary."
Added a sentence to the notepad and Chrome (search).
"Adjust long-press delay" appears under the settings.
Changed the delay as 03s or 1.5s
Press the key and then the sub-menu appears based on the delay set in the "Adjust long-press delay". The delay works after pressing the keys.
I have tested the PR 12187. The gesture works well when pressing & pulling down the key. I can select the numeric and special characters. It works when handing the multiple fingers.
Hence, I resolved this task too. Thank you.

dinakaranr · 2024-08-19T14:08:58Z

Test Results

TEST_LONGPRESS (passed):
I retested this issue with the attached "Keyman 18.0.92-alpha-test-12185" build on the Android 14 physical device and Android 12(emulator) Here is my observation.

Installed the "Keyman-18.0.92.apk" file and gave all permissions to the application.
Checked the "Enable Keyman as system-wide keyboard" and set the keyboard as the default keyboard box on the settings page.
Selected the "SIL EuroLatin" default keyboard.
Open the Keyman app. Enable the "Predictions" to install the "Dictionary."
Added a sentence to the notepad and Chrome (editpad.org).
Press the key and then the sub-menu appears based on the delay that is set in the "Adjust long-press delay".
The delay works after pressing the keys.
I can select the numeric and special characters. It works when handing the multiple fingers. Hence, I resolved this task. Thank you.

…ea-set-longpress-delay

keyman-server · 2024-08-20T18:02:48Z

Changes in this pull request will be available for download in Keyman version 18.0.93-alpha

fix(android): Pass longpress delay to KeymanWeb

d728b33

darcywong00 requested a review from sgschantz as a code owner August 14, 2024 11:55

keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed labels Aug 14, 2024

keymanapp-test-bot bot added this to the A18S8 milestone Aug 14, 2024

github-actions bot added android/ android/engine/ android/app/ feat labels Aug 14, 2024

keymanapp-test-bot bot added user-test-failed and removed user-test-required User tests have not been completed labels Aug 14, 2024

jahorton previously approved these changes Aug 15, 2024

View reviewed changes

keymanapp-test-bot bot added the user-test-required User tests have not been completed label Aug 15, 2024

darcywong00 marked this pull request as draft August 15, 2024 03:30

keymanapp-test-bot bot removed the user-test-failed label Aug 15, 2024

refactor(android): Split setLongpressDelay and applyLongpressDelay

9c9d10d

darcywong00 mentioned this pull request Aug 15, 2024

bug(web): Console errors on Android API 21 #12189

Closed

darcywong00 marked this pull request as ready for review August 15, 2024 06:27

jahorton approved these changes Aug 15, 2024

View reviewed changes

mcdurdin requested changes Aug 15, 2024

View reviewed changes

darcywong00 linked an issue Aug 16, 2024 that may be closed by this pull request

feat(android/app): Feature Request: customize long-press delay time #877

Closed

keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Aug 19, 2024

Merge branch 'feat/android/longpress-delay-menu' into feat/android/km…

6a831ef

…ea-set-longpress-delay

github-actions bot added common/ common/web/ developer/ developer/compilers/ developer/ide/ docs linux/ web/ and removed web/ developer/ linux/ common/ developer/compilers/ common/web/ developer/ide/ docs labels Aug 19, 2024

mcdurdin approved these changes Aug 20, 2024

View reviewed changes

darcywong00 mentioned this pull request Aug 20, 2024

feat(android): Add menu to specify long-press delay #12170

Merged

Base automatically changed from feat/android/longpress-delay-menu to master August 20, 2024 14:02

darcywong00 merged commit 947bf19 into master Aug 20, 2024
5 checks passed

darcywong00 deleted the feat/android/kmea-set-longpress-delay branch August 20, 2024 14:02

darcywong00 mentioned this pull request Aug 20, 2024

feat(android/app): Feature Request: customize long-press delay time #877

Closed

darcywong00 mentioned this pull request Aug 26, 2024

docs: Update API's for adjusting Android longpress delay keymanapp/help.keyman.com#1500

Merged

darcywong00 mentioned this pull request Sep 4, 2024

docs(android): Add in-app help for adjusting longpress delay #12359

Merged

darcywong00 mentioned this pull request Sep 13, 2024

fix(android): Add gating to setLongpressDelay() #12410

Merged

darcywong00 mentioned this pull request Feb 13, 2025

fix(android): Remove sendOptionsToKeyboard function from Engine API #13219

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(android): Pass longpress delay to KeymanWeb #12185

feat(android): Pass longpress delay to KeymanWeb #12185

darcywong00 commented Aug 14, 2024 •

edited

Loading

keymanapp-test-bot bot commented Aug 14, 2024 •

edited

Loading

dinakaranr commented Aug 14, 2024

darcywong00 commented Aug 15, 2024 •

edited

Loading

darcywong00 commented Aug 15, 2024

jahorton commented Aug 15, 2024

darcywong00 commented Aug 15, 2024

mcdurdin commented Aug 15, 2024

mcdurdin left a comment

mcdurdin Aug 14, 2024

mcdurdin Aug 15, 2024

mcdurdin Aug 15, 2024

mcdurdin Aug 15, 2024

mcdurdin Aug 15, 2024

mcdurdin Aug 15, 2024

mcdurdin Aug 15, 2024

dinakaranr commented Aug 16, 2024

dinakaranr commented Aug 19, 2024

keyman-server commented Aug 20, 2024

		int longpressDelay = KMManager.getLongpressDelay(this);
		KMManager.setLongpressDelay(longpressDelay);

	public static void applyLongpressDelay(int longpressDelay) {
	public static void applyLongpressDelay() {
	int longpressDelay = getLongpressDelay();

feat(android): Pass longpress delay to KeymanWeb #12185

feat(android): Pass longpress delay to KeymanWeb #12185

Conversation

darcywong00 commented Aug 14, 2024 • edited Loading

User Testing

keymanapp-test-bot bot commented Aug 14, 2024 • edited Loading

User Test Results

Test Artifacts

dinakaranr commented Aug 14, 2024

Test Results

darcywong00 commented Aug 15, 2024 • edited Loading

darcywong00 commented Aug 15, 2024

jahorton commented Aug 15, 2024

darcywong00 commented Aug 15, 2024

mcdurdin commented Aug 15, 2024

mcdurdin left a comment

Choose a reason for hiding this comment

mcdurdin Aug 14, 2024

Choose a reason for hiding this comment

mcdurdin Aug 15, 2024

Choose a reason for hiding this comment

mcdurdin Aug 15, 2024

Choose a reason for hiding this comment

mcdurdin Aug 15, 2024

Choose a reason for hiding this comment

mcdurdin Aug 15, 2024

Choose a reason for hiding this comment

mcdurdin Aug 15, 2024

Choose a reason for hiding this comment

mcdurdin Aug 15, 2024

Choose a reason for hiding this comment

dinakaranr commented Aug 16, 2024

Test Results

dinakaranr commented Aug 19, 2024

Test Results

keyman-server commented Aug 20, 2024

darcywong00 commented Aug 14, 2024 •

edited

Loading

keymanapp-test-bot bot commented Aug 14, 2024 •

edited

Loading

darcywong00 commented Aug 15, 2024 •

edited

Loading