Searchbox global key-binding override hack (fixes: http://code.google.com/p/dart/issues/detail?id...

editor/tools/plugins/com.google.dart.tools.ui/src/com/google/dart/tools/ui/omni/OmniBoxControlContribution.java

 /*
  * Copyright (c) 2011, the Dart project authors.
  * 
  * Licensed under the Eclipse Public License v1.0 (the "License"); you may not use this file except
  * in compliance with the License. You may obtain a copy of the License at
  * 
  * http://www.eclipse.org/legal/epl-v10.html
  * 
  * Unless required by applicable law or agreed to in writing, software distributed under the License
  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
@@ skipping 16 matching lines @@
 import org.eclipse.swt.events.MouseTrackAdapter;
 import org.eclipse.swt.graphics.Point;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Control;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Event;
 import org.eclipse.swt.widgets.Listener;
 import org.eclipse.swt.widgets.Menu;
 import org.eclipse.swt.widgets.Text;
 import org.eclipse.ui.IWorkbenchWindow;
+import org.eclipse.ui.PlatformUI;
+import org.eclipse.ui.keys.IBindingService;
 import org.eclipse.ui.menus.WorkbenchWindowControlContribution;
 
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Map.Entry;
 
 /**
  * Contributes the omnibox toolbar control.
  */
 public class OmniBoxControlContribution extends WorkbenchWindowControlContribution {
@@ skipping 44 matching lines @@
    * keybinding).
    * 
    * @param window the host window
    * @return the location to root the popup
    */
   public static Point getPopupLocation(IWorkbenchWindow window) {
     OmniBoxControlContribution contrib = CONTROL_MAP.get(window);
     if (contrib == null) {
       return new Point(0, 0);
     }
-    return locationRelativeToControl(contrib.control);
+    return locationRelativeToControl(contrib.textControl);
   }
 
   private static Point locationRelativeToControl(Text control) {
     return control.toDisplay(0 + POPUP_PIXEL_HORIZ_NUDGE, control.getSize().y
         + POPUP_PIXEL_VERT_NUDGE);
   }
 
-  private Text control;
+  private Text textControl;
 
   private boolean inControl;
 
   private OmniBoxPopup popup;
 
   //used to track whether text is being modified programmatically (e.g., watermark-setting)
   private boolean listenForTextModify = true;
 
   //used when we want to advance focus off of the text control (ideally to restore previous)
   private Control previousFocusControl;
@@ skipping 11 matching lines @@
         disposedWindow = entry.getKey();
         break;
       }
     }
     if (disposedWindow != null) {
       CONTROL_MAP.remove(disposedWindow);
     }
   }
 
   public void giveFocus() {
-    cacheFocusControl(control.getDisplay().getFocusControl());
-    control.setFocus();
+    cacheFocusControl(textControl.getDisplay().getFocusControl());
+    textControl.setFocus();
     clearWatermark();
   }
 
   @Override
   protected Control createControl(Composite parent) {
-    control = createTextControl(parent);
+    textControl = createTextControl(parent);
     setWatermarkText();
     hookupListeners();
     CONTROL_MAP.put(getWorkbenchWindow(), this);
-    return control;
+    return textControl;
   }
 
   protected void defocus() {
     if (previousFocusControl != null && !previousFocusControl.isDisposed()) {
       previousFocusControl.setFocus();
     } else {
-      control.getParent().setFocus();
+      textControl.getParent().setFocus();
     }
   }
 
