Move processing of Swing border to AWT event dispatcher thread

This is a continuation of 979a129,
where the Swing border is now consumed in the AWT event dispatcher
thread, rather than the SWT UI thread. Interactions between those
threads are done asynchronously, to avoid accidental deadlocks.

Author: ptziegler

org.eclipse.wb.swing/src/org/eclipse/wb/internal/swing/model/property/editor/border/BorderDialog.java

@@ -58,6 +58,7 @@
 import org.apache.commons.lang3.StringUtils;
 
 import java.util.ArrayList;
+import java.util.concurrent.CompletableFuture;
 
 import javax.swing.border.Border;
 
@@ -224,29 +225,26 @@ protected void okPressed() {
 	 * Updates GUI using current {@link Border}.
 	 */
 	private void updateGUI() {
-		// select page
-		{
+		SwingUtils.runLogLater(() -> {
+			// select page
 			m_pagesLayout.topControl = m_pages.get(0);
-			ExecutionUtils.runLog(new RunnableEx() {
-				@Override
-				public void run() throws Exception {
-					for (AbstractBorderComposite page : m_pages) {
-						// TODO BorderValue
-						boolean understands = page.setBorder(m_borderValue.doGetValue());
-						if (understands && m_borderModified) {
-							m_pagesLayout.topControl = page;
-						}
-					}
+			for (AbstractBorderComposite page : m_pages) {
+				CompletableFuture<?> understands = page.setBorderValue(m_borderValue);
+				if (understands != null && m_borderModified) {
+					m_pagesLayout.topControl = page;
 				}
+			}
+			// update combo
+			ExecutionUtils.runLogLater(() -> {
+				m_pagesComposite.layout();
+				// select in "type" combo
+				m_typeCombo.select(m_pages.indexOf(m_pagesLayout.topControl));
 			});
-			m_pagesComposite.layout();
-			// select in "type" combo
-			m_typeCombo.select(m_pages.indexOf(m_pagesLayout.topControl));
-		}
-		// update preview
-		if (m_previewCanvas != null) {
-			SwingUtils.runLogLater(() -> m_previewCanvas.setBorder(m_borderValue));
-		}
+			// update preview
+			if (m_previewCanvas != null) {
+				m_previewCanvas.setBorder(m_borderValue);
+			}
+		});
 	}
 
 	////////////////////////////////////////////////////////////////////////////

org.eclipse.wb.swing/src/org/eclipse/wb/internal/swing/model/property/editor/border/BorderValue.java

@@ -60,8 +60,7 @@ public Class<?> getValueType() {
 	}
 
 	@Override
-	public Border doGetValue() {
-		// TODO Make protected
+	protected Border doGetValue() {
 		return border;
 	}
 

org.eclipse.wb.swing/src/org/eclipse/wb/internal/swing/model/property/editor/border/fields/AbstractBorderField.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011 Google, Inc.
+ * Copyright (c) 2011, 2025 Google, Inc. and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
@@ -53,5 +53,5 @@ public AbstractBorderField(Composite parent, int columns, String labelText) {
 	/**
 	 * @return the source corresponding to the made selection.
 	 */
-	public abstract String getSource() throws Exception;
+	public abstract String getSource();
 }

org.eclipse.wb.swing/src/org/eclipse/wb/internal/swing/model/property/editor/border/fields/BorderField.java

@@ -17,6 +17,7 @@
 import org.eclipse.wb.internal.swing.model.property.editor.border.BorderDialog;
 import org.eclipse.wb.internal.swing.model.property.editor.border.BorderValue;
 import org.eclipse.wb.internal.swing.model.property.editor.border.pages.AbstractBorderComposite;
+import org.eclipse.wb.internal.swing.utils.SwingUtils;
 
 import org.eclipse.core.runtime.Assert;
 import org.eclipse.jface.window.Window;
@@ -28,9 +29,7 @@
 import org.eclipse.swt.widgets.Shell;
 import org.eclipse.swt.widgets.Text;
 
-import java.util.Iterator;
-import java.util.LinkedList;
-import java.util.List;
+import java.util.concurrent.CompletableFuture;
 
 import javax.swing.border.Border;
 
@@ -103,7 +102,7 @@ public BorderValue getBorderValue() {
 	public void setBorderValue(BorderValue borderValue) throws Exception {
 		Assert.isNotNull(borderValue, "Border value must not be null.");
 		m_borderValue = borderValue;
-		m_source = calculateSource();
+		calculateSource();
 		showBorder();
 	}
 
@@ -112,25 +111,25 @@ public String getSource() {
 		return m_source;
 	}
 
-	private String calculateSource() throws Exception{
+	private void calculateSource() throws Exception {
 		// try to use AbstractBorderComposite's to convert Border into source
-		// TODO BorderValue
-		Border border = m_borderValue.doGetValue();
-		if (border != null) {
-			Class<?> compositeClass = AbstractBorderComposite.getCompositeClass(border.getClass());
-			if (compositeClass != null) {
-				AbstractBorderComposite borderComposite = getBorderComposite(compositeClass);
-				try {
-					if (borderComposite.setBorder(border)) {
-						return borderComposite.getSource();
-					}
-				} finally {
-					returnBorderComposite(borderComposite);
+		Class<?> compositeClass = AbstractBorderComposite.getCompositeClass(m_borderValue.getValueType());
+		if (compositeClass != null) {
+			AbstractBorderComposite borderComposite = getBorderComposite(compositeClass);
+			SwingUtils.runLogLater(() -> {
+				CompletableFuture<Void> understands = borderComposite.setBorderValue(m_borderValue);
+				if (understands != null) {
+					understands.thenRunAsync(() -> {
+						m_source = borderComposite.getSource();
+						borderComposite.dispose();
+					}, getDisplay()::asyncExec);
+				} else {
+					// no, we don't understand this Border return null;
+					m_source = null;
+					getDisplay().asyncExec(borderComposite::dispose);
 				}
-			}
+			});
 		}
-		// no, we don't understand this Border
-		return null;
 	}
 
 	@Override
@@ -143,35 +142,19 @@ public AbstractBorderComposite getParent() {
 	// Borders
 	//
 	////////////////////////////////////////////////////////////////////////////
-	private final List<AbstractBorderComposite> m_borderComposites = new LinkedList<>();
 
 	/**
 	 * Note, that we can not reuse {@link AbstractBorderComposite}'s, so when we get some
 	 * {@link AbstractBorderComposite}, we should return it back, else new instance will be created.
 	 *
 	 * @return the instance free of {@link AbstractBorderComposite}.
 	 */
-	private final AbstractBorderComposite getBorderComposite(Class<?> compositeClass)
-			throws Exception {
-		for (Iterator<AbstractBorderComposite> I = m_borderComposites.iterator(); I.hasNext();) {
-			AbstractBorderComposite borderComposite = I.next();
-			if (borderComposite.getClass() == compositeClass) {
-				I.remove();
-				return borderComposite;
-			}
-		}
+	private final AbstractBorderComposite getBorderComposite(Class<?> compositeClass) throws Exception {
 		// create new instance
 		Shell shell = getParent().getDialog().getTemporaryShell();
 		return (AbstractBorderComposite) compositeClass.getConstructor(Composite.class).newInstance(shell);
 	}
 
-	/**
-	 * Returns given {@link AbstractBorderComposite} to the list of available.
-	 */
-	private final void returnBorderComposite(AbstractBorderComposite borderComposite) {
-		m_borderComposites.add(borderComposite);
-	}
-
 	////////////////////////////////////////////////////////////////////////////
 	//
 	// Internal

org.eclipse.wb.swing/src/org/eclipse/wb/internal/swing/model/property/editor/border/pages/AbstractBorderComposite.java

@@ -14,6 +14,7 @@
 
 import org.eclipse.wb.internal.core.utils.ast.AstEditor;
 import org.eclipse.wb.internal.swing.model.property.editor.border.BorderDialog;
+import org.eclipse.wb.internal.swing.model.property.editor.border.BorderValue;
 import org.eclipse.wb.internal.swing.model.property.editor.border.fields.AbstractBorderField;
 import org.eclipse.wb.internal.swing.model.property.editor.border.fields.BooleanField;
 import org.eclipse.wb.internal.swing.model.property.editor.border.fields.BorderField;
@@ -30,6 +31,7 @@
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.concurrent.CompletableFuture;
 import java.util.function.Predicate;
 
 import javax.swing.border.Border;
@@ -75,17 +77,17 @@ public final String getTitle() {
 	}
 
 	/**
-	 * Sets the {@link Border} to edit.
+	 * Sets the {@link BorderValue} to edit.
 	 *
-	 * @return <code>true</code> if this {@link AbstractBorderComposite} understands given
-	 *         {@link Border}.
+	 * @return A {@link CompletableFuture} if this {@link AbstractBorderComposite}
+	 *         understands given {@link BorderValue}, otherwise {@code null}.
 	 */
-	public abstract boolean setBorder(Border border) throws Exception;
+	public abstract CompletableFuture<Void> setBorderValue(BorderValue borderValue);
 
 	/**
 	 * @return the source for updated {@link Border}.
 	 */
-	public abstract String getSource() throws Exception;
+	public abstract String getSource();
 
 	/**
 	 * Used by the {@link BorderField} for the source code generation.

org.eclipse.wb.swing/src/org/eclipse/wb/internal/swing/model/property/editor/border/pages/BevelBorderComposite.java

@@ -15,13 +15,18 @@
 import org.eclipse.wb.internal.core.utils.execution.ExecutionUtils;
 import org.eclipse.wb.internal.core.utils.ui.GridLayoutFactory;
 import org.eclipse.wb.internal.swing.model.ModelMessages;
+import org.eclipse.wb.internal.swing.model.property.editor.border.BorderValue;
 import org.eclipse.wb.internal.swing.model.property.editor.border.fields.ColorField;
 import org.eclipse.wb.internal.swing.model.property.editor.border.fields.RadioField;
 
+import org.eclipse.core.runtime.Assert;
 import org.eclipse.swt.widgets.Composite;
 
+import java.awt.Color;
+import java.util.concurrent.CompletableFuture;
+
+import javax.swing.SwingUtilities;
 import javax.swing.border.BevelBorder;
-import javax.swing.border.Border;
 
 /**
  * Implementation of {@link AbstractBorderComposite} that sets {@link BevelBorder}.
@@ -72,19 +77,25 @@ public BevelBorderComposite(Composite parent) {
 	//
 	////////////////////////////////////////////////////////////////////////////
 	@Override
-	public boolean setBorder(Border border) throws Exception {
-		if (border instanceof BevelBorder ourBorder) {
-			m_typeField.setValue(ourBorder.getBevelType());
-			m_highlightOuterField.setValue(ourBorder.getHighlightOuterColor());
-			m_highlightInnerField.setValue(ourBorder.getHighlightInnerColor());
-			m_shadowOuterField.setValue(ourBorder.getShadowOuterColor());
-			m_shadowInnerField.setValue(ourBorder.getShadowInnerColor());
+	public CompletableFuture<Void> setBorderValue(BorderValue borderValue) {
+		Assert.isTrue(SwingUtilities.isEventDispatchThread(), "Must be called from the AWT event dispatcher thread");
+		if (borderValue.getValue() instanceof BevelBorder ourBorder) {
+			int bevelType = ourBorder.getBevelType();
+			Color highlightOuterColor = ourBorder.getHighlightOuterColor();
+			Color highlightInnerColor = ourBorder.getHighlightInnerColor();
+			Color shadowOuterColor = ourBorder.getShadowOuterColor();
+			Color shadowInnerColor = ourBorder.getShadowInnerColor();
 			// OK, this is our Border
-			return true;
-		} else {
-			// no, we don't know this Border
-			return false;
+			return ExecutionUtils.runLogLater(() -> {
+				m_typeField.setValue(bevelType);
+				m_highlightOuterField.setValue(highlightOuterColor);
+				m_highlightInnerField.setValue(highlightInnerColor);
+				m_shadowOuterField.setValue(shadowOuterColor);
+				m_shadowInnerField.setValue(shadowInnerColor);
+			});
 		}
+		// no, we don't know this Border
+		return null;
 	}
 
 	@Override

org.eclipse.wb.swing/src/org/eclipse/wb/internal/swing/model/property/editor/border/pages/CompoundBorderComposite.java

@@ -22,13 +22,16 @@
 import org.eclipse.wb.internal.swing.model.property.editor.border.BorderValue;
 import org.eclipse.wb.internal.swing.model.property.editor.border.fields.BorderField;
 
+import org.eclipse.core.runtime.Assert;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Event;
 import org.eclipse.swt.widgets.Listener;
 
-import javax.swing.border.Border;
+import java.util.concurrent.CompletableFuture;
+
+import javax.swing.SwingUtilities;
 import javax.swing.border.CompoundBorder;
 
 /**
@@ -96,20 +99,23 @@ public void initialize(BorderDialog borderDialog, AstEditor editor) {
 	}
 
 	@Override
-	public boolean setBorder(Border border) throws Exception {
-		if (border instanceof CompoundBorder ourBorder) {
-			m_outsideField.setBorderValue(new BorderValue(ourBorder.getOutsideBorder()));
-			m_insideField.setBorderValue(new BorderValue(ourBorder.getInsideBorder()));
+	public CompletableFuture<Void> setBorderValue(BorderValue borderValue) {
+		Assert.isTrue(SwingUtilities.isEventDispatchThread(), "Must be called from the AWT event dispatcher thread");
+		if (borderValue.getValue() instanceof CompoundBorder ourBorder) {
+			BorderValue outsideBorder = new BorderValue(ourBorder.getOutsideBorder());
+			BorderValue insideBorder = new BorderValue(ourBorder.getInsideBorder());
 			// OK, this is our Border
-			return true;
-		} else {
-			// no, we don't know this Border
-			return false;
+			return ExecutionUtils.runLogLater(() -> {
+				m_outsideField.setBorderValue(outsideBorder);
+				m_insideField.setBorderValue(insideBorder);
+			});
 		}
+		// no, we don't know this Border
+		return null;
 	}
 
 	@Override
-	public String getSource() throws Exception {
+	public String getSource() {
 		String outsideSource = m_outsideField.getSource();
 		String insideSource = m_insideField.getSource();
 		if (outsideSource == null && insideSource == null) {

org.eclipse.wb.swing/src/org/eclipse/wb/internal/swing/model/property/editor/border/pages/DefaultBorderComposite.java

@@ -12,8 +12,12 @@
  *******************************************************************************/
 package org.eclipse.wb.internal.swing.model.property.editor.border.pages;
 
+import org.eclipse.wb.internal.swing.model.property.editor.border.BorderValue;
+
 import org.eclipse.swt.widgets.Composite;
 
+import java.util.concurrent.CompletableFuture;
+
 import javax.swing.JComponent;
 import javax.swing.border.Border;
 
@@ -41,8 +45,8 @@ public DefaultBorderComposite(Composite parent) {
 	//
 	////////////////////////////////////////////////////////////////////////////
 	@Override
-	public boolean setBorder(Border border) throws Exception {
-		return false;
+	public CompletableFuture<Void> setBorderValue(BorderValue border) {
+		return null;
 	}
 
 	@Override