OpenHarmony UI开发-组件TextLayoutBuilder

项目简介

TextLayoutBuilder是一个可定制任意样式的文本构建工具，包括字体间距、大小、颜色、布局方式、富文本高亮显示等，在文字显示的业务场景中都会使用到，特别是通知类特殊显示的字体样式时，TextLayoutBuilder极大的方便了开发者的开发效率。

效果演示

下载安装

ohpm install @ohos/textlayoutbuilder 

OpenHarmony ohpm 环境配置等更多内容，请参考如何安装 OpenHarmony ohpm 包

使用说明：

第一步： 初始化，导入 TextLayout 组件到自己项目中，实例化TextLayout.Layout对象；

...
import TextLayout from '@ohos/textlayoutbuilder';
import {TextInfo} from '@ohos/textlayoutbuilder';
...
@State layout:TextLayout.Layout = new TextLayout.Layout(); 
...

第二步：属性设置，通过layout类对象设置UI属性来自定义所需风格，也可以添加所需的回调；

private aboutToAppear() {

    let textInfo = new TextInfo();
    textInfo.setStart(2)
    textInfo.setEnd(8)
    textInfo.setFontColor('#ff0000')
    ... ...

    this.layout
    .setText(this.strTest)
    .setSpecialTextInfo(textInfo1)
    .setSpecialTextInfo(textInfo2)
    .setSpecialTextInfo(textInfo3)
    .setSpecialTextClick((textInfo) =>{
    console.info('我点击了 = '+textInfo.getText())
    });
}

第三步：界面绘制，将定制好的layout传给TextLayout。

build() {
    Column() {
         Text("默认显示").fontSize(16).fontColor("#999999").margin({ left: 14, top: 14, bottom: 14 })
         Column() {
            TextLayout({ model: this.layout })
         }.backgroundColor("#cccccc").margin({ left: 14, right: 14 }).borderRadius(10)
    }.alignItems(HorizontalAlign.Start)
}

接口说明

let layout:TextLayout.Layout = new TextLayout.Layout();

1. 设置文字内容：layout.setText(text: string)

   参数：

   参数名	参数类型	必填	参数描述
   text	string	是	文本内容

2. 设置指定文字内容样式：layout.setSpecialTextInfo(specialTextInfo: TextInfo)

   参数：

   参数名	参数类型	必填	参数描述
   specialTextInfo	TextInfo	是	文本内容样式

3. 设置文字颜色：layout.setTextColor(textColor: string|Color|number)

   参数：

   参数名	参数类型	必填	参数描述
   textColor	string	Color	number

4. 设置是否单行显示：layout.setSingleLine(singleLine: boolean)

   参数：

   参数名	参数类型	必填	参数描述
   singleLine	boolean	是	是否单行显示，默认否

5. 设置最大行数：layout.setMaxLines(maxLines: number)

   参数：

   参数名	参数类型	必填	参数描述
   maxLines	number	是	最大行数

6. 设置文本显示不下时的省略号替代方式：layout.setEllipsize(ellipsize: TextOverflow)

   参数：

   参数名	参数类型	必填	参数描述
   ellipsize	TextOverflow	是	文本溢出显示方式

7. 设置文本对齐方式：layout.setAlignment(textalign: TextAlign)

   参数：

   参数名	参数类型	必填	参数描述
   textalign	TextAlign	是	文本对齐方式

8. 设置每行最小显示字数：layout.setMinEms(minEms: number)

   参数：

   参数名	参数类型	必填	参数描述
   minEms	number	是	每行显示字数

9. 设置组件是否设置内边距：layout.setIncludeFontPadding(shouldInclude: boolean)

   参数：

   参数名	参数类型	必填	参数描述
   shouldInclude	boolean	是	是否设置padding，默认否

10. 设置最大宽度：layout.setMaxWidth(maxWidth: number)

**参数：**

| 参数名 | 参数类型 | 必填 | 参数描述 |
| :-- | --- | --- | --- |
| maxWidth | number | 是 | 最大宽度 |

11. 设置是否开启按下文字时状态变化开关：layout.setIsEnablePressState(isEnablePressState: boolean)

**参数：**

| 参数名 | 参数类型 | 必填 | 参数描述 |
| :-- | --- | --- | --- |
| isEnablePressState | boolean | 是 | 是否开启按下文字时状态变化开关，默认否 |

