Refactor dialog buttons to have equal width

Author: pcastornii

tabshell-core/src/main/java/com/techsenger/tabshell/core/dialog/AbstractDialogFxView.java

@@ -16,6 +16,7 @@
 
 package com.techsenger.tabshell.core.dialog;
 
+import com.techsenger.annotations.Unmodifiable;
 import com.techsenger.tabshell.core.popup.AbstractPopupFxView;
 import com.techsenger.tabshell.material.button.ResultButton;
 import com.techsenger.tabshell.material.button.ResultButtonName;
@@ -27,13 +28,14 @@
 import com.techsenger.toolkit.fx.RegionResizer;
 import com.techsenger.toolkit.fx.Spacer;
 import com.techsenger.toolkit.fx.pulse.LayoutPhase;
-import com.techsenger.toolkit.fx.pulse.LayoutPulseListener;
 import com.techsenger.toolkit.fx.utils.ButtonUtils;
 import com.techsenger.toolkit.fx.value.ValueUtils;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Stream;
+import javafx.application.Platform;
 import javafx.beans.binding.Bindings;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.DoubleProperty;
@@ -44,7 +46,6 @@
 import javafx.geometry.Orientation;
 import javafx.geometry.Pos;
 import javafx.scene.Cursor;
-import javafx.scene.Node;
 import javafx.scene.control.Button;
 import javafx.scene.control.Label;
 import javafx.scene.input.MouseEvent;
