TweetFollow Us on Twitter

The Ins and Outs of Drag and Drop

Volume Number: 18 (2002)
Issue Number: 11
Column Tag: Mac OS X

The Ins and Outs of Drag and Drop

by Andrew C. Stone

The most copied feature of the Mac OS X interface is the ubiquitous drag and drop. When NeXTStep advanced the techniques pioneered at Xerox's Palo Alto Research Center in the late '80's, the way in which people interacted with software was changed forever. The ability to move data and objects seamlessly between windows and applications without any additional steps is the hallmark of a native OS X application. This article will explore some more advanced techniques and some of the issues you might encounter when preparing your interface for drag and drop, as covered in other MacTech articles, such as http://www.stone.com/The_Cocoa_Files/What_a_Drag_.html. We'll cover making an entire window a receptacle for drag and drop, using central control to reduce code, dealing with temporary subviews such as field editors, and auto-swapping Tab views based on the type of data being dropped.

Many of Stone Design's applications fit into the category of "just drag and drop and you're done," such as PStill, GIFfun, PackUpAndGo, DOCtor and SliceAndDice. Taking PStill as an example, the user just drags a file onto the PStill window or application tile in the Dock or the Finder to convert the file to or redistill it as PDF:



Drag files onto Dock or Window

The strategy I like to employ is to make the entire window a valid drag target by subclassing NSWindow or NSPanel, and forwarding the actual methods to the window's delegate:

@interface NSObject(implement_this_in_delegate)
- (void)registerTypesForPanel:(NSPanel *)panel;
@end
@interface SDDragInPanel : NSPanel
{}
@end
@implementation SDDragInPanel
- (void)awakeFromNib
{
   [[self delegate] registerTypesForPanel:self];
}
- (unsigned int) draggingEntered:sender
{
    return [[self delegate] draggingEntered:sender];
}
- (unsigned int) draggingUpdated:sender
{
    return [[self delegate] draggingUpdated:sender];
}
- (BOOL) prepareForDragOperation:sender
{
        return [[self delegate] prepareForDragOperation:sender];
}
- (BOOL) performDragOperation:(id <NSDraggingInfo>)sender
{
    return [[self delegate] performDragOperation:sender];
}
@end

Typical code for delegate would be:

// Dragging stuff:
- (NSArray *)acceptableDragTypes{
    return [NSArray arrayWithObjects:NSFilenamesPboardType,nil];
}
- (void)registerTypesForPanel:(NSPanel *)panel;
{
   [panel registerForDraggedTypes:[self acceptableDragTypes]];
}
- (unsigned int)draggingEnteredOrUpdated:(id <NSDraggingInfo>)sender {
    // we want to ignore drags originating in our own window:
    if ([sender draggingSource] == dragWellView) return NSDragOperationNone;
    else {
        unsigned int sourceMask = [sender draggingSourceOperationMask];
        NSPasteboard *pboard = [sender draggingPasteboard];
        NSString *type = [pboard availableTypeFromArray:[self acceptableDragTypes]];
        if (type) return sourceMask;
        return NSDragOperationNone;
    }
}
- (unsigned int)draggingEntered:(id <NSDraggingInfo>)sender
{
    return [self draggingEnteredOrUpdated:sender];
}
- (unsigned int)draggingUpdated:(id <NSDraggingInfo>)sender
{
    return [self draggingEnteredOrUpdated:sender];
}
- (BOOL)performDragOperation:(id <NSDraggingInfo>)sender
{
    NSPasteboard *pboard = [sender draggingPasteboard];
    NSString *type = [pboard availableTypeFromArray:[self acceptableDragTypes]];
    BOOL loaded = NO;
    id ts = nil;
    if (type) {
        if ([type isEqualToString:NSFilenamesPboardType]) {
            NSArray *files = [pboard propertyListForType:NSFilenamesPboardType];
            unsigned i = [files count];
            while (i-- > 0) {
                NSString *f = [files objectAtIndex:i];
                if ([[self acceptableFileTypes] containsObject:[f pathExtension]] && 
                (ts = [SomeObject objectWithContentsOfFile:f])!=nil) {
                    loaded = YES;
          break;
      }
            }
        }
     }
    return loaded;
}
- (BOOL)prepareForDragOperation:sender
{
    return YES;
}
Be sure to register the view for the accepted types. A good place to do this is in 
-(void)awakeFromNib. This method is called on any object instantiated in a NIB (NeXT Interface 
Builder) file that has an implementation of awakeFromNib after all the objects are created and linked 
up, but before the window appears on screen. By implementing a single method acceptableDragTypes that 
returns which types you actually accept, you can avoid out-of-synch code when you add more types to 
open later:

   [panel registerForDraggedTypes:[self acceptableDragTypes]];

