NSTextStorage

NSTextStorage 定义了 TextKit 最基本的存储机制。这个类是 NSMutableAttributedString 的半具体的子类(我特么也没看明白是啥子意思),并添加一组 NSLayoutManager 的管理行为。一个文本存储对象当字符或属性发生改变的时候会通知布局管理者,让布局管理者在需要的时候重新显示文本。

概览

NSTextSorage 对象能够在任何线程进行存取。但是你必须保证在同一时间只能在一个线程进行存取。

子类化注意事项
NSTextSorage 类实现改变管理(通过 beginEditing() 和 endEditing() ),验证属性,代理回调,布局管理通知。NSTextSorage 类是不完整的,这个类没有实现实际的属性字符串存储,子类通过重载 NSAttributedString 的两个函数进行管理:

  • string
  • attributes(at:effectiveRange:)

子类化也必须同时重载 NSMutableAttributedString 的两个函数:

  • replaceCharacters(in:with:)
  • setAttributes(_:range:)

这些函数完成改变后,然后就会调用 edited(_:range:changeInLength:)去通知父类知道 改变已经发生。

// 接收器的内容字符
/*
依附的字符串是不能通过这个属性的值进行移除。
由于性能的考虑,这个属性只会返回当前背后存储的属性字符串对象。如果你想要去维持这个你操作后返回字符串的快照,你需要对子字符串进行拷贝。

这个函数属性必须保证有效的去存储字符到属性字符串,子类必须实现这个属性。
*/
var string: String { get }
给指定索引的字符返回属性
func attributes(at location: Int, effectiveRange range: NSRangePointer?) -> [String : Any]
根据给定的返回和给定的字符串替换字符
func attributes(at location: Int, effectiveRange range: NSRangePointer?) -> [String : Any]
根据给定的范围和属性数组设置属性
func setAttributes(_ attrs: [String : Any]?, range: NSRange)

变化类型

@available(iOS 7.0, *)
public struct NSTextStorageEditActions : OptionSet {

    public init(rawValue: UInt)

    // 属性被添加, 移除,改变
    public static var editedAttributes: NSTextStorageEditActions { get }

    // 字符串被添加,移除,替换
    public static var editedCharacters: NSTextStorageEditActions { get }
}

/* Note for subclassing NSTextStorage: NSTextStorage is a semi-abstract subclass of NSMutableAttributedString.
It implements change management (beginEditing/endEditing), verification of attributes, delegate handling, and layout management notification. 
The one aspect it does not implement is the actual attributed string storage --- this is left up to the subclassers, which need to override the two NSMutableAttributedString primitives in addition to two NSAttributedString primitives:
 
 - (NSString *)string;
 - (NSDictionary *)attributesAtIndex:(NSUInteger)location effectiveRange:(NSRangePointer)range;

 - (void)replaceCharactersInRange:(NSRange)range withString:(NSString *)str;
 - (void)setAttributes:(NSDictionary *)attrs range:(NSRange)range;
 
 These primitives should perform the change then call edited:range:changeInLength: to get everything else to happen.
*/

@available(iOS 7.0, *)
open class NSTextStorage : NSMutableAttributedString {

    
    
    // NSLayoutManager objects owned by the receiver.
    /**************************** Layout manager ****************************/
    // 与存储对象相关连的 布局管理者
    open var layoutManagers: [NSLayoutManager] { get }

    
    // Adds aLayoutManager to the receiver.  Sends -[NSLayoutManager setTextStorage:] to aLayoutManager with the receiver.
    // 添加布局管理者
    open func addLayoutManager(_ aLayoutManager: NSLayoutManager)

    
    // Removes aLayoutManager from the receiver if already owned by it.  Sends -[NSLayoutManager setTextStorage:] to aLayoutManager with nil.
    // 移除布局管理者
    open func removeLayoutManager(_ aLayoutManager: NSLayoutManager)

    


    // These methods return information about the editing status. Especially useful when there are outstanding beginEditing calls or during processEditing...
    //  这些方法返回的关于编辑状态的信息特别有用(在编辑之前 和 正在编辑的过程中的编辑状态信息)
    
