Create BackEvent interface for back navigation parameters. (a39fa749) · Commits · e / os / android_frameworks_base

core/java/android/view/OnBackInvokedCallback.java

+4 −5

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

		import android.app.Activity;
		import android.app.Dialog;
		import android.window.BackEvent;

		/**
		* Interface for applications to register back invocation callbacks. This allows the client
		@@ -46,14 +47,12 @@ public interface OnBackInvokedCallback {
		/**
		* Called on back gesture progress.
		*
		* @param touchX Absolute X location of the touch point.
		* @param touchY Absolute Y location of the touch point.
		* @param progress Value between 0 and 1 on how far along the back gesture is.
		* @param backEvent An {@link android.window.BackEvent} object describing the progress event.
		*
		* @see android.window.BackEvent
		* @hide
		*/
		// TODO(b/210539672): combine back progress params into BackEvent.
		default void onBackProgressed(int touchX, int touchY, float progress) { };
		default void onBackProgressed(BackEvent backEvent) { };

		/**
		* Called when a back gesture or back button press has been cancelled.

core/java/android/window/BackEvent.aidl

0 → 100644

+22 −0

Original line number	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.window;

		/**
		* @hide
		*/
		parcelable BackEvent;

core/java/android/window/BackEvent.java

0 → 100644

+159 −0

Original line number	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.window;

		import android.annotation.IntDef;
		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.os.Parcel;
		import android.os.Parcelable;
		import android.view.RemoteAnimationTarget;

		import java.lang.annotation.Retention;
		import java.lang.annotation.RetentionPolicy;

		/**
		* Represents an event that is sent out by the system during back navigation gesture.
		* Holds information about the touch event, swipe direction and overall progress of the gesture
		* interaction.
		*
		* @hide
		*/
		public class BackEvent implements Parcelable {
		/** Indicates that the edge swipe starts from the left edge of the screen */
		public static final int EDGE_LEFT = 0;
		/** Indicates that the edge swipe starts from the right edge of the screen */
		public static final int EDGE_RIGHT = 1;

		@IntDef({
		EDGE_LEFT,
		EDGE_RIGHT,
		})
		@Retention(RetentionPolicy.SOURCE)
		public @interface SwipeEdge{}

		private final int mTouchX;
		private final int mTouchY;
		private final float mProgress;

		@SwipeEdge
		private final int mSwipeEdge;
		@Nullable
		private final RemoteAnimationTarget mDepartingAnimationTarget;

		/**
		* Creates a new {@link BackEvent} instance.
		*
		* @param touchX Absolute X location of the touch point.
		* @param touchY Absolute Y location of the touch point.
		* @param progress Value between 0 and 1 on how far along the back gesture is.
		* @param swipeEdge Indicates which edge the swipe starts from.
		* @param departingAnimationTarget The remote animation target of the departing application
		* window.
		*/
		public BackEvent(int touchX, int touchY, float progress, @SwipeEdge int swipeEdge,
		@Nullable RemoteAnimationTarget departingAnimationTarget) {
		mTouchX = touchX;
		mTouchY = touchY;
		mProgress = progress;
		mSwipeEdge = swipeEdge;
		mDepartingAnimationTarget = departingAnimationTarget;
		}

		private BackEvent(@NonNull Parcel in) {
		mTouchX = in.readInt();
		mTouchY = in.readInt();
		mProgress = in.readFloat();
		mSwipeEdge = in.readInt();
		mDepartingAnimationTarget = in.readTypedObject(RemoteAnimationTarget.CREATOR);
		}

		public static final Creator<BackEvent> CREATOR = new Creator<BackEvent>() {
		@Override
		public BackEvent createFromParcel(Parcel in) {
		return new BackEvent(in);
		}

		@Override
		public BackEvent[] newArray(int size) {
		return new BackEvent[size];
		}
		};

		@Override
		public int describeContents() {
		return 0;
		}

		@Override
		public void writeToParcel(@NonNull Parcel dest, int flags) {
		dest.writeInt(mTouchX);
		dest.writeInt(mTouchY);
		dest.writeFloat(mProgress);
		dest.writeInt(mSwipeEdge);
		dest.writeTypedObject(mDepartingAnimationTarget, flags);
		}

		/**
		* Returns a value between 0 and 1 on how far along the back gesture is.
		*/
		public float getProgress() {
		return mProgress;
		}

		/**
		* Returns the absolute X location of the touch point.
		*/
		public int getTouchX() {
		return mTouchX;
		}

		/**
		* Returns the absolute Y location of the touch point.
		*/
		public int getTouchY() {
		return mTouchY;
		}

		/**
		* Returns the screen edge that the swipe starts from.
		*/
		public int getSwipeEdge() {
		return mSwipeEdge;
		}

		/**
		* Returns the {@link RemoteAnimationTarget} of the top departing application window,
		* or {@code null} if the top window should not be moved for the current type of back
		* destination.
		*/
		@Nullable
		public RemoteAnimationTarget getDepartingAnimationTarget() {
		return mDepartingAnimationTarget;
		}

		@Override
		public String toString() {
		return "BackEvent{"
		+ "mTouchX=" + mTouchX
		+ ", mTouchY=" + mTouchY
		+ ", mProgress=" + mProgress
		+ ", mSwipeEdge" + mSwipeEdge
		+ ", mDepartingAnimationTarget" + mDepartingAnimationTarget
		+ "}";
		}
		}

core/java/android/window/IOnBackInvokedCallback.aidl

+3 −1

Original line number	Diff line number	Diff line
		@@ -17,6 +17,8 @@

		package android.window;

		import android.window.BackEvent;

		/**
		* Interface that wraps a {@link OnBackInvokedCallback} object, to be stored in window manager
		* and called from back handling process when back is invoked.
		@@ -38,7 +40,7 @@ oneway interface IOnBackInvokedCallback {
		* @param touchY Absolute Y location of the touch point.
		* @param progress Value between 0 and 1 on how far along the back gesture is.
		*/
		void onBackProgressed(int touchX, int touchY, float progress);
		void onBackProgressed(in BackEvent backEvent);

		/**
		* Called when a back gesture or back button press has been cancelled.

core/java/android/window/WindowOnBackInvokedDispatcher.java

+2 −2

Original line number	Diff line number	Diff line
		@@ -202,9 +202,9 @@ public class WindowOnBackInvokedDispatcher implements OnBackInvokedDispatcher {
		}

		@Override
		public void onBackProgressed(int touchX, int touchY, float progress)
		public void onBackProgressed(BackEvent backEvent)
		throws RemoteException {
		Handler.getMain().post(() -> mCallback.onBackProgressed(touchX, touchY, progress));
		Handler.getMain().post(() -> mCallback.onBackProgressed(backEvent));
		}

		@Override