feat(android): Enhance how ENTER key is handled for FV and KMSample2

[darcywong00]

Follows #12125 and fixes #12743

The ENTER key was enhanced in the Keyman system keyboard depending on the type of input field.
This ports the functionality to the FirstVoices for Android and KMSample2 apps.

Copying user tests from the original PR:

User Testing

Setup - On an Android device, install the PR build of FirstVoices for Android and the Android KMSample2 app. Preferably use a physical device instead of emulator because you'll also need additional Android apps installed:

• Google Keep
• Messaging app like Facebook Messenger
• X (twitter)

For the corresponding groups, setup a keyboard and enable as the default corresponding keyboard.
On FirstVoices, can do Region --> BC Coast --> SENCOTEN keyboard.

• GROUP_FV: Use FirstVoices for Android as system keyboard

• GROUP_SAMPLE2: Use KMSample2 as system keyboard

• TEST_KEEP - Verifies how ENTER key is handled in Keep app

1. Launch Keep
2. With the GROUP_ keyboard selected as the system keyboard, type in the Keep app
3. Press the "ENTER" key
4. Verify a newline is inserted in the text

• TEST_MESSAGING - Verifies how ENTER key is handled in a multi-line text field (as requested in the original issue)

1. Launch messaging app (like Facebook Messenger)
2. Select a contact to message and start typing a message with GROUP_ keyboard as the system keyboard
3. Press the "ENTER" key
4. Verify a newline is inserted in the text
5. Above the keyboard, the device should have an arrow key to send the message
6. Press the arrow key
7. Verify the message is sent

• TEST_SEARCH - Verifies how ENTER key is handled in a search field (as @dyacob requested in the original issue)
• Launch X (Twitter app)
• Click the eyeglass icon to start a search
• Start typing in the search field with the GROUP_ keyboard as the system keyboard
• Press the "ENTER" key
• Verify the search is triggered

[keymanapp-test-bot]

User Test Results

Test specification and instructions

• ✅ GROUP_FV: Use FirstVoices for Android as system keyboard

  3 tests PASSED

  • ✅ TEST_KEEP (PASSED) (notes)
  • ✅ TEST_MESSAGING (PASSED) (notes)
  • ✅ TEST_SEARCH (PASSED) (notes)

• ✅ GROUP_SAMPLE2: Use KMSample2 as system keyboard

  3 tests PASSED

  • ✅ TEST_KEEP (PASSED) (notes)
  • ✅ TEST_MESSAGING (PASSED) (notes)
  • ✅ TEST_SEARCH (PASSED) (notes)

Test Artifacts

• Android
  • Keyman for Android apk
  • FirstVoices for Android 16.0 apk
  • FirstVoices Keyboards for Android apk
  • KeyboardHarness apk
  • Keyman for Android 16.0 apk
  • KMSample1 apk
  • KMSample2 apk

[dinakaranr]

Test Results

I tested this issue with the attached firstvoices-18.0.148.apk file in the Android 14 environment. Here is my observation.

1. Installed the below application on the Android 14 mobile and signed in with the valid credentials.
2. Installed the "Google Keep"
3. Installed the "Messaging app like Facebook Messenger."
4. Installed the "X (Twitter)"

GROUP_FV: Use FirstVoices for Android as the system keyboard

Setup:

1. Open the first voice keyboard.
2. Installed the below keyboard in the "FirstVoice" keyboard.
3. Region --> BC Coast --> SENCOTEN.
4. Select the FirstVoices keyboard by clicking the "Enable FirstVoices"  checkbox.
5. Set the first voice as the system keyboard by clicking the "Choose first voice as current input method"

• TEST_KEEP (Passed): 

1. Open the Keep application.
2. Create a new note by clicking the "+" icon.
3. The keyboard is set as a system keyboard. Region --> BC Coast --> SENCOTEN.
4. Add some text and then press the "Enter" key on the keyboard.
5. Verified a newline added below the text.
6. Move the cursor between letters and then press the "Enter" key on the keyboard.
7. Verified a newline added between letters. 

• TEST_MESSAGING (Passed): 

1. Open the Facebook Messenger application.
2. Select a contact to message and start typing a message with the FirstVoice keyboard as the system keyboard.
3. Press the "Enter" key.
4. Verified a newline added in the text box.
5. The message was sent to the user by pressing the "Arrow" key.
6. Verified the message is sent.

• TEST_SEARCH (Passed): 

1. Open the X application.
2. Click the search icon to start a search.
3. Start typing in the search box with the FirstVoice keyboard as the system keyboard.
4. Press the "Enter" key.
5. Verified the search is triggered and results appeared.

GROUP_SAMPLE2: Use KMSample2 as system keyboard

I tested this issue with the attached app-debug.apk(KMSample2) file in the Android 14 environment. Here is my observation.
Setup:

1. Open the "KMSample2" application.
2. Enable the "KMSample2" keyboard by clicking the "Open Input method settings" button.
3. Select the "KMSample2" keyboard as the system keyboard by clicking the "Open Input method menu" button.

• TEST_KEEP (Passed):

1. Open the Keep application.
2. Create a new note by clicking the "+" icon.
3. The keyboard is set as a system keyboard. (by clicking the "Open Input method menu" button.)
4. Add some text and then press the "Enter" key on the keyboard.
5. Verified a newline added below the text.
6. Move the cursor between letters and then press the "Enter" key on the keyboard.
7. Verified a newline added between letters.

• TEST_MESSAGING (Passed):

1. Open the Facebook Messenger application.
2. Select a contact to message and start typing a message with the KMSample2 keyboard as the system keyboard.
3. Press the "Enter" key.
4. Verified a newline was added to the text box.
5. The message was sent to the user by pressing the "Arrow" key.
6. Verified the message is sent.

• TEST_SEARCH (Passed):

1. Open the X application.
2. Click the search icon to start a search.
3. Start typing in the search box with the KMSample2 keyboard as the system keyboard.
4. Press the "Enter" key.
5. Verified the search is triggered and results appeared.

Note: The error message appeared on the toast message box when opening the KMSample2 the first time after the installation.
Please refer to the screenshot

[darcywong00]

Additional info for reviewers:

The bulk of functionality was done in the original PR in Keyman Engine for Android (main control unit is KMManager)

KMManager would alter how the ENTER key was handled depending on what type of input field the cursor was at.

The SystemKeyboard.java for the apps using Keyman Engine would call KMManager.setEnterMode() to initialize this handling. I only updated SystemKeyboard for the Keyman for Android in the original PR.

Hence this one makes the corresponding changes to FirstVoices for Android and the KMSample2 app (the sample system keyboard app we include with the Keyman Engine for Android libraries)

[sgschantz]

Looks good -- just one suggestion to improve the code.

[sgschantz]

Though you are only adding a couple lines to the code here, it would be nice to break up the functionality of onStartInput into several methods. It is about 50 lines long and is checking several conditions with discrete tasks. Rather than having blocks of code with nice comments, it would be better to extract these into small well-named methods. Even if the methods are not used anywhere else, it will be more readable and unit-testable.

[darcywong00]

Yep - that's a good suggestion (maybe can do some in early 19.0).

A lot of the Android code could use refactoring (SystemKeyboard and the main culprit KMManager).

[keyman-server]

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