/*
 * Copyright (C) 2017 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.allapps;

import static com.android.launcher3.LauncherState.ALL_APPS_HEADER;

import android.graphics.Rect;
import android.view.KeyEvent;
import android.view.animation.Interpolator;
import android.widget.EditText;

import androidx.annotation.Nullable;

import com.android.launcher3.anim.PropertySetter;

/**
 * Interface for controlling the Apps search UI.
 */
public interface SearchUiManager {

    /**
     * Initializes the search manager.
     */
    void initialize(AllAppsContainerView containerView);

    /**
     * Notifies the search manager to close any active search session.
     */
    void resetSearch();

    /**
     * Called before dispatching a key event, in case the search manager wants to initialize
     * some UI beforehand.
     */
    void preDispatchKeyEvent(KeyEvent keyEvent);

    /**
     * Returns the vertical shift for the all-apps view, so that it aligns with the hotseat.
     */
    float getScrollRangeDelta(Rect insets);

    /**
     * Called as part of state transition to update the content UI
     */
    void setContentVisibility(int visibleElements, PropertySetter setter,
            Interpolator interpolator);

    /**
     * Returns true if the QSB should be visible for the given set of visible elements
     */
    default boolean isQsbVisible(int visibleElements) {
        return (visibleElements & ALL_APPS_HEADER) != 0;
    }

    /**
     * Called to control how the search UI result should be handled.
     *
     * @param isEnabled when {@code true}, the search is all handled inside AOSP
     *                  and is not overlayable.
     * @return the searchbox edit text object
     */
    @Nullable
    EditText setTextSearchEnabled(boolean isEnabled);
}
