Merge pull request #112 from Omega-R/develop

Expandable recyclerview

Author: anton-knyazev

.gitignore

@@ -1,8 +1,14 @@
 *.iml
 .gradle
 /local.properties
-/.idea/workspace.xml
+/.idea/assetWizardSettings.xml
+/.idea/caches
 /.idea/libraries
+/.idea/dictionaries
+/.idea/misc.xml
+/.idea/workspace.xml
+/.idea/markdown-navigator
+/.idea/markdown-navigator.xml
 .DS_Store
 /build
 /captures

.idea/misc.xml

@@ -289,6 +289,139 @@ setLongClickListener(@Nullable OnItemLongClickListener<T> longClickListener)
 ```
 You can subscribe to this event on the fly - all view holders will be notified.
 
+## Expandable
+<img src="/images/exp_fade_single.gif?raw=true" width="250" height="400" />    <img src="/images/exp_dd_single.gif?raw=true" width="250" height="400" />    <img src="/images/exp_dd_multi.gif?raw=true" width="250" height="400" />
+
+Adding OmegaExpandableRecyclerView to layout:
+```
+<com.omega_r.libs.omegarecyclerview.expandable_recycler_view.OmegaExpandableRecyclerView
+        android:id="@+id/recyclerview"
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        app:childAnimation="Dropdown"
+        app:expandMode="single"/>
+```
+
+Create adapter like following:
+```
+public class ExpandableAdapter extends OmegaExpandableRecyclerView.Adapter<QuoteGlobalInfo, String> {
+
+    @Override
+    protected ExGroupViewHolder provideGroupViewHolder(@NonNull ViewGroup viewGroup) {
+        return new ExGroupViewHolder(viewGroup);
+    }
+
+    @Override
+    protected ExChildViewHolder provideChildViewHolder(@NonNull ViewGroup viewGroup) {
+        return new ExChildViewHolder(viewGroup);
+    }
+
+    class ExGroupViewHolder extends GroupViewHolder {
+
+        private TextView textView;
+
+        ExGroupViewHolder(ViewGroup parent) {
+            super(parent, R.layout.item_exp_group);
+            textView = findViewById(R.id.textview_group_name);
+        }
+
+        @Override
+        protected void onExpand(GroupViewHolder viewHolder, int groupIndex) {
+            // nothing
+        }
+
+        @Override
+        protected void onCollapse(GroupViewHolder viewHolder, int groupIndex) {
+            // nothing
+        }
+
+        @Override
+        protected void onBind(QuoteGlobalInfo item) {
+            textView.setText(item.getTitle());
+        }
+    }
+
+    class ExChildViewHolder extends ChildViewHolder {
+
+        private TextView textView;
+
+        ExChildViewHolder(ViewGroup parent) {
+            super(parent, R.layout.item_exp_child);
+            textView = findViewById(R.id.textview_child_content);
+        }
+
+        @Override
+        protected void onBind(String item) {
+            textView.setText(item);
+        }
+    }
+}
+```
+
+Use one of the following methods to set items for adapter or use adapter constructors:
+```
+void setItems(@NonNull List<ExpandableViewData<G, CH>> expandableViewData)
+void setItems(ExpandableViewData<G, CH>... expandableViewData)
+void setItems(GroupProvider<G, CH>... groupProviders)
+```
+
+Your view data (group and childs) should be wrapped with ```ExpandableViewData``` using one of the following ways:
+```
+ExpandableViewData(G group, List<CH> childs, @Nullable Integer stickyId) // constructor
+
+static <G, CH> ExpandableViewData<G, CH> of(G group, @Nullable Integer stickyId, List<CH> childs)
+static <G, CH> ExpandableViewData<G, CH> of(G group, @Nullable Integer stickyId, CH... childs)
+```
+
+Or it should implement interface 
+```
+public interface GroupProvider<G, CH> {
+    G provideGroup();
+
+    List<CH> provideChilds();
+
+    @Nullable
+    Integer provideStickyId();
+}
+```
+
+You can set expandMode and childAnimation both with xml attr and programmatically
+
+*Available expandModes are single and multiple*
+
+*Available childAnimations are Dropdown and Fade*
+
+You can simply create your own animations by extending ```ExpandableItemAnimator``` class and then just set it to RecyclerView ```recyclerView.setItemAnimator```
+
+<img src="/images/exp_bg.gif?raw=true" width="250" height="400" />
+
+It is possible to emulate background expanding using "app:backgrounds" attribute.
+
+Create LevelListDrawable in res/drawable folder
+
+*expandable_backgrounds.xml*
+```
+<?xml version="1.0" encoding="utf-8"?>
+<level-list xmlns:android="http://schemas.android.com/apk/res/android">
+    <item android:maxLevel="@integer/backgroundGroupCollapsed" android:drawable="@drawable/group_collapsed" />
+    <item android:maxLevel="@integer/backgroundGroupExpanded" android:drawable="@drawable/group_expanded" />
+    <item android:maxLevel="@integer/backgroundFirstChild" android:drawable="@drawable/child_bg" />
+    <item android:maxLevel="@integer/backgroundLastChild" android:drawable="@drawable/child_last" />
+    <item android:maxLevel="@integer/backgroundChild" android:drawable="@drawable/child_bg" />
+</level-list>
+```
+
+And then just add ```app:backgrounds="@drawable/expandable_backgrounds"``` attribute to your OmegaExpandableRecyclerView
+
+<img src="/images/exp_sticky_sup.gif?raw=true" width="250" height="400" />   <img src="/images/exp_sticky_group.gif?raw=true" width="250" height="400" />   <img src="/images/exp_sticky_all.gif?raw=true" width="250" height="400" />
+
+OmegaExpandableRecyclerView have 2 ways of using Sticky Header feature: Default (that is described above in StickyHeader section) and StickyGroups. Last one is the way to make GroupViewHolders work as StickyHeaders.
+
+To do that just add ```app:stickyGroups="true"``` attribute to your OmegaExpandableRecyclerView and be sure that you set items providing unique ```stickyId``` for each group.
+
+And, of course, you CAN use both sticky behaviors at the same time
+
+
 # License
 ```
 The MIT License

