add initScaleType, fix #20

Author: Piasy

.gitignore

@@ -6,3 +6,10 @@ bintray.properties
 .DS_Store
 **/build
 /captures
+
+.buckd
+.okbuck
+buck-out
+.buckconfig
+.buckconfig.local
+**/BUCK

BigImageViewer/src/main/java/com/github/piasy/biv/view/BigImageView.java

@@ -26,6 +26,7 @@
 
 import android.Manifest;
 import android.content.Context;
+import android.content.res.TypedArray;
 import android.net.Uri;
 import android.provider.MediaStore;
 import android.support.annotation.UiThread;
@@ -39,6 +40,7 @@
 import com.davemorrissey.labs.subscaleview.ImageSource;
 import com.davemorrissey.labs.subscaleview.SubsamplingScaleImageView;
 import com.github.piasy.biv.BigImageViewer;
+import com.github.piasy.biv.R;
 import com.github.piasy.biv.indicator.ProgressIndicator;
 import com.github.piasy.biv.loader.ImageLoader;
 import com.tbruyelle.rxpermissions2.RxPermissions;
@@ -56,6 +58,10 @@
  */
 
 public class BigImageView extends FrameLayout implements ImageLoader.Callback {
+    public static final int INIT_SCALE_TYPE_CENTER_INSIDE = 1;
+    public static final int INIT_SCALE_TYPE_CENTER_CROP = 2;
+    public static final int INIT_SCALE_TYPE_AUTO = 3;
+
     private final SubsamplingScaleImageView mImageView;
 
     private final ImageLoader mImageLoader;
@@ -80,6 +86,7 @@ public void run() {
             }
         }
     };