12. 设置按下文字状态样式：layout.setTextPressStateStyle(textPressStateStyle: string)

**参数：**

| 参数名 | 参数类型 | 必填 | 参数描述 |
| :-- | --- | --- | --- |
| textPressStateStyle | string | 是 | 按下文字状态样式 |

13. 设置指定文本的点击事件：layout.setSpecialTextClick(clickCallback: (textInfo: TextInfo) => void)

**参数：**

| 参数名 | 参数类型 | 必填 | 参数描述 |
| :-- | --- | --- | --- |
| clickCallback | (textInfo: TextInfo) => void | 是 | 用户自定义回调函数 |

特殊字符属性设置： let textInfo = new TextInfo();

1. 设置特殊文字开始位置：textInfo.setStart(start:number)

   参数：

   参数名	参数类型	必填	参数描述
   start	number	是	特殊文字开始位置

2. 设置特殊文字结束位置：textInfo.setEnd(end:number)

   参数：

   参数名	参数类型	必填	参数描述
   end	number	是	特殊文字结束位置

3. 设置文字颜色：textInfo.setFontColor(fontColor:string)

   参数：

   参数名	参数类型	必填	参数描述
   fontColor	string	是	文字颜色

4. 设置文字内容：textInfo.setText(text:string)

   参数：

   参数名	参数类型	必填	参数描述
   text	string	是	文本内容

5. 设置文字类型：textInfo.setTextType(textType:string)

   参数：

   参数名	参数类型	必填	参数描述
   textType	string	是	文本类型（TEXT_TYPE_NORMAL

6. 设置文本字体之间的距离：textInfo.setFontLetterSpacing(fontLetterSpacing:string)

   参数：

   参数名	参数类型	必填	参数描述
   fontLetterSpacing	string	是	文本字体之间的距离

7. 设置字体大小：textInfo.setFontSize(fontSize:string)

   参数：

   参数名	参数类型	必填	参数描述
   fontSize	string	是	字体大小

8. 设置字体样式：textInfo.setFontStyle(fontStyle:string)

   参数：

   参数名	参数类型	必填	参数描述
   fontStyle	string	是	字体样式

约束与限制

在下述版本验证通过：

• DevEco Studio 版本：3.1 Beta2(3.1.0.400), SDK: API9 Release(3.2.11.9)

目录结构

|---- TextLayoutBuilder
|     |---- entry  # 示例代码文件夹
|     |---- library  # TextLayout库文件夹
|          |---- src
|            |---- main
|              |---- ets
|                  |---- commonents
|                       |---- TextInfo.ets  # 富文本数据实体
|                       |---- TextLayout.ets  # UI 自定义组件
|           |---- index.ets  # 对外接口
|     |---- README.md  # 安装使用方法

为了能让大家更好的学习鸿蒙（HarmonyOS NEXT）开发技术，这边特意整理了《鸿蒙开发学习手册》（共计890页），希望对大家有所帮助：https://qr21.cn/FV7h05

《鸿蒙开发学习手册》：

如何快速入门：https://qr21.cn/FV7h05

1. 基本概念
2. 构建第一个ArkTS应用
3. ……

开发基础知识：https://qr21.cn/FV7h05

1. 应用基础知识
2. 配置文件
3. 应用数据管理
4. 应用安全管理
5. 应用隐私保护
6. 三方应用调用管控机制
7. 资源分类与访问
8. 学习ArkTS语言
9. ……

基于ArkTS 开发：https://qr21.cn/FV7h05

1. Ability开发
2. UI开发
3. 公共事件与通知
4. 窗口管理
5. 媒体
6. 安全
7. 网络与链接
8. 电话服务
9. 数据管理
10. 后台任务(Background Task)管理
11. 设备管理
12. 设备使用信息统计
13. DFX
14. 国际化开发
15. 折叠屏系列
16. ……

鸿蒙开发面试真题（含参考答案）：https://qr18.cn/F781PH

鸿蒙开发面试大盘集篇（共计319页）：https://qr18.cn/F781PH

1.项目开发必备面试题
2.性能优化方向
3.架构方向
4.鸿蒙开发系统底层方向
5.鸿蒙音视频开发方向
6.鸿蒙车载开发方向
7.鸿蒙南向开发方向