1 /*
2  * Copyright (C) 2024 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;
18 
19 /**
20  * This interface should be implemented for any container/view that has a CellLayout as a children.
21  */
22 public interface CellLayoutContainer {
23 
24     /**
25      * Get the CellLayoutId for the given cellLayout.
26      */
getCellLayoutId(CellLayout cellLayout)27     int getCellLayoutId(CellLayout cellLayout);
28 
29     /**
30      * Get the index of the given CellLayout out of all the other CellLayouts.
31      */
getCellLayoutIndex(CellLayout cellLayout)32     int getCellLayoutIndex(CellLayout cellLayout);
33 
34     /**
35      * The total number of CellLayouts in the container.
36      */
getPanelCount()37     int getPanelCount();
38 
39     /**
40      * Used for accessibility, it returns the string that the assistant is going to say when
41      * referring to the given CellLayout.
42      */
getPageDescription(int pageIndex)43     String getPageDescription(int pageIndex);
44 }
45