So we are done, right? Not quite, because of the way NSTextFields work. When you click or tab into a text field, a shared NSTextView is inserted into the view hierarchy. When the user drags a file over any part of the window that doesn't have an active textfield, the draggingEntered works as planned. But when you pass over the active text field, the NSTextView's drag validation methods come into play. The solution is to subclass NSTextView to also forward the methods to your window's delegate - or just to the window, since the window will forward on to the delegate:

#import <Cocoa/Cocoa.h>
@interface DragTextView : NSTextView
{
}
@end
#import "DragTextView.h"
@implementation DragTextView
// override drag stuff...
- (id)initWithFrame:(NSRect)r
{
    [super initWithFrame:r];
    [self registerForDraggedTypes:[[[self window] delegate] acceptableDragTypes]];
   // this is so TAB and RETURN end editing
   // instead of being inserted into the field:
    [self setFieldEditor:YES];  
    return self;
}
// note we just pass it up to the window:
- (unsigned int) draggingEntered:sender
{
    return [[self window] draggingEntered:sender];
}
... etc, just passing on the method to the window
@end

Now we have our custom text view, but how do we make sure our text view is used in place of the standard text view? We can't set z in Interface Builder, but we can code it. If a window's delegate implements a method called -windowWillReturnFieldEditor:(NSWindow *)sender toObject:(id)client, the Appkit code will call this method and use the text view it returns if non-nil, otherwise it uses a standard text view set in field editor mode.)

// add textView as  an iVar to the NSWindowController subclass which controls the window
- (id)windowWillReturnFieldEditor:(NSWindow *)sender toObject:(id)client {
    if (sender == [self window]) {
        if (!textView) textView = [[DragTextView alloc]initWithFrame:[myField bounds]];
        return textView;
    }
    return nil;
}

At this point, our interface is ready to accept the correct files and data at any location in the window.

There's one final issue: what if a user can drag a file out of your interface (for example, in PStill, you can drag the distilled PDF file out of the "drag out well") and that file type can also be dragged in to the application (for example, PStill accepts PDF files as input). A user might start a drag out of the application, change her mind, and drop the file back onto the application window. In this case, the application should probably not process the file. Therefore, the window delegate should check the draggingSource to make sure it's not a component of the window itself. This is why we have this line in the draggingEnteredOrUpdated code above:

    if ([sender draggingSource] == dragWellView) return NSDragOperationNone;

Autoswapping Tab Views

The concept of filtering the dragging methods through the window's delegate can be very useful when your window contains an NSTabView with different acceptable types in each view. In Create(R), for example, there is a resources library which can accept art, images, effects, blends, patterns and pages:


Create(R) lets you store many different types of resources - and it will swap to the correct tab view as necessary

Each of these tabviews has an NSScrollView, which contains an NSMatrix. When a user 
drags in a certain type that is not correct for the current view, but is acceptable in another one of 
the tab views, the tab view should automatically switch to the other view so that the drag can drop 
successfully in the right place. We do this by first checking if we can deal with it - and if not, 
we'll ask the window controller (which keeps track of the other views) to check the other resource 
managers. Note we also don't want to accept drags that start from this particular resource's matrix:

- (unsigned int)draggingEntered:(id <NSDraggingInfo>)sender
{
   return [self draggingEnteredOrUpdated:sender checkOthers:YES];
}
- (unsigned int)draggingUpdated:(id <NSDraggingInfo>)sender
{
    return [self draggingEnteredOrUpdated:sender checkOthers:YES];
}
- (unsigned int)draggingEnteredOrUpdated:(id <NSDraggingInfo>)sender 
checkOthers:(BOOL)checkOthers
{
    if ([sender draggingSource] == dragMatrix) return NSDragOperationNone;
    else {
        NSPasteboard *pboard = [sender draggingPasteboard];
        NSString *type = [pboard availableTypeFromArray:[self acceptableDraggedTypes]];
        if (type) {
            unsigned int sourceMask = [sender draggingSourceOperationMask];
            if ([type isEqualToString:NSFilenamesPboardType]) {
                NSArray *filenames = [pboard propertyListForType:NSFilenamesPboardType];
                if ([filenames count] == 1) {
                    NSString *filename = [filenames objectAtIndex:0];
                    if ([[[self resourceClass] fileTypes] containsObject:
         [filename pathExtension]])
                     return sourceMask;
                }
            } else return sourceMask;
        }
    }
    if (checkOthers) return [_controller draggingEnteredOrUpdated:sender];
    else return NSDragOperationNone;
}

The _controller's implementation might look something like this:

- (unsigned int)draggingEnteredOrUpdated:(id <NSDraggingInfo>)sender
{
    int i, c = [_resourceSources count];
    unsigned int returnValue;
    for (i = 0; i < c; i++) {
        ResourceSource *res = [_resourceSources objectAtIndex:i];
   if (res == _currentSource) continue;   // already checked!
        if ((returnValue = [res draggingEnteredOrUpdated:sender checkOthers:NO]) 
        != NSDragOperationNone) {
            [self showResourceSourceNamed:[res resourceSourceName]];
       return returnValue;
        }
    }
    return NSDragOperationNone;
}
- (void)showResourceSourceNamed:(NSString *)name
{
    [tabView selectTabViewItemAtIndex:[tabView indexOfTabViewItemWithIdentifier:name]];
}

Because the matrix may not fill the scroll view entirely, we'll also have to subclass the scroll view to forward draggingEntered methods to the matrix. To the end user, the entire scroll view is seen as the target, not just the matrix!

- (unsigned int)draggingEntered:(id <NSDraggingInfo>)sender
{
    return [[self documentView]draggingEntered:sender];
}

... etc. for all the other methods.

Application Tile Drag Support

You only have to perform a few tasks to add support for drag and drop to your Application icon and its Dock tile. First, you'll need to alert the system of the valid file types handled by your application. Then, you'll implement a method in the Application's delegate subclass which calls the actual method to deal with that file type.

First, add information about which files can be opened by your application in Project Builder's application Target Inspector, in the "Document Types" pane:


Be sure to add the file types that your application can open in Project Builder

Second, set your application's delegate. You can do this programmatically with NSApplication's setDelegate:. Or, you can use Interface Builder: (a) instantiate an object of your delegate class in your main NIB file, and (b) connect the File's Owner instance variable "delegate" to this new object.

Third, implement a single method in your delegate's class:

- (BOOL)application:(NSApplication *)sender openFile:(NSString *)path
{
   MyDocument *doc = [[NSDocumentController sharedDocumentController] 
   openDocumentWithContentsOfFile:path display:YES];
   return doc;
}

Now, not only will the dock tile accept drag and drop, but Finder will display your application as a choice for opening that kind of document.

Conclusion

If you want your application to really sing, be sure users can take full advantage of drag and drop everywhere! Not only will it make program interaction easier and more fun, it makes demoing the app more spectacular!


Andrew Stone is founder, janitor and chief computer scientist at Stone Design, www.stone.com.

 
AAPL
$99.76
Apple Inc.
+2.09
MSFT
$44.08
Microsoft Corpora
+0.45
GOOG
$520.84
Google Inc.
+9.67

MacTech Search:
Community Search:

Software Updates via MacUpdate

