Added accessory button to message cell (jessesquires#1719), close jessesquires#1519

Author: adubr

JSQMessages.xcodeproj/project.pbxproj

@@ -130,6 +130,7 @@
 		54271E3F1C905D1600294290 /* JSQAudioMediaItemTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = JSQAudioMediaItemTests.m; sourceTree = "<group>"; };
 		544A321F1CB2EE380084BFC0 /* JSQAudioMediaViewAttributes.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = JSQAudioMediaViewAttributes.h; sourceTree = "<group>"; };
 		544A32201CB2EE380084BFC0 /* JSQAudioMediaViewAttributes.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = JSQAudioMediaViewAttributes.m; sourceTree = "<group>"; };
+		58620BCC6ABA99E3C6FD36F5 /* JSQMessagesViewAccessoryButtonDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = JSQMessagesViewAccessoryButtonDelegate.h; sourceTree = "<group>"; };
 		88078A9B19D8FEB5005B4595 /* JSQMessagesMediaPlaceholderView.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = JSQMessagesMediaPlaceholderView.h; sourceTree = "<group>"; };
 		88078A9C19D8FEB5005B4595 /* JSQMessagesMediaPlaceholderView.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = JSQMessagesMediaPlaceholderView.m; sourceTree = "<group>"; };
 		88324C3319F6301C00BC732D /* JSQMessagesMediaViewBubbleImageMaskerTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = JSQMessagesMediaViewBubbleImageMaskerTests.m; sourceTree = "<group>"; };
@@ -497,6 +498,7 @@
 				88A25F8619D8E01A00924534 /* JSQPhotoMediaItem.m */,
 				886C33FB19F4371E006B4997 /* JSQVideoMediaItem.h */,
 				886C33FC19F4371E006B4997 /* JSQVideoMediaItem.m */,
+				58620BCC6ABA99E3C6FD36F5 /* JSQMessagesViewAccessoryButtonDelegate.h */,
 			);
 			path = Model;
 			sourceTree = "<group>";

JSQMessagesDemo/Base.lproj/Main.storyboard

@@ -17,6 +17,10 @@
 //
 
 #import "DemoMessagesViewController.h"
+#import "JSQMessagesViewAccessoryButtonDelegate.h"
+
+@interface DemoMessagesViewController () <JSQMessagesViewAccessoryButtonDelegate>
+@end
 
 @implementation DemoMessagesViewController
 
@@ -44,7 +48,12 @@ - (void)viewDidLoad
      */
     self.demoData = [[DemoModelData alloc] init];
 
-    
+
+    /**
+     *  Set up message accessory button delegate and configuration
+     */
+    self.collectionView.accessoryDelegate = self;
+
     /**
      *  You can set custom avatar sizes
      */
@@ -563,10 +572,16 @@ - (UICollectionViewCell *)collectionView:(JSQMessagesCollectionView *)collection
         cell.textView.linkTextAttributes = @{ NSForegroundColorAttributeName : cell.textView.textColor,
                                               NSUnderlineStyleAttributeName : @(NSUnderlineStyleSingle | NSUnderlinePatternSolid) };
     }
+
+    cell.accessoryButton.hidden = ![self shouldShowAccessoryButtonForMessage:msg];
 
     return cell;
 }
 
+- (BOOL)shouldShowAccessoryButtonForMessage:(id<JSQMessageData>)message
+{
+    return ([message isMediaMessage] && [NSUserDefaults accessoryButtonForMediaMessages]);
+}
 
 
 #pragma mark - UICollectionView Delegate
@@ -682,7 +697,6 @@ - (void)collectionView:(JSQMessagesCollectionView *)collectionView didTapCellAtI
 
 #pragma mark - JSQMessagesComposerTextViewPasteDelegate methods
 
