Transferee

transferee 可以帮助你完成从缩略视图到原视图的无缝过渡转变, 优雅的浏览普通图片、长图、gif图、视频等不同格式的多媒体。

支持的功能:

支持视频预览
支持 Gif 图预览
支持大长图预览
支持拖拽关闭
支持自定义页面索引指示器
支持自定义资源加载进度条
支持自定义图片加载器[目前已经有 UniversalImageLoader / GlideImageLoader / PicassoImageLoader]
支持图片保存
支持预览图片缩放，拖动，旋转等手势操作
缩略图到大图或者大图到缩略图的无缝过渡动画，无缩略图信息时，自动改变动画的行为为平移过渡->加载大图->伸展图片动画
支持傻瓜式绑定 RecyclerView / ListView / GridView / ImageView
支持不绑定任何 View, 即可启动 transferee

如有任何问题欢迎提 Issues

Preview

Sample

demo.apk

Dependency

step1.

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

step2.

// 添加所有 module  [包括 Transferee、GlideImageLoader、PicassoImageLoader、UniversalImageLoader]
implementation 'com.github.Hitomis:transferee:1.6.1'

// 单独添加核心 module Transferee, 之后至少还需要添加以下三种图片加载器中的一种
implementation 'com.github.Hitomis.transferee:Transferee:1.6.1'

// 添加 Glide 图片加载器
implementation 'com.github.Hitomis.transferee:GlideImageLoader:1.6.1'

// 添加 Picasso 图片加载器
implementation 'com.github.Hitomis.transferee:PicassoImageLoader:1.6.1'

// 添加 Universal 图片加载器
implementation 'com.github.Hitomis.transferee:UniversalImageLoader:1.6.1'

Usage

如果针对单个 ImageView 使用，将非常简单：

Transferee transfer = Transferee.getDefault(context);
transfer.apply(TransferConfig.build()
        .setImageLoader(UniversalImageLoader.with(getApplicationContext()))
        .setSourceUrlList(SourceConfig.getMixingSourceGroup())
        .create()
).show());

// 离开页面不要忘记调用
transfer.destroy();

如果你需要更多的功能，下面是 transferee 完整的使用示例：

step 1: 一个页面只创建一个 transferee 示例 (建议写在 onCreate 方法中)

transferee = Transferee.getDefault(context);

step 2: 为 transferee 创建参数配置器

TransferConfig config = TransferConfig.build()
       .setSourceImageList(sourceUrlList) // 资源 url 集合, String 格式
       .setSourceUriList(sourceUriList) // 资源 uri 集合， Uri 格式
       .setMissPlaceHolder(R.mipmap.ic_empty_photo) // 资源加载前的占位图
       .setErrorPlaceHolder(R.mipmap.ic_empty_photo) // 资源加载错误后的占位图
       .setProgressIndicator(new ProgressPieIndicator()) // 资源加载进度指示器, 可以实现 IProgressIndicator 扩展
       .setIndexIndicator(new NumberIndexIndicator()) // 资源数量索引指示器，可以实现 IIndexIndicator 扩展
       .setImageLoader(GlideImageLoader.with(getApplicationContext())) // 图片加载器，可以实现 ImageLoader 扩展
       .setBackgroundColor(Color.parseColor("#000000")) // 背景色
       .setDuration(300) // 开启、关闭、手势拖拽关闭、显示、扩散消失等动画时长
       .setOffscreenPageLimit(2) // 第一次初始化或者切换页面时预加载资源的数量，与 justLoadHitImage 属性冲突，默认为 1
       .setCustomView(customView) // 自定义视图，将放在 transferee 的面板上
       .setNowThumbnailIndex(index) // 缩略图在图组中的索引
       .enableJustLoadHitPage(true) // 是否只加载当前显示在屏幕中的的资源，默认关闭
       .enableDragClose(true) // 是否开启下拉手势关闭，默认开启
       .enableDragHide(false) // 下拉拖拽关闭时，是否先隐藏页面上除主视图以外的其他视图，默认开启
       .enableDragPause(false) // 下拉拖拽关闭时，如果当前是视频，是否暂停播放，默认关闭
       .enableHideThumb(false) // 是否开启当 transferee 打开时，隐藏缩略图, 默认关闭
       .enableScrollingWithPageChange(false) // 是否启动列表随着页面的切换而滚动你的列表，默认关闭
       .setOnLongClickListener(new Transferee.OnTransfereeLongClickListener() { // 长按当前页面监听器
            @Override
            public void onLongClick(ImageView imageView, String imageUri, int pos) {
                saveImageFile(imageUri); // 使用 transferee.getFile(imageUri) 获取缓存文件保存，视频不支持
            }
        })
       .bindImageView(imageView, source) // 绑定一个 ImageView, 所有绑定方法只能调用一个
       .bindListView(listView, R.id.iv_thumb) // 绑定一个 ListView， 所有绑定方法只能调用一个
       .bindRecyclerView(recyclerView, R.id.iv_thumb)  // 绑定一个 RecyclerView， 所有绑定方法只能调用一个