TechTool Pro 7.0.5 - Hard drive and syst...
TechTool Pro is now 7, and this is the most advanced version of the acclaimed Macintosh troubleshooting utility created in its 20-year history. Micromat has redeveloped TechTool Pro 7 to be fully 64... Read more
PDFKey Pro 4.0.2 - Edit and print passwo...
PDFKey Pro can unlock PDF documents protected for printing and copying when you've forgotten your password. It can now also protect your PDF files with a password to prevent unauthorized access and/... Read more
Yasu 2.9.1 - System maintenance app; per...
Yasu was originally created with System Administrators who service large groups of workstations in mind, Yasu (Yet Another System Utility) was made to do a specific group of maintenance tasks... Read more
Hazel 3.3 - Create rules for organizing...
Hazel is your personal housekeeper, organizing and cleaning folders based on rules you define. Hazel can also manage your trash and uninstall your applications. Organize your files using a... Read more
Autopano Giga 3.7 - Stitch multiple imag...
Autopano Giga allows you to stitch 2, 20, or 2,000 images. Version 3.0 integrates impressive new features that will definitely make you adopt Autopano Pro or Autopano Giga: Choose between 9... Read more
MenuMeters 1.8 - CPU, memory, disk, and...
MenuMeters is a set of CPU, memory, disk, and network monitoring tools for Mac OS X. Although there are numerous other programs which do the same thing, none had quite the feature set I was looking... Read more
Coda 2.5 - One-window Web development su...
Coda is a powerful Web editor that puts everything in one place. An editor. Terminal. CSS. Files. With Coda 2, we went beyond expectations. With loads of new, much-requested features, a few... Read more
Arq 4.6.1 - Online backup to Google Driv...
Arq is super-easy online backup for the Mac. Back up to your own Google Drive storage (15GB free storage), your own Amazon Glacier ($.01/GB per month storage) or S3, or any SFTP server. Arq backs up... Read more
Airfoil 4.8.10 - Send audio from any app...
Airfoil allows you to send any audio to AirPort Express units, Apple TVs, and even other Macs and PCs, all in sync! It's your audio - everywhere. With Airfoil you can take audio from any... Read more
Apple iMovie 10.0.6 - Edit personal vide...
With an all-new design, Apple iMovie lets you enjoy your videos like never before. Browse your clips more easily, instantly share your favorite moments, and create beautiful HD movies and Hollywood-... Read more

Latest Forum Discussions

See All

This Week at 148Apps: October 13-17, 201...
Expert App Reviewers   So little time and so very many apps. What’s a poor iPhone/iPad lover to do? Fortunately, 148Apps is here to give you the rundown on the latest and greatest releases. And we even have a tremendous back catalog of reviews; just... | Read more »
Angry Birds Transformers Review
Angry Birds Transformers Review By Jennifer Allen on October 20th, 2014 Our Rating: :: TRANSFORMED BIRDSUniversal App - Designed for iPhone and iPad Transformed in a way you wouldn’t expect, Angry Birds Transformers is a quite... | Read more »
GAMEVIL Announces the Upcoming Launch of...
GAMEVIL Announces the Upcoming Launch of Mark of the Dragon Posted by Jessica Fisher on October 20th, 2014 [ permalink ] Mark of the Dragon, by GAMEVIL, put | Read more »
Interview With the Angry Birds Transform...
Angry Birds Transformers recently transformed and rolled out worldwide. This run-and-gun title is a hit with young Transformers fans, but the ample references to classic Transformers fandom has also earned it a place in the hearts of long-time... | Read more »
Find Free Food on Campus with Ypay
Find Free Food on Campus with Ypay Posted by Jessica Fisher on October 20th, 2014 [ permalink ] iPhone App - Designed for the iPhone, compatible with the iPad | Read more »
Strung Along Review
Strung Along Review By Jordan Minor on October 20th, 2014 Our Rating: :: GOT NO STRINGSUniversal App - Designed for iPhone and iPad A cool gimmick and a great art style keep Strung Along from completely falling apart.   | Read more »
P2P file transferring app Send Anywhere...
File sharing services like Dropbox have security issues. Email attachments can be problematic when it comes to sharing large files. USB dongles don’t fit into your phone. Send Anywhere, a peer-to-peer file transferring application, solves all of... | Read more »
Zero Age Review
Zero Age Review By Jordan Minor on October 20th, 2014 Our Rating: :: MORE THAN ZEROiPad Only App - Designed for the iPad With its mind-bending puzzles and spellbinding visuals, Zero Age has it all.   | Read more »
Hay Ewe Review
Hay Ewe Review By Campbell Bird on October 20th, 2014 Our Rating: :: SAVE YOUR SHEEPLEUniversal App - Designed for iPhone and iPad Pave the way for your flock in this line drawing puzzle game from the creators of Worms.   | Read more »
My Very Hungry Caterpillar (Education)
My Very Hungry Caterpillar 1.0.0 Device: iOS Universal Category: Education Price: $3.99, Version: 1.0.0 (iTunes) Description: Care for your very own Very Hungry Caterpillar! My Very Hungry Caterpillar will captivate you as he crawls... | Read more »