+    private DisplayOptimizeListener mDisplayOptimizeListener;
 
     public BigImageView(Context context) {
         this(context, null);
@@ -92,13 +99,23 @@ public BigImageView(Context context, AttributeSet attrs) {
     public BigImageView(Context context, AttributeSet attrs, int defStyleAttr) {
         super(context, attrs, defStyleAttr);
 
+        TypedArray array = context.getTheme()
+                .obtainStyledAttributes(attrs, R.styleable.BigImageView, defStyleAttr, 0);
+        int initScaleType = array.getInteger(R.styleable.BigImageView_initScaleType,
+                INIT_SCALE_TYPE_CENTER_INSIDE);
+        array.recycle();
+
         mImageView = new SubsamplingScaleImageView(context, attrs);
         addView(mImageView);
         LayoutParams params = new LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT,
                 ViewGroup.LayoutParams.MATCH_PARENT);
         mImageView.setLayoutParams(params);
         mImageView.setMinimumTileDpi(160);
-        mImageView.setOnImageEventListener(new DisplayOptimizeListener(mImageView));
+
+        mDisplayOptimizeListener = new DisplayOptimizeListener(mImageView);
+        mImageView.setOnImageEventListener(mDisplayOptimizeListener);
+
+        setInitScaleType(initScaleType);
 
         mImageLoader = BigImageViewer.imageLoader();
 
@@ -115,6 +132,22 @@ public void setOnLongClickListener(OnLongClickListener listener) {
         mImageView.setOnLongClickListener(listener);
     }
 
+    public void setInitScaleType(int initScaleType) {
+        switch (initScaleType) {
+            case INIT_SCALE_TYPE_CENTER_CROP:
+                mImageView.setMinimumScaleType(SubsamplingScaleImageView.SCALE_TYPE_CENTER_CROP);
+                break;
+            case INIT_SCALE_TYPE_AUTO:
+                mImageView.setMinimumScaleType(SubsamplingScaleImageView.SCALE_TYPE_CUSTOM);
+                break;
+            case INIT_SCALE_TYPE_CENTER_INSIDE:
+            default:
+                mImageView.setMinimumScaleType(SubsamplingScaleImageView.SCALE_TYPE_CENTER_INSIDE);
+                break;
+        }
+        mDisplayOptimizeListener.setInitScaleType(initScaleType);
+    }
+
     public void setImageSaveCallback(ImageSaveCallback imageSaveCallback) {
         mImageSaveCallback = imageSaveCallback;
     }
@@ -241,6 +274,7 @@ public void onStart() {
         post(new Runnable() {
             @Override
             public void run() {
+                // why show thumbnail in onStart? because we may not need download it from internet
                 if (mThumbnail != Uri.EMPTY) {
                     mThumbnailView = mImageLoader.showThumbnail(BigImageView.this, mThumbnail);
                     addView(mThumbnailView);

BigImageViewer/src/main/java/com/github/piasy/biv/view/DisplayOptimizeListener.java

@@ -36,6 +36,8 @@ public class DisplayOptimizeListener implements SubsamplingScaleImageView.OnImag
 
     private final SubsamplingScaleImageView mImageView;
 
+    private int mInitScaleType;
+
     public DisplayOptimizeListener(SubsamplingScaleImageView imageView) {
         mImageView = imageView;
     }
@@ -75,6 +77,27 @@ public void onReady() {
             result += 0.2f;
         }
 
+        if (mInitScaleType == BigImageView.INIT_SCALE_TYPE_AUTO) {
+            float maxScale = Math.max((float) viewWidth / imageWidth,
+                    (float) viewHeight / imageHeight);
+            if (maxScale > 1) {
+                // image is smaller than screen, it should be zoomed out to its origin size
+                mImageView.setMinScale(1);
+
+                // and it should be zoomed in to fill the screen
+                float defaultMaxScale = mImageView.getMaxScale();
+                mImageView.setMaxScale(Math.max(defaultMaxScale, maxScale * 1.2F));
+            } else {
+                // image is bigger than screen, it should be zoomed out to fit the screen
+                float minScale = Math.min((float) viewWidth / imageWidth,
+                        (float) viewHeight / imageHeight);
+                mImageView.setMinScale(minScale);
+                // but no need to set max scale
+            }
+            // scale to fit screen, and center
+            mImageView.setScaleAndCenter(maxScale, new PointF(imageWidth / 2, imageHeight / 2));
+        }
+
         mImageView.setDoubleTapZoomScale(result);
     }
 
@@ -102,4 +125,8 @@ public void onTileLoadError(Exception e) {
     public void onPreviewReleased() {
 
     }
+
+    public void setInitScaleType(int initScaleType) {
+        mInitScaleType = initScaleType;
+    }
 }

BigImageViewer/src/main/res/values/attrs.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  ~ The MIT License (MIT)
+  ~
+  ~ Copyright (c) 2016 Piasy
+  ~
+  ~ Permission is hereby granted, free of charge, to any person obtaining a copy
+  ~ of this software and associated documentation files (the "Software"), to deal
+  ~ in the Software without restriction, including without limitation the rights
+  ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  ~ copies of the Software, and to permit persons to whom the Software is
+  ~ furnished to do so, subject to the following conditions:
+  ~
+  ~ The above copyright notice and this permission notice shall be included in all
+  ~ copies or substantial portions of the Software.
+  ~
+  ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  ~ SOFTWARE.
+  -->
+
+<resources>
+    <declare-styleable name="BigImageView">
+        <attr format="enum" name="initScaleType">
+            <enum name="centerInside" value="1"/>
+            <enum name="centerCrop" value="2"/>
+            <enum name="auto" value="3"/>
+        </attr>
+    </declare-styleable>
+</resources>

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Change log
 
++ v1.2.3
+  - add initScaleType
 + v1.2.2
   - Fix #16
 + v1.2.1

README.md

@@ -114,6 +114,28 @@ bigImageView.saveImageIntoGallery();
 String path = bigImageView.currentImageFile(); // only valid when image file is downloaded.
 ```
 
+### Init scale type
+
+``` xml
+<com.github.piasy.biv.view.BigImageView
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        app:initScaleType="centerInside"
+        />
+```
+
+``` java
+mBigImageView.setInitScaleType(BigImageView.INIT_SCALE_TYPE_CENTER_CROP);
+```
+
+| value | effect |
+| ------| ------ |
+| centerInside | default, Scale the image so that both dimensions of the image will be equal to or less than the corresponding dimension of the view. The image is then centered in the view. This is the default behaviour and best for galleries. |
+| centerCrop | Scale the image uniformly so that both dimensions of the image will be equal to or larger than the corresponding dimension of the view. The image is then centered in the view. |
+| auto | determine the max scale and min scale by image size and view size, fit the image to screen and centered when loaded. |
+
+You can try the example to checkout the differences! https://fir.im/BIV . Thanks for fir.im!
+
 ## Why another big image viewer?
 
 There are several big image viewer libraries, [PhotoDraweeView](https://github.com/ongakuer/PhotoDraweeView), [FrescoImageViewer](https://github.com/stfalcon-studio/FrescoImageViewer), and [Subsampling Scale Image View](https://github.com/davemorrissey/subsampling-scale-image-view).

app/OpenKey.jks

@@ -29,16 +29,37 @@ android {
     buildToolsVersion rootProject.ext.androidBuildToolsVersion
 
     defaultConfig {
-        minSdkVersion rootProject.ext.minSdkVersion
+        minSdkVersion 14
         targetSdkVersion rootProject.ext.targetSdkVersion
         versionCode rootProject.ext.releaseVersionCode
         versionName rootProject.ext.releaseVersionName
 
         applicationId "com.github.piasy.biv.example"
+
+        vectorDrawables.useSupportLibrary = true
     }
+
+    signingConfigs {
+        develop {
+            storeFile file('OpenKey.jks')
+            storePassword '123456'
+            keyAlias '123456'
+            keyPassword '123456'
+        }
+    }
+
     buildTypes {
-        release {
+        debug {
             minifyEnabled false
+            debuggable true
+            signingConfig signingConfigs.develop
+        }
+
+        release {
+            minifyEnabled true
+            debuggable false
+            shrinkResources true
+            signingConfig signingConfigs.develop
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
         }
     }

app/build.gradle

@@ -21,8 +21,7 @@
   ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   ~ SOFTWARE.
-  -->
-
+-->
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
         package="com.github.piasy.biv.example">
 
@@ -45,6 +44,8 @@
         </activity>
         <activity android:name=".LongImageActivity">
         </activity>
+        <activity android:name=".ScaleTypeActivity">
+        </activity>
     </application>
 
 </manifest>

app/src/main/AndroidManifest.xml

@@ -28,17 +28,13 @@
 import android.os.Bundle;
 import android.support.v7.app.AppCompatActivity;
 import android.view.View;
-import com.github.piasy.biv.BigImageViewer;
 import com.github.piasy.biv.indicator.progresspie.ProgressPieIndicator;
-import com.github.piasy.biv.loader.fresco.FrescoImageLoader;
 import com.github.piasy.biv.view.BigImageView;
 
 public class FrescoLoaderActivity extends AppCompatActivity {
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
-        BigImageViewer.initialize(FrescoImageLoader.with(getApplicationContext()));
-
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_big_image);
 

app/src/main/java/com/github/piasy/biv/example/FrescoLoaderActivity.java

@@ -28,17 +28,13 @@
 import android.os.Bundle;
 import android.support.v7.app.AppCompatActivity;
 import android.view.View;
-import com.github.piasy.biv.BigImageViewer;
 import com.github.piasy.biv.indicator.progresspie.ProgressPieIndicator;
-import com.github.piasy.biv.loader.glide.GlideImageLoader;
 import com.github.piasy.biv.view.BigImageView;
 
 public class GlideLoaderActivity extends AppCompatActivity {
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
-        BigImageViewer.initialize(GlideImageLoader.with(getApplicationContext()));
-
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_big_image);
 

app/src/main/java/com/github/piasy/biv/example/GlideLoaderActivity.java

@@ -31,18 +31,14 @@
 import android.view.View;
 import android.widget.Toast;
 import com.afollestad.materialdialogs.MaterialDialog;
-import com.github.piasy.biv.BigImageViewer;
 import com.github.piasy.biv.indicator.progresspie.ProgressPieIndicator;
-import com.github.piasy.biv.loader.fresco.FrescoImageLoader;
 import com.github.piasy.biv.view.BigImageView;
 import com.github.piasy.biv.view.ImageSaveCallback;
 
 public class LongImageActivity extends AppCompatActivity {
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
-        BigImageViewer.initialize(FrescoImageLoader.with(getApplicationContext()));
-
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_big_image);
 

app/src/main/java/com/github/piasy/biv/example/LongImageActivity.java

@@ -28,11 +28,14 @@
 import android.os.Bundle;
 import android.support.v7.app.AppCompatActivity;
 import android.view.View;
+import com.github.piasy.biv.BigImageViewer;
+import com.github.piasy.biv.loader.fresco.FrescoImageLoader;
 
 public class MainActivity extends AppCompatActivity {
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
+        BigImageViewer.initialize(FrescoImageLoader.with(getApplicationContext()));
 
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
@@ -55,5 +58,11 @@ public void onClick(View v) {
                 startActivity(new Intent(MainActivity.this, LongImageActivity.class));
             }
         });
+        findViewById(R.id.mScaleType).setOnClickListener(new View.OnClickListener() {
+            @Override
+            public void onClick(View v) {
+                startActivity(new Intent(MainActivity.this, ScaleTypeActivity.class));
+            }
+        });
     }
 }