Finished adapter customization, added ability to put custom footer view

Author: kbiakov

codeview/src/main/java/io/github/kbiakov/codeview/CodeView.kt

@@ -16,7 +16,6 @@ import io.github.kbiakov.codeview.adapters.CodeWithNotesAdapter
 import io.github.kbiakov.codeview.highlight.ColorTheme
 import io.github.kbiakov.codeview.highlight.ColorThemeData
 import java.util.*
-import kotlin.reflect.KClass
 
 /**
  * @class CodeView
@@ -35,7 +34,7 @@ import kotlin.reflect.KClass
  *
  * @author Kirill Biakov
  */
-class CodeView<T> : RelativeLayout {
+class CodeView : RelativeLayout {
 
     private val vPlaceholder: View
     private val vShadowRight: View
@@ -57,6 +56,11 @@ class CodeView<T> : RelativeLayout {
      * (and awaiting for build) or view was built & code is presented.
      */
     private var state: ViewState
+        set(newState) {
+            if (newState == ViewState.PRESENTED)
+                hidePlaceholder()
+            field = newState
+        }
 
     /**
      * Default constructor.
@@ -99,53 +103,19 @@ class CodeView<T> : RelativeLayout {
     fun isPrepared() = state == ViewState.PREPARE
     fun isPresented() = state == ViewState.PRESENTED
 
-    /**
-     * TODO
-     */
-    private var AdapterClass: KClass<out AbstractCodeAdapter<T>>? = null
-
-    fun registerAdapterClass(adapterClass: KClass<out AbstractCodeAdapter<T>>) {
-        if (state == ViewState.BUILD)
-            AdapterClass = adapterClass
-        else throw RuntimeException("CodeView is already registered with " +
-                "${AdapterClass?.simpleName} class name. Please, check the build flow.")
-    }
-
-    fun registerAdapterClass(adapterClass: Class<out AbstractCodeAdapter<T>>) =
-            registerAdapterClass(adapterClass.kotlin)
-
     /**
      * Accessor/mutator to reduce frequently used actions.
      */
-    private var adapter: AbstractCodeAdapter<T>
+    var adapter: AbstractCodeAdapter<*>
         get() {
-            return rvCodeContent.adapter as AbstractCodeAdapter<T>
+            return rvCodeContent.adapter as AbstractCodeAdapter<*>
         }
         set(adapter) {
-            rvCodeContent.adapter = adapter
-            state = ViewState.PRESENTED
-        }
-
-    /**
-     * TODO
-     */
-    private fun createAdapter(content: String) =
-            (AdapterClass ?: CodeWithNotesAdapter::class)
-                .constructors
-                .first()
-                .call(context, content)
-
-    /**
-     * TODO
-     */
-    private fun setupInitAdapter(content: String) {
-        try {
-            rvCodeContent.adapter = createAdapter(content)
-        } catch (e: IllegalArgumentException) {
-            throw IllegalArgumentException("You're registered ${AdapterClass?.simpleName}, " +
-                    "but default constructor with 2 params (context & code content) not found.")
+            delayed { // to prevent UI overhead & initialization inconsistency
+                rvCodeContent.adapter = adapter
+                state = ViewState.PRESENTED
+            }
         }
-    }
 
     // - Build processor
 
@@ -156,7 +126,7 @@ class CodeView<T> : RelativeLayout {
      *
      * @param task Task to process
      */
-    private fun addTask(task: () -> Unit): CodeView<T> {
+    private fun addTask(task: () -> Unit): CodeView {
         when (state) {
             ViewState.BUILD ->
                 tasks.add(task)
@@ -237,25 +207,6 @@ class CodeView<T> : RelativeLayout {
         vShadowBottomContent.visibility = visibility
     }
 
-    /**
-     * Add entities to code snippet as footer.
-     *
-     * @param entities Map of entities (line number -> list of entities)
-     */
-    fun addFooterEntities(entities: HashMap<Int, List<T>>) = addTask {
-        adapter.footerEntities = entities
-    }
-
-    /**
-     * Add footer entity to code line.
-     *
-     * @param num Line number
-     * @param entity Entity content
-     */
-    fun addFooterEntity(num: Int, entity: T) = addTask {
-        adapter.addFooterEntity(num, entity)
-    }
-
     /**
      * Update code content if view was built or, finally, build code view.
      *
@@ -289,7 +240,7 @@ class CodeView<T> : RelativeLayout {
         state = ViewState.PREPARE
 
         delayed {
-            setupInitAdapter(content)
+            rvCodeContent.adapter = CodeWithNotesAdapter(context, content)
             processBuildTasks()
             setupShadows()
             hidePlaceholder()

codeview/src/main/java/io/github/kbiakov/codeview/adapters/AbstractCodeAdapter.kt

@@ -19,7 +19,7 @@ import java.util.*
 /**
  * @class AbstractCodeAdapter
  *
- * Adapter for code view.
+ * Basic adapter for code view.
  *
  * @author Kirill Biakov
  */
@@ -103,7 +103,7 @@ abstract class AbstractCodeAdapter<T> : RecyclerView.Adapter<AbstractCodeAdapter
         mLines = lines
     }
 
-    // - User interaction interface
+    // - Adapter interface
 
     /**
      * Update code with new content.
@@ -156,6 +156,15 @@ abstract class AbstractCodeAdapter<T> : RecyclerView.Adapter<AbstractCodeAdapter
         }
     }
 
+    /**
+     * Mapper from entity to footer view.
+     *
+     * @param context Context
+     * @param entity Entity to init view
+     * @return Footer view
+     */
+    abstract fun createFooter(context: Context, entity: T): View
+
     // - Helpers (for accessors)
 
     private fun updateContent(codeLines: List<String>, onUpdated: () -> Unit) {
@@ -175,7 +184,7 @@ abstract class AbstractCodeAdapter<T> : RecyclerView.Adapter<AbstractCodeAdapter
         updateContent(lines, onReady)
     }
 
-    internal fun showAllBottomNote() = mContext.getString(R.string.show_all)
+    private fun showAllBottomNote() = mContext.getString(R.string.show_all)
 
     private fun monoTypeface() = MonoFontCache.getInstance(mContext).typeface
 
@@ -206,13 +215,13 @@ abstract class AbstractCodeAdapter<T> : RecyclerView.Adapter<AbstractCodeAdapter
         }
 
         setupLine(position, codeLine, holder)
-        displayFooterEntities(position, holder)
+        displayLineFooter(position, holder)
         addExtraPadding(position, holder)
     }
 
     override fun getItemCount() = mLines.size
 
-    // Helpers (for view holder)
+    // - Helpers (for view holder)
 
     private fun setupLine(position: Int, line: String, holder: ViewHolder) {
         holder.tvLineContent.text = html(line)
@@ -227,7 +236,7 @@ abstract class AbstractCodeAdapter<T> : RecyclerView.Adapter<AbstractCodeAdapter
         }
     }
 
-    private fun displayFooterEntities(position: Int, holder: ViewHolder) {
+    private fun displayLineFooter(position: Int, holder: ViewHolder) {
         val entityList = footerEntities[position]
 
         holder.llLineFooter.removeAllViews()
@@ -243,40 +252,36 @@ abstract class AbstractCodeAdapter<T> : RecyclerView.Adapter<AbstractCodeAdapter
                 footerView.setPadding(dpToPx(mContext, 46), if (isFirst) dp8 else 0, dp8, dp8)
 
                 holder.llLineFooter.addView(footerView)
+
                 isFirst = false
             }
         }
     }
 
-    abstract fun createFooter(context: Context, entity: T): View
-
     private fun addExtraPadding(position: Int, holder: ViewHolder) {
         val dp8 = dpToPx(mContext, 8)
         val isFirst = position == 0
         val isLast = position == itemCount - 1
 
         if (isFirst || isLast) {
-            // holder.itemView.layoutParams.height = dp8 * 4
-
             val topPadding = if (isFirst) dp8 else 0
             val bottomPadding = if (isLast) dp8 else 0
             holder.tvLineNum.setPadding(0, topPadding, 0, bottomPadding)
             holder.tvLineContent.setPadding(0, topPadding, 0, bottomPadding)
         } else {
-            // holder.itemView.layoutParams.height = dp8 * 3
-
             holder.tvLineNum.setPadding(0, 0, 0, 0)
             holder.tvLineContent.setPadding(0, 0, 0, 0)
         }
-
-        // TODO: measure height
-        // holder.tvLineNum.layoutParams.height = holder.itemView.layoutParams.height
     }
 
     companion object {
         internal const val MAX_SHORTCUT_LINES = 6
     }
 
+    /**
+     * View holder for code adapter.
+     * Stores all views related to code line layout.
+     */
     class ViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
         var tvLineNum: TextView
         var tvLineContent: TextView

codeview/src/main/java/io/github/kbiakov/codeview/adapters/CodeWithNotesAdapter.kt

@@ -5,7 +5,11 @@ import io.github.kbiakov.codeview.highlight.color
 import io.github.kbiakov.codeview.views.LineNoteView
 
 /**
+ * @class CodeWithNotesAdapter
  *
+ * Default code content adapter.
+ *
+ * @author Kirill Biakov
  */
 class CodeWithNotesAdapter : AbstractCodeAdapter<String> {
     /**
@@ -14,14 +18,14 @@ class CodeWithNotesAdapter : AbstractCodeAdapter<String> {
     constructor(context: Context, content: String) : super(context, content)
 
     /**
-     * Add note to code line.
+     * Create footer view.
      *
-     * @param num Line number
+     * @param context Context
      * @param entity Note content
      */
     override fun createFooter(context: Context, entity: String) =
             LineNoteView.create(context,
-                    noteText = entity,
+                    text = entity,
                     bgColor = colorTheme.bgNum.color(),
                     textColor = colorTheme.noteColor.color())
 }

codeview/src/main/java/io/github/kbiakov/codeview/views/LineNoteView.kt

@@ -4,7 +4,9 @@ import android.content.Context
 import android.widget.TextView
 
 /**
- * Simple note view for code line.
+ * @class LineNoteView
+ *
+ * Note view for code line. Default footer view.
  *
  * @author Kirill Biakov
  */
@@ -15,15 +17,15 @@ class LineNoteView(context: Context?) : TextView(context) {
          * Simple factory method to create note view.
          *
          * @param context Context
-         * @param noteText Note text
+         * @param text Note text
          * @param bgColor Background color
          * @param textColor Text Color
          * @return Created line note view
          */
-        fun create(context: Context, noteText: String, bgColor: Int, textColor: Int): LineNoteView {
+        fun create(context: Context, text: String, bgColor: Int, textColor: Int): LineNoteView {
             val noteView = LineNoteView(context)
             noteView.textSize = 12f
-            noteView.text = noteText
+            noteView.text = text
             noteView.setTextColor(textColor)
             noteView.setBackgroundColor(bgColor)
 

example/src/main/java/io/github/kbiakov/codeviewexample/CustomAdapter.java

@@ -0,0 +1,44 @@
+package io.github.kbiakov.codeviewexample;
+
+import android.content.Context;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.widget.TextView;
+
+import org.jetbrains.annotations.NotNull;
+
+import io.github.kbiakov.codeview.adapters.AbstractCodeAdapter;
+
+public class CustomAdapter extends AbstractCodeAdapter<CustomAdapter.CustomModel> {
+
+    public CustomAdapter(@NotNull Context context, @NotNull String content) {
+        super(context, content, true, 10, context.getString(R.string.show_all), null);
+    }
+
+    @NotNull
+    @Override
+    public View createFooter(@NotNull Context context, CustomModel entity) {
+        View footerView = LayoutInflater.from(context).inflate(R.layout.custom_footer, null);
+        ((TextView) footerView.findViewById(R.id.tv_footer_title)).setText(entity.firstName);
+        ((TextView) footerView.findViewById(R.id.tv_footer_description)).setText(entity.lastName);
+        return footerView;
+    }
+
+    public static class CustomModel {
+        private String firstName;
+        private String lastName;
+
+        public CustomModel(String firstName, String lastName) {
+            this.firstName = firstName;
+            this.lastName = lastName;
+        }
+
+        public String getFirstName() {
+            return firstName;
+        }
+
+        public String getLastName() {
+            return lastName;
+        }
+    }
+}