Merge lp:~methanal-developers/methanal/1081191-modaldialog-close-notification into lp:methanal

[Jonathan Jacobs]

[Jonathan Jacobs (jjacobs)]

review: Approve

[Tristan Seligmann (mithrandi)]

I think it might be better if this had a notifyOnDisconnect()-type API where you get a new Deferred returned every time you call it.

review: Needs Fixing

=== modified file 'methanal/js/Methanal/Widgets.js'
--- methanal/js/Methanal/Widgets.js	2012-07-18 15:03:32 +0000
+++ methanal/js/Methanal/Widgets.js	2012-11-20 16:14:22 +0000
@@ -1403,6 +1403,9 @@
 
 /**
  * Modal dialog widget.
+ *
+ * @ivar onClose: L{Deferred} that is fired with a L{Boolean}, indicating if
+ *     the dialog was cancelled, when the dialog is closed.
  */
 Nevow.Athena.Widget.subclass(Methanal.Widgets, 'ModalDialog').methods(
     function nodeInserted(self) {
@@ -1411,13 +1414,22 @@
             self.node.ownerDocument.body, 'printing');
         Methanal.Util.addElementClass(
             self.node, 'print-target');
+        self.onClose = Divmod.Defer.Deferred();
+    },
+
+
+    /**
+     * Cancel the dialog.
+     */
+    function cancel(self, node) {
+        return self.close(node, true);
     },
 
 
     /**
      * Dismiss the dialog.
      */
-    function close(self) {
+    function close(self, node, cancelled) {
         Methanal.Util.removeElementClass(
             self.node.ownerDocument.body, 'printing');
         Methanal.Util.removeElementClass(
@@ -1426,6 +1438,7 @@
         self.detach();
         self.node.parentNode.removeChild(self.node);
         Methanal.Util.setModalOverlay(false);
+        self.onClose.callback(!!cancelled);
     });
 
 
@@ -1488,7 +1501,7 @@
      * Dismiss the dialog.
      */
     function cancel(self) {
-        self.widgetParent.close();
+        self.widgetParent.cancel();
         return false;
     });
 

=== modified file 'methanal/themes/methanal-base/methanal-modal-dialog.html'
--- methanal/themes/methanal-base/methanal-modal-dialog.html	2011-02-16 23:10:30 +0000
+++ methanal/themes/methanal-base/methanal-modal-dialog.html	2012-11-20 16:14:22 +0000
@@ -2,7 +2,7 @@
     <div class="modal-dialog-middle">
     <div class="modal-dialog-inner">
         <a href="#" class="modal-dialog-close" title="Close">
-            <athena:handler event="onclick" handler="close" />
+            <athena:handler event="onclick" handler="cancel" />
         </a>
         <h1 nevow:render="dialogTitle" />
         <div class="modal-dialog-content" nevow:render="dialogContent" />