@@ -116,8 +117,6 @@ public void remove() {
 
     private final BooleanProperty resizable = new SimpleBooleanProperty();
 
-    private final BooleanProperty buttonWidthEqual = new SimpleBooleanProperty(false);
-
     private final DoubleProperty minWidth = new SimpleDoubleProperty();
 
     private final DoubleProperty minHeight = new SimpleDoubleProperty();
@@ -128,14 +127,6 @@ public void remove() {
 
     private final Map<ResultButtonName, Button> buttonsByName = new HashMap<>();
 
-    private boolean buttonWidthListenerAdded = false;
-
-    private final LayoutPulseListener buttonWidthListener = () -> {
-        makeResultButtonsEqual();
-        buttonWidthListenerAdded = false;
-        return false;
-    };
-
     /**
      * While dragging we need the difference. So, we keep in this variable previous value.
      */
@@ -219,11 +210,6 @@ public void setIcon(Icon<?> icon) {
         }
     }
 
-    @Override
-    public void setButtonWidthEqual(boolean value) {
-        this.buttonWidthEqual.set(value);
-    }
-
     @Override
     public Composer getComposer() {
         return (Composer) super.getComposer();
@@ -274,10 +260,6 @@ public boolean isResizable() {
         return resizable.get();
     }
 
-    public boolean isButtonWidthEqual() {
-        return buttonWidthEqual.get();
-    }
-
     protected BooleanProperty activeProperty() {
         return resizable;
     }
@@ -286,10 +268,6 @@ protected BooleanProperty resizableProperty() {
         return resizable;
     }
 
-    protected BooleanProperty buttonWidthEqualProperty() {
-        return buttonWidthEqual;
-    }
-
     protected BooleanProperty outOfBoundsAllowedProperty() {
         return outOfBoundsAllowed;
     }
@@ -358,11 +336,6 @@ protected void bind() {
     @Override
     protected void addListeners() {
         super.addListeners();
-        ValueUtils.callAndAddListener(this.buttonWidthEqual, (ov, oldV, newV) -> {
-            if (newV) {
-                updateButtonsEqual();
-            }
-        });
         ValueUtils.callAndAddListener(this.active, (ov, oldV, newV) -> {
             dialogBox.pseudoClassStateChanged(INACTIVE_PSEUDO_CLASS, !newV);
         });
@@ -382,27 +355,34 @@ protected void addHandlers() {
     }
 
     /**
-     * Makes all buttons in left and right boxes equal.
+     * Makes the specified buttons equal in width.
      */
-    protected void makeResultButtonsEqual() {
-        var buttons = getResultButtons();
-        ButtonUtils.makeEqualWidthBySize(buttons, true);
+    protected void makeEqualWidth(Button... buttons) {
+        makeEqualWidth(Arrays.asList(buttons));
     }
 
     /**
-     * Returns added buttons from the left and right boxes.
-     *
-     * @return list of all added buttons or empty collection
+     * Makes the specified buttons equal in width.
      */
-    protected List<ResultButton> getResultButtons() {
-        Stream<Node> allChildren = Stream.concat(
-            leftButtonBox.getChildren().stream(),
-            rightButtonBox.getChildren().stream()
-        );
-        return allChildren
-                .filter(ResultButton.class::isInstance)
-                .map(ResultButton.class::cast)
-                .toList();
+    protected void makeEqualWidth(List<Button> buttons) {
+        // To avoid flickering, both button boxes are hidden for one pulse:
+        // [Before Pulse N] hide buttons, register POST-layout listener
+        // [Pulse N | Layout] calculate sizes of invisible buttons
+        // [Pulse N | POST] equalize button widths, schedule setVisible(true) via runLater
+        // [Pulse N | Render] nothing visible, nothing rendered
+        // [Between N and N+1] runLater executes → buttons marked visible + dirty
+        // [Pulse N+1 | Layout] recalculate layout with correct minWidth
+        // [Pulse N+1 | Render] buttons appear on screen with correct size
+        rightButtonBox.setVisible(false);
+        leftButtonBox.setVisible(false);
+        getPulseListenerManager().addListener(LayoutPhase.POST, () -> {
+            ButtonUtils.makeEqualWidthBySize(buttons, true);
+            Platform.runLater(() -> {
+                rightButtonBox.setVisible(true);
+                leftButtonBox.setVisible(true);
+            });
+            return false;
+        });
     }
 
     /**
@@ -433,6 +413,43 @@ protected void unregisterButtons(ResultButton... buttons) {
         }
     }
 
+    /**
+     * Returns an unmodifiable list of buttons located in the left button container.
+     *
+     * @param resultButtonsOnly if {@code true}, only buttons of type {@link ResultButton}
+     *                          are returned; otherwise all {@link Button} instances are included
+     * @return unmodifiable list of buttons from the left {@code HBox}
+     */
+    protected @Unmodifiable List<Button> getLeftButtons(boolean resultButtonsOnly) {
+        return getButtons(leftButtonBox, resultButtonsOnly);
+    }
+
+    /**
+     * Returns an unmodifiable list of buttons located in the right button container.
+     *
+     * @param resultButtonsOnly if {@code true}, only buttons of type {@link ResultButton}
+     *                          are returned; otherwise all {@link Button} instances are included
+     * @return unmodifiable list of buttons from the right {@code HBox}
+     */
+    protected @Unmodifiable List<Button> getRightButtons(boolean resultButtonsOnly) {
+        return getButtons(rightButtonBox, resultButtonsOnly);
+    }
+
+    /**
+     * Returns an unmodifiable combined list of buttons from both left and right button containers.
+     *
+     * <p>If {@code resultButtonsOnly} is {@code true}, only {@link ResultButton} instances are included.</p>
+     *
+     * @param resultButtonsOnly filter flag for selecting only result buttons
+     * @return unmodifiable list of all matching buttons from both sides
+     */
+    protected @Unmodifiable List<Button> getButtons(boolean resultButtonsOnly) {
+        return Stream.concat(
+                getLeftButtons(resultButtonsOnly).stream(),
+                getRightButtons(resultButtonsOnly).stream())
+                .toList();
+    }
+
     /**
      * Returns a button box that can contain both result and additional buttons. In other words, it is safe to
      * add custom buttons to this box.
@@ -510,7 +527,6 @@ private void addButtons(HBox box, ResultButtonName... names) {
                 box.getChildren().add(button);
             }
         }
-        updateButtonsEqual();
         updateTrap();
     }
 
@@ -520,11 +536,25 @@ private void removeButtons(HBox box) {
         );
     }
 
-    private List<ResultButtonName> getButtons(HBox box) {
-        return box.getChildren().stream()
-                .filter(ResultButton.class::isInstance)
-                .map(ResultButton.class::cast)
-                .map(b -> b.getName())
+    /**
+     * Extracts buttons from the given {@link HBox} container with optional filtering by type.
+     *
+     * <p>If {@code resultButtonsOnly} is {@code true}, only instances of {@link ResultButton}
+     * are included; otherwise all {@link Button} instances are returned.</p>
+     *
+     * @param buttonBox the container holding button nodes
+     * @param resultButtonsOnly whether to include only {@link ResultButton} instances
+     * @return unmodifiable list of buttons contained in the specified box
+     */
+    private @Unmodifiable List<Button> getButtons(HBox buttonBox, boolean resultButtonsOnly) {
+        Class<? extends Button> filterClass = Button.class;
+        if (resultButtonsOnly) {
+            filterClass = ResultButton.class;
+        }
+
+        return buttonBox.getChildren().stream()
+                .filter(filterClass::isInstance)
+                .map(Button.class::cast)
                 .toList();
     }
 
@@ -533,11 +563,4 @@ private void updateTrap() {
             this.focusTrap.update();
         }
     }
-
-    private void updateButtonsEqual() {
-        if (!this.buttonWidthListenerAdded) {
-            getPulseListenerManager().addListener(LayoutPhase.POST, buttonWidthListener);
-            buttonWidthListenerAdded = true;
-        }
-    }
 }

tabshell-core/src/main/java/com/techsenger/tabshell/core/dialog/AbstractDialogPresenter.java

@@ -76,8 +76,6 @@ public void setDisabled(boolean disabled) {
 
     private boolean resizable;
 
-    private boolean buttonWidthEqual;
-
     private boolean closeDisabled;
 
     private String title;
@@ -178,16 +176,6 @@ public void setResizable(boolean resizable) {
         getView().setResizable(resizable);
     }
 
-    @Override
-    public boolean isButtonWidthEqual() {
-        return buttonWidthEqual;
-    }
-
-    public void setButtonWidthEqual(boolean buttonWidthEqual) {
-        this.buttonWidthEqual = buttonWidthEqual;
-        getView().setButtonWidthEqual(buttonWidthEqual);
-    }
-
     @Override
     public boolean isCloseDisabled() {
         return closeDisabled;

tabshell-core/src/main/java/com/techsenger/tabshell/core/dialog/ReadOnlyDialog.java

@@ -78,13 +78,6 @@ public interface ReadOnlyDialog {
      */
     boolean isResizable();
 
-    /**
-     * Returns whether equal button width rendering is enabled.
-     *
-     * @return {@code true} if buttons should have equal width, {@code false} otherwise
-     */
-    boolean isButtonWidthEqual();
-
     /**
      * Returns whether the close button in the top right corner of the dialog is disabled.
      *

tabshell-core/src/main/java/com/techsenger/tabshell/core/dialog/WriteOnlyDialog.java

@@ -81,16 +81,6 @@ public interface WriteOnlyDialog {
      */
     void setResizable(boolean value);
 
-    /**
-     * Enables or disables equal button width rendering.
-     * <p>
-     * When set to {@code true}, the view may re-evaluate button sizes and adjust their widths according to the
-     * current layout.
-     *
-     * @param value {@code true} to enable equal button widths, {@code false} to disable
-     */
-    void setButtonWidthEqual(boolean value);
-
     /**
      * Sets the disabled state for the close button in the top right corner of the dialog.
      *

tabshell-demo/src/main/java/com/techsenger/tabshell/demo/dialogs/DemoDialogFxView.java

@@ -18,6 +18,7 @@
 
 import com.techsenger.tabshell.core.dialog.AbstractDialogFxView;
 import com.techsenger.tabshell.material.button.ResultButton;
+import com.techsenger.tabshell.material.button.ResultButtonName;
 import com.techsenger.tabshell.material.style.Spacing;
 import javafx.scene.control.Label;
 import javafx.scene.control.TextField;
@@ -55,6 +56,12 @@ public void requestFocus() {
         fooTextField.deselect();
     }
 
+    @Override
+    public void setRightButtons(ResultButtonName... names) {
+        super.setRightButtons(names);
+        makeEqualWidth(getRightButtons(true));
+    }
+
     @Override
     protected void build() {
         super.build();

tabshell-demo/src/main/java/com/techsenger/tabshell/demo/dialogs/DemoDialogPresenter.java

@@ -55,7 +55,6 @@ protected void postInitialize() {
         setResizable(true);
         setPrefWidth(500);
         setTitle("Demo Dialog");
-        setButtonWidthEqual(true); //cancel button width will be equal to ok button width
         setRightButtons(DemoResultButtons.CANCEL, DemoResultButtons.OK);
     }
 }

tabshell-demo/src/main/java/com/techsenger/tabshell/demo/dialogs/DialogsDialogFxView.java

@@ -36,6 +36,7 @@
 import com.techsenger.tabshell.dialogs.namevalue.NameValueDialogPort;
 import com.techsenger.tabshell.dialogs.namevalue.NameValueDialogPresenter;
 import com.techsenger.tabshell.material.button.ResultButton;
+import com.techsenger.tabshell.material.button.ResultButtonName;
 import java.util.List;
 import javafx.collections.FXCollections;
 import javafx.scene.control.ListCell;
@@ -124,6 +125,12 @@ public Composer getComposer() {
         return (Composer) super.getComposer();
     }
 
+    @Override
+    public void setRightButtons(ResultButtonName... names) {
+        super.setRightButtons(names);
+        makeEqualWidth(getRightButtons(true));
+    }
+
     @Override
     protected Composer createComposer() {
         return new DialogsDialogFxView.Composer();

tabshell-demo/src/main/java/com/techsenger/tabshell/demo/dialogs/DialogsDialogPresenter.java

@@ -97,7 +97,6 @@ protected void postInitialize() {
         setPrefWidth(600);
         setPrefHeight(300);
         setTitle("Dialogs");
-        setButtonWidthEqual(true);
         view.setDialogTypes(Arrays.asList(DialogType.values()));
         setResultAction((result) -> {
             requestClose();

tabshell-dialogs/src/main/java/com/techsenger/tabshell/dialogs/alert/AlertDialogFxView.java

@@ -21,6 +21,7 @@
 import static com.techsenger.tabshell.dialogs.alert.AlertDialogType.ERROR;
 import com.techsenger.tabshell.dialogs.utils.FxViewUtils;
 import com.techsenger.tabshell.material.button.ResultButton;
+import com.techsenger.tabshell.material.button.ResultButtonName;
 import com.techsenger.tabshell.material.icon.Icon;
 import com.techsenger.tabshell.material.icon.IconViewBox;
 import com.techsenger.toolkit.fx.utils.NodeUtils;
@@ -67,6 +68,16 @@ public void requestFocus() {
         NodeUtils.requestFocus(getNode());
     }
 
+    @Override
+    public void setRightButtons(ResultButtonName... names) {
+        super.setRightButtons(names);
+        makeButtonsEqualWidth();
+    }
+
+    protected void makeButtonsEqualWidth() {
+        makeEqualWidth(getRightButtons(true));
+    }
+
     @Override
     protected void build() {
         super.build();

tabshell-dialogs/src/main/java/com/techsenger/tabshell/dialogs/alert/AlertDialogPresenter.java

@@ -118,6 +118,5 @@ protected void postInitialize() {
         setResultAction((result) -> requestClose());
         setPrefWidth(600);
         setMessage(message);
-        setButtonWidthEqual(true);
     }
 }