Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3ee86dcc authored by Chris Li's avatar Chris Li
Browse files

Refactor TaskFragment related WindowContainerTransaction 

Refactor TaskFragment related WCT to a single transaction type. As we
will likely to add more TaskFragment transactions in the future, putting
them into a standalone type can make them more organized, as well as not
confusing other users of WCT, especially because WCT already have a lot
of operation types.

Refactor deleteTaskFragment to take fragment token instead of
WindowContainerToken to be consistent with other TaskFragmentOperation.

Remove support of setAdjacentRoots/clearAdjacentRoots for
TaskFragmentOrganizer since we have setAdjacentTaskFragments.

Remove reparentChildren because it is never used.

Bug: 263436063
Test: pass existing tests.
Change-Id: If01fde450f03f1f6677e583f4bdf97fcd1192553
parent b4a9fddc

core/api/test-current.txt

+1 −2
Original line number Diff line number Diff line
@@ -3664,14 +3664,13 @@ package android.window { 
    ctor public WindowContainerTransaction();

    method @NonNull public android.window.WindowContainerTransaction clearLaunchAdjacentFlagRoot(@NonNull android.window.WindowContainerToken);

    method @NonNull public android.window.WindowContainerTransaction createTaskFragment(@NonNull android.window.TaskFragmentCreationParams);

    method @NonNull public android.window.WindowContainerTransaction deleteTaskFragment(@NonNull android.window.WindowContainerToken);

    method @NonNull public android.window.WindowContainerTransaction deleteTaskFragment(@NonNull android.os.IBinder);

    method public int describeContents();

    method @NonNull public android.window.WindowContainerTransaction finishActivity(@NonNull android.os.IBinder);

    method @NonNull public android.window.WindowContainerTransaction removeTask(@NonNull android.window.WindowContainerToken);

    method @NonNull public android.window.WindowContainerTransaction reorder(@NonNull android.window.WindowContainerToken, boolean);

    method @NonNull public android.window.WindowContainerTransaction reparent(@NonNull android.window.WindowContainerToken, @Nullable android.window.WindowContainerToken, boolean);

    method @NonNull public android.window.WindowContainerTransaction reparentActivityToTaskFragment(@NonNull android.os.IBinder, @NonNull android.os.IBinder);

    method @NonNull public android.window.WindowContainerTransaction reparentChildren(@NonNull android.window.WindowContainerToken, @Nullable android.window.WindowContainerToken);

    method @NonNull public android.window.WindowContainerTransaction reparentTasks(@Nullable android.window.WindowContainerToken, @Nullable android.window.WindowContainerToken, @Nullable int[], @Nullable int[], boolean);

    method @NonNull public android.window.WindowContainerTransaction requestFocusOnTaskFragment(@NonNull android.os.IBinder);

    method @NonNull public android.window.WindowContainerTransaction scheduleFinishEnterPip(@NonNull android.window.WindowContainerToken, @NonNull android.graphics.Rect);

core/java/android/window/TaskFragmentAnimationParams.aidl

+1 −1
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 * Copyright (C) 2023 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.

core/java/android/window/TaskFragmentAnimationParams.java

+1 −1
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 * Copyright (C) 2023 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.

core/java/android/window/TaskFragmentOperation.aidl

+1 −1
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 * Copyright (C) 2023 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.

core/java/android/window/TaskFragmentOperation.java

+199 −9
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 * Copyright (C) 2023 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.
@@ -19,6 +19,8 @@ package android.window; 
import android.annotation.IntDef;

import android.annotation.NonNull;

import android.annotation.Nullable;

import android.content.Intent;

import android.os.Bundle;

import android.os.IBinder;

import android.os.Parcel;

import android.os.Parcelable;
@@ -30,41 +32,108 @@ import java.util.Objects; 
/**

 * Data object of params for TaskFragment related {@link WindowContainerTransaction} operation.

 *

 * @see WindowContainerTransaction#setTaskFragmentOperation(IBinder, TaskFragmentOperation).

 * @see WindowContainerTransaction#addTaskFragmentOperation(IBinder, TaskFragmentOperation).

 * @hide

 */

// TODO(b/263436063): move other TaskFragment related operation here.

public final class TaskFragmentOperation implements Parcelable {



    /**

     * Type for tracking other {@link WindowContainerTransaction} to TaskFragment that is not set

     * through {@link TaskFragmentOperation}, such as {@link WindowContainerTransaction#setBounds}.

     */

    public static final int OP_TYPE_UNKNOWN = -1;



    /** Creates a new TaskFragment. */

    public static final int OP_TYPE_CREATE_TASK_FRAGMENT = 0;



    /** Deletes the given TaskFragment. */

    public static final int OP_TYPE_DELETE_TASK_FRAGMENT = 1;



    /** Starts an Activity in the given TaskFragment. */

    public static final int OP_TYPE_START_ACTIVITY_IN_TASK_FRAGMENT = 2;



    /** Reparents the given Activity to the given TaskFragment. */

    public static final int OP_TYPE_REPARENT_ACTIVITY_TO_TASK_FRAGMENT = 3;



    /** Sets two TaskFragments adjacent to each other. */

    public static final int OP_TYPE_SET_ADJACENT_TASK_FRAGMENTS = 4;



    /** Requests focus on the top running Activity in the given TaskFragment. */

    public static final int OP_TYPE_REQUEST_FOCUS_ON_TASK_FRAGMENT = 5;



    /** Sets a given TaskFragment to have a companion TaskFragment. */

    public static final int OP_TYPE_SET_COMPANION_TASK_FRAGMENT = 6;



    /** Sets the {@link TaskFragmentAnimationParams} for the given TaskFragment. */

    public static final int OP_TYPE_SET_ANIMATION_PARAMS = 0;

    public static final int OP_TYPE_SET_ANIMATION_PARAMS = 7;



    @IntDef(prefix = { "OP_TYPE_" }, value = {

            OP_TYPE_UNKNOWN,

            OP_TYPE_CREATE_TASK_FRAGMENT,

            OP_TYPE_DELETE_TASK_FRAGMENT,

            OP_TYPE_START_ACTIVITY_IN_TASK_FRAGMENT,

            OP_TYPE_REPARENT_ACTIVITY_TO_TASK_FRAGMENT,

            OP_TYPE_SET_ADJACENT_TASK_FRAGMENTS,

            OP_TYPE_REQUEST_FOCUS_ON_TASK_FRAGMENT,

            OP_TYPE_SET_COMPANION_TASK_FRAGMENT,

            OP_TYPE_SET_ANIMATION_PARAMS

    })

    @Retention(RetentionPolicy.SOURCE)

    @interface OperationType {}

    public @interface OperationType {}



    @OperationType

    private final int mOpType;



    @Nullable

    private final TaskFragmentCreationParams mTaskFragmentCreationParams;



    @Nullable

    private final IBinder mActivityToken;



    @Nullable

    private final Intent mActivityIntent;



    @Nullable

    private final Bundle mBundle;



    @Nullable

    private final IBinder mSecondaryFragmentToken;



    @Nullable

    private final TaskFragmentAnimationParams mAnimationParams;



    private TaskFragmentOperation(@OperationType int opType,

            @Nullable TaskFragmentCreationParams taskFragmentCreationParams,

            @Nullable IBinder activityToken, @Nullable Intent activityIntent,

            @Nullable Bundle bundle, @Nullable IBinder secondaryFragmentToken,

            @Nullable TaskFragmentAnimationParams animationParams) {

        mOpType = opType;

        mTaskFragmentCreationParams = taskFragmentCreationParams;

        mActivityToken = activityToken;

        mActivityIntent = activityIntent;

        mBundle = bundle;

        mSecondaryFragmentToken = secondaryFragmentToken;

        mAnimationParams = animationParams;

    }



    private TaskFragmentOperation(Parcel in) {

        mOpType = in.readInt();

        mTaskFragmentCreationParams = in.readTypedObject(TaskFragmentCreationParams.CREATOR);

        mActivityToken = in.readStrongBinder();

        mActivityIntent = in.readTypedObject(Intent.CREATOR);

        mBundle = in.readBundle(getClass().getClassLoader());

        mSecondaryFragmentToken = in.readStrongBinder();

        mAnimationParams = in.readTypedObject(TaskFragmentAnimationParams.CREATOR);

    }



    @Override

    public void writeToParcel(@NonNull Parcel dest, int flags) {

        dest.writeInt(mOpType);

        dest.writeTypedObject(mTaskFragmentCreationParams, flags);

        dest.writeStrongBinder(mActivityToken);

        dest.writeTypedObject(mActivityIntent, flags);

        dest.writeBundle(mBundle);

        dest.writeStrongBinder(mSecondaryFragmentToken);

        dest.writeTypedObject(mAnimationParams, flags);

    }
@@ -90,6 +159,46 @@ public final class TaskFragmentOperation implements Parcelable { 
        return mOpType;

    }



    /**

     * Gets the options to create a new TaskFragment.

     */

    @Nullable

    public TaskFragmentCreationParams getTaskFragmentCreationParams() {

        return mTaskFragmentCreationParams;

    }



    /**

     * Gets the Activity token set in this operation.

     */

    @Nullable

    public IBinder getActivityToken() {

        return mActivityToken;

    }



    /**

     * Gets the Intent to start a new Activity.

     */

    @Nullable

    public Intent getActivityIntent() {

        return mActivityIntent;

    }



    /**

     * Gets the Bundle set in this operation.

     */

    @Nullable

    public Bundle getBundle() {

        return mBundle;

    }



    /**

     * Gets the fragment token of the secondary TaskFragment set in this operation.

     */

    @Nullable

    public IBinder getSecondaryFragmentToken() {

        return mSecondaryFragmentToken;

    }



    /**

     * Gets the animation related override of TaskFragment.

     */
@@ -102,6 +211,21 @@ public final class TaskFragmentOperation implements Parcelable { 
    public String toString() {

        final StringBuilder sb = new StringBuilder();

        sb.append("TaskFragmentOperation{ opType=").append(mOpType);

        if (mTaskFragmentCreationParams != null) {

            sb.append(", taskFragmentCreationParams=").append(mTaskFragmentCreationParams);

        }

        if (mActivityToken != null) {

            sb.append(", activityToken=").append(mActivityToken);

        }

        if (mActivityIntent != null) {

            sb.append(", activityIntent=").append(mActivityIntent);

        }

        if (mBundle != null) {

            sb.append(", bundle=").append(mBundle);

        }

        if (mSecondaryFragmentToken != null) {

            sb.append(", secondaryFragmentToken=").append(mSecondaryFragmentToken);

        }

        if (mAnimationParams != null) {

            sb.append(", animationParams=").append(mAnimationParams);

        }
@@ -112,9 +236,8 @@ public final class TaskFragmentOperation implements Parcelable { 


    @Override

    public int hashCode() {

        int result = mOpType;

        result = result * 31 + mAnimationParams.hashCode();

        return result;

        return Objects.hash(mOpType, mTaskFragmentCreationParams, mActivityToken, mActivityIntent,

                mBundle, mSecondaryFragmentToken, mAnimationParams);

    }



    @Override
@@ -124,6 +247,11 @@ public final class TaskFragmentOperation implements Parcelable { 
        }

        final TaskFragmentOperation other = (TaskFragmentOperation) obj;

        return mOpType == other.mOpType

                && Objects.equals(mTaskFragmentCreationParams, other.mTaskFragmentCreationParams)

                && Objects.equals(mActivityToken, other.mActivityToken)

                && Objects.equals(mActivityIntent, other.mActivityIntent)

                && Objects.equals(mBundle, other.mBundle)

                && Objects.equals(mSecondaryFragmentToken, other.mSecondaryFragmentToken)

                && Objects.equals(mAnimationParams, other.mAnimationParams);

    }
@@ -138,6 +266,21 @@ public final class TaskFragmentOperation implements Parcelable { 
        @OperationType

        private final int mOpType;



        @Nullable

        private TaskFragmentCreationParams mTaskFragmentCreationParams;



        @Nullable

        private IBinder mActivityToken;



        @Nullable

        private Intent mActivityIntent;



        @Nullable

        private Bundle mBundle;



        @Nullable

        private IBinder mSecondaryFragmentToken;



        @Nullable

        private TaskFragmentAnimationParams mAnimationParams;
@@ -148,6 +291,52 @@ public final class TaskFragmentOperation implements Parcelable { 
            mOpType = opType;

        }



        /**

         * Sets the {@link TaskFragmentCreationParams} for creating a new TaskFragment.

         */

        @NonNull

        public Builder setTaskFragmentCreationParams(

                @Nullable TaskFragmentCreationParams taskFragmentCreationParams) {

            mTaskFragmentCreationParams = taskFragmentCreationParams;

            return this;

        }



        /**

         * Sets an Activity token to this operation.

         */

        @NonNull

        public Builder setActivityToken(@Nullable IBinder activityToken) {

            mActivityToken = activityToken;

            return this;

        }



        /**

         * Sets the Intent to start a new Activity.

         */

        @NonNull

        public Builder setActivityIntent(@Nullable Intent activityIntent) {

            mActivityIntent = activityIntent;

            return this;

        }



        /**

         * Sets a Bundle to this operation.

         */

        @NonNull

        public Builder setBundle(@Nullable Bundle bundle) {

            mBundle = bundle;

            return this;

        }



        /**

         * Sets the secondary fragment token to this operation.

         */

        @NonNull

        public Builder setSecondaryFragmentToken(@Nullable IBinder secondaryFragmentToken) {

            mSecondaryFragmentToken = secondaryFragmentToken;

            return this;

        }



        /**

         * Sets the {@link TaskFragmentAnimationParams} for the given TaskFragment.

         */
@@ -162,7 +351,8 @@ public final class TaskFragmentOperation implements Parcelable { 
         */

        @NonNull

        public TaskFragmentOperation build() {

            return new TaskFragmentOperation(mOpType, mAnimationParams);

            return new TaskFragmentOperation(mOpType, mTaskFragmentCreationParams, mActivityToken,

                    mActivityIntent, mBundle, mSecondaryFragmentToken, mAnimationParams);

        }

    }

}