1 /* 2 * Copyright (C) 2021 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.launcher3.widget.picker.search; 18 19 import com.android.launcher3.widget.model.WidgetsListBaseEntry; 20 21 import java.util.List; 22 23 /** 24 * Interface for a widgets picker search bar. 25 */ 26 public interface WidgetsSearchBar { 27 /** 28 * Attaches a controller to the search bar which interacts with {@code searchModeListener}. 29 */ initialize(WidgetsSearchDataProvider dataProvider, SearchModeListener searchModeListener)30 void initialize(WidgetsSearchDataProvider dataProvider, SearchModeListener searchModeListener); 31 32 /** 33 * Clears search bar. 34 */ reset()35 void reset(); 36 37 /** Returns {@code true} if the search bar is in focus. */ isSearchBarFocused()38 boolean isSearchBarFocused(); 39 40 /** 41 * Clears focus from search bar. 42 */ clearSearchBarFocus()43 void clearSearchBarFocus(); 44 45 /** 46 * Sets the vertical location, in pixels, of this search bar relative to its top position. 47 */ setTranslationY(float translationY)48 void setTranslationY(float translationY); 49 50 51 /** 52 * Provides corpus from which search results must be returned. 53 */ 54 interface WidgetsSearchDataProvider { 55 /** 56 * Returns the widgets from which the search should return the results. 57 */ getWidgets()58 List<WidgetsListBaseEntry> getWidgets(); 59 } 60 } 61