summaryrefslogtreecommitdiff
path: root/core/java/android/inputmethodservice/InputMethodService.java
diff options
context:
space:
mode:
authorTetsui Ohkubo <tetsui@google.com>2021-09-17 16:34:11 +0900
committerTetsui Ohkubo <tetsui@google.com>2021-09-27 11:14:19 +0900
commite48180fb88f62fe929d384e643eceb8cf4631e1c (patch)
tree4c1702a75fa52354b90f77e9d2345c5c41d6bfc3 /core/java/android/inputmethodservice/InputMethodService.java
parente166cae76ee1e67c635f54632934eece1ea19a3a (diff)
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
Diffstat (limited to 'core/java/android/inputmethodservice/InputMethodService.java')
-rw-r--r--core/java/android/inputmethodservice/InputMethodService.java7
1 files changed, 6 insertions, 1 deletions
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