README.md

@@ -22,6 +22,10 @@
         <activity android:name=".sections_example.SectionsActivity" />
         <activity android:name=".viewpager.ViewPagerActivity" />
         <activity android:name=".ListAdapterExample.ListAdapterActivity" />
+        <activity android:name=".expandable_example.core.ExpandableActivity" />
+        <activity android:name=".expandable_example.support_sticky.DefaultStickyExpandableActivity" />
+        <activity android:name=".expandable_example.ChooseExpandableActivity" />
+        <activity android:name=".expandable_example.sticky_groups.StickyGroupsActivity"></activity>
     </application>
 
 </manifest>

app/src/main/AndroidManifest.xml

@@ -19,6 +19,7 @@ protected void onCreate(Bundle savedInstanceState) {
         findViewById(R.id.button_sections).setOnClickListener(this);
         findViewById(R.id.button_viewpager).setOnClickListener(this);
         findViewById(R.id.button_list_adapter).setOnClickListener(this);
+        findViewById(R.id.button_expandable_recyclerview).setOnClickListener(this);
     }
 
     /**
@@ -27,6 +28,7 @@ protected void onCreate(Bundle savedInstanceState) {
      */
     @Override
     public void onClick(View view) {
+        
         switch (view.getId()) {
             case R.id.button_swipe_menu:
                 AppOmegaIntentBuilder.from(this)
@@ -70,6 +72,13 @@ public void onClick(View view) {
                         .createIntentHandler()
                         .startActivity();
                 break;
+            case R.id.button_expandable_recyclerview:
+                AppOmegaIntentBuilder.from(this)
+                        .appActivities()
+                        .chooseExpandableActivity()
+                        .createIntentHandler()
+                        .startActivity();
+                break;
         }
     }
 }

app/src/main/java/com/omega_r/omegarecyclerview/MainActivity.java

@@ -0,0 +1,43 @@
+package com.omega_r.omegarecyclerview.expandable_example;
+
+import android.os.Bundle;
+import android.support.v7.app.AppCompatActivity;
+import android.view.View;
+
+import com.omega_r.libs.omegaintentbuilder.AppOmegaIntentBuilder;
+import com.omega_r.omegarecyclerview.R;
+
+import omega.com.annotations.OmegaActivity;
+
+@OmegaActivity
+public class ChooseExpandableActivity extends AppCompatActivity implements View.OnClickListener {
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        setContentView(R.layout.activity_choose_expandable);
+
+        findViewById(R.id.button_core).setOnClickListener(this);
+        findViewById(R.id.button_sticky_support).setOnClickListener(this);
+    }
+
+    @Override
+    public void onClick(View v) {
+        switch (v.getId()) {
+            case R.id.button_core:
+                AppOmegaIntentBuilder.from(this)
+                        .appActivities()
+                        .expandableActivity()
+                        .createIntentHandler()
+                        .startActivity();
+                break;
+            case R.id.button_sticky_support:
+                AppOmegaIntentBuilder.from(this)
+                        .appActivities()
+                        .defaultStickyExpandableActivity()
+                        .createIntentHandler()
+                        .startActivity();
+                break;
+        }
+    }
+}