Method Detail

• with

   static OpenImage with(FragmentActivity fragmentActivity)

  注意选择正确的 with 方法，防止内存泄漏

• with

   static OpenImage with(Fragment fragment)

  注意选择正确的 with 方法，防止内存泄漏

• with

   static OpenImage with(Context context)

  注意选择正确的 with 方法，防止内存泄漏

  Parameters:

  context - 默认为Activity

• with

  @Deprecated() static OpenImage with(Fragment fragment)

  尽量使用上边的 with 方法，防止内存泄漏。此方法以标记为废弃，不建议使用

  Parameters:

  fragment - 尽量不要使用android.app.Fragment,而是使用 androidx 下的androidx.fragment.app.Fragment，否则不好预防内存泄漏问题

• setImageUrlList

   OpenImage setImageUrlList(List<out OpenImageUrl> openImageUrls)

  设置数据

  Parameters:

  openImageUrls - 图片数据组

• setImageUrl

   OpenImage setImageUrl(OpenImageUrl openImageUrl)

  设置数据

  Parameters:

  openImageUrl - 单个图片数据可设置这个

• setImageUrlList

   OpenImage setImageUrlList(List<String> openImageUrls, MediaType mediaType)

  设置数据

  Parameters:

  openImageUrls - 图片String数据组

  mediaType - 图片还是视频

• setImageUrl

   OpenImage setImageUrl(String openImageUrl, MediaType mediaType)

  设置数据

  Parameters:

  openImageUrl - 单个String图片数据可设置这个

  mediaType - 图片还是视频

• setClickRecyclerView

   OpenImage setClickRecyclerView(RecyclerView recyclerView, SourceImageViewIdGet<OpenImageUrl> sourceImageViewIdGet)

  设置点击的 ImageView 所在的 RecyclerView 容器

  Parameters:

  recyclerView - 展示数据的RecyclerView

  sourceImageViewIdGet - 展示数据的RecyclerView 的图片Id

• setClickRecyclerView

   OpenImage setClickRecyclerView(RecyclerView recyclerView, LayoutManagerFindVisiblePosition layoutManagerFindVisiblePosition, SourceImageViewIdGet<OpenImageUrl> sourceImageViewIdGet)

  设置点击的 ImageView 所在的 RecyclerView 容器如果你使用了除 androidx.recyclerview.widget.LinearLayoutManager、androidx.recyclerview.widget.GridLayoutManager、androidx.recyclerview.widget.StaggeredGridLayoutManager之外的RecyclerView.LayoutManager，可在此设置 LayoutManagerFindVisiblePosition 并返回相应的参数即可，这样可以获得支持更多的自定义RecyclerView.LayoutManager

  Parameters:

  recyclerView - 展示数据的RecyclerView

  layoutManagerFindVisiblePosition - 返回您自定义或三方库的 RecyclerView.LayoutManager 第一个和最后一个可见 Item 的位置

  sourceImageViewIdGet - 展示数据的RecyclerView 的图片Id

• setClickViewPager2

   OpenImage setClickViewPager2(ViewPager2 viewPager2, SourceImageViewIdGet<OpenImageUrl> sourceImageViewIdGet)

  设置点击的 ImageView 所在的 ViewPager2 容器

  Parameters:

  viewPager2 - 展示数据的ViewPager2

  sourceImageViewIdGet - 展示数据的ViewPager2 的图片Id

• setClickViewPager

   OpenImage setClickViewPager(ViewPager viewPager, SourceImageViewGet<OpenImageUrl> sourceImageViewGet)

  设置点击的 ImageView 所在的 ViewPager 容器

  Parameters:

  viewPager - 展示数据的ViewPager

  sourceImageViewGet - 展示数据的ViewPager 的图片ImageView

• setClickGridView

   OpenImage setClickGridView(GridView gridView, SourceImageViewIdGet<OpenImageUrl> sourceImageViewIdGet)

  设置点击的 ImageView 所在的 GridView 容器

  Parameters:

  gridView - 展示数据的GridView

  sourceImageViewIdGet - 展示数据的GridView 的图片Id

