picturebrowser version 0.0.1

readme
LinweiJ · Nov 8, 2017 · c26cdbe · c26cdbe
1 parent 585c519
commit c26cdbe
Show file tree

Hide file tree

Showing 13 changed files with 488 additions and 149 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,130 @@
-# PictureBrowser
-PictureBrowser  base DialogFragment(基于DialogFragment的图片浏览器)
+## PictureBrowser
+
+一个基于support.v4.app.DialogFragment的图片浏览器
+
+特点:
+
+- 图片浏览器,跟Dialog一样简单使用
+- 基于DialogFragment , 支持横竖屏切换不消失
+- 基于ViewPager+FragmentPagerAdapter,滑动流畅
+- 基于PhotoView,支持图片缩放
+- 可定制图片加载器
+- 提供一些定制接口
+
+
+
+
+
+[![](https://jitpack.io/v/LinweiJ/PictureBrowser.svg)](https://jitpack.io/#LinweiJ/PictureBrowser)
+
+![PictureBrowser.gif](https://github.com/LinweiJ/PictureBrowser/blob/master/screen_shot/PictureBrowser.gif)
+
+## 文档
+
+- [English](https://github.com/LinweiJ/PictureBrowser/blob/master/README_EN.md)
+- [中文](https://github.com/LinweiJ/PictureBrowser/blob/master/README.md)
+
+## 如何使用它？
+
+### gradle
+
+#### 1.先在 project的build.gradle  添加:
+
+```
+allprojects {
+		repositories {
+			...
+			maven { url "https://jitpack.io" }
+		}
+	}
+```
+#### 2.然后在module的build.gradle 添加:
+
+```
+dependencies {
+	        compile 'com.github.LinweiJ:PictureBrowser:0.0.1'
+	}
+```
+### java
+
+#### 1.简单使用例子
+
+```java
+PictureLoader pictureLoader = new PictureLoader() {
+            @Override
+            public void showPicture(Fragment fragment, PhotoView pictureView, String pictureUrl) {
+                //使用Glide加载图片,可自行根据需求选用其他图片加载库   
+                Glide.with(fragment)
+                        .load(pictureUrl)
+                        .placeholder(new ColorDrawable(Color.LTGRAY))
+                        .into(pictureView);
+            }
+        };
+
+PictureBrowser.Builder builder = new PictureBrowser.Builder();
+builder.setFragmentManager(getSupportFragmentManager())
+        .setUrlList(pictureUrl)
+        .setStartIndex(position)
+        .initPictureLoader(pictureLoader)
+        .setShowDeleteIcon(true)
+        .setShowIndexHint(true)
+        .setCancelOutside(true)
+        .create()
+        .show();
+```
+
+#### 2.类/方法
+
+- PictureBrowser.Builder:
+
+|        方法名         |                    描述                    | 备注(是否设置) |
+| :----------------: | :--------------------------------------: | :------: |
+| setFragmentManager | 请传入android.support.v4.app.FragmentManager |    必须    |
+|     setUrlList     | 请传入ArrayList<String> ,暂时只支持String类型,一般表示为图片url |    必须    |
+| initPictureLoader  |      初始化图片加载器PictureLoader,只能设置成功一次      |    必须    |
+|  setPictureLoader  |          可重置图片加载器PictureLoader           |    可选    |
+|   setStartIndex    |              首次显示图片页码,默认为0               |    可选    |
+| setShowDeleteIcon  |           是否显示左上角关闭按钮,默认为true            |    可选    |
+|  setShowIndexHint  |            是否显示底部页码提示,默认为true            |    可选    |
+|  setCancelOutside  |             是否开启点击关闭,默认为true             |    可选    |
+|       create       |      以上设置完成后调用得到PictureBrowser的一个实例      |    必须    |
+
+- PictureLoader
+
+
+|     方法名     |                    描述                    |  备注  |
+| :---------: | :--------------------------------------: | :--: |
+| showPicture | 可用参数Fragment fragment, PhotoView pictureView, String pictureUrl,可自行根据需求选用合适图片加载库 |      |
+
+- PictureBrowser
+
+
+| 方法名  |           描述           |  备注  |
+| :--: | :--------------------: | :--: |
+| show | 调用该方法,展示PictureBrowser |  必须  |
+
+### 更多细节
+
+*可以参考 app/ 示例*
+
+## Thanks
+
+- [PhotoView](https://github.com/bm-x/PhotoView)
+
+## License
+
+```
+Copyright 2017 LinWeiJia
+
+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.
+```
diff --git a/README_EN.md b/README_EN.md
@@ -0,0 +1,143 @@
+
+
+## PictureBrowser
+
+Implementation of DialogFragment for Android that supports show a group picture 
+
+Feature
+
+- A useful picture browser,it's easy to use just like dialog
+- Implementation of DialogFragment , so  auto rebuild when the device switches between portrait and landscape orientation
+- use  ViewPager+FragmentPagerAdapter , so slipping smoothness 
+- use PhotoView, a zooming Android ImageView.
+- customizable picture loader,you can use Glide,Picasso,Fresco,UIL 
+- other customizable properties
+
+
+
+[![](https://jitpack.io/v/LinweiJ/PictureBrowser.svg)](https://jitpack.io/#LinweiJ/PictureBrowser)
+
+![PictureBrowser.gif](https://github.com/LinweiJ/PictureBrowser/blob/master/screen_shot/PictureBrowser.gif)
+
+## Document
+
+- [English](https://github.com/LinweiJ/PictureBrowser/blob/master/README_EN.md)
+- [中文](https://github.com/LinweiJ/PictureBrowser/blob/master/README.md)
+
+
+
+## usage
+
+### Gradle
+
+#### 1.Add it in your root build.gradle at the end of repositories:
+
+```xml
+allprojects {
+		repositories {
+			...
+			maven { url "https://jitpack.io" }
+		}
+	}
+```
+
+#### 2.Add the dependency in your module build.gradle :
+
+```xml
+dependencies {
+	        compile 'com.github.LinweiJ:PictureBrowser:0.0.1'
+	}
+```
+
+### java
+
+#### 1.simple example
+
+```java
+PictureLoader pictureLoader = new PictureLoader() {
+            @Override
+            public void showPicture(Fragment fragment, PhotoView pictureView, String pictureUrl) {
+                //yon can use other image loading library    
+                Glide.with(fragment)
+                        .load(pictureUrl)
+                        .placeholder(new ColorDrawable(Color.LTGRAY))
+                        .into(pictureView);
+            }
+        };
+
+PictureBrowser.Builder builder = new PictureBrowser.Builder();
+builder.setFragmentManager(getSupportFragmentManager())
+        .setUrlList(pictureUrl)
+        .setStartIndex(position)
+        .initPictureLoader(pictureLoader)
+        .setShowDeleteIcon(true)
+        .setShowIndexHint(true)
+        .setCancelOutside(true)
+        .create()
+        .show();
+```
+
+
+
+#### 2.class/method
+
+- PictureBrowser.Builder
+
+|       method       |               description                | remark(whether must) |
+| :----------------: | :--------------------------------------: | :------------------: |
+| setFragmentManager |  android.support.v4.app.FragmentManager  |         must         |
+|     setUrlList     | ArrayList<String> ,a group picture's url |         must         |
+| initPictureLoader  | init PictureLoader,set success only once |         must         |
+|  setPictureLoader  |           reset PictureLoader            |                      |
+|   setStartIndex    |   set first show picture,default true    |                      |
+| setShowDeleteIcon  | set deleteIcon show or not,default true  |                      |
+|  setShowIndexHint  |  set IndexHint show or not,default true  |                      |
+|  setCancelOutside  | set  pictureBrowser cancelable when click screen,default true |                      |
+|       create       | after all setup,get a PictureBrowser's instance |         must         |
+
+- PictureLoader
+
+|   method    |               description                | remark |
+| :---------: | :--------------------------------------: | :----: |
+| showPicture | parameter:Fragment fragment, PhotoView pictureView, String pictureUrl,choose image loading library that you like |        |
+
+- PictureBrowser
+
+| method |     description     | remark |
+| :----: | :-----------------: | :----: |
+|  show  | show PictureBrowser |  must  |
+
+
+
+### more usage
+
+For a working implementation of this project see the app/ folder.
+
+
+
+## Thanks
+
+- [PhotoView](https://github.com/bm-x/PhotoView)
+
+## License
+
+```
+Copyright 2017 LinWeiJia
+
+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.
+```
+
+## More
+
+Why not give a star ? (>_@)
+
diff --git a/app/src/main/java/com/lwj/widget/picturebrowser_demo/MainActivity.java b/app/src/main/java/com/lwj/widget/picturebrowser_demo/MainActivity.java
@@ -42,10 +42,8 @@ protected void onCreate(Bundle savedInstanceState) {
 
         RecyclerView recyclerView = findViewById(R.id.recyclerView);
 
-//        MyRecyclerAdapter adapter = new MyRecyclerAdapter(mUrlList);
+
         final MyRecyclerAdapter2 adapter = new MyRecyclerAdapter2(mUrlList);
-//        MyAdapter  adapter = new MyAdapter(mUrlList);
-//        StaggeredGridLayoutManager manager = new StaggeredGridLayoutManager(2,StaggeredGridLayoutManager.VERTICAL);
         GridLayoutManager manager = new GridLayoutManager(this, 2);
         recyclerView.setLayoutManager(manager);
 
@@ -68,17 +66,14 @@ public void onItemClick(View view, int position) {
 
                 Log.e("onItemClick","onItemClick"+position+data.size());
 
-//                PictureBrowser pictureBrowser = PictureBrowser.newInstance(data,position);
-//                PictureBrowser pictureBrowser = PictureBrowser.newInstance(null,position);
-//                pictureBrowser.show(getSupportFragmentManager());
-
-
-
                 PictureBrowser.Builder builder = new PictureBrowser.Builder();
                 builder.setFragmentManager(getSupportFragmentManager())
                         .setUrlList(data)
                         .setStartIndex(position)
-                        .setPictureLoader(pictureLoader)
+                        .initPictureLoader(pictureLoader)
+                        .setShowDeleteIcon(true)
+                        .setShowIndexHint(true)
+                        .setCancelOutside(true)
                         .create()
                         .show();