[wicket] branch WICKET-6666_modal-dialog-2 updated: WICKET-6666 improved JS doc

[svenmeier]

This is an automated email from the ASF dual-hosted git repository.

svenmeier pushed a commit to branch WICKET-6666_modal-dialog-2
in repository https://gitbox.apache.org/repos/asf/wicket.git


The following commit(s) were added to refs/heads/WICKET-6666_modal-dialog-2 by 
this push:
     new ec7b15e  WICKET-6666 improved JS doc
ec7b15e is described below

commit ec7b15e76d376ee71b0fb779f7213f62d3cddf0e
Author: Sven Meier <svenme...@apache.org>
AuthorDate: Fri Nov 29 13:41:48 2019 +0100

    WICKET-6666 improved JS doc
---
 .../extensions/ajax/markup/html/modal/trap-focus.js  | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git 
a/wicket-extensions/src/main/java/org/apache/wicket/extensions/ajax/markup/html/modal/trap-focus.js
 
b/wicket-extensions/src/main/java/org/apache/wicket/extensions/ajax/markup/html/modal/trap-focus.js
index eeb0539..681d186 100644
--- 
a/wicket-extensions/src/main/java/org/apache/wicket/extensions/ajax/markup/html/modal/trap-focus.js
+++ 
b/wicket-extensions/src/main/java/org/apache/wicket/extensions/ajax/markup/html/modal/trap-focus.js
@@ -15,6 +15,12 @@
  * limitations under the License.
  */
 
+/*
+ * Used by TrapFocusBehavior to trap focus inside a component's markup.
+ *
+ * @author Igor Vaynberg
+ * @author svenmeier
+ */
 ;
 (function($, window, document, undefined) {
        'use strict';
@@ -23,25 +29,25 @@
                return;
        }
        
-       /** Finds all elements inside container that can receive focus */
+       /** find all elements inside container that can receive focus */
        function findFocusable(container) {
                var focusables = 'a[href], area[href], input:not([disabled]), 
select:not([disabled]), textarea:not([disabled]), button:not([disabled]), 
iframe, object, embed, *[tabindex], *[contenteditable]';
                return container.find(focusables).filter(":visible, 
*:not([tabindex=-1])");
        }
 
-       // special handler listening for 'trapfocusremove' handlers - it is
-       // invoked when any element with that event handler is removed from the 
DOM
+       // special handler notified by jQuery on removal of a 'trapfocusremove' 
handler - this
+       // happens whenever an element with a focus trap is removed from the 
DOM, see below
        $.event.special.trapfocusremove = {
                remove: function(handleObj) {
-                       // forward notification of removal
+                       // forward removal notification, this allows the focus 
trap to be cleaned up  
                        handleObj.handler();
                }
        };
 
-       // global handler for 'focusin'
+       // one global active 'focusin' handler for all traps  
        var focusin = $.noop;
 
-       // setup focus trap for an element
+       // setup a focus trap for an element
        window.Wicket.trapFocus = function(element) {
                
                // keep old active element
@@ -76,7 +82,7 @@
                        }
                });
                
-               // turn off possible previous 'focusin' handler
+               // turn off previous 'focusin' handler
                var previousfocusin = focusin;
                $(document).off("focusin", focusin);