-  protected void handleMouseEnter() {
-    inControl = true;
-    //cache on mouse enter to ensure we can restore focus after an invocation initiated by a mouse click
-    cacheFocusControl(control.getDisplay().getFocusControl());
-  }
-
-  protected void handleMouseExit() {
-    inControl = false;
-  }
-
-  protected void handleSelection() {
-    clearWatermark();
-  }
-
   protected void refreshPopup() {
     if (popup != null && !popup.isDisposed()) {
       popup.refresh(getFilterText());
     }
   }
 
   private void cacheFocusControl(Control focusControl) {
     //since the point of caching the control is to restore focus away from us,
     //ignore any sets to "self"
-    if (focusControl != control) {
+    if (focusControl != textControl) {
       previousFocusControl = focusControl;
     }
   }
 
   private void clearWatermark() {
     //ensure watermark (or valid text) does not get re-cleared
-    if (control.getForeground().equals(OmniBoxColors.SEARCHBOX_TEXT_COLOR)) {
+    if (textControl.getForeground().equals(OmniBoxColors.SEARCHBOX_TEXT_COLOR)) {
       return;
     }
     silentSetControlText(""); //$NON-NLS-1$
-    control.setForeground(OmniBoxColors.SEARCHBOX_TEXT_COLOR);
+    textControl.setForeground(OmniBoxColors.SEARCHBOX_TEXT_COLOR);
   }
 
   private Text createTextControl(Composite parent) {
     Text text = new Text(parent, SEARCH_BOX_STYLE_BITS);
     text.setToolTipText(OmniBoxMessages.OmniBoxControlContribution_control_tooltip);
     // Disables the default context menu for native SWT text boxes
     text.setMenu(new Menu(parent));
     return text;
   }
 
   private String getFilterText() {
-    return control.getText().toLowerCase();
+    return textControl.getText().toLowerCase();
+  }
+
+  private void handleFocusGained() {
+    //disable global keybinding handlers so we can trap copy/paste/etc
+    ((IBindingService) PlatformUI.getWorkbench().getService(IBindingService.class)).setKeyFilterEnabled(false);
+    clearWatermark();
+  }
+
+  private void handleFocusLost() {
+    //re-enable global keybinding handlers
+    ((IBindingService) PlatformUI.getWorkbench().getService(IBindingService.class)).setKeyFilterEnabled(true);
+
+    //GTK linux requires special casing to handle the case where a click
+    //outside the search box (or popup) should cause the popup to close
+    //We identify this case by keying off focus changes --- if focus
+    //is transfered to another control we trigger a close
+    if (Util.isLinux()) {
+      //Exec async to ensure that it occurs after the focus change
+      Display.getDefault().asyncExec(new Runnable() {
+        @Override
+        public void run() {
+          Control focusControl = Display.getDefault().getFocusControl();
+          if (focusControl != textControl && popup != null && focusControl != popup.table) {
+            popup.close();
+          }
+        }
+      });
+    }
+    if (popupClosed()) {
+      setWatermarkText();
+    }
+  }
+
+  private void handleKeyPressed(KeyEvent e) {
+    if (SWT.ARROW_DOWN == e.keyCode) {
+      if (popupClosed()) {
+        openPopup();
+        refreshPopup();
+      }
+
+    }
+
+    if (popupClosed()) {
+      //have escape defocus
+      if (SWT.ESC == e.character) {
+        defocus();
+        return;
+      }
+      //and don't let other control characters invoke the popup
+      if (Character.isISOControl(e.character)) {
+        return;
+      }
+      openPopup();
+    }
+
+    if (popup != null && !popup.isDisposed()) {
+      popup.sendKeyPress(e);
+    }
+  }
+
+  private void handleModifyText() {
+    if (!listenForTextModify) {
+      return;
+    }
+    String filterText = getFilterText();
+    if (filterText.length() > 0) {
+      if (popupClosed()) {
+        openPopup();
+      }
+      refreshPopup();
+    } else {
+      popup.close();
+    }
+  }
+
+  private void handleMouseEnter() {
+    inControl = true;
+    //cache on mouse enter to ensure we can restore focus after an invocation initiated by a mouse click
+    cacheFocusControl(textControl.getDisplay().getFocusControl());
+  }
+
+  private void handleMouseExit() {
+    inControl = false;
+  }
+
+  private void handleMouseUp() {
+    if (inControl) {
+      handleSelection();
+    }
+  }
+
+  private void handleSelection() {
+    clearWatermark();
   }
 
   private void hookupListeners() {
-    control.addMouseListener(new MouseAdapter() {
+    textControl.addMouseListener(new MouseAdapter() {
       @Override
       public void mouseUp(MouseEvent e) {
-        if (inControl) {
-          handleSelection();
-        }
+        handleMouseUp();
       }
     });
 
-    control.addMouseTrackListener(new MouseTrackAdapter() {
+    textControl.addMouseTrackListener(new MouseTrackAdapter() {
       @Override
       public void mouseEnter(MouseEvent e) {
         handleMouseEnter();
       }
 
       @Override
       public void mouseExit(MouseEvent e) {
         handleMouseExit();
       }
     });
 
-    control.addModifyListener(new ModifyListener() {
+    textControl.addModifyListener(new ModifyListener() {
       @Override
       public void modifyText(ModifyEvent e) {
-        if (!listenForTextModify) {
-          return;
-        }
-        String filterText = getFilterText();
-        if (filterText.length() > 0) {
-          if (popupClosed()) {
-            openPopup();
-          }
-          refreshPopup();
-        } else {
-          popup.close();
-        }
+        handleModifyText();
       }
     });
 
-    control.addKeyListener(new KeyAdapter() {
+    textControl.addKeyListener(new KeyAdapter() {
       @Override
       public void keyPressed(KeyEvent e) {
-
-        if (SWT.ARROW_DOWN == e.keyCode) {
-          if (popupClosed()) {
-            openPopup();
-            refreshPopup();
-          }
-
-        }
-
-        if (popupClosed()) {
-          //have escape defocus
-          if (SWT.ESC == e.character) {
-            defocus();
-            return;
-          }
-          //and don't let other control characters invoke the popup
-          if (Character.isISOControl(e.character)) {
-            return;
-          }
-          openPopup();
-        }
-
-        if (popup != null && !popup.isDisposed()) {
-          popup.sendKeyPress(e);
-        }
+        handleKeyPressed(e);
       }
     });
 
-    control.addFocusListener(new FocusListener() {
+    textControl.addFocusListener(new FocusListener() {
       @Override
       public void focusGained(FocusEvent e) {
-        clearWatermark();
+        handleFocusGained();
       }
 
       @Override
       public void focusLost(FocusEvent e) {
-        //GTK linux requires special casing to handle the case where a click
-        //outside the search box (or popup) should cause the popup to close
-        //We identify this case by keying off focus changes --- if focus
-        //is transfered to another control we trigger a close
-        if (Util.isLinux()) {
-          //Exec async to esnure that it occurs after the focus change
-          Display.getDefault().asyncExec(new Runnable() {
-            @Override
-            public void run() {
-              Control focusControl = Display.getDefault().getFocusControl();
-              if (focusControl != control && popup != null && focusControl != popup.table) {
-                popup.close();
-              }
-            }
-          });
-        }
-        if (popupClosed()) {
-          setWatermarkText();
-        }
+        handleFocusLost();
       }
     });
   }
 
   private void openPopup() {
     popup = new OmniBoxPopup(getWorkbenchWindow(), null) {
       @Override
       public boolean close() {
         setWatermarkText();
         defocus();
         return super.close();
       }
 
       @Override
       protected Point getDefaultLocation(Point initialSize) {
-        return locationRelativeToControl(control);
+        return locationRelativeToControl(textControl);
       }
 
       @Override
       protected Point getDefaultSize() {
-        return new Point(control.getSize().x - POPUP_PIXEL_HORIZ_NUDGE * 2, 360);
+        return new Point(textControl.getSize().x - POPUP_PIXEL_HORIZ_NUDGE * 2, 360);
       }
 
     };
-    popup.setFilterControl(control);
+    popup.setFilterControl(textControl);
     popup.open();
 
     if (Util.isMac()) {
-      control.addListener(SWT.Deactivate, new Listener() {
+      textControl.addListener(SWT.Deactivate, new Listener() {
         @Override
         public void handleEvent(Event event) {
           //selecting the scrollbar will deactivate but in that case we don't want to close
           if (event.display.getFocusControl() != popup.table) {
             popup.close();
           }
-          control.removeListener(SWT.Deactivate, this);
+          textControl.removeListener(SWT.Deactivate, this);
         }
       });
     }
   }
 
   private boolean popupClosed() {
     return popup == null || popup.isDisposed();
   }
 
   private void setWatermarkText() {
     silentSetControlText(WATERMARK_TEXT);
-    control.setForeground(OmniBoxColors.WATERMARK_TEXT_COLOR);
+    textControl.setForeground(OmniBoxColors.WATERMARK_TEXT_COLOR);
   }
 
   //set text without notifying listeners
   private void silentSetControlText(String txt) {
     listenForTextModify = false;
-    control.setText(txt);
+    textControl.setText(txt);
     listenForTextModify = true;
   }
 
 }