feat(android): Enhance how ENTER key is handled in apps

[darcywong00]

Fixes #7796

This PR enhances how the ENTER key is handled as actions in different apps.

In multi-line text (like messaging apps), the enter key inserts a newline (\n).

When the IME action is Go / Search / Done, the ENTER key sends the corresponding action. (DONE dismisses the keyboard).
Note: EditorInfo also has more actions like PREVIOUS and NEXT, but I didn't bother implementing those this time.
(edit)
From standup, I'll add PREVIOUS and NEXT actions.

Also a future PR for KMW is getting the ENTER key label to change depending on the action

API Changes

to add to help.keyman.com

• KMManager.setEnterMode
• KMManager.getEnterMode

User Testing

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

• Messaging app like Facebook Messenger
• X (twitter)

Setup and enable Keyman as a default system keyboard

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

1. Launch Keep
2. With Keyman 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 Keyman 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 Keyman as the system keyboard
• Press the "ENTER" key
• Verify the search is triggered

[keymanapp-test-bot]

User Test Results

Test specification and instructions

• ✅ 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 "Keyman 18.0.86-alpha-test-12125" build on the Android 14 physical device. Here is my observation.

1. Installed the "Keyman-18.0.88.apk" file and gave all permissions to the application.
2. Checked the "Enable Keyman as system-wide keyboard" and set the keyboard as the default keyboard box on the settings page.
3. Open the Keyman app. Enable the "Predictions" to install the "Dictionary."

• TEST_KEEP (Passed):

1. Launch the Google Keep app.
2. Open the empty note by clicking the "+" button.
3. Enter a sentence using the keyman keyboard.
4. Press the "Enter" key.
5. I observed that an empty line was inserted under the sentence.

• TEST_MESSAGING (Failed):

1. Launch the Facebook messenger app.
2. Select a person from the contact list.
3. Enter a sentence using the keyman keyboard.
4. Press the "Enter" key.
5. I observed that the empty line was inserted under the sentence.
6. Click the arrow key.
   Observed that the message was sent to the user. but the blank line was removed in the sent message. (Which is inserted a line.)
   It is a problem. Please refer to the attached video.
   https://github.com/user-attachments/assets/131ee1b7-d6a1-48a9-a955-941a0973f6a2

• TEST_SEARCH (Passed):

1. Launch the Twitter app.
2. Open the search box by clicking the eyeglass icon.
3. Enter a word in the search field.
4. Press the "Enter" key.
   Observed that the search result appears after pressing the "Enter" key. It works well. Thank you.

[darcywong00]

@dinakaranr - I've made a code change to advance the cursor on newline.
However, on my default Gboard keyboard, entering multiple blank newlines in the messaging app ends up with the newlines also getting truncated when the text is sent.

@keymanapp-test-bot retest TEST_MESSAGING

[dinakaranr]

I tested this issue with the attached "Keyman 18.0.86-alpha-test-12125" build on the Android 14 physical device. Here is my observation.

Test Results

• TEST_MESSAGING (Passed):

1. Launch the Facebook messenger app.
2. Select a person from the contact list.
3. Enter a sentence using the keyman keyboard.
4. Press the "Enter" key.
5. I observed that the empty line was inserted under the sentence.
6. The mouse cursor moved into a new blank line.
7. Click the arrow key.
   Observed that the message was sent to the user. but the blank line was removed from the sent message. This works as expected behavior.
   Thank you Darcy for the clarification.

[mcdurdin]

LGTM. We need a new issue to make the Enter mode visible on the Enter key on the touch keyboard.

Can Shift layer change the Enter mode on other keyboard apps?

[mcdurdin]

This seems like it is an opportunity for a future feature?

[keyman-server]

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