Merge pull request #391 from Joe030984/master

Add support for settings links in NSAttributedString
jverkoey · May 28, 2013 · f5444e7 · f5444e7
2 parents e103d16 + e380de7
commit f5444e7
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 18 deletions.
diff --git a/src/attributedlabel/src/NIAttributedLabel.h b/src/attributedlabel/src/NIAttributedLabel.h
@@ -54,6 +54,8 @@ typedef enum {
   NIVerticalTextAlignmentBottom,
 } NIVerticalTextAlignment;
 
+extern NSString * const kNILinkAttributeName;
+
 @protocol NIAttributedLabelDelegate;
 
 /**

diff --git a/src/attributedlabel/src/NIAttributedLabel.m b/src/attributedlabel/src/NIAttributedLabel.m
@@ -27,7 +27,7 @@
 static const CGFloat kVMargin = 5.0f;
 static const NSTimeInterval kLongPressTimeInterval = 0.5;
 static const CGFloat kLongPressGutter = 22;
-static NSString* const kLinkAttributedName = @"NIAttributedLabel:Link";
+NSString * const kNILinkAttributeName = @"NIAttributedLabel:Link";
 
 CGFloat ImageDelegateGetAscentCallback(void* refCon);
 CGFloat ImageDelegateGetDescentCallback(void* refCon);
@@ -303,6 +303,9 @@ - (void)setAttributedString:(NSAttributedString *)attributedText {
     // Remove all images.
     self.images = nil;
 
+    // Pull any explicit links from the attributed string itself
+    [self _processLinksInAttributedString:self.mutableAttributedString];
+
     [self attributedTextDidChange];
   }
 }
@@ -322,6 +325,9 @@ - (void)setAttributedText:(NSAttributedString *)attributedText {
     // Remove all images.
     self.images = nil;
 
+    // Pull any explicit links from the attributed string itself
+    [self _processLinksInAttributedString:self.mutableAttributedString];
+
     [self attributedTextDidChange];
   }
 }
@@ -729,6 +735,33 @@ - (NSTextCheckingResult *)linkAtIndex:(CFIndex)i {
 }
 
 
+///////////////////////////////////////////////////////////////////////////////////////////////////
+- (void)_processLinksInAttributedString:(NSAttributedString *)attributedString {
+  // Pull any attributes matching the link attribute from the attributed string and store them as
+  // the current set of explicit links. This properly handles the value of the attribute being
+  // either an NSURL or an NSString.
+  __block NSMutableArray *links = [NSMutableArray array];
+  [attributedString enumerateAttribute:kNILinkAttributeName
+                               inRange:NSMakeRange(0, attributedString.length)
+                               options:0
+                            usingBlock:^(id value, NSRange range, BOOL *stop) {
+                                if (value != nil)
+                                {
+                                  if ([value isKindOfClass:[NSURL class]])
+                                  {
+                                    [links addObject:[NSTextCheckingResult linkCheckingResultWithRange:range URL:value]];
+                                  }
+                                  else if ([value isKindOfClass:[NSString class]])
+                                  {
+                                    NSURL *url = [NSURL URLWithString:value];
+                                    [links addObject:[NSTextCheckingResult linkCheckingResultWithRange:range URL:url]];
+                                  }
+                                }
+                            }];
+  self.explicitLinkLocations = links;
+}
+
+
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 - (CGFloat)_verticalOffsetForBounds:(CGRect)bounds {
   CGFloat verticalOffset = 0;
@@ -788,15 +821,15 @@ - (NSTextCheckingResult *)linkAtPoint:(CGPoint)point {
       CGPoint relativePoint = CGPointMake(point.x-CGRectGetMinX(rect),
                                           point.y-CGRectGetMinY(rect));
       CFIndex idx = CTLineGetStringIndexForPosition(line, relativePoint);
-        
+
       NSUInteger offset = 0;
       for (NIAttributedLabelImage *labelImage in self.images) {
         if (labelImage.index < idx) {
           offset++;
         }
-            
+
       }
-        
+
       foundLink = [self linkAtIndex:idx - offset];;
       if (foundLink) {
         NSTextCheckingResult *result = [NSTextCheckingResult linkCheckingResultWithRange:NSMakeRange(foundLink.range.location + offset, foundLink.range.length) URL:foundLink.URL];
@@ -1129,8 +1162,9 @@ - (void)_applyLinkStyleWithResults:(NSArray *)results toAttributedString:(NSMuta
     // We add a no-op attribute in order to force a run to exist for each link. Otherwise the
     // runCount will be one in this line, causing the entire line to be highlighted rather than
     // just the link when when no special attributes are set.
-    [attributedString addAttribute:kLinkAttributedName
-                             value:[NSNumber numberWithBool:YES]
+    [attributedString removeAttribute:kNILinkAttributeName range:result.range];
+    [attributedString addAttribute:kNILinkAttributeName
+                             value:result.URL
                              range:result.range];
 
     if (self.linksHaveUnderlines) {
@@ -1185,20 +1219,20 @@ - (NSMutableAttributedString *)mutableAttributedStringWithAdditions {
       callbacks.getAscent = ImageDelegateGetAscentCallback;
       callbacks.getDescent = ImageDelegateGetDescentCallback;
       callbacks.getWidth = ImageDelegateGetWidthCallback;
-        
+
       NSUInteger index = labelImage.index;
       if (index >= attributedString.length) {
         index = attributedString.length - 1;
       }
-    
+
       NSDictionary *attributes = [attributedString attributesAtIndex:index effectiveRange:NULL];
       CTFontRef font = (__bridge CTFontRef)[attributes valueForKey:(__bridge id)kCTFontAttributeName];
-    
+
       if (font != NULL) {
         labelImage.fontAscent = CTFontGetAscent(font);
         labelImage.fontDescent = CTFontGetDescent(font);
       }
-        
+
       CTRunDelegateRef delegate = CTRunDelegateCreate(&callbacks, (__bridge void *)labelImage);
 
       // Character to use as recommended by kCTRunDelegateAttributeName documentation.
@@ -1271,9 +1305,9 @@ - (void)drawImages {
                                                          NULL);
 
       CGFloat imageBoxHeight = labelImage.boxSize.height;
-      
+
       CGFloat xOffset = CTLineGetOffsetForStringIndex(line, CTRunGetStringRange(run).location, nil);
-      
+
       CGFloat imageBoxOriginY = 0.0f;
       switch (labelImage.verticalTextAlignment) {
         case NIVerticalTextAlignmentTop:
@@ -1286,13 +1320,13 @@ - (void)drawImages {
           imageBoxOriginY = lineBottomY;
           break;
       }
-      
+
       CGRect rect = CGRectMake(lineOrigin.x + xOffset, imageBoxOriginY, width, imageBoxHeight);
       UIEdgeInsets flippedMargins = labelImage.margins;
       CGFloat top = flippedMargins.top;
       flippedMargins.top = flippedMargins.bottom;
       flippedMargins.bottom = top;
-      
+
       CGRect imageRect = UIEdgeInsetsInsetRect(rect, flippedMargins);
       CGContextDrawImage(ctx, imageRect, labelImage.image.CGImage);
     }
@@ -1592,14 +1626,14 @@ - (void)actionSheetCancel:(UIActionSheet *)actionSheet {
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 CGFloat ImageDelegateGetAscentCallback(void* refCon) {
   NIAttributedLabelImage *labelImage = (__bridge NIAttributedLabelImage *)refCon;
-  
+
   switch (labelImage.verticalTextAlignment) {
     case NIVerticalTextAlignmentMiddle:
     {
       CGFloat ascent = labelImage.fontAscent;
       CGFloat descent = labelImage.fontDescent;
       CGFloat baselineFromMid = (ascent + descent) / 2 - descent;
-      
+
       return labelImage.boxSize.height / 2 + baselineFromMid;
     }
     case NIVerticalTextAlignmentTop:
@@ -1614,14 +1648,14 @@ CGFloat ImageDelegateGetAscentCallback(void* refCon) {
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 CGFloat ImageDelegateGetDescentCallback(void* refCon) {
   NIAttributedLabelImage *labelImage = (__bridge NIAttributedLabelImage *)refCon;
-  
+
   switch (labelImage.verticalTextAlignment) {
     case NIVerticalTextAlignmentMiddle:
     {
       CGFloat ascent = labelImage.fontAscent;
       CGFloat descent = labelImage.fontDescent;
       CGFloat baselineFromMid = (ascent + descent) / 2 - descent;
-      
+
       return labelImage.boxSize.height / 2 - baselineFromMid;
     }
     case NIVerticalTextAlignmentTop:

diff --git a/src/attributedlabel/src/NimbusAttributedLabel.h b/src/attributedlabel/src/NimbusAttributedLabel.h
@@ -96,6 +96,9 @@ label.text = @"Nimbus";
  *      @attention NIAttributedLabel is not designed to detect html anchor tags (i.e. &lt;a>). If
  *                 you want to attach a URL to a given range of text you must use
  *                 @link NIAttributedLabel::addLink:range: addLink:range:@endlink.
+ *                 You can add links to the attributed string using the attribute kNILinkAttributeName.
+ *                 The kNILinkAttributeName value should be the URL destination of the link. This can
+ *                 be either an NSURL or an NSString.
  *
  *  @image html NIAttributedLabel_autoDetectLinksOff.png "Before enabling autoDetectLinks"
  *