-
 - (BOOL)composerTextView:(JSQMessagesComposerTextView *)textView shouldPasteWithSender:(id)sender
 {
     if ([UIPasteboard generalPasteboard].image) {
@@ -699,4 +713,11 @@ - (BOOL)composerTextView:(JSQMessagesComposerTextView *)textView shouldPasteWith
     return YES;
 }
 
+#pragma mark - JSQMessagesViewAccessoryDelegate methods
+
+- (void)messageView:(JSQMessagesCollectionView *)view didTapAccessoryButtonAtIndexPath:(NSIndexPath *)path
+{
+    NSLog(@"Tapped accessory button!");
+}
+
 @end

JSQMessagesDemo/DemoMessagesViewController.m

@@ -39,4 +39,6 @@
 
 @property (weak, nonatomic) IBOutlet UISwitch *springySwitch;
 
+@property (weak, nonatomic) IBOutlet UISwitch *accessoryButtonSwitch;
+
 @end

JSQMessagesDemo/DemoSettingsViewController.h

@@ -36,6 +36,7 @@ - (void)viewDidLoad
     self.extraMessagesSwitch.on = [NSUserDefaults extraMessagesSetting];
     self.longMessageSwitch.on = [NSUserDefaults longMessageSetting];
     self.emptySwitch.on = [NSUserDefaults emptyMessagesSetting];
+    self.accessoryButtonSwitch.on = [NSUserDefaults accessoryButtonForMediaMessages];
 
     self.incomingAvatarsSwitch.on = [NSUserDefaults incomingAvatarSetting];
     self.outgoingAvatarsSwitch.on = [NSUserDefaults outgoingAvatarSetting];
@@ -47,14 +48,16 @@ - (IBAction)didTapSwitch:(UISwitch *)sender
 {
     if (sender == self.extraMessagesSwitch) {
         [NSUserDefaults saveExtraMessagesSetting:sender.on];
-        
     }
     else if (sender == self.longMessageSwitch) {
         [NSUserDefaults saveLongMessageSetting:sender.on];
     }
     else if (sender == self.emptySwitch) {
         [NSUserDefaults saveEmptyMessagesSetting:sender.on];
     }
+    else if (sender == self.accessoryButtonSwitch) {
+        [NSUserDefaults saveAccessoryButtonForMediaMessages:sender.on];
+    }
     else if (sender == self.incomingAvatarsSwitch) {
         [NSUserDefaults saveIncomingAvatarSetting:sender.on];
     }

JSQMessagesDemo/DemoSettingsViewController.m

@@ -38,4 +38,7 @@
 + (void)saveIncomingAvatarSetting:(BOOL)value;
 + (BOOL)incomingAvatarSetting;
 
++ (void)saveAccessoryButtonForMediaMessages:(BOOL)value;
++ (BOOL)accessoryButtonForMediaMessages;
+
 @end

JSQMessagesDemo/NSUserDefaults+DemoSettings.h

@@ -18,13 +18,13 @@
 
 #import "NSUserDefaults+DemoSettings.h"
 
-static NSString * const kSettingExtraMessages = @"kSettingExtraMessages";
-static NSString * const kSettingLongMessage = @"kSettingLongMessage";
-static NSString * const kSettingEmptyMessages = @"kSettingEmptyMessages";
-static NSString * const kSettingSpringiness = @"kSettingSpringiness";
-static NSString * const kSettingIncomingAvatar = @"kSettingIncomingAvatar";
-static NSString * const kSettingOutgoingAvatar = @"kSettingOutgoingAvatar";
-
+static NSString * const kSettingExtraMessages           = @"kSettingExtraMessages";
+static NSString * const kSettingLongMessage             = @"kSettingLongMessage";
+static NSString * const kSettingEmptyMessages           = @"kSettingEmptyMessages";
+static NSString * const kSettingSpringiness             = @"kSettingSpringiness";
+static NSString * const kSettingIncomingAvatar          = @"kSettingIncomingAvatar";
+static NSString * const kSettingOutgoingAvatar          = @"kSettingOutgoingAvatar";
+static NSString * const kSettingAccessoryButtonForMedia = @"kSettingAccessoryButtonForMedia";
 
 @implementation NSUserDefaults (DemoSettings)
 
@@ -88,4 +88,13 @@ + (BOOL)incomingAvatarSetting
     return [[NSUserDefaults standardUserDefaults] boolForKey:kSettingIncomingAvatar];
 }
 
++ (BOOL)accessoryButtonForMediaMessages
+{
+    return [[NSUserDefaults standardUserDefaults] boolForKey:kSettingAccessoryButtonForMedia];
+}
+
++ (void)saveAccessoryButtonForMediaMessages:(BOOL)value
+{
+    [[NSUserDefaults standardUserDefaults] setBool:value forKey:kSettingAccessoryButtonForMedia];
+}
 @end

JSQMessagesDemo/NSUserDefaults+DemoSettings.m

@@ -8,6 +8,9 @@
 /* Class = "UILabel"; text = "Outgoing avatars"; ObjectID = "9Rr-S8-Uae"; */
 "9Rr-S8-Uae.text" = "אווטאר בהודעות יוצאות";
 
+/* Class = "UILabel"; text = "Accessory button for media messages"; ObjectID = "Cae-FY-b5Q"; */
+"Cae-FY-b5Q.text" = "Accessory button for media messages";
+
 /* Class = "UILabel"; text = "Empty view, no messages"; ObjectID = "DoU-SU-Nek"; */
 "DoU-SU-Nek.text" = "מסך רייק ללא הודעות";
 

JSQMessagesDemo/he.lproj/Main.strings

@@ -58,8 +58,10 @@ - (void)testImageAssets
     XCTAssertNotNil([UIImage jsq_defaultAccessoryImage]);
 
     XCTAssertNotNil([UIImage jsq_defaultTypingIndicatorImage]);
-    
+
     XCTAssertNotNil([UIImage jsq_defaultPlayImage]);
+
+    XCTAssertNotNil([UIImage jsq_shareActionImage]);
 }
 
 @end

