Version 12.0.1

- Closes #37

- Closes #59. Devs may now extend the class Indicator if they'd like.

Author: turing-tech

lib/build.gradle

@@ -1,6 +1,6 @@
 apply plugin: 'com.android.library'
 
-def libVersion = '12.0.0'
+def libVersion = '12.0.1'
 
 android {
     compileSdkVersion 25

lib/src/main/java/com/turingtechnologies/materialscrollbar/AlphabetIndicator.java

@@ -31,30 +31,30 @@ public AlphabetIndicator (Context c){
     }
 
     @Override
-    String getTextElement(Integer currentSection, RecyclerView.Adapter adapter) {
+    protected String getTextElement(Integer currentSection, RecyclerView.Adapter adapter) {
         Character provided = ((INameableAdapter) adapter).getCharacterForElement(currentSection);
         return String.valueOf(Character.toUpperCase(provided));
     }
 
     @Override
-    int getIndicatorHeight() {
+    protected int getIndicatorHeight() {
         return 75;
     }
 
     @Override
-    int getIndicatorWidth() {
+    protected int getIndicatorWidth() {
         return 75;
     }
 
     @Override
-    void testAdapter(RecyclerView.Adapter adapter) {
+    protected void testAdapter(RecyclerView.Adapter adapter) {
         if(!(adapter instanceof INameableAdapter)){
             throw new CustomExceptions.AdapterNotSetupForIndicatorException(adapter.getClass(), "INameableAdapter");
         }
     }
 
     @Override
-    int getTextSize() {
+    protected int getTextSize() {
         return 40;
     }
 

lib/src/main/java/com/turingtechnologies/materialscrollbar/CustomIndicator.java

@@ -34,7 +34,7 @@ public CustomIndicator(Context context){
     }
 
     @Override
-    String getTextElement(Integer currentSection, RecyclerView.Adapter adapter) {
+    protected String getTextElement(Integer currentSection, RecyclerView.Adapter adapter) {
         String text = ((ICustomAdapter)adapter).getCustomStringForElement(currentSection);
         LayoutParams layoutParams = (LayoutParams) getLayoutParams();
         if(layoutParams == null){
@@ -52,24 +52,24 @@ String getTextElement(Integer currentSection, RecyclerView.Adapter adapter) {
     }
 
     @Override
-    int getIndicatorHeight() {
+    protected int getIndicatorHeight() {
         return 75;
     }
 
     @Override
-    int getIndicatorWidth() {
+    protected int getIndicatorWidth() {
         return 0;
     }
 
     @Override
-    void testAdapter(RecyclerView.Adapter adapter) {
+    protected void testAdapter(RecyclerView.Adapter adapter) {
         if(!(adapter instanceof ICustomAdapter)){
             throw new CustomExceptions.AdapterNotSetupForIndicatorException(adapter.getClass(), "ICustomAdapter");
         }
     }
 
     @Override
-    int getTextSize() {
+    protected int getTextSize() {
         return textSize;
     }
 

lib/src/main/java/com/turingtechnologies/materialscrollbar/FastScrollerUtil.java

@@ -59,7 +59,7 @@ public static void initHeaderScroller(RecyclerView rv)
     // IHeaderAdapter - helper functions
     // --------------------
 
-    private static Integer getSpanSize(RecyclerView rv)
+    public static Integer getSpanSize(RecyclerView rv)
     {
         final RecyclerView.LayoutManager lm = rv.getLayoutManager();
         if (lm != null && lm instanceof GridLayoutManager)

lib/src/main/java/com/turingtechnologies/materialscrollbar/Indicator.java

@@ -27,7 +27,11 @@
 import android.widget.RelativeLayout;
 import android.widget.TextView;
 
-abstract class Indicator extends RelativeLayout{
+/**
+ * Devs should not normally need to extend this class. Just use {@link CustomIndicator} instead.
+ * However, this is public to leave the option open.
+ */
+public abstract class Indicator extends RelativeLayout{
 
     protected TextView textView;
     protected Context context;
@@ -43,7 +47,7 @@ public Indicator(Context context) {
         setVisibility(INVISIBLE);
     }
 
-    public void setSizeCustom(int size){
+    void setSizeCustom(int size){
         if(addSpace){
            this.size =  size + Utils.getDP(10, this);
         } else {
@@ -140,14 +144,36 @@ void setTextColour(int colour){
         textView.setTextColor(colour);
     }
 
-    abstract String getTextElement(Integer currentSection, RecyclerView.Adapter adapter);
+    /**
+     * @param currentSection The section that the indicator is indicating for.
+     * @param adapter The adapter of the attached {@link RecyclerView}.
+     * @return The text that should go in the indicator.
+     */
+    protected abstract String getTextElement(Integer currentSection, RecyclerView.Adapter adapter);
 
-    abstract int getIndicatorHeight();
+    /**
+     * @return The height of the indicator in px. If it is variable return any value and resize
+     * the view yourself.
+     */
+    protected abstract int getIndicatorHeight();
 
-    abstract int getIndicatorWidth();
+    /**
+     * @return The width of the indicator in px. If it is variable return any value and resize
+     * the view yourself.
+     */
+    protected abstract int getIndicatorWidth();
 
-    abstract void testAdapter(RecyclerView.Adapter adapter);
+    /**
+     * This method should test the adapter to make sure that it implements the needed interface(s).
+     * See {@link AlphabetIndicator#testAdapter(RecyclerView.Adapter)} for form.
+     *
+     * @param adapter The adapter of the attached {@link RecyclerView}.
+     */
+    protected abstract void testAdapter(RecyclerView.Adapter adapter);
 
-    abstract int getTextSize();
+    /**
+     * @return The size of text in the indicator.
+     */
+    protected abstract int getTextSize();
 
 }