# XBanner

**Repository Path**: hihopeorg/XBanner

## Basic Information

- **Project Name**: XBanner
- **Description**: 广告轮播，循环轮播
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-19
- **Last Updated**: 2021-11-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## XBanner

**本项目是基于开源项目XBanner进行ohos化的移植和开发的，可以通过项目标签以及github地址（https://github.com/xiaohaibin/XBanner ）追踪到原项目版本**

#### 项目介绍

- 项目名称：XBanner
- 所属系列：ohos第三方组件适配移植
- 功能：广告轮播，循环轮播
- 项目移植状态：完成
- 调用差异：无
- 项目作者和维护人：hihope
- 联系方式：hihope@hoperun.com
- 原项目Doc地址：https://github.com/xiaohaibin/XBanner
- 原项目基线版本：v1.8.1 ，sha1：65ef886844310f54ac0079b470bebca87f1a4e0d
- 编程语言：Java
- 外部库依赖：无

#### 效果展示

![gif](screenshot/operation.gif)

#### 安装教程

方法1.
1. 编译XBanner的har包。
2. 启动 DevEco Studio，将编译的har包，导入工程目录“entry->libs”下。
3. 在moudle级别下的build.gradle文件中添加依赖，在dependences标签中增加对libs目录下har包的引用。

    ```
    dependencies {
        implementation fileTree(dir: 'libs', include: ['*.jar', '*.har'])
        ……
    }
    ```

4. 在导入的har包上点击右键，选择“Add as Library”对包进行引用，选择需要引用的模块，并点击“OK”即引用成功。

方法2.

1. 在工程的build.gradle的allprojects中，添加HAR所在的Maven仓地址
```
repositories {
    maven {
        url 'http://106.15.92.248:8081/repository/Releases/' 
    }
}
```
2. 在应用模块的build.gradle的dependencies闭包中，添加如下代码:
```
dependencies {
    implementation 'com.stx.xhb.ohos:xbanner:1.0.1'
}
```

#### 使用说明

1. 在config.json中配置网络权限
```java
    "reqPermissions": [
      {
        "name": "ohos.permission.INTERNET"
      }
    ]
```

2. 布局文件定义，提供控件：ConvenientBanner

```xml
<?xml version="1.0" encoding="utf-8"?>
<DirectionalLayout
    xmlns:ohos="http://schemas.huawei.com/res/ohos"
    xmlns:app="http://schemas.huawei.com/res/ohos/"
    ohos:height="match_parent"
    ohos:width="match_parent"
    ohos:orientation="vertical">

        <com.stx.xhb.xbanner.XBanner
            ohos:id="$+id:banner"
            ohos:height="200vp"
            ohos:width="match_parent"
            app:AutoPlayTime="3000"
            app:normalIndicatorSize="6vp"
            app:isAutoPlay="true"
            app:isHandLoop="false"
            app:isShowIndicatorOnlyOne="false"
            app:isShowNumberIndicator="true"
            app:isShowTips="true"
            app:isTipsMarquee="true"
            app:pointContainerLeftRightPadding="5vp"
            app:pointLeftRightPadding="5vp"
            app:pointTopBottomPadding="5vp"
            app:pointsContainerBackground="$graphic:shape_test"
            app:pointsPosition="right"
            app:pointsVisibility="true"
            app:scaleType="STRETCH"
            app:tipTextColor="#ffffff"
            app:tipTextSize="14fp"
            app:placeholderDrawable="$media:xbanner_logo"
            />
</DirectionalLayout>
```
3. 装载数据
```java(详见sample中的MainAbilitySlice类)
    private void initData() {
        List<LocalImageInfo> data = new ArrayList<>();
        data.add(new LocalImageInfo(ResourceTable.Media_ic_test_1, "你好1"));
        data.add(new LocalImageInfo(ResourceTable.Media_ic_test_2, "你好2"));
        data.add(new LocalImageInfo(ResourceTable.Media_ic_test_3, "你好3"));
        data.add(new LocalImageInfo(ResourceTable.Media_ic_test_4, "你好4"));
        data.add(new LocalImageInfo(ResourceTable.Media_ic_test_5, "你好5"));
        data.add(new LocalImageInfo(ResourceTable.Media_ic_test_6, "你好6"));
        data.add(new LocalImageInfo(ResourceTable.Media_ic_test_0, "你好7"));
        mBanner.setBannerData(data);
        }
```

4. 设置点击监听器

```java
    mBanner.setOnItemClickListener(new XBanner.OnItemClickListener() {
        @Override
        public void onItemClick(XBanner banner, Object model, Component view, int position) {
            // 点击事件
        }
    });
```

5. 加载图片

可根据自己项目需要使用相应的图片加载工具进行**加载图片**

```java
    mBanner.loadImage(new XBanner.XBannerAdapter() {
        @Override
        public void loadBanner(XBanner banner, Object model, Component view, int position) {
            ImageLoader.loadImage(MainAbilitySlice.this, (Image)view, (String)model);
        }
    });
```

6. 自定义布局

（1）.自定义自己需要展示的Banner显示布局，如：ResourceTable.Layout_item_custom_view

```
<?xml version="1.0" encoding="utf-8"?>
<DirectionalLayout
    xmlns:ohos="http://schemas.huawei.com/res/ohos"
    ohos:height="match_content"
    ohos:width="match_parent"
    ohos:clickable="true"
    ohos:focusable="focus_enable"
    ohos:orientation="horizontal">

    <Text
        xmlns:ohos="http://schemas.huawei.com/res/ohos"
        ohos:id="$+id:text"
        ohos:height="200vp"
        ohos:width="match_parent"
        ohos:text="1"
        ohos:text_alignment="center"
        ohos:background_element="#FFA54F"
        ohos:text_color="#ffffff"
        ohos:text_size="40fp"/>

</DirectionalLayout>
```

（2）.使用 setBannerData() 方法进行设置
```
   mXBanner.setBannerData("自定义布局文件",“加载数据集合”);
```

（3）.设置数据，通过 loadImage() 方法回传的 View 根据自定义布局设置的Id找到相应的控件进行数据设置，具体请看CustomViewsAbilitySlice.java
```
    mBanner.loadImage(new XBanner.XBannerAdapter() {
       @Override
       public void loadBanner(XBanner banner, Object model, View view, int position) {
           Text tvContent = (Text) view.findComponentById(ResourceTable.Id_text);
           tvContent.setText(String.valueOf(position + 1));
           ShapeElement shapeElement = new ShapeElement();
           shapeElement.setRgbColor(RgbColor.fromArgbInt(Color.getIntColor(((CustomViewsInfo) model).getXBannerUrl())));
           tvContent.setBackground(shapeElement);
       }
    });
```

#### 版本迭代
- v1.0.1

#### 主要功能：

- 支持根据服务端返回的数据动态设置广告条的总页数
- 支持大于等于1页时的无限循环自动轮播、手指按下暂停轮播、抬起手指开始轮播
- 支持自定义状态指示点位置  左 、中 、右
- 支持自定义状态指示点
- 支持监听页面点击事件
- 支持设置图片轮播间隔
- 支持指示器背景的修改及隐藏/显示
- 支持显示提示性文字功能
- 支持设置数字指示器
- 支持设置图片框架整体占位图
- 支持自主配置图片加载框架加载图片
- 支持自定义布局

#### 版权和许可信息

    Copyright (C) 2016 xhb_199409@163.com

    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.