JSQMessagesTests/CategoryTests/JSQMessagesUIImageTests.m

@@ -83,6 +83,13 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (UIImage *)jsq_defaultPauseImage;
 
+/**
+ *  @return The standard share icon image.
+ *
+ *  @discussion This is the default icon for the message accessory button.
+ */
++ (UIImage *)jsq_shareActionImage;
+
 @end
 
 NS_ASSUME_NONNULL_END

JSQMessagesViewController/Assets/JSQMessagesAssets.bundle/Images/UIButtonBarActionSmall.png

@@ -105,4 +105,8 @@ + (UIImage *)jsq_defaultPauseImage
     return [UIImage jsq_bubbleImageFromBundleWithName:@"pause"];
 }
 
++ (UIImage *)jsq_shareActionImage
+{
+    return [UIImage jsq_bubbleImageFromBundleWithName:@"UIButtonBarActionSmall"];
+}
 @end

JSQMessagesViewController/Assets/JSQMessagesAssets.bundle/Images/[email protected]

@@ -30,16 +30,9 @@
 #import "JSQMessagesTypingIndicatorFooterView.h"
 #import "JSQMessagesLoadEarlierHeaderView.h"
 
-#import "JSQMessagesToolbarContentView.h"
-#import "JSQMessagesInputToolbar.h"
-#import "JSQMessagesComposerTextView.h"
-
 #import "NSString+JSQMessages.h"
-#import "UIColor+JSQMessages.h"
 #import "NSBundle+JSQMessages.h"
 
-#import <MobileCoreServices/UTCoreTypes.h>
-
 #import <objc/runtime.h>
 
 

JSQMessagesViewController/Assets/JSQMessagesAssets.bundle/Images/[email protected]