• setClickListView

   OpenImage setClickListView(ListView listView, SourceImageViewIdGet<OpenImageUrl> sourceImageViewIdGet)

  设置点击的 ImageView 所在的 ListView 容器

  Parameters:

  listView - 展示数据的ListView

  sourceImageViewIdGet - 展示数据的ListView 的图片Id

• setClickImageViews

   OpenImage setClickImageViews(Array<ImageView> imageViews)

  设置点击的ImageView数组

  Parameters:

  imageViews - 自己传展示数据的ImageView组

• setClickImageView

   OpenImage setClickImageView(ImageView imageView)

  设置点击的ImageView

  Parameters:

  imageView - 自己传展示数据的单个ImageView

• setClickImageViews

   OpenImage setClickImageViews(List<ImageView> imageViews)

  设置点击的ImageView集合

  Parameters:

  imageViews - 自己传展示数据的ImageView组

• setNoneClickView

   OpenImage setNoneClickView()

  如果没有可以传的点击 View 可调用这个方法

• setClickWebView

   OpenImage setClickWebView(View webView, ClickViewParam clickViewParam)

  支持在网页内点击图片，你需要和网页前端人员对接后才可获得对应的参数

  Parameters:

  webView - 网页浏览器

  clickViewParam - 点击图片或视频在网页内的参数

• setClickWebView

   OpenImage setClickWebView(View webView, List<ClickViewParam> clickViewParams)

  支持在网页内点击图片，你需要和网页前端人员对接后才可获得对应的参数

  Parameters:

  webView - 网页浏览器

  clickViewParams - 点击图片或视频在网页内的参数

• setClickPosition

   OpenImage setClickPosition(int clickPosition)

  如果数据下标 和 RecyclerView、ViewPager2、ListView、GridView 的所在位置一致 可调用这个

  Parameters:

  clickPosition - 点击的图片和View所在的位置

• setClickPosition

   OpenImage setClickPosition(int clickDataPosition, int clickViewPosition)

  如果数据下标 和 RecyclerView、ViewPager2、ListView、GridView 的所在位置不一致 调用这个

  Parameters:

  clickDataPosition - 点击的图片所在数据的位置

  clickViewPosition - 点击的图片View在RecyclerView或ListView或GridView的位置

• setSrcImageViewScaleType

   OpenImage setSrcImageViewScaleType(ImageView.ScaleType srcImageViewScaleType, boolean autoSetScaleType)

  使用普通 ImageView 时调用这个，请一定仔细核对是否设置正确，如果不正确将使显示效果不正常

  Parameters:

  srcImageViewScaleType - 点击的ImageView显示模式

  autoSetScaleType - 如果点击的ImageView与您所设置scaleType不相同，则自动设置

• setSrcImageViewScaleType

   OpenImage setSrcImageViewScaleType(ShapeImageView.ShapeScaleType srcImageViewShapeScaleType, boolean autoSetScaleType)

  使用ShapeImageView时调用这个

  Parameters:

  srcImageViewShapeScaleType - 点击的ShapeImageView显示模式

  autoSetScaleType - 如果点击的ShapeImageView与您所设置scaleType不相同，则自动设置

• setImageDiskMode

  @Deprecated() OpenImage setImageDiskMode(ImageDiskMode imageDiskMode)

  这项已被废弃请不要调用

  Parameters:

  imageDiskMode - 这项已被废弃请不要调用

• setErrorResId

   OpenImage setErrorResId(@DrawableRes() int errorResId)

  加载大图失败后:

  • 如果设置此选项则展示这个 errorResId 图片
  • 如果不设置
    • 有缓存则 "可能" 展示缓存图片
    • 没有缓存图片 "可能" 展示上一页面的加载失败图片，"也可能" 没有任何显示

  所以建议设置此项

  Parameters:

  errorResId - 大图加载失败后显示的图片

• setItemLoadHelper

  @Deprecated() OpenImage setItemLoadHelper(ItemLoadHelper itemLoadHelper)

  这项已被废弃请不要调用

  Parameters:

  itemLoadHelper - 这项已被废弃请不要调用

