Merge pull request #17154 from iterate-ch/feature/GH-17147-refactor-alert-sheets

Refactor alerts to allow display as sheet or modal.

Author: dkocher

Cyberduck.xcodeproj/project.pbxproj

@@ -19,7 +19,7 @@
 import ch.cyberduck.binding.application.NSButton;
 import ch.cyberduck.binding.application.NSCell;
 import ch.cyberduck.binding.application.NSView;
-import ch.cyberduck.binding.application.SheetCallback;
+import ch.cyberduck.binding.application.NSWindow;
 import ch.cyberduck.binding.foundation.NSEnumerator;
 import ch.cyberduck.binding.foundation.NSObject;
 import ch.cyberduck.core.ProviderHelpServiceFactory;
@@ -31,9 +31,10 @@
 import org.rococoa.Foundation;
 import org.rococoa.Rococoa;
 import org.rococoa.cocoa.CGFloat;
+import org.rococoa.cocoa.foundation.NSPoint;
 import org.rococoa.cocoa.foundation.NSRect;
 
-public abstract class AlertController extends SheetController implements SheetCallback, InputValidator {
+public abstract class AlertController extends SheetController implements InputValidator {
     private static final Logger log = LogManager.getLogger(AlertController.class);
 
     protected static final int SUBVIEWS_VERTICAL_SPACE = 4;
@@ -43,12 +44,12 @@ public abstract class AlertController extends SheetController implements SheetCa
     @Outlet
     private NSAlert alert;
 
-    public AlertController(final NSAlert alert) {
-        this.loadBundle(alert);
+    public AlertController() {
+        super();
     }
 
-    public AlertController() {
-        // No bundle
+    public AlertController(final InputValidator callback) {
+        super(callback);
     }
 
     /**
@@ -63,72 +64,60 @@ public NSView getAccessoryView(final NSAlert alert) {
         return null;
     }
 
-    public int beginSheet(final WindowController parent) {
-        return new SheetInvoker(this, parent, this).beginSheet();
-    }
-
-    @Override
-    public void callback(final int returncode) {
-        log.warn("Ignore return code {}", returncode);
-    }
-
-    @Override
-    public void invalidate() {
-        alert = null;
-        super.invalidate();
-    }
+    public abstract NSAlert loadAlert();
 
     @Override
     public void loadBundle() {
-        //
-    }
-
-    protected void loadBundle(final NSAlert alert) {
-        this.alert = alert;
+        alert = this.loadAlert();
+        log.debug("Display alert {}", alert);
         alert.setShowsHelp(true);
         alert.setDelegate(this.id());
         if(alert.showsSuppressionButton()) {
             alert.suppressionButton().setTarget(this.id());
             alert.suppressionButton().setAction(Foundation.selector("suppressionButtonClicked:"));
         }
+        final NSWindow window = alert.window();
+        log.debug("Use window {}", window);
+        this.setWindow(window);
         // Layout alert view on main thread
         this.focus(alert);
-        this.setWindow(alert.window());
     }
 
     protected void focus(final NSAlert alert) {
-        NSEnumerator buttons = alert.buttons().objectEnumerator();
+        log.debug("Focus alert {}", alert);
+        final NSEnumerator buttons = alert.buttons().objectEnumerator();
         NSObject button;
         while((button = buttons.nextObject()) != null) {
             final NSButton b = Rococoa.cast(button, NSButton.class);
             b.setTarget(this.id());
-            b.setAction(Foundation.selector("closeSheet:"));
+            b.setAction(SheetController.BUTTON_CLOSE_SELECTOR);
         }
         final NSView accessory = this.getAccessoryView(alert);
         if(accessory != null) {
-            final NSRect frame = this.getFrame(alert, accessory);
+            final NSRect frame = this.getFrame(accessory);
             accessory.setFrameSize(frame.size);
             alert.setAccessoryView(accessory);
-            alert.window().makeFirstResponder(accessory);
+            window.makeFirstResponder(accessory);
         }
         // First call layout and then do any special positioning and sizing of the accessory view prior to running the alert
         alert.layout();
-        alert.window().recalculateKeyViewLoop();
+        window.recalculateKeyViewLoop();
     }
 
-    protected NSRect getFrame(final NSAlert alert, final NSView accessory) {
-        final NSRect frame = new NSRect(alert.window().frame().size.width.doubleValue(), accessory.frame().size.height.doubleValue());
+    protected NSRect getFrame(final NSView accessory) {
+        final NSRect frame = new NSRect(window.frame().size.width.doubleValue(), accessory.frame().size.height.doubleValue());
         final NSEnumerator enumerator = accessory.subviews().objectEnumerator();
         NSObject next;
         while(null != (next = enumerator.nextObject())) {
             final NSView subview = Rococoa.cast(next, NSView.class);
             frame.size.height = new CGFloat(frame.size.height.doubleValue() + subview.frame().size.height.doubleValue() + SUBVIEWS_VERTICAL_SPACE * 2);
         }
+        log.debug("Calculated frame {} for alert {} with accessory {}", frame, this, accessory);
         return frame;
     }
 
     /**
-     * Open help page.
+     * @return Help page.
      */
     protected String help() {
         return ProviderHelpServiceFactory.get().help();
@@ -147,9 +136,17 @@ public void alertShowHelp(final NSAlert alert) {
     @Action
     public void suppressionButtonClicked(final NSButton sender) {
         suppressed = sender.state() == NSCell.NSOnState;
+        log.debug("Suppression state set to {}", suppressed);
     }
 
     public boolean isSuppressed() {
         return suppressed;
     }
+
+    protected void addAccessorySubview(final NSView accessoryView, final NSView view) {
+        view.setFrameSize(this.getFrame(view).size);
+        view.setFrameOrigin(new NSPoint(0, this.getFrame(accessoryView).size.height.doubleValue()
+                + accessoryView.subviews().count().doubleValue() * SUBVIEWS_VERTICAL_SPACE));
+        accessoryView.addSubview(view);
+    }
 }

binding/src/main/java/ch/cyberduck/binding/AlertController.java

@@ -0,0 +1,55 @@
+package ch.cyberduck.binding;
+
+/*
+ * Copyright (c) 2002-2025 iterate GmbH. All rights reserved.
+ * https://cyberduck.io/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+import ch.cyberduck.binding.application.NSWindow;
+import ch.cyberduck.binding.application.SheetCallback;
+
+/**
+ * AlertRunner is an interface for managing the display and lifecycle
+ * of modal or non-modal alert windows (sheets) in macOS applications.
+ * <p>
+ * Implementations of this interface allow invoking alert dialogs
+ * attached to a parent window (sheet-based alerts) or as standalone
+ * modal dialogs. The alert dialogs provide user feedback and receive
+ * responses via the specified callback.
+ * <p>
+ * Method implementations typically interact with system-level APIs
+ * or frameworks such as AppKit to display and manage the sheet/window.
+ */
+public interface AlertRunner {
+    /**
+     * Displays an alert dialog attached to the specified NSWindow (sheet).
+     * The user interaction result is handled via the provided callback.
+     *
+     * @param sheet    The alert dialog window
+     * @param callback The callback to handle actions triggered by the alert
+     */
+    void alert(NSWindow sheet, SheetCallback callback);
+
+    /**
+     * Callback when alert is dismissed by user
+     */
+    interface CloseHandler {
+        /**
+         * Notified when alert is closed by user input
+         *
+         * @param sheet      Sheet window
+         * @param returncode Selected option
+         */
+        void closed(NSWindow sheet, int returncode);
+    }
+}