SectionCursorAdapter   

SectionCursorAdapter adds sections and fast scroll to CursorAdapter as an easily implementable feature. A blog post on the implementation rational can be found on toastdroid.com

2.0.0 Branch

This is the 2.0 Branch. The readme will not be update because this is an in between ListView and RecyclerView branch which bases everything on ViewHolders. Release 3.0 will have an updated readme. Everything here has been pretty well tested but there is more likely to be bugs.

Changelog

• These adapters are still for ListView, not RecyclerView.
• newView() and bindView() have been replaced with createViewHolder and bindViewHolder.
• Views are automatically created for you and tagged. In other words, ALL recycling is done for you! Checkout the sample app on this branch for examples on implementing this. If you want to create your own Views, then just override newView. Just remember to tag your own views.
• Generics have been implemented. When your handed an object in bindViewHolder you no longer need to cast it.
• Sections are not limited to the Cursor. Therefore SectionArrayAdapter has been built. It helps you build setions just like SectionCursorAdapter does and also lets you set your own map. Both Arrays and Lists are supported. FastScroll has been implemented and is free.
• Awesome ViewHolder recycling is not limited to Adapters that use sections. Therefore NonSectioningArrayAdapter has been build just for that. It gives you all the sweet ViewHolder stuff and extends ArrayAdapter.
• No one wants to convert stuff onItemClick to figureout want has actually been clicked. Therefore each Adapter now has it's own special OnItemClickListener you can implement which converts positions and gives you objects for those positions. All in package com.twotoasters.sectioncursoradapter.adapter.ItemClickListeners.

Future!

• All of these adapters will be updated when RecyclerView is officially released to support it.
• Readme will be updated after RecyclerView is officially released.
• Updated sample app will be on the play store after RecyclerView is officially released. Note that the sample app in the branch is updated but does not show off the other adapters.
• Tests for the new adapters after RecyclerView is officially released.
• ToastDroid will be updated and a post on the new Adapters or RecyclerView or something will be up after, you guessed it, RecyclerView is officially released.

Download

Sample

If you are using maven add to your pom file:

<dependency>
    <groupId>com.twotoasters.SectionCursorAdapter</groupId>
    <artifactId>library</artifactId>
    <version>2.0.0</version>
</dependency>

or if you are using Gradle:

dependencies {
    compile 'com.twotoasters.SectionCursorAdapter:library:2.0.+'
}

Basics - Concepts are good but view stuff is out of date.

SectionCursorAdapter is implemented in a similar way to Android's CursorAdapter which it extends. Instead of having newView and bindView the SectionCursorAdpater uses newSectionView and bindSectionView plus newItemView and bindItemView.

There is one additional abstract method Object getSectionFromCursor(Cursor cursor). This is the method tells the adapter how to remap the cursor positions to allow for sections. The object which is returned is then passed through to newSectionView and bindSectionView. You can make an alphabitical adapter with the following method. Noob tip: You will have to sort alphabitically when querying your database for your cursor.

@Override
protected Object getSectionFromCursor(Cursor cursor) {
    int columnIndex = cursor.getColumnIndex(StoreModel.NAME);
    String name = cursor.getString(columnIndex);
    return name.toUpperCase().substring(0, 1);
}

If you prefer to use the onItemClickListenter instead of using click listeners when binding your views you'll more then likely need to convert your position to a cursorPosition.

listView.setOnItemClickListener(new OnItemClickListener() {
    @Override
    public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
        MyAdapter adapter = (MyAdapter) parent.getAdapter();
        Object sectionObject = adapter.getItem(position);
        int cursorPosition = adapter.getCursorPositionWithoutSections(position);

        if (adapter.isSection(position) && sectionObject != null) {
            // Handle the section being clicked on.
            Log.i("SCA", "Section: " + sectionObject);
        } else if (cursorPosition != SectionCursorAdapter.NO_CURSOR_POSITION) {
            // Handle the cursor item being clicked on.
            Log.i("SCA", "CursorPosition: " + cursorPosition);
        }
    }
});

Advanced

To build sections in a more advanced way you can override buildSections. The following is an example for how to build a simple alphabitical map.

@Override
protected SortedMap<Integer, Object> buildSections(Cursor cursor) {
    TreeMap<Integer, Object> sections = new TreeMap<>();
    int columnIndex = cursor.getColumnIndex(StoreModel.NAME);
    int cursorPosition = 0;
        
    while (cursor.moveToNext()) {
        String name = cursor.getString(columnIndex);
        String section = name.toUpperCase().substring(0, 1);
        if (!sections.containsValue(section)) {
            sections.put(cursorPosition + sections.size(), section);
        }
        cursorPosition++;
    }
    return sections;
}

You can give a custom object as a value in the map instead of a number or string. To use the fast scroll with this object override toString. This will allow you to control what is displayed in the fast scroll dialog. Note that in versions of Android before KitKat this dialog does not resize to fit content. SectionCursorAdapter by default only allows a maximum of 3 characters in this dialog on these older version of Android, but by overriding getMaxIndexerLength() the length can be whatever you choose.

License

Copyright 2014 Two Toasters

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.