Support IME to take extra information to editor (c33444b7) · Commits · e / os / android_frameworks_base

core/api/current.txt

+18 −0

Original line number	Original line	Diff line number	Diff line
	@@ -52183,6 +52183,7 @@ package android.view.inputmethod {
	method public boolean commitContent(@NonNull android.view.inputmethod.InputContentInfo, int, @Nullable android.os.Bundle);		method public boolean commitContent(@NonNull android.view.inputmethod.InputContentInfo, int, @Nullable android.os.Bundle);
	method public boolean commitCorrection(android.view.inputmethod.CorrectionInfo);		method public boolean commitCorrection(android.view.inputmethod.CorrectionInfo);
	method public boolean commitText(CharSequence, int);		method public boolean commitText(CharSequence, int);
			method public default boolean commitText(@NonNull CharSequence, int, @Nullable android.view.inputmethod.TextAttribute);
	method public boolean deleteSurroundingText(int, int);		method public boolean deleteSurroundingText(int, int);
	method public boolean deleteSurroundingTextInCodePoints(int, int);		method public boolean deleteSurroundingTextInCodePoints(int, int);
	method public boolean endBatchEdit();		method public boolean endBatchEdit();
	@@ -52202,7 +52203,9 @@ package android.view.inputmethod {
	method public boolean requestCursorUpdates(int);		method public boolean requestCursorUpdates(int);
	method public boolean sendKeyEvent(android.view.KeyEvent);		method public boolean sendKeyEvent(android.view.KeyEvent);
	method public boolean setComposingRegion(int, int);		method public boolean setComposingRegion(int, int);
			method public default boolean setComposingRegion(int, int, @Nullable android.view.inputmethod.TextAttribute);
	method public boolean setComposingText(CharSequence, int);		method public boolean setComposingText(CharSequence, int);
			method public default boolean setComposingText(@NonNull CharSequence, int, @Nullable android.view.inputmethod.TextAttribute);
	method public default boolean setImeConsumesInput(boolean);		method public default boolean setImeConsumesInput(boolean);
	method public boolean setSelection(int, int);		method public boolean setSelection(int, int);
	method @Nullable public default android.view.inputmethod.TextSnapshot takeSnapshot();		method @Nullable public default android.view.inputmethod.TextSnapshot takeSnapshot();
	@@ -52418,6 +52421,21 @@ package android.view.inputmethod {
	field @NonNull public static final android.os.Parcelable.Creator<android.view.inputmethod.SurroundingText> CREATOR;		field @NonNull public static final android.os.Parcelable.Creator<android.view.inputmethod.SurroundingText> CREATOR;
	}		}

			public final class TextAttribute implements android.os.Parcelable {
			method public int describeContents();
			method @NonNull public android.os.PersistableBundle getExtras();
			method @NonNull public java.util.List<java.lang.String> getTextConversionSuggestions();
			method public void writeToParcel(@NonNull android.os.Parcel, int);
			field @NonNull public static final android.os.Parcelable.Creator<android.view.inputmethod.TextAttribute> CREATOR;
			}

			public static final class TextAttribute.TextAttributeBuilder {
			ctor public TextAttribute.TextAttributeBuilder();
			method @NonNull public android.view.inputmethod.TextAttribute build();
			method @NonNull public android.view.inputmethod.TextAttribute.TextAttributeBuilder setExtras(@NonNull android.os.PersistableBundle);
			method @NonNull public android.view.inputmethod.TextAttribute.TextAttributeBuilder setTextConversionSuggestions(@NonNull java.util.List<java.lang.String>);
			}

	public final class TextSnapshot {		public final class TextSnapshot {
	ctor public TextSnapshot(@NonNull android.view.inputmethod.SurroundingText, @IntRange(from=0xffffffff) int, @IntRange(from=0xffffffff) int, int);		ctor public TextSnapshot(@NonNull android.view.inputmethod.SurroundingText, @IntRange(from=0xffffffff) int, @IntRange(from=0xffffffff) int, int);
	method @IntRange(from=0xffffffff) public int getCompositionEnd();		method @IntRange(from=0xffffffff) public int getCompositionEnd();

core/java/android/inputmethodservice/RemoteInputConnection.java

+27 −0

Original line number	Original line	Diff line number	Diff line
	@@ -31,6 +31,7 @@ import android.view.inputmethod.ExtractedTextRequest;
	import android.view.inputmethod.InputConnection;		import android.view.inputmethod.InputConnection;
	import android.view.inputmethod.InputContentInfo;		import android.view.inputmethod.InputContentInfo;
	import android.view.inputmethod.SurroundingText;		import android.view.inputmethod.SurroundingText;
			import android.view.inputmethod.TextAttribute;

	import com.android.internal.inputmethod.CancellationGroup;		import com.android.internal.inputmethod.CancellationGroup;
	import com.android.internal.inputmethod.CompletableFutureUtil;		import com.android.internal.inputmethod.CompletableFutureUtil;
	@@ -271,6 +272,17 @@ final class RemoteInputConnection implements InputConnection {
	return handled;		return handled;
	}		}

			@AnyThread
			public boolean commitText(@NonNull CharSequence text, int newCursorPosition,
			@Nullable TextAttribute textAttribute) {
			final boolean handled =
			mInvoker.commitText(text, newCursorPosition, textAttribute);
			if (handled) {
			notifyUserActionIfNecessary();
			}
			return handled;
			}

	@AnyThread		@AnyThread
	private void notifyUserActionIfNecessary() {		private void notifyUserActionIfNecessary() {
	final InputMethodServiceInternal imsInternal = mImsInternal.getAndWarnIfNull();		final InputMethodServiceInternal imsInternal = mImsInternal.getAndWarnIfNull();
	@@ -310,6 +322,11 @@ final class RemoteInputConnection implements InputConnection {
	return mInvoker.setComposingRegion(start, end);		return mInvoker.setComposingRegion(start, end);
	}		}

			@AnyThread
			public boolean setComposingRegion(int start, int end, @Nullable TextAttribute textAttribute) {
			return mInvoker.setComposingRegion(start, end, textAttribute);
			}

	@AnyThread		@AnyThread
	public boolean setComposingText(CharSequence text, int newCursorPosition) {		public boolean setComposingText(CharSequence text, int newCursorPosition) {
	final boolean handled = mInvoker.setComposingText(text, newCursorPosition);		final boolean handled = mInvoker.setComposingText(text, newCursorPosition);
	@@ -319,6 +336,16 @@ final class RemoteInputConnection implements InputConnection {
	return handled;		return handled;
	}		}

			@AnyThread
			public boolean setComposingText(CharSequence text, int newCursorPosition,
			@Nullable TextAttribute textAttribute) {
			final boolean handled = mInvoker.setComposingText(text, newCursorPosition, textAttribute);
			if (handled) {
			notifyUserActionIfNecessary();
			}
			return handled;
			}

	@AnyThread		@AnyThread
	public boolean finishComposingText() {		public boolean finishComposingText() {
	return mInvoker.finishComposingText();		return mInvoker.finishComposingText();

core/java/android/view/inputmethod/InputConnection.java

+65 −0

Original line number	Original line	Diff line number	Diff line
	@@ -544,6 +544,33 @@ public interface InputConnection {
	*/		*/
	boolean setComposingText(CharSequence text, int newCursorPosition);		boolean setComposingText(CharSequence text, int newCursorPosition);

			/**
			* The variant of {@link #setComposingText(CharSequence, int)}. This method is
			* used to allow the IME to provide extra information while setting up composing text.
			*
			* @param text The composing text with styles if necessary. If no style
			* object attached to the text, the default style for composing text
			* is used. See {@link android.text.Spanned} for how to attach style
			* object to the text. {@link android.text.SpannableString} and
			* {@link android.text.SpannableStringBuilder} are two
			* implementations of the interface {@link android.text.Spanned}.
			* @param newCursorPosition The new cursor position around the text. If
			* > 0, this is relative to the end of the text - 1; if <= 0, this
			* is relative to the start of the text. So a value of 1 will
			* always advance you to the position after the full text being
			* inserted. Note that this means you can't position the cursor
			* within the text, because the editor can make modifications to
			* the text you are providing so it is not possible to correctly
			* specify locations there.
			* @param textAttribute The extra information about the text.
			* @return true on success, false if the input connection is no longer
			*
			*/
			default boolean setComposingText(@NonNull CharSequence text, int newCursorPosition,
			@Nullable TextAttribute textAttribute) {
			return setComposingText(text, newCursorPosition);
			}

	/**		/**
	* Mark a certain region of text as composing text. If there was a		* Mark a certain region of text as composing text. If there was a
	* composing region, the characters are left as they were and the		* composing region, the characters are left as they were and the
	@@ -578,6 +605,22 @@ public interface InputConnection {
	*/		*/
	boolean setComposingRegion(int start, int end);		boolean setComposingRegion(int start, int end);

			/**
			* The variant of {@link InputConnection#setComposingRegion(int, int)}. This method is
			* used to allow the IME to provide extra information while setting up text.
			*
			* @param start the position in the text at which the composing region begins
			* @param end the position in the text at which the composing region ends
			* @param textAttribute The extra information about the text.
			* @return {@code true} on success, {@code false} if the input connection is no longer valid.
			* Since Android {@link android.os.Build.VERSION_CODES#N} until
			* {@link android.os.Build.VERSION_CODES#TIRAMISU}, this API returned {@code false} when
			* the target application does not implement this method.
			*/
			default boolean setComposingRegion(int start, int end, @Nullable TextAttribute textAttribute) {
			return setComposingRegion(start, end);
			}

	/**		/**
	* Have the text editor finish whatever composing text is		* Have the text editor finish whatever composing text is
	* currently active. This simply leaves the text as-is, removing		* currently active. This simply leaves the text as-is, removing
	@@ -633,6 +676,28 @@ public interface InputConnection {
	*/		*/
	boolean commitText(CharSequence text, int newCursorPosition);		boolean commitText(CharSequence text, int newCursorPosition);

			/**
			* The variant of {@link InputConnection#commitText(CharSequence, int)}. This method is
			* used to allow the IME to provide extra information while setting up text.
			*
			* @param text The text to commit. This may include styles.
			* @param newCursorPosition The new cursor position around the text,
			* in Java characters. If > 0, this is relative to the end
			* of the text - 1; if <= 0, this is relative to the start
			* of the text. So a value of 1 will always advance the cursor
			* to the position after the full text being inserted. Note that
			* this means you can't position the cursor within the text,
			* because the editor can make modifications to the text
			* you are providing so it is not possible to correctly specify
			* locations there.
			* @param textAttribute The extra information about the text.
			* @return true on success, false if the input connection is no longer
			*/
			default boolean commitText(@NonNull CharSequence text, int newCursorPosition,
			@Nullable TextAttribute textAttribute) {
			return commitText(text, newCursorPosition);
			}

	/**		/**
	* Commit a completion the user has selected from the possible ones		* Commit a completion the user has selected from the possible ones
	* previously reported to {@link InputMethodSession#displayCompletions		* previously reported to {@link InputMethodSession#displayCompletions

core/java/android/view/inputmethod/InputConnectionWrapper.java

+30 −0

Original line number	Original line	Diff line number	Diff line
	@@ -17,6 +17,7 @@
	package android.view.inputmethod;		package android.view.inputmethod;

	import android.annotation.IntRange;		import android.annotation.IntRange;
			import android.annotation.NonNull;
	import android.annotation.Nullable;		import android.annotation.Nullable;
	import android.os.Bundle;		import android.os.Bundle;
	import android.os.Handler;		import android.os.Handler;
	@@ -153,6 +154,16 @@ public class InputConnectionWrapper implements InputConnection {
	return mTarget.setComposingText(text, newCursorPosition);		return mTarget.setComposingText(text, newCursorPosition);
	}		}

			/**
			* {@inheritDoc}
			* @throws NullPointerException if the target is {@code null}.
			*/
			@Override
			public boolean setComposingText(@NonNull CharSequence text,
			int newCursorPosition, @Nullable TextAttribute textAttribute) {
			return mTarget.setComposingText(text, newCursorPosition, textAttribute);
			}

	/**		/**
	* {@inheritDoc}		* {@inheritDoc}
	* @throws NullPointerException if the target is {@code null}.		* @throws NullPointerException if the target is {@code null}.
	@@ -162,6 +173,15 @@ public class InputConnectionWrapper implements InputConnection {
	return mTarget.setComposingRegion(start, end);		return mTarget.setComposingRegion(start, end);
	}		}

			/**
			* {@inheritDoc}
			* @throws NullPointerException if the target is {@code null}.
			*/
			@Override
			public boolean setComposingRegion(int start, int end, @Nullable TextAttribute textAttribute) {
			return mTarget.setComposingRegion(start, end, textAttribute);
			}

	/**		/**
	* {@inheritDoc}		* {@inheritDoc}
	* @throws NullPointerException if the target is {@code null}.		* @throws NullPointerException if the target is {@code null}.
	@@ -180,6 +200,16 @@ public class InputConnectionWrapper implements InputConnection {
	return mTarget.commitText(text, newCursorPosition);		return mTarget.commitText(text, newCursorPosition);
	}		}

			/**
			* {@inheritDoc}
			* @throws NullPointerException if the target is {@code null}.
			*/
			@Override
			public boolean commitText(@NonNull CharSequence text, int newCursorPosition,
			@Nullable TextAttribute textAttribute) {
			return mTarget.commitText(text, newCursorPosition, textAttribute);
			}

	/**		/**
	* {@inheritDoc}		* {@inheritDoc}
	* @throws NullPointerException if the target is {@code null}.		* @throws NullPointerException if the target is {@code null}.

core/java/android/view/inputmethod/TextAttribute.aidl

0 → 100644

+19 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* Copyright (C) 2021 The Android Open Source Project
			*
			* Licensed under the Apache License, Version 2.0 (the "License");
			* you may not use this file except in compliance with the License.
			* You may obtain a copy of the License at
			*
			* http://www.apache.org/licenses/LICENSE-2.0
			*
			* Unless required by applicable law or agreed to in writing, software
			* distributed under the License is distributed on an "AS IS" BASIS,
			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
			* See the License for the specific language governing permissions and
			* limitations under the License.
			*/

			package android.view.inputmethod;

			parcelable TextAttribute;
			No newline at end of file