TextKit框架介紹
本項目的Demo地址:https://github.com/MonkeyiOS/TextKitDemo.git
TextKit 框架是對 Core Text 的封裝,用簡潔的調用方式實現了大部分 Core Text 的功能,常用的 iOS 端文本布局都可以用它來搞定。我們常用的 UILabel 、UITextField 、UITextView 文本顯示控件都是基于 TextKit。
TextKit 框架主要的成員對象(典型的MVC):
- NSTextStorage 是 NSMutableAttributedString 的子類,負責存儲需要處理的文本及其屬性。
- NSLayoutManager 負責將 NSTextStorage 中的文本數據渲染到顯示區域上,負責字符的編碼和布局。
- NSTextContainer 描述了一個顯示區域,默認是矩形,其子類可以定義任意的形狀。它不僅定義了可填充的區域,而且內部還定義了一個不可填充區域(Bezier Path 數組)。
一個簡單的數據流程如圖:
![pic_01] (http://otuch1370.bkt.clouddn.com/pic_01.png)
他們并不是一對一的關系,一份數據文件可以有多種布局樣式,一個布局樣式也可以有多個顯示區域。
NSTextStorage 中的這個方法來添加對象
//用來添加一個布局對象
- (void)addLayoutManager:(NSLayoutManager *)aLayoutManager;
NSLayoutManager 中的這個方法來添加對象
//用來添加一個顯示區域對象
- (void)addTextContainer:(NSTextContainer *)container;
實際應用
語法高亮
先看效果
高亮其實就是改變富文本的屬性,所以當然由NSTextStorage來負責。NSTextStorage是NSMutableAttributedString類簇中的一個,所以它的子類需要實現一些抽象的方法。如下:
這些方法是負責文本的存儲,蘋果官方推薦用NSMutableAttributedString, NSAttributedString, NSMutableString, and NSString 來做字符層的操作,所以我們自定義的NSTextStorage子類中真正實現字符存儲操作的是NSMutableAttributedString。代碼如下:
NSTextStorage中下面這個方法在每次字符有變動的時候都會調用,在這個方法中,我們先清除當前可編輯的段落中之前的富文本屬性,然后用正則去匹配我們的目標單詞,進而給目標單詞設置我們想要的屬性。代碼如下:
這個自定義的NSTextStorage使用起來沒有任何區別:
一個NSLayoutManager對應多個NSTextContainer
官方文檔介紹:
先看效果
一份NSLayoutManager布局文件可以用在多個NSTextContainer文本顯示器上,效果就是同樣一份文本內容分段、分區域展示在不同的容器內。值得注意的是,如果容器都是基于UITextView展示的話就只能讓一個UITextView可以滾動,很容易想明白,如果都是可以滾動起來的話,那NSLayoutManager就不知道怎么劃分不同的內容布局了。
核心代碼如下:
一個NSTextStorage對應多個NSLayoutManager
官方文檔介紹:

這部分主要表達的是同一份文本文件可以同時由多種不同的展示樣式,就像大部分的MarkDown編輯器效果一樣。由于完全公用一套數據源,所以能做到多個布局效果能同時對數據的改變作出響應。
基本代碼如下:
NSLayoutManager提供了NSLayoutManagerDelegate協議,實現這些協議方法就可以對當前的布局文件進行一些簡單的布局調整。
在這部分,我修改了_layoutManagerB布局文件默認的展示樣式。需求是這樣的:
“文本中有網址的地方不要截斷換行,要保證在同一行顯示”
核心代碼如下:
排除路徑
NSTextContainer作為一個展示的容器,它可以是呈現任意的展示樣式,其中有一個屬性exclusionPaths就是描述一組禁止填充數據的區域,內部元素是UIBezierPath。動態的給exclusionPaths屬性賦值,就有了Demo演示的效果了。值得注意的是,我是基于UITextView來展示的數據,所以在計算排除路徑的區域位置時候需要減去默認的邊緣空隙。
代碼如下:
其中添加拖動手勢就可以達到Demo的效果了。
不規則的顯示區域
NSTextContainer不僅可以通過exclusionPaths來定義不可填充的區域,還可以通過子類來更個性的定義顯示的區域樣式。
子類中這個方法,是每一行將要斷行的時候都會調用的,我們可以在這個方法里重新計算出我們想要的每一行的Rect。例子中我定義的是一個上半部分是圓形,下部是矩形的特殊顯示區域。具體的計算方法在代碼中注釋已經寫明。
示例代碼如下:
該自定義的NSTextContainer在使用起來沒有任何區別。
實現一個可點擊的UILabel
UILabel原本就是基于TextKit框架的三大要素組成的。既然我們要完成自定義,我們就需要自己顯式的用這三大要素來填充一個Label。
- 在UILabel初始化的時候就初始化內部的NSTextStorage、NSLayoutManager、NSTextContainer。
- 重寫drawTextInRect:方法,讓我們自己的NSTextContainer去替代默認的展示控件。其中要注意,先畫背景,再畫文本內容,就是說要依次調用這兩個方法:
這一步完成以后,我們就已經接管了Label的文本展示系統了,我們可以在此基礎上進行任意的自定義操作。
- 為了實現可點擊,當然要在touchBegan:withEvent:方法中操作。步驟可以歸為:
- 根據點擊的Location找到TextContainer中對應的字形索引
- 找到該索引對應的字形的Rect
- 判斷該Rect是否包含剛才點擊的Location
- 如果包含的Location話就根據剛才的字形索引就可以找到對應的字符了
代碼如下:
本項目的Demo地址:https://github.com/MonkeyiOS/TextKitDemo.git