step 3: 显示 transferee

transferee.apply(config).show();

step 4: 离开页面的时候需要销毁 transferee 中的资源，防止内存泄漏 (建议写在 onDestroy 方法中)

transferee.destroy()

Config

属性	说明
sourceUrlList	将要预览的资源 url 集合, String 格式
sourceUriList	将要预览的资源 uri 集合， Uri 格式
nowThumbnailIndex	缩略图在图组中的索引, 如果你绑定了 ListView 或者 RecyclerView，这个属性是必须的，否则可以忽略; 亦或可以作为打开 transferee 时指定初始化显示页面的 position
offscreenPageLimit	显示 transferee 时初始化加载的资源数量, 默认为1, 表示第一次加载3张(nowThumbnailIndex, nowThumbnailIndex + 1, nowThumbnailIndex - 1); 值为 2, 表示加载5张。依次类推
missPlaceHolder	缺省的占位图，资源 id 格式。资源未加载完成时默认显示的图片
missDrawable	缺省的占位图，Drawable 格式。资源未加载完成时默认显示的图片
errorPlaceHolder	加载错误的占位图，资源 id 格式。原图加载错误时显示的图片
errorDrawable	加载错误的占位图，Drawable 格式。原图加载错误时显示的图片
backgroundColor	transferee 显示时，transferee 背景色
duration	开启、关闭、手势拖拽关闭、透明度动画显示、扩散消失等动画的时长
justLoadHitPage	是否只加载当前页面中的资源。如果设置为 true，那么只有当 transferee 切换到当前页面时，才会触发当前页面的加载动作，否则按 offscreenPageLimit 所设置的数值去做预加载和当前页面的加载动作，默认关闭
enableDragClose	是否支持向下拖拽关闭，默认开启
enableDragHide	拖拽关闭时是否隐藏除主视图以外的其他 view，默认开启
enableDragPause	拖拽关闭时是否暂停当前页面视频播放，默认关闭
enableHideThumb	是否开启当 transferee 打开时，隐藏缩略图，默认开启
enableScrollingWithPageChange	是否启动列表随着 page 的切换而滚动，仅仅针对绑定 RecyclerView/GridView/ListView 有效, 启动之后因为列表会实时滚动，缩略图 view 将不会出现为空的现象，从而保证关闭 transferee 时为过渡关闭动画，默认关闭
progressIndicator	资源加载进度指示器 (默认内置 ProgressPieIndicator 和 ProgressBarIndicator)。可实现 IProgressIndicator 接口定义自己的资源加载进度指示器
indexIndicator	资源索引指示器 (默认内置 CircleIndexIndicator 和 NumberIndexIndicator)。可实现 IIndexIndicator 接口定义自己的资源索引指示器
imageLoader	资源加载器。可实现 ImageLoader 接口定义自己的图片加载器
imageId	RecyclerView 或者 ListView 的 ItemView 中的 ImageView id
customView	用户自定义的视图，放置在 transferee 显示后的面板之上
listView	如果你是使用的 ListView 或者 GridView 来排列显示图片，那么需要将你的 ListView 或者 GridView 传入 bindListView() 方法中
recyclerView	如果你使用的 RecyclerView 来排列显示图片，需要将 RecyclerView 传入 bindRecyclerView() 方法中
imageView	如果只想对单个 ImageView 使用此库的功能，或者界面上单个的 ImageView 是相册的封面，那么使用 bindImageView(...) 或者它的重载方法可以满足你的需求

Method

方法	说明
getDefault(context)	获取 transferee 实例
apply(config)	将配置参数对象应用到 transferee 实例中
show()	打开/显示 transferee
show(listener)	打开/显示 transferee，并监听显示/关闭状态
isShown()	transferee 是否显示
dismiss()	关闭 transferee
clear()	清除图片和视频等所有缓存文件
destroy()	销毁 transferee 使用到的资源，防止内存泄漏
getImageFile(url)	获取与 url 对应的缓存图片
setOnTransfereeStateChangeListener(listener)	设置 transferee 显示/关闭状态改变的监听器

Thanks

如果你觉得这个项目帮助到了你，对你项目的用户体验有提升，或者帮你解决了一些问题，可以扫描下面支付宝二维码给个随意打赏或者给个 star。你的鼓励是我维护项目最大的动力。

另外由于平时比较忙，都是自己的休息时间更新，如果你的 issues 比较急，可以给个针对你问题觉得合适的打赏，我会优先解决。时间不够充裕，还请谅解。

Update log

