By Oscar Apeland


2013-09-17 11:31:45 8 Comments

I was wondering how to add a long press gesture recognizer to a (subclass of) UICollectionView. I read in the documentation that it is added by default, but I can't figure out how.

What I want to do is: Long press on a cell ( I have a calendar thingy from github ), get which cell is tapped and then do stuff with it. I need to know what cell is longpressed. Sorry for this broad question, but i couldn't find anything better on either google or SO

7 comments

@abbood 2013-09-17 11:36:05

Objective-C

In your myCollectionViewController.h file add the UIGestureRecognizerDelegate protocol

@interface myCollectionViewController : UICollectionViewController<UIGestureRecognizerDelegate>

in your myCollectionViewController.m file:

- (void)viewDidLoad
{
    // attach long press gesture to collectionView
    UILongPressGestureRecognizer *lpgr 
       = [[UILongPressGestureRecognizer alloc]
                     initWithTarget:self action:@selector(handleLongPress:)];
    lpgr.delegate = self;
    lpgr.delaysTouchesBegan = YES;
    [self.collectionView addGestureRecognizer:lpgr];
}

-(void)handleLongPress:(UILongPressGestureRecognizer *)gestureRecognizer
{
    if (gestureRecognizer.state != UIGestureRecognizerStateEnded) {
        return;
    }
    CGPoint p = [gestureRecognizer locationInView:self.collectionView];

    NSIndexPath *indexPath = [self.collectionView indexPathForItemAtPoint:p];
    if (indexPath == nil){
        NSLog(@"couldn't find index path");            
    } else {
        // get the cell at indexPath (the one you long pressed)
        UICollectionViewCell* cell =
        [self.collectionView cellForItemAtIndexPath:indexPath];
        // do stuff with the cell
    }
}

Swift

class Some {

    @objc func handleLongPress(gesture : UILongPressGestureRecognizer!) {
        if gesture.state != .Ended {
            return
        }
        let p = gesture.locationInView(self.collectionView)

        if let indexPath = self.collectionView.indexPathForItemAtPoint(p) {
            // get the cell at indexPath (the one you long pressed)
            let cell = self.collectionView.cellForItemAtIndexPath(indexPath)
            // do stuff with the cell
        } else {
            print("couldn't find index path")
        }
    }
}

