19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2008 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.widget; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Interface that should be implemented on Adapters to enable fast scrolling 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in an {@link AbsListView} between sections of the list. A section is a group of list items 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to jump to that have something in common. For example, they may begin with the 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * same letter or they may be songs from the same artist. 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic interface SectionIndexer { 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This provides the list view with an array of section objects. In the simplest 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * case these are Strings, each containing one letter of the alphabet. 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * They could be more complex objects that indicate the grouping for the adapter's 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * consumption. The list view will call toString() on the objects to get the 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * preview letter to display while scrolling. 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the array of objects that indicate the different sections of the list. 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Object[] getSections(); 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Provides the starting index in the list for a given section. 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param section the index of the section to jump to. 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the starting position of that section. If the section is out of bounds, the 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * position must be clipped to fall within the size of the list. 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int getPositionForSection(int section); 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This is a reverse mapping to fetch the section index for a given position 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in the list. 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param position the position for which to return the section 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the section index. If the position is out of bounds, the section index 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * must be clipped to fall within the size of the section array. 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int getSectionForPosition(int position); 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 53