• setOpenImageStyle

   OpenImage setOpenImageStyle(@StyleRes() int openImageStyle)

  Parameters:

  openImageStyle - 查看图片显示设置StyleId

• setOpenPageAnimTimeMs

   OpenImage setOpenPageAnimTimeMs(long openPageAnimTimeMs)

  Parameters:

  openPageAnimTimeMs - 打开页面动画的时间

• setOnSelectMediaListener

   OpenImage setOnSelectMediaListener(OnSelectMediaListener onSelectMediaListener)

  设置 item 切换监听器

  Parameters:

  onSelectMediaListener - 回调查看图片所在数据的位置

• setAutoScrollScanPosition

   OpenImage setAutoScrollScanPosition(boolean autoScrollScanPosition)

  只对传入RecyclerView，ViewPager，ViewPager2， ListView, GridView 有效

  Parameters:

  autoScrollScanPosition - 自动滑向最后看的图片的位置

• addPageTransformer

   OpenImage addPageTransformer(Array<ViewPager2.PageTransformer> pageTransformer)

  Parameters:

  pageTransformer - ViewPager的页面切换效果

• setGalleryEffect

   OpenImage setGalleryEffect(int leftRightShowWidthDp)

  Parameters:

  leftRightShowWidthDp - 可设置画廊效果，左右漏出的宽度，单位dp

• setWechatExitFillInEffect

   OpenImage setWechatExitFillInEffect(boolean wechatExitFillInEffect)

  设置微信补位效果，设置后当退出大图页面时，如果前一页面没有当前图片，则自动回到点击进来的那张图的位置开启后自动自动滚动效果关闭(只对父容器是RecyclerView, ViewPager2，ListView, GridView 时有效)

  Parameters:

  wechatExitFillInEffect - 是否设置微信补位效果

• setOnItemClickListener

   OpenImage setOnItemClickListener(OnItemClickListener onItemClickListener)

  设置点击图片监听

  Parameters:

  onItemClickListener - 点击 item 监听类

• setOnItemLongClickListener

   OpenImage setOnItemLongClickListener(OnItemLongClickListener onItemLongClickListener)

  设置长按图片监听

  Parameters:

  onItemLongClickListener - 长按 item 监听类

• disableClickClose

   OpenImage disableClickClose()

  禁用点击图片关闭页面功能，设置此项后setDisEnableClickClose 就不起作用了

• enableClickClose

   OpenImage enableClickClose()

  开始点击图片关闭页面功能，设置此项后setDisEnableClickClose 就不起作用了

• addMoreView

   OpenImage addMoreView(@LayoutRes() int layoutRes, @NonNull() FrameLayout.LayoutParams layoutParams, MoreViewShowType moreViewShowType, OnLoadViewFinishListener onLoadViewFinishListener)

  添加View 到大图页面，此方法可多次调用，添加多个View，可以联合 setOnSelectMediaListener 使用，获取正在显示的图片或视频（即您传入的数据 OpenImageUrl）

  Parameters:

  layoutRes - 添加的布局xml id

  layoutParams - 要添加到页面布局的参数

  moreViewShowType - 展示类型

  onLoadViewFinishListener - 加载完毕View后回调

• addMoreView

   OpenImage addMoreView(View layoutView, @NonNull() FrameLayout.LayoutParams layoutParams, MoreViewShowType moreViewShowType)

  添加View 到大图页面，此方法可多次调用，添加多个View，可以联合 setOnSelectMediaListener 使用，获取正在显示的图片或视频（即您传入的数据 OpenImageUrl）

  Parameters:

  layoutView - 添加的View

  layoutParams - 要添加到页面布局的参数

  moreViewShowType - 展示类型

• addMoreView

   OpenImage addMoreView(@LayoutRes() int layoutRes, @NonNull() FrameLayout.LayoutParams layoutParams, MoreViewShowType moreViewShowType, boolean followTouch, OnLoadViewFinishListener onLoadViewFinishListener)

  添加View 到大图页面，此方法可多次调用，添加多个View，可以联合 setOnSelectMediaListener 使用，获取正在显示的图片或视频（即您传入的数据 OpenImageUrl）

  Parameters:

  layoutRes - 添加的布局xml id

  layoutParams - 要添加到页面布局的参数

  moreViewShowType - 展示类型

  followTouch - 是否跟随图片拖动

  onLoadViewFinishListener - 加载完毕View后回调

