tests/tapl/com/android/launcher3/tapl/WorkspaceDragSource.java

/*
 * 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 com.android.launcher3.tapl;

import android.graphics.Point;

import java.util.function.Supplier;

/** {@link Launchable} that can serve as a source for dragging and dropping to the workspace. */
interface WorkspaceDragSource {

    /**
     * Drags an object to the center of homescreen.
     *
     * @param startsActivity   whether it's expected to start an activity.
     * @param isWidgetShortcut whether we drag a widget shortcut
     */
    default void dragToWorkspace(boolean startsActivity, boolean isWidgetShortcut) {
        Launchable launchable = getLaunchable();
        LauncherInstrumentation launcher = launchable.mLauncher;
        try (LauncherInstrumentation.Closable e = launcher.eventsCheck()) {
            internalDragToWorkspace(startsActivity, isWidgetShortcut);
        }
    }

    /**
     * TODO(Redesign WorkspaceDragSource to have actual private methods)
     * Temporary private method
     *
     * @param startsActivity   whether it's expected to start an activity.
     * @param isWidgetShortcut whether we drag a widget shortcut
     */
    default void internalDragToWorkspace(boolean startsActivity, boolean isWidgetShortcut) {
        Launchable launchable = getLaunchable();
        LauncherInstrumentation launcher = launchable.mLauncher;
        final Point launchableCenter = launchable.getObject().getVisibleCenter();
        final Point displaySize = launcher.getRealDisplaySize();
        final int width = displaySize.x / 2;
        Workspace.dragIconToWorkspace(
                launcher,
                launchable,
                () -> new Point(
                        launchableCenter.x >= width
                                ? launchableCenter.x - width / 2
                                : launchableCenter.x + width / 2,
                        displaySize.y / 2),
                startsActivity,
                isWidgetShortcut,
                launchable::addExpectedEventsForLongClick);
    }

    /**
     * Drag an object to the given cell in workspace. The target cell must be empty.
     *
     * @param cellX zero based column number, starting from the left of the screen.
     * @param cellY zero based row number, starting from the top of the screen.     *
     */
    default HomeAppIcon dragToWorkspace(int cellX, int cellY) {
        Launchable launchable = getLaunchable();
        final String iconName = launchable.getObject().getText();
        LauncherInstrumentation launcher = launchable.mLauncher;
        try (LauncherInstrumentation.Closable e = launcher.eventsCheck();
             LauncherInstrumentation.Closable c = launcher.addContextLayer(
                     String.format("want to drag the icon to cell(%d, %d)", cellX, cellY))) {
            final Supplier<Point> dest = () -> Workspace.getCellCenter(launcher, cellX, cellY);
            Workspace.dragIconToWorkspace(
                    launcher,
                    launchable,
                    dest,
                    launchable::addExpectedEventsForLongClick,
                    /*expectDropEvents= */ null);

            try (LauncherInstrumentation.Closable ignore = launcher.addContextLayer("dragged")) {
                WorkspaceAppIcon appIcon =
                        (WorkspaceAppIcon) launcher.getWorkspace().getWorkspaceAppIcon(iconName);
                launcher.assertTrue(
                        String.format(
                                "The %s icon should be in the cell (%d, %d).", iconName, cellX,
                                cellY),
                        appIcon.isInCell(cellX, cellY));
                return appIcon;
            }
        }
    }

    /** This method requires public access, however should not be called in tests. */
    Launchable getLaunchable();
}