[Mac] Make BookmarkBubbleController is-a BaseBubbleController.

chrome/browser/ui/cocoa/bookmarks/bookmark_bubble_controller.mm

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "chrome/browser/ui/cocoa/bookmarks/bookmark_bubble_controller.h"
 
 #include "base/mac/bundle_locations.h"
 #include "base/mac/mac_util.h"
 #include "base/sys_string_conversions.h"
 #include "chrome/browser/bookmarks/bookmark_model.h"
@@ skipping 52 matching lines @@
 // An object to represent the ChooseAnotherFolder item in the pop up.
 @interface ChooseAnotherFolder : NSObject
 @end
 
 @implementation ChooseAnotherFolder
 @end
 
 @interface BookmarkBubbleController (PrivateAPI)
 - (void)updateBookmarkNode;
 - (void)fillInFolderList;
-- (void)parentWindowWillClose:(NSNotification*)notification;
 @end
 
 @implementation BookmarkBubbleController
 
 @synthesize node = node_;
 
 + (id)chooseAnotherFolderObject {
   // Singleton object to act as a representedObject for the "choose another
   // folder" item in the pop up.
   static ChooseAnotherFolder* object = nil;
   if (!object) {
     object = [[ChooseAnotherFolder alloc] init];
   }
   return object;
 }
 
 - (id)initWithParentWindow:(NSWindow*)parentWindow
                      model:(BookmarkModel*)model
                       node:(const BookmarkNode*)node
      alreadyBookmarked:(BOOL)alreadyBookmarked {
-  NSString* nibPath =
-      [base::mac::FrameworkBundle() pathForResource:@"BookmarkBubble"
-                                             ofType:@"nib"];
-  if ((self = [super initWithWindowNibPath:nibPath owner:self])) {
-    parentWindow_ = parentWindow;
+  if ((self = [super initWithWindowNibPath:@"BookmarkBubble"
+                              parentWindow:parentWindow
+                                anchoredAt:NSZeroPoint])) {
     model_ = model;
     node_ = node;
     alreadyBookmarked_ = alreadyBookmarked;
-
-    // Watch to see if the parent window closes, and if so, close this one.
-    NSNotificationCenter* center = [NSNotificationCenter defaultCenter];
-    [center addObserver:self
-               selector:@selector(parentWindowWillClose:)
-                   name:NSWindowWillCloseNotification
-                 object:parentWindow_];
   }
   return self;
 }
 
 - (void)awakeFromNib {
+  [super awakeFromNib];
+
   // Check if NSTextFieldCell supports the method. This check is in place as
   // only 10.6 and greater support the setUsesSingleLineMode method.
   // TODO(kushi.p): Remove this when the project hits a 10.6+ only state.
   NSTextFieldCell* nameFieldCell_ = [nameTextField_ cell];
   if ([nameFieldCell_
           respondsToSelector:@selector(setUsesSingleLineMode:)]) {
     [nameFieldCell_ setUsesSingleLineMode:YES];
   }
 }
 
-- (void)dealloc {
-  [[NSNotificationCenter defaultCenter] removeObserver:self];
-  [super dealloc];
-}
-
 // If this is a new bookmark somewhere visible (e.g. on the bookmark
 // bar), pulse it.  Else, call ourself recursively with our parent
 // until we find something visible to pulse.
 - (void)startPulsingBookmarkButton:(const BookmarkNode*)node  {
   while (node) {
     if ((node->parent() == model_->bookmark_bar_node()) ||
         (node == model_->other_node())) {
       pulsingBookmarkNode_ = node;
       NSValue *value = [NSValue valueWithPointer:node];
       NSDictionary *dict = [NSDictionary
@@ skipping 31 matching lines @@
 
 // Close the bookmark bubble without changing anything.  Unlike a
 // typical dialog's OK/Cancel, where Cancel is "do nothing", all
 // buttons on the bubble have the capacity to change the bookmark
 // model.  This is an IBOutlet-looking entry point to remove the
 // dialog without touching the model.
 - (void)dismissWithoutEditing:(id)sender {
   [self close];
 }
 
-- (void)parentWindowWillClose:(NSNotification*)notification {
-  [self close];
-}
-
 - (void)windowWillClose:(NSNotification*)notification {
   // We caught a close so we don't need to watch for the parent closing.
-  [[NSNotificationCenter defaultCenter] removeObserver:self];
   bookmark_observer_.reset(NULL);
   chrome_observer_.reset(NULL);
   [self stopPulsingBookmarkButton];
-  [self autorelease];
+  [super windowWillClose:notification];
 }
 
 // We want this to be a child of a browser window.  addChildWindow:
 // (called from this function) will bring the window on-screen;
 // unfortunately, [NSWindowController showWindow:] will also bring it

[Nico, 2012/03/15 21:21:34]

Is this comment still needed? Maybe just "Override BaseBubbleController's
-showWindow to tweak the arrow location"? (Also in the other files, sorry)

[Robert Sesek, 2012/03/16 15:31:08]

Done.

 // on-screen (but will cause unexpected changes to the window's
 // position).  We cannot have an addChildWindow: and a subsequent
 // showWindow:. Thus, we have our own version.
 - (void)showWindow:(id)sender {
+  NSWindow* window = [self window];  // Force load the NIB.
+  NSWindow* parentWindow = self.parentWindow;
   BrowserWindowController* bwc =
-      [BrowserWindowController browserWindowControllerForWindow:parentWindow_];
+      [BrowserWindowController browserWindowControllerForWindow:parentWindow];
   [bwc lockBarVisibilityForOwner:self withAnimation:NO delay:NO];
-  NSWindow* window = [self window];  // completes nib load
-  [bubble_ setArrowLocation:info_bubble::kTopRight];
+
+  InfoBubbleView* bubble = self.bubble;
+  [bubble setArrowLocation:info_bubble::kTopRight];
+
   // Insure decent positioning even in the absence of a browser controller,
   // which will occur for some unit tests.
-  NSPoint arrowtip = bwc ? [bwc bookmarkBubblePoint] :
+  NSPoint arrowTip = bwc ? [bwc bookmarkBubblePoint] :
       NSMakePoint([window frame].size.width, [window frame].size.height);
-  NSPoint origin = [parentWindow_ convertBaseToScreen:arrowtip];
-  NSPoint bubbleArrowtip = [bubble_ arrowTip];
-  bubbleArrowtip = [bubble_ convertPoint:bubbleArrowtip toView:nil];
-  origin.y -= bubbleArrowtip.y;
-  origin.x -= bubbleArrowtip.x;
-  [window setFrameOrigin:origin];
-  [parentWindow_ addChildWindow:window ordered:NSWindowAbove];
+  arrowTip = [parentWindow convertBaseToScreen:arrowTip];
+  NSPoint bubbleArrowTip = [bubble arrowTip];
+  bubbleArrowTip = [bubble convertPoint:bubbleArrowTip toView:nil];
+  arrowTip.y -= bubbleArrowTip.y;
+  arrowTip.x -= bubbleArrowTip.x;
+  [window setFrameOrigin:arrowTip];
+
   // Default is IDS_BOOKMARK_BUBBLE_PAGE_BOOKMARK; "Bookmark".
   // If adding for the 1st time the string becomes "Bookmark Added!"
   if (!alreadyBookmarked_) {
     NSString* title =
         l10n_util::GetNSString(IDS_BOOKMARK_BUBBLE_PAGE_BOOKMARKED);
     [bigTitle_ setStringValue:title];
   }
 
   [self fillInFolderList];
 
   // Ping me when things change out from under us.  Unlike a normal
   // dialog, the bookmark bubble's cancel: means "don't add this as a
   // bookmark", not "cancel editing".  We must take extra care to not
   // touch the bookmark in this selector.
   bookmark_observer_.reset(new BookmarkModelObserverForCocoa(
                                node_, model_,
                                self,
                                @selector(dismissWithoutEditing:)));
   chrome_observer_.reset(new BookmarkBubbleNotificationBridge(
                              self, @selector(dismissWithoutEditing:)));
 
   // Pulse something interesting on the bookmark bar.
   [self startPulsingBookmarkButton:node_];
 
+  [parentWindow addChildWindow:window ordered:NSWindowAbove];
   [window makeKeyAndOrderFront:self];
 }
 
 - (void)close {
-  [[BrowserWindowController browserWindowControllerForWindow:parentWindow_]
+  [[BrowserWindowController browserWindowControllerForWindow:self.parentWindow]
       releaseBarVisibilityForOwner:self withAnimation:YES delay:NO];
-  [parentWindow_ removeChildWindow:[self window]];
-
-  // If you quit while the bubble is open, sometimes we get a
-  // DidResignKey before we get our parent's WindowWillClose and
-  // sometimes not.  We protect against a multiple close (or reference
-  // to parentWindow_ at a bad time) by clearing it out once we're
-  // done, and by removing ourself from future notifications.
-  [[NSNotificationCenter defaultCenter]
-    removeObserver:self
-              name:NSWindowWillCloseNotification
-            object:parentWindow_];
-  parentWindow_ = nil;
 
   [super close];
 }
 
 // Shows the bookmark editor sheet for more advanced editing.
 - (void)showEditor {
   [self ok:self];
   // Send the action up through the responder chain.
   [NSApp sendAction:@selector(editBookmarkNode:) to:nil from:self];
 }
@@ skipping 29 matching lines @@
   [self ok:sender];
 }
 
 // The controller is  the target of the pop up button box action so it can
 // handle when "choose another folder" was picked.
 - (IBAction)folderChanged:(id)sender {
   DCHECK([sender isEqual:folderPopUpButton_]);
   // It is possible that due to model change our parent window has been closed
   // but the popup is still showing and able to notify the controller of a
   // folder change.  We ignore the sender in this case.
-  if (!parentWindow_)
+  if (!self.parentWindow)
     return;
   NSMenuItem* selected = [folderPopUpButton_ selectedItem];
   ChooseAnotherFolder* chooseItem = [[self class] chooseAnotherFolderObject];
   if ([[selected representedObject] isEqual:chooseItem]) {
     content::RecordAction(
         UserMetricsAction("BookmarkBubble_EditFromCombobox"));
     [self showEditor];
   }
 }
 
@@ skipping 57 matching lines @@
   [item setRepresentedObject:obj];
   // Finally, select the current parent.
   NSValue* parentValue = [NSValue valueWithPointer:node_->parent()];
   NSInteger idx = [menu indexOfItemWithRepresentedObject:parentValue];
   [folderPopUpButton_ selectItemAtIndex:idx];
 }
 
 @end  // BookmarkBubbleController
 
 
-@implementation BookmarkBubbleController(ExposedForUnitTesting)
+@implementation BookmarkBubbleController (ExposedForUnitTesting)
 
 + (NSString*)chooseAnotherFolderString {
   return l10n_util::GetNSStringWithFixup(
       IDS_BOOKMARK_BUBBLE_CHOOSER_ANOTHER_FOLDER);
 }
 
 // For the given folder node, walk the tree and add folder names to
 // the given pop up button.
 - (void)addFolderNodes:(const BookmarkNode*)parent
          toPopUpButton:(NSPopUpButton*)button
@@ skipping 32 matching lines @@
   NSInteger idx = [menu indexOfItemWithRepresentedObject:parentValue];
   DCHECK(idx != -1);
   [folderPopUpButton_ selectItemAtIndex:idx];
 }
 
 - (NSPopUpButton*)folderPopUpButton {
   return folderPopUpButton_;
 }
 
 @end  // implementation BookmarkBubbleController(ExposedForUnitTesting)