• addMoreView

   OpenImage addMoreView(View layoutView, @NonNull() FrameLayout.LayoutParams layoutParams, MoreViewShowType moreViewShowType, boolean followTouch)

  添加View 到大图页面，此方法可多次调用，添加多个View，可以联合 setOnSelectMediaListener 使用，获取正在显示的图片或视频（即您传入的数据 OpenImageUrl）

  Parameters:

  layoutView - 添加的View

  layoutParams - 要添加到页面布局的参数

  moreViewShowType - 展示类型

  followTouch - 是否跟随图片拖动

• setShowSrcImageView

   OpenImage setShowSrcImageView(boolean showSrcImageView)

  Parameters:

  showSrcImageView - 退出时，前一页面的ImageView是否可见

• setImageFragmentCreate

   OpenImage setImageFragmentCreate(ImageFragmentCreate imageFragmentCreate)

  调用这个方法将覆盖 setImageFragmentCreate 的配置，用于解决在app内多种不同需求的场景

  Parameters:

  imageFragmentCreate - 用于自定义图片展示页面

• setVideoFragmentCreate

   OpenImage setVideoFragmentCreate(VideoFragmentCreate videoFragmentCreate)

  调用这个方法将覆盖 setVideoFragmentCreate 的配置，用于解决在app内多种不同需求的场景

  Parameters:

  videoFragmentCreate - 用于自定义视频展示页面

• setUpperLayerFragmentCreate

   OpenImage setUpperLayerFragmentCreate(UpperLayerFragmentCreate upperLayerFragmentCreate, Bundle bundle)

  这是可以显示在页面上方的Fragment

  Parameters:

  upperLayerFragmentCreate - 用于创建覆盖在页面上方的Fragment

  bundle - 传入数据

• setUpperLayerFragmentCreate

   OpenImage setUpperLayerFragmentCreate(UpperLayerFragmentCreate upperLayerFragmentCreate, Bundle bundle, boolean followTouch)

  这是可以显示在页面上方的Fragment

  Parameters:

  upperLayerFragmentCreate - 用于创建覆盖在页面上方的Fragment

  bundle - 传入数据

  followTouch - 是否跟随拖动

• setUpperLayerFragmentCreate

   OpenImage setUpperLayerFragmentCreate(UpperLayerFragmentCreate upperLayerFragmentCreate, Bundle bundle, boolean followTouch, boolean touchingHide)

  这是可以显示在页面上方的Fragment

  Parameters:

  upperLayerFragmentCreate - 用于创建覆盖在页面上方的Fragment

  bundle - 传入数据

  followTouch - 是否跟随拖动

  touchingHide - 拖动图片时是否隐藏Fragment页面

• setOpenImageActivityCls

   OpenImage setOpenImageActivityCls(@NonNull() Class<out OpenImageActivity> openImageActivityCls)

  如果以上定义页面样式的方法还不够用，可继承 OpenImageActivity 页面自己去写页面

  Parameters:

  openImageActivityCls - 自己定义的大图页面，必须继承 OpenImageActivity

