From e48180fb88f62fe929d384e643eceb8cf4631e1c Mon Sep 17 00:00:00 2001
From: Tetsui Ohkubo <tetsui@google.com>
Date: Fri, 17 Sep 2021 16:34:11 +0900
Subject: Update javadoc for EditorInfo.actionId usage

We concluded that the behavior of sendDefaultEditorAction should be kept
for compatibility. To compensate that, we should update the javadoc to
reflect the current behavior.

Test: None
Bug: 28898996
Change-Id: Idcb2b7180f9e22818ab819715fe2723a05b4894a
---
 core/java/android/inputmethodservice/InputMethodService.java | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'core/java/android/inputmethodservice/InputMethodService.java')

diff --git a/core/java/android/inputmethodservice/InputMethodService.java b/core/java/android/inputmethodservice/InputMethodService.java
index dadea6792ac1..fc0533e75470 100644
--- a/core/java/android/inputmethodservice/InputMethodService.java
+++ b/core/java/android/inputmethodservice/InputMethodService.java
@@ -2867,7 +2867,12 @@ public class InputMethodService extends AbstractInputMethodService {
      * Ask the input target to execute its default action via
      * {@link InputConnection#performEditorAction
      * InputConnection.performEditorAction()}.
-     * 
+     *
+     * <p>For compatibility, this method does not execute a custom action even if {@link
+     * EditorInfo#actionLabel EditorInfo.actionLabel} is set. The implementor should directly call
+     * {@link InputConnection#performEditorAction InputConnection.performEditorAction()} with
+     * {@link EditorInfo#actionId EditorInfo.actionId} if they want to execute a custom action.</p>
+     *
      * @param fromEnterKey If true, this will be executed as if the user had
      * pressed an enter key on the keyboard, that is it will <em>not</em>
      * be done if the editor has set {@link EditorInfo#IME_FLAG_NO_ENTER_ACTION
-- 
cgit v1.2.3