Merge changes from topic "revert-21476203-cherrypick-delegate-yv7lsnf9lu-WDFXBNMFFU" into udc-dev (17028b3d) · Commits · e / os / android_frameworks_base

core/api/current.txt

+8 −12

core/java/android/view/HandwritingDelegateConfiguration.java

0 → 100644

+74 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* Copyright (C) 2022 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;

			import android.annotation.IdRes;
			import android.annotation.NonNull;

			/**
			* Configuration for a view to act as a handwriting initiation delegate. This allows handwriting
			* mode for a delegator editor view to be initiated by stylus movement on the delegate view.
			*
			* <p>If a stylus {@link MotionEvent} occurs within the delegate view's bounds, the callback
			* returned by {@link #getInitiationCallback()} will be called. The callback implementation is
			* expected to show and focus the delegator editor view. If a view with identifier matching {@link
			* #getDelegatorViewId()} creates an input connection while the same stylus {@link MotionEvent}
			* sequence is ongoing, handwriting mode will be initiated for that view.
			*
			* <p>A common use case is a custom view which looks like a text editor but does not actually
			* support text editing itself, and clicking on the custom view causes an EditText to be shown. To
			* support handwriting initiation in this case, {@link View#setHandwritingDelegateConfiguration} can
			* be called on the custom view to configure it as a delegate, and set the EditText as the delegator
			* by passing the EditText's identifier as the {@code delegatorViewId}. The {@code
			* initiationCallback} implementation is typically the same as the click listener implementation
			* which shows the EditText.
			*/
			public class HandwritingDelegateConfiguration {
			@IdRes private final int mDelegatorViewId;
			@NonNull private final Runnable mInitiationCallback;

			/**
			* Constructs a HandwritingDelegateConfiguration instance.
			*
			* @param delegatorViewId identifier of the delegator editor view for which handwriting mode
			* should be initiated
			* @param initiationCallback callback called when a stylus {@link MotionEvent} occurs within
			* this view's bounds. This will be called from the UI thread.
			*/
			public HandwritingDelegateConfiguration(
			@IdRes int delegatorViewId, @NonNull Runnable initiationCallback) {
			mDelegatorViewId = delegatorViewId;
			mInitiationCallback = initiationCallback;
			}

			/**
			* Returns the identifier of the delegator editor view for which handwriting mode should be
			* initiated.
			*/
			public int getDelegatorViewId() {
			return mDelegatorViewId;
			}

			/**
			* Returns the callback which should be called when a stylus {@link MotionEvent} occurs within
			* the delegate view's bounds. The callback should only be called from the UI thread.
			*/
			@NonNull
			public Runnable getInitiationCallback() {
			return mInitiationCallback;
			}
			}

core/java/android/view/HandwritingInitiator.java

+22 −28

