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

Merge "Clean up InputConnection.commitContent() javadocs DO NOT MERGE" into nyc-mr1-dev

Browse Source
This commit is contained in:
Chet Haase
2016-11-01 17:25:38 +00:00
committed by Android (Google) Code Review
parent e82b728101 5c0af88764
commit bbae4e6ce6
1 changed files with 15 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

@@ -860,32 +860,35 @@ public interface InputConnection {
android.content.Intent.FLAG_GRANT_READ_URI_PERMISSION; // 0x00000001 android.content.Intent.FLAG_GRANT_READ_URI_PERMISSION; // 0x00000001
/** /**
* Called by the input method to commit a content such as PNG image to the editor. * Called by the input method to commit content such as a PNG image to the editor.
* *
* <p>In order to avoid variety of compatibility issues, this focuses on a simple use case, * <p>In order to avoid a variety of compatibility issues, this focuses on a simple use case,
* where we expect editors and IMEs work cooperatively as follows:</p> * where editors and IMEs are expected to work cooperatively as follows:</p>
* <ul> * <ul>
* <li>Editor must keep {@link EditorInfo#contentMimeTypes} to be {@code null} if it does * <li>Editor must keep {@link EditorInfo#contentMimeTypes} equal to {@code null} if it does
* not support this method at all.</li> * not support this method at all.</li>
* <li>Editor can ignore this request when the MIME type specified in * <li>Editor can ignore this request when the MIME type specified in
* {@code inputContentInfo} does not match to any of {@link EditorInfo#contentMimeTypes}. * {@code inputContentInfo} does not match any of {@link EditorInfo#contentMimeTypes}.
* </li> * </li>
* <li>Editor can ignore the cursor position when inserting the provided context.</li> * <li>Editor can ignore the cursor position when inserting the provided content.</li>
* <li>Editor can return {@code true} asynchronously, even before it starts loading the * <li>Editor can return {@code true} asynchronously, even before it starts loading the
* content.</li> * content.</li>
* <li>Editor should provide a way to delete the content inserted by this method, or revert * <li>Editor should provide a way to delete the content inserted by this method or to
* the effect caused by this method.</li> * revert the effect caused by this method.</li>
* <li>IME should not call this method when there is any composing text, in case calling * <li>IME should not call this method when there is any composing text, in case calling
* this method causes focus change.</li> * this method causes a focus change.</li>
* <li>IME should grant a permission for the editor to read the content. See * <li>IME should grant a permission for the editor to read the content. See
* {@link EditorInfo#packageName} about how to obtain the package name of the editor.</li> * {@link EditorInfo#packageName} about how to obtain the package name of the editor.</li>
* </ul> * </ul>
* *
* @param inputContentInfo Content to be inserted. * @param inputContentInfo Content to be inserted.
* @param flags {@code 0} or {@link #INPUT_CONTENT_GRANT_READ_URI_PERMISSION}. * @param flags {@link #INPUT_CONTENT_GRANT_READ_URI_PERMISSION} if the content provider
* allows {@link android.R.styleable#AndroidManifestProvider_grantUriPermissions
* grantUriPermissions} or {@code 0} if the application does not need to call
* {@link InputContentInfo#requestPermission()}.
* @param opts optional bundle data. This can be {@code null}. * @param opts optional bundle data. This can be {@code null}.
* @return {@code true} if this request is accepted by the application, no matter if the request * @return {@code true} if this request is accepted by the application, whether the request
* is already handled or still being handled in background. * is already handled or still being handled in background, {@code false} otherwise.
*/ */
public boolean commitContent(@NonNull InputContentInfo inputContentInfo, int flags, public boolean commitContent(@NonNull InputContentInfo inputContentInfo, int flags,
@Nullable Bundle opts); @Nullable Bundle opts);