feat: ability to set custom PageTransformer

ilchenko-peter · ilchenko-peter · commit 246467cdb70c · 2016-09-21T16:08:31.000+03:00
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ All you need to do is:
 First, add gradle dependency into your build.gradle:
 ```groovy
 dependencies {
-    compile 'com.cleveroad:slidingtutorial:1.0.3'
+    compile 'com.cleveroad:slidingtutorial:1.0.4'
 }
 ``` 
 
diff --git a/build.gradle b/build.gradle
@@ -5,7 +5,7 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:2.1.0'
+        classpath 'com.android.tools.build:gradle:2.2.0'
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }
diff --git a/gradle.properties b/gradle.properties
@@ -1,5 +1,5 @@
-VERSION_NAME=1.0.3
-VERSION_CODE=13
+VERSION_NAME=1.0.4
+VERSION_CODE=14
 GROUP=com.cleveroad
 
 POM_DESCRIPTION=Sliding tutorial is simple library that help other developers easy create great tutotial
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
-#Thu Aug 18 11:11:03 EEST 2016
+#Wed Sep 21 09:37:23 EEST 2016
 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
+distributionUrl=https\://services.gradle.org/distributions/gradle-2.14.1-all.zip
diff --git a/lib/build.gradle b/lib/build.gradle
@@ -7,8 +7,8 @@ android {
     defaultConfig {
         minSdkVersion 14
         targetSdkVersion 24
-        versionCode 12
-        versionName "1.0.2"
+        versionCode 14
+        versionName "1.0.4"
     }
     buildTypes {
         release {
@@ -22,7 +22,7 @@ android {
 
 dependencies {
     compile fileTree(dir: 'libs', include: ['*.jar'])
-    compile 'com.android.support:support-v4:24.2.0'
+    compile 'com.android.support:support-v4:24.2.1'
 }
 
 apply from: './gradle-mvn-push.gradle'
diff --git a/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialImpl.java b/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialImpl.java
@@ -295,6 +295,11 @@ public void transformPage(View view, float position) {
             if (obj instanceof PageImpl) {
                 ((PageImpl) obj).transformPage(view.getWidth(), position);
             }
+
+            ViewPager.PageTransformer userPageTransformer = mTutorialOptions.getPageTransformer();
+            if(userPageTransformer != null) {
+                userPageTransformer.transformPage(view, position);
+            }
         }
     }
 
diff --git a/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java b/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java
@@ -26,6 +26,7 @@
 import android.content.Context;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
+import android.support.v4.view.ViewPager;
 import android.view.View;
 
 /**
@@ -41,13 +42,16 @@ public final class TutorialOptions {
     private View.OnClickListener mOnSkipClickListener;
     private IndicatorOptions mIndicatorOptions;
     private TutorialPageProvider mTutorialPageProvider;
+    private ViewPager.PageTransformer mPageTransformer;
 
     @SuppressWarnings("unchecked")
     static TutorialOptions create(@NonNull Builder builder) {
-        return new TutorialOptions(builder.isUseAutoRemoveTutorialFragment(),
+        TutorialOptions tutorialOptions =  new TutorialOptions(builder.isUseAutoRemoveTutorialFragment(),
                 builder.isUseInfiniteScroll(), builder.getPagesCount(), builder.getPagesColors(),
                 builder.getOnSkipClickListener(), builder.getTutorialPageProvider(),
                 builder.getIndicatorOptions());
+        tutorialOptions.mPageTransformer = builder.mPageTransformer;
+        return tutorialOptions;
     }
 
     private TutorialOptions(boolean autoRemoveTutorialFragment, boolean useInfiniteScroll,
@@ -96,6 +100,11 @@ TutorialPageProvider getTutorialPageProvider() {
         return mTutorialPageProvider;
     }
 
+    @Nullable
+    ViewPager.PageTransformer getPageTransformer() {
+        return mPageTransformer;
+    }
+
     /**
      * Create new {@link TutorialOptions.Builder} instance.
      *
@@ -120,6 +129,7 @@ public final static class Builder<TFragment> {
         private IndicatorOptions mIndicatorOptions;
         private TutorialPageProvider<TFragment> mTutorialPageProvider;
         private Context mContext;
+        private ViewPager.PageTransformer mPageTransformer;
 
         private Builder(@NonNull Context context, Class<TFragment> aClass) {
             mContext = ValidationUtil.checkNotNull(context);
@@ -266,6 +276,22 @@ public Builder<TFragment> setTutorialPageProvider(@NonNull TutorialPageProvider<
             return this;
         }
 
+        /**
+         * Set a {@link ViewPager.PageTransformer} that will be called for each attached page whenever
+         * the scroll position is changed. This allows the application to apply custom property
+         * transformations to each page, overriding the default sliding look and feel.
+         *
+         * <p><em>Note:</em> Prior to Android 3.0 the property animation APIs did not exist.
+         * As a result, setting a PageTransformer prior to Android 3.0 (API 11) will have no effect.</p>
+         * @param pageTransformer PageTransformer that will modify each page's animation properties
+         * @return current {@link Builder}
+         * @see ViewPager#setPageTransformer(boolean, ViewPager.PageTransformer)
+         */
+        public Builder<TFragment> setPageTransformer(ViewPager.PageTransformer pageTransformer) {
+            mPageTransformer = pageTransformer;
+            return this;
+        }
+
         /**
          * Create {@link TutorialOptions} instance based on specified parameters in {@link Builder}.
          *

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ All you need to do is:`
`31`	`31`	`First, add gradle dependency into your build.gradle:`
`32`	`32`	```groovy
`33`	`33`	`dependencies {`
`34`		`- compile 'com.cleveroad:slidingtutorial:1.0.3'`
	`34`	`+ compile 'com.cleveroad:slidingtutorial:1.0.4'`
`35`	`35`	`}`
`36`	`36`	```
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ buildscript {`
`5`	`5`	`jcenter()`
`6`	`6`	`}`
`7`	`7`	`dependencies {`
`8`		`- classpath 'com.android.tools.build:gradle:2.1.0'`
	`8`	`+ classpath 'com.android.tools.build:gradle:2.2.0'`
`9`	`9`	`// NOTE: Do not place your application dependencies here; they belong`
`10`	`10`	`// in the individual module build.gradle files`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -295,6 +295,11 @@ public void transformPage(View view, float position) {`
`295`	`295`	`if (obj instanceof PageImpl) {`
`296`	`296`	`((PageImpl) obj).transformPage(view.getWidth(), position);`
`297`	`297`	`}`
	`298`	`+`
	`299`	`+ ViewPager.PageTransformer userPageTransformer = mTutorialOptions.getPageTransformer();`
	`300`	`+ if(userPageTransformer != null) {`
	`301`	`+ userPageTransformer.transformPage(view, position);`
	`302`	`+ }`
`298`	`303`	`}`
`299`	`304`	`}`
`300`	`305`