v1.6.1
- 新增图片方向自动校正功能
- 新增图片处理，优化大图的显示
- ImageLoader 接口代码重构简化
- State 代码重构，去除了无用代码，并删除了 RemoteThumbState
- 修复部分机型上 stage 模式动画在阶段切换的时候抖动的 bug
- 修复部分机型上状态栏和导航栏显示错误的问题
- 修复打开和关闭的状态不能保持一致的 bug
- 下滑手势优化
- 重置不再当前显示区域的图片状态
- 优化了内存占用，当浏览多图相册时，保证内存稳定
- 解决了因为 Config 资源未回收而导致的内存泄漏问题
v1.6.0
- 新增视频播放以及视频配套功能的支持
- 新增 enableDragPause 属性控制视频拖拽关闭时是否暂停
- 新增 enableHideThumb 属性控制缩略图是否消失
- 新增 enableScrollingWithPageChange 属性控制用户的列表是否跟随 transferee 页面切换而滚动
- 优化下拉关闭手势的交互
- 优化页面切换时，性能较差手机上可能出现一次闪屏的问题
- 优化在没有网络的情况下，transferee 启动或者关闭时一些边界性质的问题
- 优化图片没有加载出来的时候，手势关闭的时候动画不正常的问题
- 修复因为无法获取 originImage 导致的占位图为空的 bug
- 修复加载失败的时候，无法通过点击屏幕关闭的 bug
- 修复关闭时，背景色渐变算法错误的 bug
- 修复使用修复 bindImageView api 出现数组下标越界的 bug
- 修复当动画时长较长时，出现的没有打开完成之前，就能使用物理按键关闭的 bug
- 修复部分机型上只加载缩略图，没有加载高清图，打开后，占位图大小不一样的 bug
- 修复了全面屏、刘海屏 dialog 全屏适配错误的 bug
- 修复部分机型上 enableDragHide 功能不正常的 bug
- 修复弱网或者无网的情况下，被隐藏的页面占位图不显示的 bug
- 修复了一些代码逻辑错误
v1.5.2
- 修改 transferee 容器 dialog 固定为全屏样式。更好的配合当前可定制化的状态栏。
- transferee 绑定的 ListView 或者 RecyclerView 支持添加 header 或者 footer
- RecyclerViewActivity 新增线性排列和九宫格排列切换，演示在不同的列表下 transferee 使用方式
v1.5.1
- 修改在无网络的时候，使用 GlideImageLoader 加载图片闪退和行为错乱的问题
- 添加 enableDragHide 属性，控制在拖拽关闭的时候，是否立即隐藏其他 view
- 由于历史原因，不再兼容4.4以下的全屏模式。同时修复了 StatusBar 抖动的问题
- 拓展 Uri 格式的图片数据源接口
- 添加不绑定 view 也能使用 Transferee 的状态模型
- 同步更新 demo
v1.5.0
- 新增拖拽关闭功能
- 新增 gif 图片和大长图显示
- 添加图片源文件保存功能
- 添加 GlideImageLoader 作为图片加载的扩展项
- 添加 PicassoLoader 作为加载图片的扩展项
- 新增自定义显示面板 ui 的接口，可以让用户自己添加 view 到显示面板上
- 兼容 AndroidX
- 修复长图显示模糊的问题
- 修复因为网络错误或者图片地址问题而导致图片加载失败后，进度条没有关闭的bug
- 兼容图片比ImageView多的情况「fix bug#70」
- 化调用方式，不需要关注缩略图片是否加载完成
- 修复缓存清除的crash
v1.3.0
- 支持 transferee 绑定单个 ImageView 直接使用
- 支持 transferee 绑定单个 ImageView 后多样化展示图片，兼容有缩略图，无缩略图，或者实际图片数量远大于这里的一个 ImageView 数量，例如点击相册封面图片，可以查看相册中其他的图片的的功能
- 优化 api 使用方式，最简可以只需要绑定控件，传入图片地址后就能使用
- 优化用户体验，不再需要关注缩略图是否加载完成，任何时刻都可以立即打开 transferee
- 修复内存泄漏问题
- 简化 demo 代码
v1.2.0
- 针对之前版本的使用复杂考虑，添加了直接绑定 ListView，GridView，RecyclerView 即可使用，不再需要人肉传入 originImageList
- 修复有超出屏幕外图片情境下 transferee 崩溃的情景
- 修复 Issues 中各位同学反馈的bug
v1.1.0
- 修复 transferee 单例为普通实例，解决多个界面公用 transferee 单例时的异常问题
v1.0.0
- 将项目托管到 jitpack。目前可以使用添加 dependencies 的方式，导入 transferee 组件
v0.5
- 优化打开或者关闭 transferee 时背景色显示效果，从直接显示背景色优化为渐变显示。
- 基于 #26 添加 transferee 使用本地图片场景下的 Demo
- 为 transferee 组件添加背景色自定义功能
- 为 transferee 组件添加长按监听器，并添加了长按保存图片到相册的示例代码
- 更新了部分示例代码中失效的图片地址

Licence

Copyright 2017 Vans, Inc.

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.

fengyuwuzu526/transferee