• setOpenImageActivityCls

   OpenImage setOpenImageActivityCls(@NonNull() Class<out OpenImageActivity> openImageActivityCls, String bundleKey, Bundle bundle)

  如果以上定义页面样式的方法还不够用，可继承 OpenImageActivity 页面自己去写页面

  Parameters:

  openImageActivityCls - 自己定义的大图页面，必须继承 OpenImageActivity

  bundleKey - 传给页面的数据 key [ bundle = getIntent().

  bundle - 传给页面的数据

• setOpenImageActivityCls

   OpenImage setOpenImageActivityCls(@NonNull() Class<out OpenImageActivity> openImageActivityCls, OnUpdateViewListener onUpdateViewListener)

  如果以上定义页面样式的方法还不够用，可继承 OpenImageActivity 页面自己去写页面

  Parameters:

  openImageActivityCls - 自己定义的大图页面，必须继承 OpenImageActivity

  onUpdateViewListener - 如果您想在大图页面加载更多数据并且更新前一页面的列表，那么你可传入此接口

• setOpenImageActivityCls

   OpenImage setOpenImageActivityCls(@NonNull() Class<out OpenImageActivity> openImageActivityCls, String bundleKey, Bundle bundle, @Nullable() OnUpdateViewListener onUpdateViewListener)

  如果以上定义页面样式的方法还不够用，可继承 OpenImageActivity 页面自己去写页面

  Parameters:

  openImageActivityCls - 自己定义的大图页面，必须继承 OpenImageActivity

  bundleKey - 传给页面的数据 key [ bundle = getIntent().

  bundle - 传给页面的数据

  onUpdateViewListener - 如果您想在大图页面加载更多数据并且更新前一页面的列表，那么你可传入此接口

• setImageShapeParams

   OpenImage setImageShapeParams(ImageShapeType shapeType, RectangleConnerRadius rectangleConnerRadius)

  如果你想让圆图和矩形圆角图在打开关闭时追求更细腻的体验可以设置这个

  Parameters:

  shapeType - 图片类型

  rectangleConnerRadius - 如果是矩形圆角图，设置这个为圆角角度

• setOnExitListener

   OpenImage setOnExitListener(OnExitListener onExitListener)

  如果你需要监听大图退出复位的时刻不妨调用这个

  Parameters:

  onExitListener - 退出复位监听

• setShowDownload

   OpenImage setShowDownload()

  设置显示下载按钮

• setShowDownload

   OpenImage setShowDownload(DownloadParams downloadParams)

  设置显示下载按钮

  Parameters:

  downloadParams - 下载按钮相关参数DownloadParams

• setShowClose

   OpenImage setShowClose()

  设置显示关闭按钮

• setShowClose

   OpenImage setShowClose(CloseParams closeParams)

  设置显示关闭按钮

  Parameters:

  closeParams - 关闭按钮相关参数CloseParams

• disableTouchClose

   OpenImage disableTouchClose()

  禁用下拉触摸关闭页面功能，设置此项后setDisEnableTouchClose 就不起作用了

• enableTouchClose

   OpenImage enableTouchClose()

  启用下拉触摸关闭页面功能

• setOnPermissionsInterceptListener

   OpenImage setOnPermissionsInterceptListener(OnPermissionsInterceptListener onPermissionsInterceptListener)

  自定义权限申请

• setPreloadCount

   OpenImage setPreloadCount(boolean lazyPreload, @IntRange(from = 1, to = 10) int preloadCount)

  局部设置预加载个数，可通过setPreloadCount全局设置，设置此参数全局设置在此次调用中暂时失效打开预加载，对于图片来说可以提前加载出来，对于视频来说可以拥有切换秒播的效果

  不设置时，默认是

  • 如果你用的是 「OpenImageLib」 或 「OpenImageGlideLib」默认是 lazyPreload = true , preloadCount = 1
  • 如果你用的是 「OpenImageFullLib」默认是 lazyPreload = false , preloadCount = 2

  Parameters:

  lazyPreload - 是否懒加载 true 的话打开页面时不会预加载，滑动一个时才开始预加载；false的话打开页面时就开始预加载

  preloadCount - 预加载个数，对应于setOffscreenPageLimit

• closePreload

   OpenImage closePreload()

  局部设置关闭预加载，可通过closePreload全局设置，设置此参数全局设置在此次调用中暂时失效关闭预加载，关闭后不会预加载，页面回收会更频繁

• setBothLoadCover

   OpenImage setBothLoadCover(boolean bothLoadCover)

  局部设置是否同时加载缩略图

  • 设置为true时，加载大图的同时也会加载缩略图，如果缩略图优先加载出来则会先显示缩略图，后显示大图，否则如果大图先加载出来则不会再显示缩略图
  • 设置为false时，只会加载大图，缩略图不会加载

  Parameters:

  bothLoadCover - 是否同时加载缩略图，默认为 true

• show

   void show()

  打开大图页面，只可以调用一次哦～切勿多次调用