Original line number	Original line	Diff line number	Diff line
	@@ -16,6 +16,7 @@

	package android.view;		package android.view;

			import android.annotation.IdRes;
	import android.annotation.NonNull;		import android.annotation.NonNull;
	import android.annotation.Nullable;		import android.annotation.Nullable;
	import android.content.Context;		import android.content.Context;
	@@ -171,11 +172,15 @@ public class HandwritingInitiator {
	if (candidateView != null) {		if (candidateView != null) {
	if (candidateView == getConnectedView()) {		if (candidateView == getConnectedView()) {
	startHandwriting(candidateView);		startHandwriting(candidateView);
	} else if (candidateView.getHandwritingDelegatorCallback() != null) {		} else if (candidateView.getHandwritingDelegateConfiguration() != null) {
	mImm.prepareStylusHandwritingDelegation(		mState.mDelegatorViewId =
	candidateView,		candidateView
	candidateView.getAllowedHandwritingDelegatePackageName());		.getHandwritingDelegateConfiguration()
	candidateView.getHandwritingDelegatorCallback().run();		.getDelegatorViewId();
			candidateView
			.getHandwritingDelegateConfiguration()
			.getInitiationCallback()
			.run();
	} else {		} else {
	if (candidateView.getRevealOnFocusHint()) {		if (candidateView.getRevealOnFocusHint()) {
	candidateView.setRevealOnFocusHint(false);		candidateView.setRevealOnFocusHint(false);
	@@ -222,9 +227,6 @@ public class HandwritingInitiator {
	} else {		} else {
	mConnectedView = new WeakReference<>(view);		mConnectedView = new WeakReference<>(view);
	mConnectionCount = 1;		mConnectionCount = 1;
	if (view.isHandwritingDelegate() && tryAcceptStylusHandwritingDelegation(view)) {
	return;
	}
	if (mState != null && mState.mShouldInitHandwriting) {		if (mState != null && mState.mShouldInitHandwriting) {
	tryStartHandwriting();		tryStartHandwriting();
	}		}
	@@ -277,7 +279,9 @@ public class HandwritingInitiator {
	}		}

	final Rect handwritingArea = getViewHandwritingArea(connectedView);		final Rect handwritingArea = getViewHandwritingArea(connectedView);
	if (isInHandwritingArea(		if ((mState.mDelegatorViewId != View.NO_ID
			&& mState.mDelegatorViewId == connectedView.getId())
			\|\| isInHandwritingArea(
	handwritingArea, mState.mStylusDownX, mState.mStylusDownY, connectedView)) {		handwritingArea, mState.mStylusDownX, mState.mStylusDownY, connectedView)) {
	startHandwriting(connectedView);		startHandwriting(connectedView);
	} else {		} else {
	@@ -285,7 +289,7 @@ public class HandwritingInitiator {
	}		}
	}		}

	/** Starts a stylus handwriting session for the view. */		/** For test only. */
	@VisibleForTesting		@VisibleForTesting
	public void startHandwriting(@NonNull View view) {		public void startHandwriting(@NonNull View view) {
	mImm.startStylusHandwriting(view);		mImm.startStylusHandwriting(view);
	@@ -293,23 +297,6 @@ public class HandwritingInitiator {
	mState.mShouldInitHandwriting = false;		mState.mShouldInitHandwriting = false;
	}		}

	/**
	* Starts a stylus handwriting session for the delegate view, if {@link
	* InputMethodManager#prepareStylusHandwritingDelegation} was previously called.
	*/
	@VisibleForTesting
	public boolean tryAcceptStylusHandwritingDelegation(@NonNull View view) {
	if (mImm.acceptStylusHandwritingDelegation(
	view, view.getAllowedHandwritingDelegatorPackageName())) {
	if (mState != null) {
	mState.mHasInitiatedHandwriting = true;
	mState.mShouldInitHandwriting = false;
	}
	return true;
	}
	return false;
	}

	/**		/**
	* Notify that the handwriting area for the given view might be updated.		* Notify that the handwriting area for the given view might be updated.
	* @param view the view whose handwriting area might be updated.		* @param view the view whose handwriting area might be updated.
	@@ -555,6 +542,13 @@ public class HandwritingInitiator {
	* built InputConnection.		* built InputConnection.
	*/		*/
	private boolean mExceedHandwritingSlop;		private boolean mExceedHandwritingSlop;
			/**
			* If the current ongoing stylus MotionEvent sequence started over a handwriting initiation
			* delegate view, then this is the view identifier of the corresponding delegator view. If
			* the delegator view creates an input connection while the MotionEvent sequence is still
			* ongoing, then handwriting mode will be initiated for the delegator view.
			*/
			@IdRes private int mDelegatorViewId = View.NO_ID;

	/** The pointer id of the stylus pointer that is being tracked. */		/** The pointer id of the stylus pointer that is being tracked. */
	private final int mStylusPointerId;		private final int mStylusPointerId;

core/java/android/view/View.java

+18 −160

Original line number	Original line	Diff line number	Diff line
	@@ -5101,13 +5101,12 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
	*/		*/
	private boolean mHoveringTouchDelegate = false;		private boolean mHoveringTouchDelegate = false;

	// These two fields are set if the view is a handwriting delegator.		/**
	private Runnable mHandwritingDelegatorCallback;		* Configuration for this view to act as a handwriting initiation delegate. This allows
	private String mAllowedHandwritingDelegatePackageName;		* handwriting mode for a delegator editor view to be initiated by stylus movement on this
			* delegate view.
	// These two fields are set if the view is a handwriting delegate.		*/
	private boolean mIsHandwritingDelegate;		private HandwritingDelegateConfiguration mHandwritingDelegateConfiguration;
	private String mAllowedHandwritingDelegatorPackageName;

	/**		/**
	* Solid color to use as a background when creating the drawing cache. Enables		* Solid color to use as a background when creating the drawing cache. Enables
	@@ -12411,168 +12410,27 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
	}		}

	/**		/**
	* Sets a callback which should be called when a stylus {@link MotionEvent} occurs within this		* Configures this view to act as a handwriting initiation delegate. This allows handwriting
	* view's bounds. The callback will be called from the UI thread.		* mode for a delegator editor view to be initiated by stylus movement on this delegate view.
	*
	* <p>Setting a callback allows this view to act as a handwriting delegator, so that handwriting
	* mode for a delegate editor view can be initiated by stylus movement on this delegator view.
	* The callback implementation is expected to show and focus the delegate editor view. If a view
	* which returns {@code true} for {@link #isHandwritingDelegate()} creates an input connection
	* while the same stylus {@link MotionEvent} sequence is ongoing, handwriting mode will be
	* initiated for that view.
	*
	* <p>A common use case is a custom view which looks like a text editor but does not actually
	* support text editing itself, and clicking on the custom view causes an EditText to be shown.
	* To support handwriting initiation in this case, this method can be called on the custom view
	* to configure it as a delegator. The EditText should call {@link #setIsHandwritingDelegate} to
	* set it as a delegate. The {@code callback} implementation is typically the same as the click
	* listener implementation which shows the EditText.
	*		*
	* <p>If {@code null} is passed, this view will no longer act as a handwriting initiation		* <p>If {@code null} is passed, this view will no longer act as a handwriting initiation
	* delegator.		* delegate.
	*
	* @param callback a callback which should be called when a stylus {@link MotionEvent} occurs
	* within this view's bounds
	*/		*/
	public void setHandwritingDelegatorCallback(@Nullable Runnable callback) {		public void setHandwritingDelegateConfiguration(
	mHandwritingDelegatorCallback = callback;		@Nullable HandwritingDelegateConfiguration configuration) {
	if (callback != null) {		mHandwritingDelegateConfiguration = configuration;
	// By default, the delegate must be from the same package as the delegator view.		if (configuration != null) {
	mAllowedHandwritingDelegatePackageName = mContext.getOpPackageName();
	setHandwritingArea(new Rect(0, 0, getWidth(), getHeight()));		setHandwritingArea(new Rect(0, 0, getWidth(), getHeight()));
	} else {
	mAllowedHandwritingDelegatePackageName = null;
	}		}
	}		}

	/**		/**
	* Returns the callback set by {@link #setHandwritingDelegatorCallback} which should be called		* If this view has been configured as a handwriting initiation delegate, returns the delegate
	* when a stylus {@link MotionEvent} occurs within this view's bounds. The callback should only		* configuration.
	* be called from the UI thread.
	*/		*/
	@Nullable		@Nullable
	public Runnable getHandwritingDelegatorCallback() {		public HandwritingDelegateConfiguration getHandwritingDelegateConfiguration() {
	return mHandwritingDelegatorCallback;		return mHandwritingDelegateConfiguration;
	}

	/**
	* Specifies that this view may act as a handwriting initiation delegator for a delegate editor
	* view from the specified package. If this method is not called, delegators may only be used to
	* initiate handwriting mode for a delegate editor view from the same package as the delegator
	* view. This method allows specifying a different trusted package which may contain a delegate
	* editor view linked to this delegator view. This should be called after {@link
	* #setHandwritingDelegatorCallback}.
	*
	* <p>If this method is called on the delegator view, then {@link
	* #setAllowedHandwritingDelegatorPackage} should also be called on the delegate editor view.
	*
	* <p>For example, to configure a delegator view in package 1:
	*
	* <pre>
	* delegatorView.setHandwritingDelegatorCallback(callback);
	* delegatorView.setAllowedHandwritingDelegatePackage(package2);</pre>
	*
	* Then to configure the corresponding delegate editor view in package 2:
	*
	* <pre>
	* delegateEditorView.setIsHandwritingDelegate(true);
	* delegateEditorView.setAllowedHandwritingDelegatorPackage(package1);</pre>
	*
	* @param allowedPackageName the package name of a delegate editor view linked to this delegator
	* view
	* @throws IllegalStateException If the view has not been configured as a handwriting delegator
	* using {@link #setHandwritingDelegatorCallback}.
	*/
	public void setAllowedHandwritingDelegatePackage(@NonNull String allowedPackageName) {
	if (mHandwritingDelegatorCallback == null) {
	throw new IllegalStateException("This view is not a handwriting delegator.");
	}
	mAllowedHandwritingDelegatePackageName = allowedPackageName;
	}

	/**
	* Returns the allowed package for delegate editor views for which this view may act as a
	* handwriting delegator. If {@link #setAllowedHandwritingDelegatePackage} has not been called,
	* this will return this view's package name, since by default delegators may only be used to
	* initiate handwriting mode for a delegate editor view from the same package as the delegator
	* view. This will return a different allowed package if set by {@link
	* #setAllowedHandwritingDelegatePackage}.
	*
	* @throws IllegalStateException If the view has not been configured as a handwriting delegator
	* using {@link #setHandwritingDelegatorCallback}.
	*/
	@NonNull
	public String getAllowedHandwritingDelegatePackageName() {
	if (mHandwritingDelegatorCallback == null) {
	throw new IllegalStateException("This view is not a handwriting delegator.");
	}
	return mAllowedHandwritingDelegatePackageName;
	}

	/**
	* Sets this view to be a handwriting delegate. If a delegate view creates an input connection
	* while a stylus {@link MotionEvent} sequence from a delegator view is ongoing, handwriting
	* mode will be initiated for the delegate view.
	*
	* @param isHandwritingDelegate whether this view is a handwriting initiation delegate
	* @see #setHandwritingDelegatorCallback(Runnable)
	*/
	public void setIsHandwritingDelegate(boolean isHandwritingDelegate) {
	mIsHandwritingDelegate = isHandwritingDelegate;
	if (mIsHandwritingDelegate) {
	// By default, the delegator must be from the same package as the delegate view.
	mAllowedHandwritingDelegatorPackageName = mContext.getOpPackageName();
	} else {
	mAllowedHandwritingDelegatePackageName = null;
	}
	}

	/**
	* Returns whether this view has been set as a handwriting delegate by {@link
	* #setIsHandwritingDelegate}.
	*/
	public boolean isHandwritingDelegate() {
	return mIsHandwritingDelegate;
	}

	/**
	* Specifies that a view from the specified package may act as a handwriting delegator for this
	* delegate editor view. If this method is not called, only views from the same package as the
	* delegate editor view may act as a handwriting delegator. This method allows specifying a
	* different trusted package which may contain a delegator view linked to this delegate editor
	* view. This should be called after {@link #setIsHandwritingDelegate}.
	*
	* <p>If this method is called on the delegate editor view, then {@link
	* #setAllowedHandwritingDelegatePackage} should also be called on the delegator view.
	*
	* @param allowedPackageName the package name of a delegator view linked to this delegate editor
	* view
	* @throws IllegalStateException If the view has not been configured as a handwriting delegate
	* using {@link #setIsHandwritingDelegate}.
	*/
	public void setAllowedHandwritingDelegatorPackage(@NonNull String allowedPackageName) {
	if (!mIsHandwritingDelegate) {
	throw new IllegalStateException("This view is not a handwriting delegate.");
	}
	mAllowedHandwritingDelegatorPackageName = allowedPackageName;
	}

	/**
	* Returns the allowed package for views which may act as a handwriting delegator for this
	* delegate editor view. If {@link #setAllowedHandwritingDelegatorPackage} has not been called,
	* this will return this view's package name, since by default only views from the same package
	* as the delegator editor view may act as a handwriting delegator. This will return a different
	* allowed package if set by {@link #setAllowedHandwritingDelegatorPackage}.
	*
	* @throws IllegalStateException If the view has not been configured as a handwriting delegate
	* using {@link #setIsHandwritingDelegate}.
	*/
	@NonNull
	public String getAllowedHandwritingDelegatorPackageName() {
	if (!mIsHandwritingDelegate) {
	throw new IllegalStateException("This view is not a handwriting delegate.");
	}
	return mAllowedHandwritingDelegatorPackageName;
	}		}

	/**		/**
	@@ -24616,7 +24474,7 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
	}		}
	}		}
	rebuildOutline();		rebuildOutline();
	if (onCheckIsTextEditor() \|\| mHandwritingDelegatorCallback != null) {		if (onCheckIsTextEditor() \|\| mHandwritingDelegateConfiguration != null) {
	setHandwritingArea(new Rect(0, 0, newWidth, newHeight));		setHandwritingArea(new Rect(0, 0, newWidth, newHeight));
	}		}
	}		}

core/java/android/view/inputmethod/IInputMethodManagerGlobalInvoker.java

+0 −34

Original line number	Original line	Diff line number	Diff line
	@@ -504,40 +504,6 @@ final class IInputMethodManagerGlobalInvoker {
	}		}
	}		}

	@AnyThread
	static void prepareStylusHandwritingDelegation(
	@NonNull IInputMethodClient client,
	@NonNull String delegatePackageName,
	@NonNull String delegatorPackageName) {
	final IInputMethodManager service = getService();
	if (service == null) {
	return;
	}
	try {
	service.prepareStylusHandwritingDelegation(
	client, delegatePackageName, delegatorPackageName);
	} catch (RemoteException e) {
	throw e.rethrowFromSystemServer();
	}
	}

	@AnyThread
	static boolean acceptStylusHandwritingDelegation(
	@NonNull IInputMethodClient client,
	@NonNull String delegatePackageName,
	@NonNull String delegatorPackageName) {
	final IInputMethodManager service = getService();
	if (service == null) {
	return false;
	}
	try {
	return service.acceptStylusHandwritingDelegation(
	client, delegatePackageName, delegatorPackageName);
	} catch (RemoteException e) {
	throw e.rethrowFromSystemServer();
	}
	}

	@AnyThread		@AnyThread
	@RequiresPermission(value = Manifest.permission.INTERACT_ACROSS_USERS_FULL, conditional = true)		@RequiresPermission(value = Manifest.permission.INTERACT_ACROSS_USERS_FULL, conditional = true)
	static boolean isStylusHandwritingAvailableAsUser(@UserIdInt int userId) {		static boolean isStylusHandwritingAvailableAsUser(@UserIdInt int userId) {