Skip to content

07.API文档

ZhangPan edited this page Jan 10, 2024 · 7 revisions

(1)Java API

方法名 方法描述 说明
setCanLoop(boolean) 是否开启循环 默认值true
setAutoPlay(boolean) 是否开启自动轮播 默认值true
setInterval(int) 自动轮播时间间隔 单位毫秒,默认值3000
setScrollDuration(int) 设置页面滚动时间 设置页面滚动时间
setRoundCorner(int) 设置圆角 默认无圆角 需要SDK_INT>=LOLLIPOP(API 21)
setOnPageClickListener(OnPageClickListener) 设置页面点击事件
setAdapter(BaseBannerAdapter) 设置Adapter 必须设置Adapter,否则会抛出NullPointerException
setIndicatorVisibility(int) 设置指示器是否可见 默认值VISIBLE 2.4.2 新增
setIndicatorStyle(int) 设置指示器样式 可选枚举(CIRCLE, DASH、ROUND_RECT) 默认CIRCLE
setIndicatorGravity(int) 指示器位置 可选值(CENTER、START、END)默认值CENTER
setIndicatorSliderColor(int,int) 指示器圆点颜色 normalColor:未选中时颜色默认"#8C6C6D72", checkedColor:选中时颜色 默认"#8C18171C"
setIndicatorSlideMode(int slideMode) 设置Indicator滑动模式 可选(NORMAL、SMOOTH、WORM、COLOR、SCALE),默认值NORMAL
setIndicatorSliderRadius(int radius) 设置指示器圆点半径 默认值4dp
setIndicatorSliderRadius(int normalRadius,int checkRadius) 设置指示器圆点半径 normalRadius:未选中时半径 checkedRadius:选中时的半径,默认值4dp
setIndicatorSliderWidth(int) 设置指示器宽度,如果是圆形指示器,则为直径 默认值8dp
setIndicatorSliderWidth(int normalWidth, int checkWidth) 设置指示器宽度,如果是圆形指示器,则为直径 默认值8dp
setIndicatorHeight(int) 设置指示器高度,仅在Indicator样式为非圆形时有效 默认值normalIndicatorWidth/2
setIndicatorSliderGap(int) 指示器圆点间距 默认值为指示器宽度(或者是圆的直径)
setIndicatorView(IIndicator) 设置自定义指示器 自定义View需要继承BaseIndicatorView或实现IIndicator
setPageTransformer(ViewPager2.PageTransformer) 设置页面Transformer样式
addPageTransformer(ViewPager2.PageTransformer) 3.0.0新增,添加页面Transformer样式
removeTransformer(ViewPager2.PageTransformer) 3.0.0新增,移除页面Transformer
setCurrentItem(int) 切换到指定页面 2.3.5新增
int getCurrentItem() 获取当前position 2.3.5新增
setPageStyle(PageStyle) 设置页面样式 2.4.0新增 可选(MULTI_PAGE_SCALE、MULTI_PAGE_OVERLAP)
setRevealWidth(int) 设置一屏多页模式下左右两边 Item 显示出来的宽度
setPageMargin(int) 设置页面间隔 2.4.0新增
setIndicatorMargin(int left, int top, int right, int bottom) 设置Indicator边距 2.4.1新增
registerOnPageChangeCallback(OnPageChangeListener) 页面改变的监听事件 2.4.3新增
setRoundRect(int) 设置BVP为圆角样式,参数为圆角大小 注意,这里是为BVP设置圆角,而非Item的圆角,Item圆角需要自行处理。
setOrientation(int) 设置页面滑动方向 3.0.0新增 支持水平和竖直滑动
setUserInputEnabled(int) 是否开启用户输入 设置为false则用户无法手动触发页面滑动
setLifecycleRegistry(Lifecycle) 为BVP设置Lifecycle 用于监听页面生命周期,在页面停止或者销毁时停止轮播
startLoop() 开启自动轮播 初始化BannerViewPager时不必调用该方法,设置setAutoPlay(true)即可开启自动轮播
stopLoop() 停止自动轮播
getData() 获取Banner中的集合数据
showIndicatorWhenOneItem(boolean) 当只有一个Item的时候是否显示指示器 默认不显示
stopLoopWhenDetachedFromWindow(boolean) 当BVP与Window Detache的时候是否停止轮播 默认停止轮播
create(List list) 初始化并构造BannerViewPager 如果创建BannerViewPager时已经有数据可以调用此方法
create() 创建没有数据的BannerViewPager 如果创建BannerViewPager时还没有数据,比如数据是来自服务器,可以调用此方法,等到成功获取数据后调用refreshData()刷新数据

(2)xml支持的attrs

Attributes format description
bvp_interval integer 自动轮播时间间隔
bvp_scroll_duration integer 页面切换时滑动时间
bvp_can_loop boolean 是否循环
bvp_auto_play boolean 是否自动播放
bvp_indicator_checked_color color indicator选中时颜色
bvp_indicator_normal_color color indicator未选中时颜色
bvp_indicator_radius dimension indicator圆点半径或者Dash模式的1/2宽度
bvp_round_corner dimension Banner圆角大小
bvp_page_margin dimension 页面item间距
bvp_reveal_width dimension 一屏多页模式下两边item漏出的宽度
bvp_indicator_style enum indicator样式(circle/dash/round_rect)
bvp_indicator_slide_mode enum indicator滑动模式(normal;smooth;worm;color;scale)
bvp_indicator_gravity enum indicator位置(center/start/end)
bvp_page_style enum page样式(normal/multi_page/multi_page_overlap/multi_page_scale)
bvp_indicator_visibility enum indicator visibility(visible/gone/invisible)