Repository: Batterii/PagingRecycler Branch: master Commit: 5e281eeb0ae0 Files: 20 Total size: 23.5 KB Directory structure: gitextract_s3c1ibv1/ ├── .gitignore ├── README.md ├── build.gradle ├── gradle/ │ └── wrapper/ │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradle.properties ├── gradlew ├── gradlew.bat ├── library/ │ ├── .gitignore │ ├── build.gradle │ ├── proguard-rules.pro │ └── src/ │ ├── androidTest/ │ │ └── java/ │ │ └── com/ │ │ └── akiniyalocts/ │ │ └── pagingrecycler/ │ │ └── ApplicationTest.java │ ├── main/ │ │ ├── AndroidManifest.xml │ │ ├── java/ │ │ │ └── com/ │ │ │ └── akiniyalocts/ │ │ │ └── pagingrecycler/ │ │ │ ├── PagingAdapter.java │ │ │ └── PagingDelegate.java │ │ └── res/ │ │ └── values/ │ │ ├── colors.xml │ │ ├── strings.xml │ │ └── styles.xml │ └── test/ │ └── java/ │ └── com/ │ └── akiniyalocts/ │ └── pagingrecycler/ │ └── ExampleUnitTest.java └── settings.gradle ================================================ FILE CONTENTS ================================================ ================================================ FILE: .gitignore ================================================ target/ .classpath .project .settings/ gen/ bin/ local.properties .metadata/ *.class *.apk *.res *.dex *.iml ButtercupMobile/out .idea .gradle/ ButtercupMobile/obj .gradle local.properties .DS_Store build/ *.iml .idea/ *.swp com_crashlytics_export_strings.xml crashlytics-build.properties ajcore.* .navgation/ ================================================ FILE: README.md ================================================ # PagingRecycler [![](https://jitpack.io/v/Batterii/PagingRecycler.svg)](https://jitpack.io/#Batterii/PagingRecycler) A quick way to implement a paging pattern for a RecyclerView. PagingRecycler will show a "loading" view at the bottom of your RecyclerView while you are waiting for a page of results from your api call, then remove it when you are finished. ### Gradle ```gradle allprojects { repositories { ... maven { url "https://jitpack.io" } } } dependencies { compile 'com.github.Batterii:PagingRecycler:v1.1.1' } ``` ## Usage ### Adapter ```java public class MyAdapter extends PagingAdapter{ private List myItems; public MyAdapter(){ myItems = new ArrayList<>(); } @Override public int getPagingLayout() { return R.layout.paging_item; } @Override public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) { // Do your normal view creation // End with this return super.onCreateViewHolder(parent, viewType); } @Override public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) { // Call super! super.onBindViewHolder(holder, position); // Do your normal binding } @Override public int getItemCount() { // just return super here return super.getItemCount(); } @Override public int getPagingItemCount() { // return your actual item size here return myItems.size(); } } ``` ### Your Activity/Fragment etc. ```java public class MyActivity extends AppCompatActivity implements PagingDelegate.OnPageListener{ @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); MyAdapter adapter = new MyAdapter(); RecyclerView mRecycler = (RecyclerView)findViewById(R.id.my_recycler); PagingDelegate pagingDelegate = new PagingDelegate.Builder(adapter) .attachTo(mRecycler) .listenWith(this) .build(); mRecycler.setAdapter(adapter); } @Override public void onPage(int offset) { // Perform your paging request } @Override public void onDonePaging() { } } ``` License -------- 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. ================================================ FILE: build.gradle ================================================ // Top-level build file where you can add configuration options common to all sub-projects/modules. buildscript { repositories { jcenter() } dependencies { classpath 'com.android.tools.build:gradle:1.5.0' // NOTE: Do not place your application dependencies here; they belong // in the individual module build.gradle files } } allprojects { repositories { jcenter() } } task clean(type: Delete) { delete rootProject.buildDir } ================================================ FILE: gradle/wrapper/gradle-wrapper.properties ================================================ #Mon Dec 28 10:00:20 PST 2015 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists distributionUrl=https\://services.gradle.org/distributions/gradle-2.10-all.zip ================================================ FILE: gradle.properties ================================================ # Project-wide Gradle settings. # IDE (e.g. Android Studio) users: # Gradle settings configured through the IDE *will override* # any settings specified in this file. # For more details on how to configure your build environment visit # http://www.gradle.org/docs/current/userguide/build_environment.html # Specifies the JVM arguments used for the daemon process. # The setting is particularly useful for tweaking memory settings. # Default value: -Xmx10248m -XX:MaxPermSize=256m # org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8 # When configured, Gradle will run in incubating parallel mode. # This option should only be used with decoupled projects. More details, visit # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects # org.gradle.parallel=true ================================================ FILE: gradlew ================================================ #!/usr/bin/env bash ############################################################################## ## ## Gradle start up script for UN*X ## ############################################################################## # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. DEFAULT_JVM_OPTS="" APP_NAME="Gradle" APP_BASE_NAME=`basename "$0"` # Use the maximum available, or set MAX_FD != -1 to use that value. MAX_FD="maximum" warn ( ) { echo "$*" } die ( ) { echo echo "$*" echo exit 1 } # OS specific support (must be 'true' or 'false'). cygwin=false msys=false darwin=false case "`uname`" in CYGWIN* ) cygwin=true ;; Darwin* ) darwin=true ;; MINGW* ) msys=true ;; esac # Attempt to set APP_HOME # Resolve links: $0 may be a link PRG="$0" # Need this for relative symlinks. while [ -h "$PRG" ] ; do ls=`ls -ld "$PRG"` link=`expr "$ls" : '.*-> \(.*\)$'` if expr "$link" : '/.*' > /dev/null; then PRG="$link" else PRG=`dirname "$PRG"`"/$link" fi done SAVED="`pwd`" cd "`dirname \"$PRG\"`/" >/dev/null APP_HOME="`pwd -P`" cd "$SAVED" >/dev/null CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar # Determine the Java command to use to start the JVM. if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables JAVACMD="$JAVA_HOME/jre/sh/java" else JAVACMD="$JAVA_HOME/bin/java" fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else JAVACMD="java" which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi # Increase the maximum file descriptors if we can. if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then MAX_FD_LIMIT=`ulimit -H -n` if [ $? -eq 0 ] ; then if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then MAX_FD="$MAX_FD_LIMIT" fi ulimit -n $MAX_FD if [ $? -ne 0 ] ; then warn "Could not set maximum file descriptor limit: $MAX_FD" fi else warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" fi fi # For Darwin, add options to specify how the application appears in the dock if $darwin; then GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" fi # For Cygwin, switch paths to Windows format before running java if $cygwin ; then APP_HOME=`cygpath --path --mixed "$APP_HOME"` CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` JAVACMD=`cygpath --unix "$JAVACMD"` # We build the pattern for arguments to be converted via cygpath ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` SEP="" for dir in $ROOTDIRSRAW ; do ROOTDIRS="$ROOTDIRS$SEP$dir" SEP="|" done OURCYGPATTERN="(^($ROOTDIRS))" # Add a user-defined pattern to the cygpath arguments if [ "$GRADLE_CYGPATTERN" != "" ] ; then OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" fi # Now convert the arguments - kludge to limit ourselves to /bin/sh i=0 for arg in "$@" ; do CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` else eval `echo args$i`="\"$arg\"" fi i=$((i+1)) done case $i in (0) set -- ;; (1) set -- "$args0" ;; (2) set -- "$args0" "$args1" ;; (3) set -- "$args0" "$args1" "$args2" ;; (4) set -- "$args0" "$args1" "$args2" "$args3" ;; (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; esac fi # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules function splitJvmOpts() { JVM_OPTS=("$@") } eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" ================================================ FILE: gradlew.bat ================================================ @if "%DEBUG%" == "" @echo off @rem ########################################################################## @rem @rem Gradle startup script for Windows @rem @rem ########################################################################## @rem Set local scope for the variables with windows NT shell if "%OS%"=="Windows_NT" setlocal @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. set DEFAULT_JVM_OPTS= set DIRNAME=%~dp0 if "%DIRNAME%" == "" set DIRNAME=. set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% @rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 if "%ERRORLEVEL%" == "0" goto init echo. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. echo. echo Please set the JAVA_HOME variable in your environment to match the echo location of your Java installation. goto fail :findJavaFromJavaHome set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe if exist "%JAVA_EXE%" goto init echo. echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% echo. echo Please set the JAVA_HOME variable in your environment to match the echo location of your Java installation. goto fail :init @rem Get command-line arguments, handling Windowz variants if not "%OS%" == "Windows_NT" goto win9xME_args if "%@eval[2+2]" == "4" goto 4NT_args :win9xME_args @rem Slurp the command line arguments. set CMD_LINE_ARGS= set _SKIP=2 :win9xME_args_slurp if "x%~1" == "x" goto execute set CMD_LINE_ARGS=%* goto execute :4NT_args @rem Get arguments from the 4NT Shell from JP Software set CMD_LINE_ARGS=%$ :execute @rem Setup the command line set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar @rem Execute Gradle "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% :end @rem End local scope for the variables with windows NT shell if "%ERRORLEVEL%"=="0" goto mainEnd :fail rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of rem the _cmd.exe /c_ return code! if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 exit /b 1 :mainEnd if "%OS%"=="Windows_NT" endlocal :omega ================================================ FILE: library/.gitignore ================================================ target/ .classpath .project .settings/ gen/ bin/ local.properties .metadata/ *.class *.apk *.res *.dex *.iml ButtercupMobile/out .idea .gradle/ ButtercupMobile/obj .gradle local.properties .DS_Store build/ *.iml .idea/ *.swp com_crashlytics_export_strings.xml crashlytics-build.properties ajcore.* .navgation/ /build ================================================ FILE: library/build.gradle ================================================ apply plugin: 'com.android.library' android { compileSdkVersion 25 buildToolsVersion "25.0.2" defaultConfig { minSdkVersion 15 targetSdkVersion 25 versionCode 1 versionName "1.0" } buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } } dependencies { compile fileTree(dir: 'libs', include: ['*.jar']) testCompile 'junit:junit:4.12' compile 'com.android.support:appcompat-v7:25.3.0' compile 'com.android.support:recyclerview-v7:25.3.0' } ================================================ FILE: library/proguard-rules.pro ================================================ # Add project specific ProGuard rules here. # By default, the flags in this file are appended to flags specified # in /Users/anthonykiniyalocts/Library/Android/sdk/tools/proguard/proguard-android.txt # You can edit the include path and order by changing the proguardFiles # directive in build.gradle. # # For more details, see # http://developer.android.com/guide/developing/tools/proguard.html # Add any project specific keep options here: # If your project uses WebView with JS, uncomment the following # and specify the fully qualified class name to the JavaScript interface # class: #-keepclassmembers class fqcn.of.javascript.interface.for.webview { # public *; #} ================================================ FILE: library/src/androidTest/java/com/akiniyalocts/pagingrecycler/ApplicationTest.java ================================================ package com.akiniyalocts.pagingrecycler; import android.app.Application; import android.test.ApplicationTestCase; /** * Testing Fundamentals */ public class ApplicationTest extends ApplicationTestCase { public ApplicationTest() { super(Application.class); } } ================================================ FILE: library/src/main/AndroidManifest.xml ================================================ ================================================ FILE: library/src/main/java/com/akiniyalocts/pagingrecycler/PagingAdapter.java ================================================ package com.akiniyalocts.pagingrecycler; import android.os.Handler; import android.support.v7.widget.RecyclerView; import android.support.v7.widget.StaggeredGridLayoutManager; import android.view.LayoutInflater; import android.view.View; import android.view.ViewGroup; /** * Created by AKiniyalocts on 3/21/16. * * An extension of @see android.support.v7.widget.RecyclerView.Adapter that simplifies the common * "paging" pattern we see in clients. @see PagingDelegate */ public abstract class PagingAdapter extends RecyclerView.Adapter{ // View tag for paging view public static int VIEW_TYPE_PAGING = -100; private final Handler postHandler; // Empty ViewHolder for paging view static class LoadingViewHolder extends RecyclerView.ViewHolder{ public LoadingViewHolder(View itemView) { super(itemView); } } // Are we currently paging? protected boolean paging = false; /** * @see PagingDelegate */ private PagingDelegate pagingDelegate; public PagingAdapter() { postHandler = new Handler(); } /** * Provide the layout you wish to inflate when the adapter is loading * @return R.layout.your_loading_layout */ public abstract int getPagingLayout(); /** * Provide a count of items in your adapter. Use this instead of getItemCount(); * @return itemCount */ public abstract int getPagingItemCount(); public void setPagingDelegate(PagingDelegate pagingDelegate) { this.pagingDelegate = pagingDelegate; } /** * Notify the adapter that it is paging by inserting an new item at the index of * @see android.support.v7.widget.RecyclerView.Adapter getItemCount() + 1 */ public void setPaging(){ if(!paging) { paging = true; final Runnable r = new Runnable() { public void run() { PagingAdapter.this.notifyItemInserted(getItemCount() + 1); } }; postHandler.post(r); } } /** * If the adapter is paging, return the original item size + 1 to account for the new paging view * in the RecyclerView. Otherwise, return item amount. * @return int currentItemCount */ @Override public int getItemCount() { return paging ? getPagingItemCount() + 1: getPagingItemCount(); } /** * Notify the adapter that it is done paging by removing the previously added item * at the index of @see android.support.v7.widget.RecyclerView.Adapter getItemCount() + 1 */ public void donePaging(){ paging = false; notifyItemRemoved(getItemCount() + 1); } /** * Get the appropriate viewType for the recycler. If we are paging we return @see VIEW_TYPE_PAGING, * otherwise super it out. * @param position position in adapter * @return viewType */ @Override public int getItemViewType(int position) { if(paging){ return VIEW_TYPE_PAGING; } return super.getItemViewType(position); } /** * If there is a LoadingViewHolder in this position, inflate the view from getPagingLayout() * @param parent * @param viewType * @return LoadingViewHolder */ @Override public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) { if(viewType == VIEW_TYPE_PAGING){ View itemView = LayoutInflater.from(parent.getContext()).inflate(getPagingLayout(), parent, false); return new PagingAdapter.LoadingViewHolder(itemView); } return null; } /** * If the PagingDelegate isFullSpanLoadingView(), then we should check to make sure its a StaggeredGrid, and then set * the span to full size. * @param holder * @param position */ @Override public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) { if(getItemViewType(position) == VIEW_TYPE_PAGING){ if(pagingDelegate != null) { if(pagingDelegate.isFullspanLoadingView()) { if (pagingDelegate.getRecyclerView().getLayoutManager() instanceof StaggeredGridLayoutManager) { StaggeredGridLayoutManager.LayoutParams layoutParams = (StaggeredGridLayoutManager.LayoutParams) holder.itemView.getLayoutParams(); layoutParams.setFullSpan(true); } } } } } } ================================================ FILE: library/src/main/java/com/akiniyalocts/pagingrecycler/PagingDelegate.java ================================================ package com.akiniyalocts.pagingrecycler; import android.support.v7.widget.RecyclerView; /** * Intermediates between your @see PagingAdapter and your Activity. * * Create a new PagingDelegate with @see PagingDelegate.Builder(); */ public class PagingDelegate extends RecyclerView.OnScrollListener{ // Callbacks for when to page private OnPageListener onPageListener; // RecyclerView adapter attached private PagingAdapter pagingAdapter; private RecyclerView recyclerView; // Should the paging view span the entire list? private boolean fullspanLoadingView; // Automatically show the paging view private boolean autoPage; // Automatically hide the paging view private boolean autoCancel; private PagingDelegate() {} public void attach(RecyclerView recyclerView, PagingAdapter pagingAdapter){ recyclerView.addOnScrollListener(this); this.pagingAdapter = pagingAdapter; } @Override public void onScrolled(RecyclerView recyclerView, int dx, int dy) { super.onScrolled(recyclerView, dx, dy); if(!recyclerView.canScrollVertically(1)){ onPageListener.onPage(pagingAdapter.getItemCount()); } } public void setPaging(){ pagingAdapter.setPaging(); } public void donePaging(){ pagingAdapter.donePaging(); } private void setOnPageListener(OnPageListener onPageListener) { this.onPageListener = onPageListener; } private void setPagingAdapter(PagingAdapter pagingAdapter) { this.pagingAdapter = pagingAdapter; } private void setRecyclerView(RecyclerView recyclerView) { this.recyclerView = recyclerView; recyclerView.addOnScrollListener(this); } private void setAutoPage(boolean autoPage) { this.autoPage = autoPage; } private void setAutoCancel(boolean autoCancel) { this.autoCancel = autoCancel; } private void setFullspanLoadingView(boolean fullspanLoadingView) { this.fullspanLoadingView = fullspanLoadingView; } public boolean isFullspanLoadingView() { return fullspanLoadingView; } public RecyclerView getRecyclerView() { return recyclerView; } public interface OnPageListener{ void onPage(int offset); void onDonePaging(); } public static class Builder{ private OnPageListener onPageListener; private PagingAdapter pagingAdapter; private RecyclerView recyclerView; private boolean autoPage = false; private boolean autoCancel = false; private boolean fullspanLoadingView = false; public Builder(PagingAdapter pagingAdapter){ this.setPagingAdapter(pagingAdapter); } public Builder listenWith(OnPageListener listener){ this.setOnPageListener(listener); return this; } public Builder attachTo(RecyclerView recyclerView){ this.setRecyclerView(recyclerView); return this; } public Builder spanLoadingView(boolean fullspanLoadingView){ this.fullspanLoadingView = fullspanLoadingView; return this; } public Builder autoPage(boolean autoPage){ this.setAutoPage(autoPage); return this; } public Builder autoStop(boolean autoStop){ this.setAutoCancel(autoStop); return this; } public PagingDelegate build(){ PagingDelegate pagingDelegate= new PagingDelegate(); pagingDelegate.setOnPageListener(this.onPageListener); pagingDelegate.setRecyclerView(this.recyclerView); pagingDelegate.setPagingAdapter(this.pagingAdapter); pagingDelegate.setAutoCancel(this.autoCancel); pagingDelegate.setAutoPage(this.autoPage); pagingDelegate.setFullspanLoadingView(this.fullspanLoadingView); return pagingDelegate; } private void setOnPageListener(OnPageListener onPageListener) { this.onPageListener = onPageListener; } private void setPagingAdapter(PagingAdapter pagingAdapter) { this.pagingAdapter = pagingAdapter; } private void setRecyclerView(RecyclerView recyclerView) { this.recyclerView = recyclerView; } private void setAutoPage(boolean autoPage) { this.autoPage = autoPage; } private void setAutoCancel(boolean autoCancel) { this.autoCancel = autoCancel; } } } ================================================ FILE: library/src/main/res/values/colors.xml ================================================ ================================================ FILE: library/src/main/res/values/strings.xml ================================================ PagingRecycler ================================================ FILE: library/src/main/res/values/styles.xml ================================================ ================================================ FILE: library/src/test/java/com/akiniyalocts/pagingrecycler/ExampleUnitTest.java ================================================ package com.akiniyalocts.pagingrecycler; import org.junit.Test; import static org.junit.Assert.*; /** * To work on unit tests, switch the Test Artifact in the Build Variants view. */ public class ExampleUnitTest { @Test public void addition_isCorrect() throws Exception { assertEquals(4, 2 + 2); } } ================================================ FILE: settings.gradle ================================================ include ':library'