TextKit框架介绍

2017-09-07 12:00:00 杨雄 点融黑帮

TextKit 框架是对 Core Text 的封装,用简洁的调用方式实现了大部分 Core Text 的功能,常用的 iOS 端文本布局都可以用它来搞定。我们常用的 UILabelUITextFieldUITextView 文本显示控件都是基于 TextKit

(Text Kit Framework Position)


TextKit 框架主要的成员对象(典型的MVC):

  • NSTextStorage NSMutableAttributedString 的子类,负责存储需要处理的文本及其属性;

  • NSLayoutManager 负责将 NSTextStorage 中的文本数据渲染到显示区域上,负责字符的编码和布局;

  • NSTextContainer 描述了一个显示区域,默认是矩形,其子类可以定义任意的形状。它不仅定义了可填充的区域,而且内部还定义了一个不可填充区域(Bezier Path 数组)。


一个简单的数据流程如图:

(Object configuration for a single text flow)


他们并不是一对一的关系,一份数据文件可以有多种布局样式,一个布局样式也可以有多个显示区域。


NSTextStorage 中的这个方法来添加一个布局对象:


NSLayoutManager 中的这个方法来添加一个显示区域对象:


实际应用


1语法高亮


先看效果:


高亮其实就是改变富文本的属性,所以当然由 NSTextStorage 来负责。

NSTextStorage 是 NSMutableAttributedString 类族中的一个,所以它的子类需要实现一些抽象的方法。如下:


这些方法是负责文本的存储,苹果官方推荐用 NSMutableAttributedString, NSAttributedString, NSMutableString, and NSString 来做字符层的操作,所以我们自定义的 NSTextStorage 子类中真正实现字符存储操作的是 NSMutableAttributedString代码如下:


NSTextStorage 中下面这个方法在每次字符有变动的时候都会调用,在这个方法中,我们先清除当前可编辑的段落中之前的富文本属性,然后用正则去匹配我们的目标单词,进而给目标单词设置我们想要的属性。代码如下:


这个自定义的 NSTextStorage 使用起来没有任何区别:


 

2一个 NSLayoutManager 对应多个 NSTextContainer


(Object configuration for paginated text)


先看效果:


一份 NSLayoutManager 布局文件可以用在多个 NSTextContainer 文本显示器上,效果就是同样一份文本内容分段、分区域展示在不同的容器内。值得注意的是,如果容器都是基于 UITextView 展示的话就只能让一个 UITextView 可以滚动,很容易想明白,如果都是可以滚动起来的话,那 NSLayoutManager 就不知道怎么划分不同的内容布局了。核心代码如下:


 

3一个 NSTextStorage 对应多个 NSLayoutManager


(Object configuration for multiple views of the same text)


先看效果:



这部分主要表达的是同一份文本文件可以同时由多种不同的展示样式,就像大部分的 MarkDown 编辑器效果一样。由于完全公用一套数据源,所以能做到多个布局效果能同时对数据的改变作出响应。基本代码如下:


NSLayoutManager 提供了 NSLayoutManagerDelegate 协议,实现这些协议方法就可以对当前的布局文件进行一些简单的布局调整。

在这部分,我修改了 _layoutManagerB 布局文件默认的展示样式。需求是这样的:

“文本中有网址的地方不要截断换行,要保证在同一行显示。”

核心代码如下:


 

4排除路径



NSTextContainer 作为一个展示的容器,它可以是呈现任意的展示样式,其中有一个属性 exclusionPaths 就是描述一组禁止填充数据的区域,内部元素是 UIBezierPath。动态的给 exclusionPaths 属性赋值,就有了 Demo 演示的效果了。值得注意的是,我是基于 UITextView 来展示的数据,所以在计算排除路径的区域位置时候需要减去默认的边缘空隙。代码如下:


其中添加拖动手势就可以达到 Demo 的效果了。


 

5不规则的显示区域



NSTextContainer 不仅可以通过 exclusionPaths 来定义不可填充的区域,还可以通过子类来更个性的定义显示的区域样式。


子类中这个方法,是每一行将要断行的时候都会调用的,我们可以在这个方法里重新计算出我们想要的每一行的 Rect。例子中我定义的是一个上半部分是圆形,下部是矩形的特殊显示区域。具体的计算方法在代码中注释已经写明。示例代码如下:


该自定义的 NSTextContainer 在使用起来没有任何区别。


 

5实现一个可点击的 UILabel



UILabel 原本就是基于 TextKit 框架的三大要素组成的。既然我们要完成自定义,我们就需要自己显式的用这三大要素来填充一个 Label。在 UILabel 初始化的时候就初始化内部的 NSTextStorageNSLayoutManagerNSTextContainer。重写drawTextInRect方法,让我们自己的 NSTextContainer 去替代默认的展示控件。其中要注意,先画背景,再画文本内容,就是说要依次调用这两个方法:


这一步完成以后,我们就已经接管了 Label 的文本展示系统了,我们可以在此基础上进行任意的自定义操作。为了实现可点击,当然要在 touchBegan:withEvent方法中操作。步骤可以归为:

  • 根据点击的 Location 找到 TextContainer 中对应的字形索引

  • 找到该索引对应的字形的 Rect

  • 判断该 Rect 是否包含刚才点击的 Location

  • 如果包含的 Location 话就根据刚才的字形索引就可以找到对应的字符了

代码如下:


本项目的 Demo 地址:https://github.com/MonkeyiOS/TextKitDemo.git