Add close button to find/replace overlay #1991

The find/replace overlay can currently only be closed via pressing
Escape or using the shortcut CTRL+F when the overlay has input focus.
This change adds a close button to the overlay for providing an easy and
comprehensible way of closing the overlay.

Contributes to
#1991

Author: HeikoKlare

bundles/org.eclipse.ui.workbench.texteditor/icons/full/elcl16/close.png

@@ -60,6 +60,7 @@ private FindReplaceMessages() {
 	public static String FindReplace_SelectAllButton_label;
 	public static String FindReplace_CloseButton_label;
 
+	public static String FindReplaceOverlay_closeButton_toolTip;
 	public static String FindReplaceOverlay_downSearchButton_toolTip;
 	public static String FindReplaceOverlay_upSearchButton_toolTip;
 	public static String FindReplaceOverlay_searchAllButton_toolTip;

bundles/org.eclipse.ui.workbench.texteditor/icons/full/elcl16/[email protected]

@@ -45,7 +45,8 @@ FindReplace_ReplaceAllButton_label=Replace &All
 FindReplace_SelectAllButton_label=&Select All
 FindReplace_CloseButton_label=Close
 
-# Messages for the "new" Find-Replace-Overlay
+# Messages for the find/replace overlay
+FindReplaceOverlay_closeButton_toolTip=Close (Esc)
 FindReplaceOverlay_upSearchButton_toolTip=Search backward (Shift + Enter)
 FindReplaceOverlay_downSearchButton_toolTip=Search forward (Enter)
 FindReplaceOverlay_searchAllButton_toolTip=Search all (Ctrl + Enter)

bundles/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/findandreplace/FindReplaceMessages.java

@@ -34,7 +34,6 @@
 import org.eclipse.swt.graphics.RGBA;
 import org.eclipse.swt.graphics.Rectangle;
 import org.eclipse.swt.layout.GridData;
-import org.eclipse.swt.layout.GridLayout;
 import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Control;
@@ -92,14 +91,15 @@ public class FindReplaceOverlay extends Dialog {
 	private Composite searchBarContainer;
 	private Text searchBar;
 	private AccessibleToolBar searchTools;
-
 	private ToolItem searchInSelectionButton;
 	private ToolItem wholeWordSearchButton;
 	private ToolItem caseSensitiveSearchButton;
 	private ToolItem regexSearchButton;
 	private ToolItem searchUpButton;
 	private ToolItem searchDownButton;
 	private ToolItem searchAllButton;
+	private AccessibleToolBar closeTools;
+	private ToolItem closeButton;
 
 	private Composite replaceContainer;
 	private Composite replaceBarContainer;
@@ -378,6 +378,9 @@ private void restoreOverlaySettings() {
 	}
 
 	private void applyOverlayColors(Color color, boolean tryToColorReplaceBar) {
+		closeTools.setBackground(color);
+		closeButton.setBackground(color);
+
 		searchTools.setBackground(color);
 		searchInSelectionButton.setBackground(color);
 		wholeWordSearchButton.setBackground(color);
@@ -441,6 +444,7 @@ private Control createDialog(final Composite parent) {
 		createFindContainer();
 		createSearchBar();
 		createSearchTools();
+		createCloseTools();
 
 		container.layout();
 
@@ -464,7 +468,7 @@ private void retrieveBackgroundColor() {
 
 	private void createSearchTools() {
 		searchTools = new AccessibleToolBar(searchContainer);
-		GridDataFactory.fillDefaults().grab(false, true).align(GridData.CENTER, GridData.END).applyTo(searchTools);
+		GridDataFactory.fillDefaults().grab(false, true).align(GridData.END, GridData.END).applyTo(searchTools);
 
 		createCaseSensitiveButton();
 		createRegexSearchButton();
@@ -499,6 +503,16 @@ private void createSearchTools() {
 				})).build();
 	}
 
+	private void createCloseTools() {
+		closeTools = new AccessibleToolBar(searchContainer);
+		GridDataFactory.fillDefaults().grab(false, true).align(GridData.END, GridData.END).applyTo(closeTools);
+
+		closeButton = new AccessibleToolItemBuilder(closeTools).withStyleBits(SWT.PUSH)
+				.withImage(FindReplaceOverlayImages.get(FindReplaceOverlayImages.KEY_CLOSE))
+				.withToolTipText(FindReplaceMessages.FindReplaceOverlay_closeButton_toolTip)
+				.withSelectionListener(SelectionListener.widgetSelectedAdapter(e -> close())).build();
+	}
+
 	private void createAreaSearchButton() {
 		searchInSelectionButton = new AccessibleToolItemBuilder(searchTools).withStyleBits(SWT.CHECK)
 				.withImage(FindReplaceOverlayImages.get(FindReplaceOverlayImages.KEY_SEARCH_IN_AREA))
@@ -633,7 +647,7 @@ private void createReplaceBar() {
 	private void createFindContainer() {
 		searchContainer = new Composite(contentGroup, SWT.NONE);
 		GridDataFactory.fillDefaults().grab(true, true).align(GridData.FILL, GridData.FILL).applyTo(searchContainer);
-		GridLayoutFactory.fillDefaults().numColumns(2).extendedMargins(4, 4, 2, 8).equalWidth(false)
+		GridLayoutFactory.fillDefaults().numColumns(3).extendedMargins(4, 4, 2, 8).equalWidth(false)
 				.applyTo(searchContainer);
 		searchContainer.setBackground(getShell().getDisplay().getSystemColor(SWT.COLOR_WIDGET_LIGHT_SHADOW));
 		searchBarContainer = new Composite(searchContainer, SWT.NONE);
@@ -713,12 +727,6 @@ private void createReplaceDialog() {
 	private void enableSearchTools(boolean enable) {
 		((GridData) searchTools.getLayoutData()).exclude = !enable;
 		searchTools.setVisible(enable);
-
-		if (enable) {
-			((GridLayout) searchTools.getParent().getLayout()).numColumns = 2;
-		} else {
-			((GridLayout) searchTools.getParent().getLayout()).numColumns = 1;
-		}
 	}
 
 	private void enableReplaceToggle(boolean enable) {
@@ -735,20 +743,14 @@ private void enableReplaceTools(boolean enable) {
 		}
 		((GridData) replaceTools.getLayoutData()).exclude = !enable;
 		replaceTools.setVisible(enable);
-
-		if (enable) {
-			((GridLayout) replaceTools.getParent().getLayout()).numColumns = 2;
-		} else {
-			((GridLayout) replaceTools.getParent().getLayout()).numColumns = 1;
-		}
 	}
 
 	private int getIdealDialogWidth(Rectangle targetBounds) {
 		int replaceToggleWidth = 0;
 		if (okayToUse(replaceToggle)) {
 			replaceToggleWidth = replaceToggle.getBounds().width;
 		}
-		int toolBarWidth = searchTools.getSize().x;
+		int toolBarWidth = searchTools.getSize().x + closeTools.getSize().x;
 		GC gc = new GC(searchBar);
 		gc.setFont(searchBar.getFont());
 		int idealWidth = gc.stringExtent(IDEAL_WIDTH_TEXT).x; // $NON-NLS-1$

bundles/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/findandreplace/FindReplaceMessages.properties

@@ -35,6 +35,7 @@
 class FindReplaceOverlayImages {
 	private static final String PREFIX_ELCL = TextEditorPlugin.PLUGIN_ID + ".elcl."; //$NON-NLS-1$
 
+	static final String KEY_CLOSE = PREFIX_ELCL + "close"; //$NON-NLS-1$
 	static final String KEY_FIND_NEXT = PREFIX_ELCL + "select_next"; //$NON-NLS-1$
 	static final String KEY_FIND_PREV = PREFIX_ELCL + "select_prev"; //$NON-NLS-1$
 	static final String KEY_FIND_REGEX = PREFIX_ELCL + "regex"; //$NON-NLS-1$
@@ -60,6 +61,7 @@ class FindReplaceOverlayImages {
 	 * Declare all images
 	 */
 	private static void declareImages() {
+		declareRegistryImage(KEY_CLOSE, ELCL + "close.png"); //$NON-NLS-1$
 		declareRegistryImage(KEY_FIND_NEXT, ELCL + "select_next.png"); //$NON-NLS-1$
 		declareRegistryImage(KEY_FIND_PREV, ELCL + "select_prev.png"); //$NON-NLS-1$
 		declareRegistryImage(KEY_FIND_REGEX, ELCL + "regex.png"); //$NON-NLS-1$