    // The NSTextStorageEditActions mask indicating that there are pending changes for attributes, characters, or both.
    /**************************** Pending edit info ****************************/
    open var editedMask: NSTextStorageEditActions { get }

    
    // The range for pending changes. {NSNotFound, 0} when there is no pending changes.
    open var editedRange: NSRange { get }

    
    // The length delta for the pending changes.
    open var changeInLength: Int { get }

    
    
    /**************************** Delegate ****************************/
    unowned(unsafe) open var delegate: NSTextStorageDelegate?

    
    
    // Notifies and records a recent change.  If there are no outstanding -beginEditing calls, this method calls -processEditing to trigger post-editing processes.  
    // This method has to be called by the primitives after changes are made if subclassed and overridden.  editedRange is the range in the original string (before the edit).
    /**************************** Edit management ****************************/
    open func edited(_ editedMask: NSTextStorageEditActions, range editedRange: NSRange, changeInLength delta: Int)

    
    // Sends out -textStorage:willProcessEditing, fixes the attributes, sends out -textStorage:didProcessEditing, and notifies the layout managers of change with the -processEditingForTextStorage:edited:range:changeInLength:invalidatedRange: method. 
    // Invoked from -edited:range:changeInLength: or -endEditing.
    open func processEditing()

    
    
    // Indicates if the receiver fixes invalidated attributes lazily.  The concrete UIKit subclass fixes attributes lazily by default.  
    // The abstract class (hence, all custom subclasses) is not lazy.
    /**************************** Attribute fixing ****************************/
    open var fixesAttributesLazily: Bool { get }

    
    // Notes the range of attributes that requires validation.  If the NSTextStorage is not lazy this just calls fixAttributesInRange:. 
    // If it is lazy this instead just records the range needing fixing in order to do it later.
    open func invalidateAttributes(in range: NSRange)

    
    // Ensures all attributes in range are validated and ready to be used.  An NSTextStorage that is lazy is required to call the following method before accessing any attributes.  
    // This gives the attribute fixing a chance to occur if necessary.  NSTextStorage subclasses that wish to support laziness must call it from all attribute accessors that they implement. 
    // The default concrete subclass does call this from its accessors.
    open func ensureAttributesAreFixed(in range: NSRange)
}

** 文本存储的代理方法**


/****  NSTextStorage delegate methods ****/

public protocol NSTextStorageDelegate : NSObjectProtocol {

    
    // Sent inside -processEditing right before fixing attributes.  Delegates can change the characters or attributes.
    @available(iOS 7.0, *)
    optional public func textStorage(_ textStorage: NSTextStorage, willProcessEditing editedMask: NSTextStorageEditActions, range editedRange: NSRange, changeInLength delta: Int)

    
    // Sent inside -processEditing right before notifying layout managers.  Delegates can change the attributes.
    @available(iOS 7.0, *)
    optional public func textStorage(_ textStorage: NSTextStorage, didProcessEditing editedMask: NSTextStorageEditActions, range editedRange: NSRange, changeInLength delta: Int)
}

通知
观察着不应该比代理对 textStorage 进行进一步的改变操作。 通知中会包含 编辑的步骤信息,不包含该 userInfo 信息

extension NSNotification.Name {

    
    /**** Notifications ****/
    @available(iOS 7.0, *)
    // 在调用 processEditing() 之后发送
    public static let NSTextStorageWillProcessEditing: NSNotification.Name

    @available(iOS 7.0, *)
   // 在调用 processEditing() 之前发送
    public static let NSTextStorageDidProcessEditing: NSNotification.Name
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,818评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,633评论 18 139
  • *面试心声:其实这些题本人都没怎么背,但是在上海 两周半 面了大约10家 收到差不多3个offer,总结起来就是把...
    Dove_iOS阅读 27,134评论 30 470
  • 从小到大,我一直很羡慕一类人,他们也许不是最聪明的,也不是最漂亮的。但是他们有兴趣爱好,有天赋所在。兴趣或是爱好让...
    首相你会唱小星星么阅读 345评论 0 1
  • 简怡被拉进大学群的瞬间,就发现了那条“李楠被XX拉入该群聊”的提示,两个人竟几乎同时被不同的同学拉进这个群,简怡没...
    李清浅阅读 1,341评论 18 23