UITextView-placeholder的實現和解析
前言
專案中UITextfield使用的比較頻繁，對於placeholder可以直接設定，文字，顏色，字型等等，但是UITextView繼承自UIScrollView,並沒有placeholder屬性。專案中以前就有使用到UITextView的placeholder,當時只是外加了一個UILabel,但是每次都需要重新定製label，所以想著能夠寫一個類別，新增一個label，實現字型，顏色，位置的可調節。
這裡主要是在GitHub上面發現一個很好的類別，該類別的編寫者也是我所喜歡的一位iOS開發者。自己嘗試寫了一次，有了一定的瞭解，所以記錄下來，方便以後查閱。
首先先上圖看看效果：
預設效果圖：
設定顏色和location圖：
下面開始解析程式碼
根據意圖，也是在UITextView中新增一個UILabel,然後新增文字，顏色，富文字，位置等屬性，實現placeholder的可定製。
.h 解析
- (readOnly)UILabel *placeholdLabel
- NSString *placeholder placeholder 文字
- UIColor *placeholderColor 顏色
- NSAttributedString *attributePlaceholder 富文字
- CGPoint location 位置
#import <UIKit/UIKit.h>
@interface UITextView (WJPlaceholder)
@property(nonatomic,readonly) UILabel *placeholdLabel;
@property(nonatomic,strong) IBInspectable NSString *placeholder;
@property(nonatomic,strong) IBInspectable UIColor 使用IBInspectable修飾，可以使該屬性在interface builder中進行編輯。placeholder和placeholder color都可以在user defined runtime attributes中進行配置，如下圖：
.m 解析
首先設定三個key值，用於關聯屬性的建立和獲取
static char *labelKey = "placeholderKey";
static char *needAdjust = "needAdjust";
static char *changeLocation = "location";建立的類別是不支援新增屬性的，要實現屬性的可設定，可以使用runtime來動態設定和獲取屬性值。
runtime新增關聯屬性
void objc_setAssociatedObject(id object, const void *key, id value, objc_AssociationPolicy policy)第一個引數(object)表示要新增屬性的類，第二引數(const void *key)為一個key值，用來獲取設定的屬性值，第三個引數(value)為屬性的值，第四個引數(objc_AssociationPolicy policy)為屬性的修飾型別：一共有5個可選項：
typedef OBJC_ENUM(uintptr_t, objc_AssociationPolicy) {
OBJC_ASSOCIATION_ASSIGN = 0, /**< Specifies a weak reference to the associated object. */
OBJC_ASSOCIATION_RETAIN_NONATOMIC = 1, /**< Specifies a strong reference to the associated object.
* The association is not made atomically. */
OBJC_ASSOCIATION_COPY_NONATOMIC = 3, /**< Specifies that the associated object is copied.
* The association is not made atomically. */
OBJC_ASSOCIATION_RETAIN = 01401, /**< Specifies a strong reference to the associated object.
* The association is made atomically. */
OBJC_ASSOCIATION_COPY = 01403 /**< Specifies that the associated object is copied.
* The association is made atomically. */
};分別對應assign,retain_nonatomic,copy_nonatomic,retain,copy。
runtime獲取成員屬性方法為：
id objc_getAssociatedObject(id object, const void *key)第一個引數（object）為屬性所屬的類，一般使用self，第二個引數（key）為key值，和設定關聯屬性時使用的key一樣。
placeholderLabel為readOnly，重寫其get方法。
/**
* 設定placeholderLabel
*
* @return label
*/
- (UILabel *)placeholdLabel
{
UILabel *label = objc_getAssociatedObject(self, labelKey);
if (!label) {
label = [[UILabel alloc] init];
label.textAlignment = NSTextAlignmentLeft;
label.numberOfLines = 0;
label.textColor = [self.class defaultColor];
objc_setAssociatedObject(self, labelKey, label, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
//新增通知
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(updateLabel) name:UITextViewTextDidChangeNotification object:nil];
//監聽font的變化
[self addObserver:self forKeyPath:@"font" options:NSKeyValueObservingOptionNew context:nil];
}
return label;
}
/**
* 設定預設顏色
*
* @return color
*/
+ (UIColor *)defaultColor
{
static UIColor *color = nil;
static dispatch_once_t once_t;
dispatch_once(&once_t, ^{
UITextField *textField = [[UITextField alloc] init];
textField.placeholder = @" ";
color = [textField valueForKeyPath:@"_placeholderLabel.textColor"];
});
return color;
}建立UILabel時，設定基本屬性，這裡採用UITextfiled的placeholder的顏色作為預設顏色。
同時新增對UITextView的狀態通知，UITextView主要有以下幾個通知可供使用
UIKIT_EXTERN NSNotificationName const UITextViewTextDidBeginEditingNotification;
UIKIT_EXTERN NSNotificationName const UITextViewTextDidChangeNotification;
UIKIT_EXTERN NSNotificationName const UITextViewTextDidEndEditingNotification;這裡使用UITextViewTextDidChangeNotification，在text改變的時候執行updateLabel方法，進行label的顯示和隱藏以及其他設定。
對於UITextView的字型，使用KVO監聽UITextView的font屬性，在設定時改變placeholderLabel的font。
以下是一些成員屬性的set get方法，通過set方法，將text,color,attributedText賦給placeholderLabel。
該類別主要使用runtime建立了3個關聯屬性，分別為
* placeholderLabel
* location CGPoint 位置
* needAdJust BOOL 判斷是否需要調整
- (void)setPlaceholder:(NSString *)placeholder
{
self.placeholdLabel.text = placeholder;
[self updateLabel];
}
- (NSString *)placeholder
{
return self.placeholdLabel.text;
}
- (void)setPlaceholderColor:(UIColor *)placeholderColor
{
self.placeholdLabel.textColor = placeholderColor;
[self updateLabel];
}
- (UIColor *)placeholderColor
{
return self.placeholdLabel.textColor;
}
- (void)setAttributePlaceholder:(NSAttributedString *)attributePlaceholder
{
self.placeholdLabel.attributedText = attributePlaceholder;
[self updateLabel];
}
- (NSAttributedString *)attributePlaceholder
{
return self.placeholdLabel.attributedText;
}
- (void)setLocation:(CGPoint)location
{
objc_setAssociatedObject(self, changeLocation,NSStringFromCGPoint(location), OBJC_ASSOCIATION_RETAIN_NONATOMIC);
[self updateLabel];
}
-(CGPoint)location
{
return CGPointFromString(objc_getAssociatedObject(self, changeLocation));
}
//是否需要調整字型
- (BOOL)needAdjustFont
{
return [objc_getAssociatedObject(self, needAdjust) boolValue ];
}
- (void)setNeedAdjustFont:(BOOL)needAdjustFont
{
objc_setAssociatedObject(self, needAdjust, @(needAdjustFont), OBJC_ASSOCIATION_ASSIGN);
}KVO 監聽方法，判斷是否是font，執行updataLabel方法。
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context
{
if ([keyPath isEqualToString:@"font"])
{
self.needAdjustFont = YES;
[self updateLabel];
}
}下面則是更新placeholderLabel的主要方法，調整位置，字型等。
/**
* 更新label資訊
*/
- (void)updateLabel
{
if (self.text.length) {
[self.placeholdLabel removeFromSuperview];
return;
}
//顯示label
[self insertSubview:self.placeholdLabel atIndex:0];
//是否需要更新字型（NO 採用預設字型大小）
if (self.needAdjustFont) {
self.placeholdLabel.font = self.font;
self.needAdjustFont = NO;
}
CGFloat lineFragmentPadding = self.textContainer.lineFragmentPadding; //邊距
UIEdgeInsets contentInset = self.textContainerInset;
//設定label frame
CGFloat labelX = lineFragmentPadding + contentInset.left;
CGFloat labelY = contentInset.top;
if (self.location.x != 0 || self.location.y != 0) {
if (self.location.x < 0 || self.location.x > CGRectGetWidth(self.bounds) - lineFragmentPadding - contentInset.right || self.location.y< 0) {
// 不做處理
}else{
labelX += self.location.x;
labelY += self.location.y;
}
}
CGFloat labelW = CGRectGetWidth(self.bounds) - contentInset.right - labelX;
CGFloat labelH = [self.placeholdLabel sizeThatFits:CGSizeMake(labelW, MAXFLOAT)].height;
self.placeholdLabel.frame = CGRectMake(labelX, labelY, labelW, labelH);
}對於placeholderLabel的frame設定，需要考慮幾個方面：
* lineFragmentPadding UITextView textContainer邊距
* contentInset 輸入區域偏移 UIEdgeInsets
* location 設定的位置
* labeltextHeight placeholder的text高度
placeholder的frame.orgin.x = 邊距lineFragmentPadding + contentInset.left + location.x;
frame.orgin.y = contentInset.top + location.y;
frame.size.width = UITextView的寬度 - placeholder的frame.orgin.x - contentInset.right;
frame.height = placeholder.text的高度