Price Scanner via MacPrices.net

2013 15-inch 2.0GHz Retina MacBook Pro availa...
B&H Photo has leftover previous-generation 15″ 2.0GHz Retina MacBook Pros now available for $1599 including free shipping plus NY sales tax only. Their price is $400 off original MSRP. B&H... Read more
Updated iPad Prices
We’ve updated our iPad Air Price Tracker and our iPad mini Price Tracker with the latest information on prices and availability from Apple and other resellers, including the new iPad Air 2 and the... Read more
Apple Pay Available to Millions of Visa Cardh...
Visa Inc. brings secure, convenient payments to iPad Air 2 and iPad mini 3as well as iPhone 6 and 6 Plus. Starting October 20th, eligible Visa cardholders in the U.S. will be able to use Apple Pay,... Read more
Textkraft Pocket – the missing TextEdit for i...
infovole GmbH has announced the release and immediate availability of Textkraft Pocket 1.0, a professional text editor and note taking app for Apple’s iPhone. In March 2014 rumors were all about... Read more
C Spire to offer iPad Air 2 and iPad mini 3,...
C Spire on Friday announced that it will offer iPad Air 2 and iPad mini 3, both with Wi-Fi + Cellular, on its 4G+ LTE network in the coming weeks. C Spire will offer the new iPads with a range of... Read more
Belkin Announces Full Line of Keyboards and C...
Belkin International has unveiled a new lineup of keyboard cases and accessories for Apple’s newest iPads, featuring three QODE keyboards and a collection of thin, lightweight folios for both the... Read more
Verizon offers new iPad Air 2 preorders for $...
Verizon Wireless is accepting preorders for the new iPad Air 2, cellular models, for $100 off MSRP with a 2-year service agreement: - 16GB iPad Air 2 WiFi + Cellular: $529.99 - 64GB iPad Air 2 WiFi... Read more
Price drops on refurbished Mac minis, now ava...
The Apple Store has dropped prices on Apple Certified Refurbished previous-generation Mac minis, with models now available starting at $419. Apple’s one-year warranty is included with each mini, and... Read more
Apple refurbished 2014 MacBook Airs available...
The Apple Store has Apple Certified Refurbished 2014 MacBook Airs available for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is free.... Read more
Refurbished 2013 MacBook Pros available for u...
The Apple Store has Apple Certified Refurbished 13″ and 15″ MacBook Pros available starting at $929. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.5GHz MacBook Pros (4GB RAM/... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Position Opening at *Apple* - Apple (United...
…customers purchase our products, you're the one who helps them get more out of their new Apple technology. Your day in the Apple Store is filled with a range of Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** At the Apple Store, you connect business professionals and entrepreneurs with the tools they need in order to put Apple solutions to work in their Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** The Apple Store is a retail environment like no other - uniquely focused on delivering amazing customer experiences. As an Expert, you introduce people Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** As businesses discover the power of Apple computers and mobile devices, it's your job - as a Solutions Engineer - to show them how to introduce these Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.