let some = Some()
let lpgr = UILongPressGestureRecognizer(target: some, action: #selector(Some.handleLongPress))

Swift 4

class Some {

    @objc func handleLongPress(gesture : UILongPressGestureRecognizer!) {
        if gesture.state != .ended { 
            return 
        } 

        let p = gesture.location(in: self.collectionView) 

        if let indexPath = self.collectionView.indexPathForItem(at: p) { 
            // get the cell at indexPath (the one you long pressed) 
            let cell = self.collectionView.cellForItem(at: indexPath) 
            // do stuff with the cell 
        } else { 
            print("couldn't find index path") 
        }
    }
}

let some = Some()
let lpgr = UILongPressGestureRecognizer(target: some, action: #selector(Some.handleLongPress))

@Oscar Apeland 2013-09-17 11:44:52

Bonus noob question: How do I get a cell from indexpath? It worked btw, thanks

@abbood 2013-09-17 11:46:28

it's already in the answer : UICollectionViewCell* cell = [self.collectionView cellForItemAtIndexPath:indexPath]; reference here hope all this merits a correct answer award :D

@Oscar Apeland 2013-09-17 11:47:51

Oh, haha, I'm stupid. Ofcourse! 15 minute cooldown before accept youknow ;)

@tiguero 2013-09-17 11:55:24

@abbood how can the buildin longpress gesture recognizer not interfere with the custom one in ur code? I think that was the real question here

@abbood 2013-09-17 12:01:55

@tiguero what built-in longpress gesture recognizer are you talking about?

@DynamicDan 2014-01-01 17:29:36

For (at least) ios7 you have to add lpgr.delaysTouchesBegan = YES; to avoid the didHighlightItemAtIndexPath being triggered first.

@abbood 2014-01-02 05:39:27

@DynamicDan thanks! I'll update my answer to include your comment

@Yevhen Dubinin 2014-08-07 11:06:18

Why did you add lpgr.delegate = self;? It works fine without delegate, which you have not provided, either.

@Pétur Ingi Egilsson 2014-08-18 09:46:56

@abbood the answer works, but i can not scroll up and down in the collectionview (using another finger) while the long press recognizer is active. What gives?

@Jeffrey Sun 2015-04-18 19:50:54

Personally, I would do UIGestureRecognizerStateBegan, so the gesture is used when it is recognized, not when the user releases their finger.

@Loic Verrall 2015-08-11 22:42:54

@abbood @DynamicDan, I don't need to add the lpgr.delaysTouchesBegan = YES line when programming for iOS 9 in Swift. Has something changed?

@Bhavin Ramani 2015-12-28 09:52:35

@abbood how can I exchange position of cells on which we swipe? I am trying to exchange position of cells by gesture.

@abbood 2015-12-28 09:55:32

@bhavinramani that's a separate question.. please create a new one and link to it from the comments

@Bhavin Ramani 2015-12-28 10:15:21

@Bhavin Ramani 2015-12-29 04:44:16

@abbood please give me solution for above link.

@abbood 2015-12-29 04:47:17

Have you tried the answer posted on your question? The answerer works on my team he's good

@Bhavin Ramani 2015-12-29 05:19:45

@abbood thanks a lot.. I added comment on that answer please take a look. Lobo Labs rockss....

@jk2K 2016-01-29 07:47:30

lpgr.delegate = self; lpgr.delaysTouchesBegan = YES; is redundant

@Nikhil Chaurasiya 2016-07-22 07:34:06

Thanks bro, you save my day. :)

@JonSlowCN 2017-12-06 06:48:20

Update for Swfit 4: if gesture.state != .ended { return } let p = gesture.location(in: self.collectionView) if let indexPath = self.collectionView.indexPathForItem(at: p) { // get the cell at indexPath (the one you long pressed) let cell = self.collectionView.cellForItem(at: indexPath) // do stuff with the cell } else { print("couldn't find index path") }

@abbood 2017-12-06 07:15:37

@LordSpark feel free to edit the answer

@Андрей Кошманский 2016-08-12 16:26:21

Perhaps, using UILongPressGestureRecognizer is the most widespread solution. But I encounter with it two annoying troubles:

  • sometimes this recognizer works in incorrect way when we're moving our touch;
  • recognizer intercepts other touch actions so we can't use highlight callbacks of our UICollectionView in a proper way.

Let me suggest one a little bit bruteforce, but working as it's required suggestion:

Declaring a callback description for long click on our cell:

typealias OnLongClickListener = (view: OurCellView) -> Void

Extending UICollectionViewCell with variables (we can name it OurCellView, for example):

/// To catch long click events.
private var longClickListener: OnLongClickListener?

/// To check if we are holding button pressed long enough.
var longClickTimer: NSTimer?

/// Time duration to trigger long click listener.
private let longClickTriggerDuration = 0.5

Adding two methods in our cell class:

/**
 Sets optional callback to notify about long click.

 - Parameter listener: A callback itself.
 */
func setOnLongClickListener(listener: OnLongClickListener) {
    self.longClickListener = listener
}

/**
 Getting here when long click timer finishs normally.
 */
@objc func longClickPerformed() {
    self.longClickListener?(view: self)
}

And overriding touch events here:

/// Intercepts touch began action.
override func touchesBegan(touches: Set<UITouch>, withEvent event: UIEvent?) {
    longClickTimer = NSTimer.scheduledTimerWithTimeInterval(self.longClickTriggerDuration, target: self, selector: #selector(longClickPerformed), userInfo: nil, repeats: false)
    super.touchesBegan(touches, withEvent: event)
}

/// Intercepts touch ended action.
override func touchesEnded(touches: Set<UITouch>, withEvent event: UIEvent?) {
    longClickTimer?.invalidate()
    super.touchesEnded(touches, withEvent: event)
}

/// Intercepts touch moved action.
override func touchesMoved(touches: Set<UITouch>, withEvent event: UIEvent?) {
    longClickTimer?.invalidate()
    super.touchesMoved(touches, withEvent: event)
}

/// Intercepts touch cancelled action.
override func touchesCancelled(touches: Set<UITouch>?, withEvent event: UIEvent?) {
    longClickTimer?.invalidate()
    super.touchesCancelled(touches, withEvent: event)
}

Then somewhere in controller of our collection view declaring callback listener:

let longClickListener: OnLongClickListener = {view in
    print("Long click was performed!")
}

And finally in cellForItemAtIndexPath setting callback for our cells:

/// Data population.
func collectionView(collectionView: UICollectionView, cellForItemAtIndexPath indexPath: NSIndexPath) -> UICollectionViewCell {
    let cell = collectionView.dequeueReusableCellWithReuseIdentifier("Cell", forIndexPath: indexPath)
    let castedCell = cell as? OurCellView
    castedCell?.setOnLongClickListener(longClickListener)

    return cell
}

Now we can intercept long click actions on our cells.

@tiguero 2013-09-17 12:15:26

Answers here to add a custom longpress gesture recognizer are correct however according to the documentation here: the parent class of UICollectionView class installs a default long-press gesture recognizer to handle scrolling interactions so you must link your custom tap gesture recognizer to the default recognizer associated with your collection view.

The following code will avoid your custom gesture recognizer to interfere with the default one:

UILongPressGestureRecognizer* longPressGesture = [[UILongPressGestureRecognizer alloc] initWithTarget:self action:@selector(handleLongPressGesture:)];

longPressGesture.minimumPressDuration = .5; //seconds
longPressGesture.delegate = self;

// Make the default gesture recognizer wait until the custom one fails.
for (UIGestureRecognizer* aRecognizer in [self.collectionView gestureRecognizers]) {
   if ([aRecognizer isKindOfClass:[UILongPressGestureRecognizer class]])
      [aRecognizer requireGestureRecognizerToFail:longPressGesture];
} 

@abbood 2013-09-17 12:22:08

i see what you're saying, but it's not black and white, documentation says: The parent class of UICollectionView class installs a default tap gesture recognizer and a default long-press gesture recognizer to handle scrolling interactions. You should never try to reconfigure these default gesture recognizers or replace them with your own versions. so the default long-press recognizer is made for scrolling.. which implies it has to be accompanied with a vertical movement.. the OP isn't asking about that kind of behavior nor is he trying to replace it

@abbood 2013-09-17 12:29:24

sorry for sounding defensive, but I've been using the above code with my iOS app for months.. can't think of a single time a glitch happened

@tiguero 2013-09-17 12:32:05

@abbood that's fine. I don't know the third-party calendar component the PO is using but i think preventing a glitch even if u think it can never happen couldn't be a bad idea ;-)

@abbood 2013-09-17 12:37:20

couldn't agree more with you on that one, I just bookmarked your link as well and +1'ed your answer :)

@Crashalot 2016-05-01 23:01:41

If you must wait for the default recognizer to fail doesn't that mean there will be a delay?

@liuyuning 2016-04-28 11:20:21

Use the delegate of UICollectionView receive long press event

You must impl 3 method below.

//UICollectionView menu delegate
- (BOOL)collectionView:(UICollectionView *)collectionView shouldShowMenuForItemAtIndexPath:(NSIndexPath *)indexPath{

   //Do something

   return YES;
}
- (BOOL)collectionView:(UICollectionView *)collectionView canPerformAction:(SEL)action forItemAtIndexPath:(NSIndexPath *)indexPath withSender:(nullable id)sender{
    //do nothing
    return NO;
}

- (void)collectionView:(UICollectionView *)collectionView performAction:(SEL)action forItemAtIndexPath:(NSIndexPath *)indexPath withSender:(nullable id)sender{
    //do nothing
}

@ShannonS 2017-05-26 21:57:22

Note: If you return false for shouldShowMenuForItemAtIndexPath, the didSelectItemAtIndexPath will also be kicked off as well. This became problematic for me when I wanted two different actions for long press vs single press.

@Dmitry Fantastik 2015-12-28 15:56:55

To have an external gesture recognizer and do not conflict with internal gesture recognizers on the UICollectionView you need to:

Add your gesture recognizer, set up it and capture a reference for it somewhere (the best option is on your subclass if you subclassed UICollectionView)

@interface UICollectionViewSubclass : UICollectionView <UIGestureRecognizerDelegate>    

@property (strong, nonatomic, readonly) UILongPressGestureRecognizer *longPressGestureRecognizer;   

@end

Override default initialization methods initWithFrame:collectionViewLayout: and initWithCoder: and add set up method for you long press gesture recognizer

@implementation UICollectionViewSubclass

-(instancetype)initWithFrame:(CGRect)frame collectionViewLayout:(UICollectionViewLayout *)layout
{
    if (self = [super initWithFrame:frame collectionViewLayout:layout]) {
        [self setupLongPressGestureRecognizer];
    }
    return self;
}

-(instancetype)initWithCoder:(NSCoder *)aDecoder
{
    if (self = [super initWithCoder:aDecoder]) {
        [self setupLongPressGestureRecognizer];
    }
    return self;
}

@end

Write your setup method so it instantiates long press gesture recognizer, set it's delegate, setup dependencies with UICollectionView gesture recognizer (so it be the main gesture and all other gestures will wait till that gesture fails before being recognized) and add gesture to the view

-(void)setupLongPressGestureRecognizer
{
    _longPressGestureRecognizer = [[UILongPressGestureRecognizer alloc] initWithTarget:self
                                                                                action:@selector(handleLongPressGesture:)];
    _longPressGestureRecognizer.delegate = self;

    for (UIGestureRecognizer *gestureRecognizer in self.collectionView.gestureRecognizers) {
        if ([gestureRecognizer isKindOfClass:[UILongPressGestureRecognizer class]]) {
            [gestureRecognizer requireGestureRecognizerToFail:_longPressGestureRecognizer];
        }
    }

    [self.collectionView addGestureRecognizer:_longPressGestureRecognizer];
}

Also don't forget to implement UIGestureRecognizerDelegate methods that fails that gesture and allow simultaneous recognition (you may or may don't need to implement it, it depends on other gesture recognizers you have or dependencies with internal gesture recognizers)

- (BOOL)gestureRecognizer:(UIGestureRecognizer *)gestureRecognizer shouldRecognizeSimultaneouslyWithGestureRecognizer:(UIGestureRecognizer *)otherGestureRecognizer {
    if ([self.longPressGestureRecognizer isEqual:gestureRecognizer]) {
        return NO;
    }

    return NO;
}

credentials for that goes to internal implementation of LXReorderableCollectionViewFlowLayout

@benjaminhallock 2016-04-26 05:14:35

This is the same dance I did for my Snapchat clone. ahhh true love.

@satheeshwaran 2013-09-17 11:38:08

UILongPressGestureRecognizer *longPress = [[UILongPressGestureRecognizer alloc] initWithTarget:self action:@selector(longPress:)];

[cell addGestureRecognizer:longPress];

and add the method like this.

- (void)longPress:(UILongPressGestureRecognizer*)gesture
{
    if ( gesture.state == UIGestureRecognizerStateEnded ) {

        UICollectionViewCell *cellLongPressed = (UICollectionViewCell *) gesture.view;
    }
}

@Guilherme de Freitas 2015-10-26 18:28:58

The same code @abbood's code for Swift:

In viewDidLoad:

let lpgr : UILongPressGestureRecognizer = UILongPressGestureRecognizer(target: self, action: "handleLongPress:")
lpgr.minimumPressDuration = 0.5
lpgr.delegate = self
lpgr.delaysTouchesBegan = true
self.collectionView?.addGestureRecognizer(lpgr)

And the function:

func handleLongPress(gestureRecognizer : UILongPressGestureRecognizer){

    if (gestureRecognizer.state != UIGestureRecognizerState.Ended){
        return
    }

    let p = gestureRecognizer.locationInView(self.collectionView)

    if let indexPath : NSIndexPath = (self.collectionView?.indexPathForItemAtPoint(p))!{
        //do whatever you need to do
    }

}

Do not forget the delegate UIGestureRecognizerDelegate

@Joseph Geraghty 2016-04-18 17:20:40

Worked great, just a note that "handleLongPress:" should be changed to #selector(YourViewController.handleLongPress(_:))

@D-32 2016-05-01 20:52:34

The delegate isn't needed & not used in your code.

@Crashalot 2016-05-01 22:59:35

Works well, but change UIGestureRecognizerState.Ended to UIGestureRecognizerState.Began if you want the code to fire once the minimum duration has passed, not just when the user picks up his/her finger.

Related Questions

Sponsored Content

4 Answered Questions

1 Answered Questions

How to add gesture to custom UICollectionViewCell NIB?

0 Answered Questions

Adding a menu overlay to a UICollectionView using LongPress gesture

  • 2017-08-16 01:32:16
  • jmeiertx
  • 216 View
  • 1 Score
  • 0 Answer
  • Tags:   ios iphone swift

1 Answered Questions

[SOLVED] How can I add LongPress Gesture for a label in UICollectionViewCell in Swift

  • 2017-07-25 09:39:30
  • javimuu
  • 903 View
  • 1 Score
  • 1 Answer
  • Tags:   ios iphone swift

2 Answered Questions

2 Answered Questions

[SOLVED] Long press and pan gesture in UICollectionView

0 Answered Questions

2 Answered Questions

Sponsored Content