Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Fix an off-by-one bug in EditableInputConnection#endBatchEdit() return value"

Browse Source
This commit is contained in:
Treehugger Robot
2021-12-15 17:00:15 +00:00
committed by Gerrit Code Review
parent 629810015f 1fdc14b8a9
commit e908851af5
2 changed files with 17 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
core/java/android/view/inputmethod/InputConnection.java
View File

@@ -770,20 +770,25 @@ public interface InputConnection {
boolean beginBatchEdit();
/**
* Tell the editor that you are done with a batch edit previously
* initiated with {@link #beginBatchEdit}. This ends the latest
* batch only.
* Tell the editor that you are done with a batch edit previously initiated with
* {@link #beginBatchEdit()}. This ends the latest batch only.
*
* <p><strong>IME authors:</strong> make sure you call this
* exactly once for each call to {@link #beginBatchEdit}.</p>
* <p><strong>IME authors:</strong> make sure you call this exactly once for each call to
* {@link #beginBatchEdit()}.</p>
*
* <p><strong>Editor authors:</strong> please be careful about
* batch edit nesting. Updates still to be held back until the end
* of the last batch edit.</p>
* <p><strong>Editor authors:</strong> please be careful about batch edit nesting. Updates still
* to be held back until the end of the last batch edit. In case you are delegating this API
* call to the one obtained from
* {@link android.widget.EditText#onCreateInputConnection(EditorInfo)}, there was an off-by-one
* that had returned {@code true} when its nested batch edit count becomes {@code 0} as a result
* of invoking this API. This bug is fixed in {@link android.os.Build.VERSION_CODES#TIRAMISU}.
* </p>
*
* @return true if there is still a batch edit in progress after closing
* the latest one (in other words, if the nesting count is > 0), false
* otherwise or if the input connection is no longer valid.
* @return For editor authors, you must return {@code true} if a batch edit is still in progress
* after closing the latest one (in other words, if the nesting count is still a
* positive number). Return {@code false} otherwise. For IME authors, you will
* always receive {@code true} as long as the request was sent to the editor, and
* receive {@code false} only if the input connection is no longer valid.
*/
boolean endBatchEdit();

2
core/java/com/android/internal/widget/EditableInputConnection.java
View File

@@ -92,7 +92,7 @@ public class EditableInputConnection extends BaseInputConnection
// contribution to mTextView's nested batch edit count is zero.
mTextView.endBatchEdit();
mBatchEditNesting--;
return true;
return mBatchEditNesting > 0;
}
}
return false;