-
Notifications
You must be signed in to change notification settings - Fork 180
Documentation_3.x
详情代码请参阅:IPickerPresenter
使用方法请参考:WeChatPresenter
该框架支持自定义所有界面的ui样式。通过presenter中 getUiConfig 方法生成一个 PickerUiConfig 对象。该对象包含了全局ui配置和自定义ui配置。全局ui配置通过set方法直接设置,自定义ui需要配置 PickerUiProvider 对象,PickerUiProvider中包含了6组自定义配置。分别为:选择器标题栏/选择器底部栏/选择器item/选择器文件夹item/预览页面/单图剪裁页面
在presenter的getUiConfig方法中添加如下配置:
PickerUiConfig uiConfig = new PickerUiConfig();
//设置主题色
uiConfig.setThemeColor(Color.RED);
//设置是否显示标题栏
uiConfig.setShowStatusBar(true);
//设置标题栏颜色
uiConfig.setStatusBarColor(Color.parseColor("#F5F5F5"));
//设置选择器背景
uiConfig.setPickerBackgroundColor(Color.BLACK);
//设置单图剪裁背景色
uiConfig.setSingleCropBackgroundColor(Color.BLACK);
//设置预览页面背景色
uiConfig.setPreviewBackgroundColor(Color.BLACK);
//设置选择器文件夹打开方向
uiConfig.setFolderListOpenDirection(PickerUiConfig.DIRECTION_BOTTOM);
//设置文件夹列表距离顶部/底部边距
uiConfig.setFolderListOpenMaxMargin(0);
//设置小红书剪裁区域的背景色
uiConfig.setCropViewBackgroundColor(Color.BLACK);
//设置小红书剪裁自适应状态图标
uiConfig.setFitIconID();
//设置小红书剪裁充满状态图标
uiConfig.setFullIconID();
//设置小红书剪裁留白状态图标
uiConfig.setGapIconID();
//设置小红书剪裁填充状态图标
uiConfig.setFillIconID();
//设置视频预览暂停图标
uiConfig.setVideoPauseIconID();
//自定义选择器标题栏,底部栏,item,文件夹列表item,预览页面,剪裁页面
uiConfig.setPickerUiProvider(new PickerUiProvider() {
//定制选择器标题栏,默认实现为 WXTitleBar
@Override
public PickerControllerView getTitleBar(Context context) {
return super.getTitleBar(context);
}
//定制选择器底部栏,返回null即代表没有底部栏,默认实现为 WXBottomBar
@Override
public PickerControllerView getBottomBar(Context context) {
return super.getBottomBar(context);
}
//定制选择器item,默认实现为 WXItemView
@Override
public PickerItemView getItemView(Context context) {
WXItemView itemView = (WXItemView) super.getItemView(context);
itemView.setBackgroundColor(Color.parseColor("#303030"));
return itemView;
}
//定制选择器文件夹列表item,默认实现为 WXFolderItemView
@Override
public PickerFolderItemView getFolderItemView(Context context) {
return super.getFolderItemView(context);
}
//定制选择器预览页面,默认实现为 WXPreviewControllerView
@Override
public PreviewControllerView getPreviewControllerView(Context context) {
return super.getPreviewControllerView(context);
}
//定制选择器单图剪裁页面,默认实现为 WXSingleCropControllerView
@Override
public SingleCropControllerView getSingleCropControllerView(Context context) {
return super.getSingleCropControllerView(context);
}
});
继承PickerControllerView,并在uiConfig.setPickerUiProvider 中返回自定义的PickerControllerView,详细使用可参考框架内WXTitleBar/RedBookTitleBar 和 WXBottomBar 实现
uiConfig.setPickerUiProvider(new PickerUiProvider(){
@Override
public PickerControllerView getTitleBar(Context context) {
//这里返回自定义的PickerControllerView,默认返回WXTitleBar
return super.getTitleBar(context);
}
@Override
public PickerControllerView getBottomBar(Context context) {
//这里返回自定义的PickerControllerView,默认返回WXBottomBar,如果没有底部栏,则返回null
return super.getBottomBar(context);
}
//...省略其他方法
});
继承PickerItemView,并在uiConfig.setPickerUiProvider 中返回自定义的PickerItemView,,可参考框架内 WXItemView 和RedBookItemView 两个类
uiConfig.setPickerUiProvider(new PickerUiProvider(){
@Override
public PickerItemView getItemView(Context context) {
//这里返回自定义的PickerItemView,默认返回PickerItemView
return super.getItemView(context);
}
//...省略其他方法
});
继承PickerFolderItemView,并在uiConfig.setPickerUiProvider 中返回自定义的PickerFolderItemView,可参考框架内 WXFolderItemView
uiConfig.setPickerUiProvider(new PickerUiProvider(){
@Override
public PickerFolderItemView getFolderItemView(Context context) {
//这里返回自定义的PickerFolderItemView,默认返回 WXFolderItemView
return super.getFolderItemView(context);
}
//...省略其他方法
});
继承PreviewControllerView,并在uiConfig.setPickerUiProvider 中返回自定义的PreviewControllerView,可参考框架内 WXPreviewControllerView
uiConfig.setPickerUiProvider(new PickerUiProvider(){
@Override
public PreviewControllerView getPreviewControllerView(Context context) {
//这里返回自定义的PreviewControllerView,默认返回 WXPreviewControllerView
return super.getPreviewControllerView(context);
}
//...省略其他方法
});
继承SingleCropControllerView,并在uiConfig.setPickerUiProvider 中返回自定义的SingleCropControllerView,可参考框架内 WXSingleCropControllerView
uiConfig.setPickerUiProvider(new PickerUiProvider(){
@Override
public SingleCropControllerView getSingleCropControllerView(Context context) {
//这里返回自定义的PreviewControllerView,默认返回 WXSingleCropControllerView
return super.getSingleCropControllerView(context);
}
//...省略其他方法
});
ImagePicker.withCrop(new RedBookPresenter())//设置presenter
.setMaxCount(9)//设置选择数量
.showCamera(true)//设置显示拍照
.setColumnCount(4)//设置列数
.mimeTypes(MimeType.ofImage())//设置需要加载的文件类型
.filterMimeTypes(MimeType.GIF)//设置需要过滤掉的文件类型
.assignGapState(false)//强制留白模式
.setFirstImageItem(null)//设置上一次选中的图片
.setFirstImageItemSize(1,1)//设置上一次选中的图片地址
.setVideoSinglePick(true)//设置视频单选
.setMaxVideoDuration(2000L)//设置可选区的最大视频时长
.setMinVideoDuration(60000L)//设置视频可选取的最小时长
.pick(this, new OnImagePickCompleteListener() {
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//图片剪裁回调,主线程
//注意:剪裁回调里的ImageItem中getCropUrl()才是剪裁过后的图片地址
}
});
ImagePicker.withCrop(new RedBookPresenter())//设置presenter
//...省略若干属性
.pick(this, new OnImagePickCompleteListener() {
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//图片剪裁回调,主线程
//注意:剪裁回调里的ImageItem中getCropUrl()才是剪裁过后的图片地址
}
});
MultiImageCropFragment fragment= ImagePicker.withCrop(new RedBookPresenter())//设置presenter
//...省略若干属性
.pickWithFragment(new OnImagePickCompleteListener() {
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//图片剪裁回调,主线程
//注意:剪裁回调里的ImageItem中getCropUrl()才是剪裁过后的图片地址
}
});
- 外部activity需要复写onBackPressed
@Override
public void onBackPressed() {
if (fragment != null && fragment.onBackPressed()) {
return;
}
super.onBackPressed();
}
ImagePicker.withMulti(new WeChatPresenter())//指定presenter //设置选择的最大数
.setMaxCount(9)
//设置列数
.setColumnCount(4)
//设置要加载的文件类型,可指定单一类型
.mimeTypes(MimeType.ofAll())
//设置需要过滤掉加载的文件类型
.filterMimeTypes(MimeType.GIF)
.showCamera(true)//显示拍照
.setPreview(true)//开启预览
//大图预览时是否支持预览视频
.setPreviewVideo(true)
//设置视频单选
.setVideoSinglePick(true)
//设置图片和视频单一类型选择
.setSinglePickImageOrVideoType(true)
//当单选或者视频单选时,点击item直接回调,无需点击完成按钮
.setSinglePickWithAutoComplete(false)
.setOriginal(true) //显示原图
//设置单选模,当maxCount==1时,可执行单选(下次选中会取消上一次选中)
.setSelectMode(SelectMode.MODE_SINGLE)
//设置视频可选取的最大时长
.setMaxVideoDuration(2000L)
//设置视频可选取的最小时长
.setMinVideoDuration(60000L)
//设置上一次操作的图片列表,下次选择时默认恢复上一次选择的状态
.setLastImageList(null)
//设置需要屏蔽掉的图片列表,下次选择时已屏蔽的文件不可选择
.setShieldList(null)
.pick(this, new OnImagePickCompleteListener() {
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//图片选择回调,主线程
}
});
支持Fragment嵌入自定义的activity中,使用可参考MultiImagePickerActivity。
MultiImagePickerFragment fragment = ImagePicker.withMulti(new WeChatPresenter())
//...省略若干属性
.pickWithFragment(new OnImagePickCompleteListener() {
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//图片选择回调,主线程
}
});
外部activity需要复写onBackPressed
@Override
public void onBackPressed() {
if (fragment != null && fragment.onBackPressed()) {
return;
}
super.onBackPressed();
}
支持对一组图片进行预览操作,支持超长图、大图、高清图的加载
//配置需要预览的所有图片列表
ArrayList<ImageItem> allPreviewImageList = new ArrayList<>();
//默认选中的图片索引
int defaultPosition = 0;
//开启预览
ImagePicker.preview(this, new WeChatPresenter(), allPreviewImageList, defaultPosition, new OnImagePickCompleteListener() {
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//图片编辑回调,主线程
}
});
支持对单张图片进行剪裁。支持调用选择器并剪裁,拍照并剪裁和直接调用剪裁
ImagePicker.withMulti(new WeChatPresenter())
.mimeTypes(MimeType.ofImage())
.filterMimeTypes(MimeType.GIF)
//剪裁完成的图片是否保存在DCIM目录下
//true:存储在DCIM下 false:存储在 data/包名/files/imagePicker/ 目录下
.cropSaveInDCIM(false)
//设置剪裁比例
.setCropRatio(1,1)
//设置剪裁框间距,单位px
.cropRectMinMargin(50)
//是否圆形剪裁,圆形剪裁时,setCropRatio无效
.cropAsCircle()
//设置剪裁模式,留白或充满 CropConfig.STYLE_GAP 或 CropConfig.STYLE_FILL
.cropStyle(CropConfig.STYLE_FILL)
//设置留白模式下生成的图片背景色,支持透明背景
.cropGapBackgroundColor(Color.TRANSPARENT)
.crop(this, new OnImagePickCompleteListener() {
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//图片剪裁回调,主线程
}
});
CropConfig cropConfig = new CropConfig();
//设置上一次剪裁矩阵位置信息,用于恢复上一次剪裁,Info类型从imageitem或者cropimageview中取,可为null
cropConfig.setCropRestoreInfo(new Info());
//设置剪裁比例
cropConfig.setCropRatio(1, 1);
//设置剪裁框间距,单位px
cropConfig.setCropRectMargin(100);
//是否圆形剪裁,圆形剪裁时,setCropRatio无效
cropConfig.setCircle(false);
//设置剪裁模式,留白或充满 CropConfig.STYLE_GAP 或 CropConfig.STYLE_FILL
cropConfig.setCropStyle(CropConfig.STYLE_GAP);
//设置留白模式下生成的图片背景色,支持透明背景
cropConfig.setCropGapBackgroundColor(Color.TRANSPARENT );
//调用拍照
ImagePicker.takePhotoAndCrop(this, new WXImgPickerPresenter(), cropConfig,
new OnImagePickCompleteListener() {
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//剪裁回调,主线程
}
});
需要指定剪裁的原图完整路径
CropConfig cropConfig = new CropConfig();
//设置上一次剪裁矩阵位置信息,用于恢复上一次剪裁,Info类型从imageitem或者cropimageview中取,可为null
cropConfig.setCropRestoreInfo(new Info());
//设置剪裁比例
cropConfig.setCropRatio(1, 1);
//设置剪裁框间距,单位px
cropConfig.setCropRectMargin(100);
//是否保存到DCIM目录下,false时会生成在 data/files/imagepicker/ 目录下
cropConfig.saveInDCIM(false);
//是否圆形剪裁,圆形剪裁时,setCropRatio无效
cropConfig.setCircle(false);
//设置剪裁模式,留白或充满 CropConfig.STYLE_GAP 或 CropConfig.STYLE_FILL
cropConfig.setCropStyle(CropConfig.STYLE_GAP);
//设置留白模式下生成的图片背景色,支持透明背景
cropConfig.setCropGapBackgroundColor(Color.TRANSPARENT );
//调用剪裁
String needCropImageUrl="需要剪裁的图片路径";
ImagePicker.crop(this, new WXImgPickerPresenter(), cropConfig, needCropImageUrl,
new OnImagePickCompleteListener() {
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//剪裁回调,主线程
}
});
支持直接调用手机摄像头
支持直接打开摄像头拍照,3.1版本去除了原有的拍照保存路径,新增了isCopyInDCIM入参,代表是否将拍照的图片copy一份到外部DCIM目录中 因为安卓Q禁止直接写入文件到系统DCIM文件下,所以拍照入参必须是私有目录路径.所以废弃掉原有的imagepath入参 如果想让拍摄的照片写入外部存储中,则需要copy一份文件到DCIM目录中并刷新媒体库 示例如下:
String name="图片名称,不要加后缀";//可为null
boolean isCopyInDCIM=true;//copy一份保存到系统相册文件
ImagePicker.takePhoto(this,name,isCopyInDCIM, new OnImagePickCompleteListener() {
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//拍照回调,主线程
}
});
支持直接打开摄像头拍视频,3.1已变更,变更理由参考拍照 示例如下:
String name="视频名称,不要加后缀";//可为null
long maxDuration=10000l;//可录制的最大时常,单位毫秒ms
boolean isCopyInDCIM=true;//copy一份保存到系统相册文件
ImagePicker.takeVideo(this,name,maxDuration, isCopyInDCIM,new OnImagePickCompleteListener() {
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//视频回调,主线程
}
});
支持直接回调出媒体数据
//指定要回调的相册类型,可以指定13种图片视频文件格式混合
Set<MimeType> mimeTypes = MimeType.ofAll();
ImagePicker.provideMediaSets(this, mimeTypes, new MediaSetsDataSource.MediaSetProvider() {
@Override
public void providerMediaSets(ArrayList<ImageSet> imageSets) {
//相册列表回调,主线程
}
});
//指定要回调的相册类型,可以指定13种图片视频文件格式混合
Set<MimeType> mimeTypes = MimeType.ofAll();
ImagePicker.provideAllMediaItems(this, mimeTypes, new MediaItemsDataSource.MediaItemProvider() {
@Override
public void providerMediaItems(ArrayList<ImageItem> imageItems, ImageSet allVideoSet) {
//全部媒体数据回调,主线程
//只有当mimeTypes既包含图片或者视频格式文件时,allVideoSet才有值
}
});
//指定要回调的相册类型,可以指定13种图片视频文件格式混合
Set<MimeType> mimeTypes = MimeType.ofAll();
//指定相册,id不能为空
ImageSet imageSet = new ImageSet();
ImagePicker.provideMediaItemsFromSet(this, imageSet, mimeTypes, new MediaItemsDataSource.MediaItemProvider() {
@Override
public void providerMediaItems(ArrayList<ImageItem> imageItems, ImageSet allVideoSet) {
//全部媒体数据回调,主线程
//只有当mimeTypes既包含图片或者视频格式文件时,allVideoSet才有值
}
});
支持指定先加载默认数量的item,防止文件夹中图片过多,导致等待过长
//指定要回调的相册类型,可以指定13种图片视频文件格式混合
Set<MimeType> mimeTypes = MimeType.ofAll();
//指定相册,id不能为空
ImageSet imageSet = new ImageSet();
//预加载个数
int preloadSize = 40;
ImagePicker.provideMediaItemsFromSetWithPreload(this, imageSet, mimeTypes, preloadSize,
new MediaItemsDataSource.MediaItemPreloadProvider() {
@Override
public void providerMediaItems(ArrayList<ImageItem> imageItems) {
//预加载回调,预先加载指定数目的媒体文件回调
}
},
new MediaItemsDataSource.MediaItemProvider() {
@Override
public void providerMediaItems(ArrayList<ImageItem> imageItems, ImageSet allVideoSet) {
//所有媒体文件回调
}
});
所有OnImagePickCompleteListener回调都可以设置OnImagePickCompleteListener2监听
ImagePicker.withMulti(new WXImgPickerPresenter())
//...省略若干属性
.pick(new OnImagePickCompleteListener2() {
@Override
public void onPickFailed(PickerError error) {
//调用选择器失败回调
}
@Override
public void onImagePickComplete(ArrayList<ImageItem> items) {
//图片选择回调,主线程
}
})
详见PickerError类
- CANCEL :-26883 选择器返回,即取消选择
- MEDIA_NOT_FOUND :-26884 没有媒体文件
- PRESENTER_NOT_FOUND :-26885 没有配置presenter
- UI_CONFIG_NOT_FOUND :-26886 没有配置presenter里的UiConfig
- SELECT_CONFIG_NOT_FOUND :-26887 配置选项错误
- CROP_URL_NOT_FOUND :-26888 剪裁url错误
- CROP_EXCEPTION -26889 :剪裁异常
- OTHER :-26890 其他错误
所有OnImagePickCompleteListener回调都可以被自定义回调OnPickerCompleteListener给替换
ImagePicker.withMulti(new WXImgPickerPresenter())
//...省略若干属性
.pick(new OnPickerCompleteListener<String>() {
@Override
public String onTransit(ArrayList<ImageItem> items) {
return null;
}
@Override
public void onPickComplete(String s) {
//回调
}
});
本库中默认实现了两种类型的转化
- OnStringCompleteListener
ImagePicker.withMulti(new WXImgPickerPresenter())
//...省略若干属性
.pick(new OnStringCompleteListener() {
@Override
public void onPickComplete(String path) {
//回调
}
});
- OnStringListCompleteListener
ImagePicker.withMulti(new WXImgPickerPresenter())
//...省略若干属性
.pick(new OnStringListCompleteListener() {
@Override
public void onPickComplete(ArrayList<String> list) {
//回调
}
});
支持更改选择器中string文件中所有常量。需要在主项目中的string文件中复写选择器框架中的某个string常量
若要实现国际化,则参考demo中values-en 示例如下:
<string name="picker_str_title_all">在string中修改文本</string>
<string name="picker_str_title_right">下一步</string>
查看string
<!-- title of activity -->
<string name="picker_str_title_all">图片和视频</string>
<string name="picker_str_title_video">视频选择</string>
<string name="picker_str_title_image">图片选择</string>
<string name="picker_str_title_right">完成</string>
<!-- title of crop activity -->
<string name="picker_str_title_crop">图片剪裁</string>
<string name="picker_str_title_crop_right">确定</string>
<!-- state of multiCrop activity -->
<string name="picker_str_redBook_full">充满</string>
<string name="picker_str_redBook_gap">留白</string>
<!-- bottom of activity -->
<string name="picker_str_bottom_preview">预览</string>
<string name="picker_str_bottom_original">原图</string>
<string name="picker_str_bottom_choose">选择</string>
<!-- folder item text -->
<string name="picker_str_folder_item_all">图片和视频</string>
<string name="picker_str_folder_item_video">所有视频</string>
<string name="picker_str_folder_item_image">所有图片</string>
<string name="picker_str_folder_image_unit">张</string>
<!-- camera item text -->
<string name="picker_str_item_take_video">拍摄视频</string>
<string name="picker_str_item_take_photo">拍摄照片</string>
<!-- permission -->
<string name="picker_str_camera_permission">您拒绝了拍照权限,如拒绝设置会导致该功能无法使用!是否前去设置?</string>
<string name="picker_str_storage_permission">您拒绝了存储权限,如拒绝设置会导致该功能无法使用!是否前去设置?</string>
<string name="picker_str_permission_refuse_setting">拒绝设置</string>
<string name="picker_str_permission_go_setting">前去设置</string>
<!-- tip -->
<string name="picker_str_tip_mimeTypes_empty">请至少选择一种文件加载类型!</string>
<string name="picker_str_tip_singleCrop_error">剪裁异常,已为您重置图片,请重试!</string>
<string name="picker_str_tip_shield">该文件已选过或无法选择!</string>
<string name="picker_str_tip_media_empty">暂未发现媒体文件</string>
<string name="picker_str_tip_only_select_image">只能选择图片!</string>
<string name="picker_str_tip_only_select_video">只能选择视频!</string>
<string name="picker_str_str_video_over_max_duration">视频时长不得超过</string>
<string name="picker_str_tip_video_less_min_duration">视频时长不得少于</string>
<string name="picker_str_tip_cant_preview_video">不支持预览视频!</string>
<string name="picker_str_tip_only_select_one_video">只能选择一个视频!</string>
<string name="picker_str_tip_action_frequently">请勿操作过快!</string>
<!-- time format -->
<string name="picker_str_today">今天</string>
<string name="picker_str_this_week">本周</string>
<string name="picker_str_this_months">这个月</string>
<string name="picker_str_time_format">yyyy年mm月</string>
<string name="picker_str_day">天</string>
<string name="picker_str_hour">小时</string>
<string name="picker_str_minute">分钟</string>
<string name="picker_str_second">秒</string>
<string name="picker_str_milli">毫秒</string>
<string name="picker_str_preview_empty">预览数据为空!</string>