@@ -0,0 +1,42 @@
+//
+//  Created by Jesse Squires
+//  http://www.jessesquires.com
+//
+//  Documentation
+//  http://cocoadocs.org/docsets/JSQMessagesViewController
+//
+//
+//  GitHub
+//  https://github.com/jessesquires/JSQMessagesViewController
+//
+//
+//  License
+//  Copyright (c) 2014 Jesse Squires
+//  Released under an MIT license: http://opensource.org/licenses/MIT
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@class JSQMessagesCollectionView;
+
+/**
+*  The `JSQMessagesViewAccessoryButtonDelegate` protocol defines methods that allow you to
+*  handle accessory actions for the collection view.
+*/
+@protocol JSQMessagesViewAccessoryButtonDelegate <NSObject>
+
+@required
+
+/**
+ *  Notifies the delegate that the accessory button at the specified indexPath did receive a tap event.
+ *
+ *  @param messageView    The collection view object that is notifying the delegate of the tap event.
+ *  @param indexPath      The index path of the item for which the accessory button was tapped.
+ */
+- (void)messageView:(JSQMessagesCollectionView *)messageView didTapAccessoryButtonAtIndexPath:(NSIndexPath *)path;
+
+@end
+
+NS_ASSUME_NONNULL_END

JSQMessagesViewController/Categories/UIImage+JSQMessages.h

@@ -25,6 +25,7 @@
 
 @class JSQMessagesTypingIndicatorFooterView;
 @class JSQMessagesLoadEarlierHeaderView;
+@protocol JSQMessagesViewAccessoryButtonDelegate;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -46,6 +47,12 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (weak, nonatomic, nullable) id<JSQMessagesCollectionViewDelegateFlowLayout> delegate;
 
+/**
+ *  The object that handles accessory actions for the collection view.
+ *  It must adopt the `JSQMessagesViewAccessoryButtonDelegate` protocol.
+ */
+@property (weak, nonatomic, nullable) id<JSQMessagesViewAccessoryButtonDelegate> accessoryDelegate;
+
 /**
  *  The layout used to organize the collection view’s items.
  */

JSQMessagesViewController/Categories/UIImage+JSQMessages.m

@@ -18,7 +18,8 @@
 
 #import "JSQMessagesCollectionView.h"
 
-#import "JSQMessagesCollectionViewFlowLayout.h"
+#import "JSQMessagesViewAccessoryButtonDelegate.h"
+
 #import "JSQMessagesCollectionViewCellIncoming.h"
 #import "JSQMessagesCollectionViewCellOutgoing.h"
 
@@ -183,4 +184,14 @@ - (void)messagesCollectionViewCell:(JSQMessagesCollectionViewCell *)cell didPerf
                        withSender:sender];
 }
 
+- (void)messagesCollectionViewCellDidTapAccessoryButton:(JSQMessagesCollectionViewCell *)cell
+{
+    NSIndexPath *indexPath = [self indexPathForCell:cell];
+    if (indexPath == nil) {
+        return;
+    }
+
+    [self.accessoryDelegate messageView:self didTapAccessoryButtonAtIndexPath:indexPath];
+}
+
 @end

JSQMessagesViewController/Controllers/JSQMessagesViewController.m

@@ -74,6 +74,13 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)messagesCollectionViewCell:(JSQMessagesCollectionViewCell *)cell didPerformAction:(SEL)action withSender:(id)sender;
 
+/**
+ *  Tells the delegate that the accessory button of the cell has been tapped.
+ *
+ *  @param cell The cell that the accessory button belongs to.
+ */
+- (void)messagesCollectionViewCellDidTapAccessoryButton:(JSQMessagesCollectionViewCell *)cell;
+
 @end
 
 
@@ -156,6 +163,16 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (weak, nonatomic, readonly, nullable) UIView *avatarContainerView;
 
+/**
+ *  Returns the accessory button of the cell.
+ */
+@property (weak, nonatomic, readonly, nullable) UIButton *accessoryButton;
+
+/**
+ *  Sets an image for the accessory button of the cell.
+ */
+- (void)setAccessoryButtonImage:(UIImage *)image;
+
 /**
  *  The media view of the cell. This view displays the contents of a media message.
  *