Ticket #2924: 2924.patch

_samples/api_dialog.html

@@ -75 +75 @@
                                         {
                                                 id : 'myField1',
                                                 type : 'text',
-                                                label : 'My Text Field'
+                                                label : 'My Text Field',
+                                                onEnterKey : function(evt)
+                                                {
+                                                        this.getDialog().getContentElement( 'customTab', 'myField2' ).focus();
+                                                        evt.cancel();
+                                                },
                                         },
                                         {
                                                 id : 'myField2',

_source/plugins/dialogui/plugin.js

@@ -60 +60 @@
                 {
                         return this._.initValue;
                 }
+        };
+        
+        //SpecialKeyMap
+        var keystrokeEnum = {
+                ENTER : 13,
+                CTRLENTER : 1013
         },
-        commonEventProcessors = CKEDITOR.tools.extend( {}, CKEDITOR.ui.dialog.uiElement.prototype.eventProcessors,
+        //special-keystroke handlers in elementDefinition
+        keystrokeHandlers = {};
+        
+        var commonEventProcessors = CKEDITOR.tools.extend( {}, CKEDITOR.ui.dialog.uiElement.prototype.eventProcessors,
                 {
                         onChange : function( dialog, func )
                         {
@@ -75 +84 @@
                                 }
 
                                 this.on( 'change', func );
+                        },
+                        
+                        /**
+                         * Dispatch special-keystroke to their corresponding named handler function in element definition. 
+                         * @param {Object} dialog
+                         * @param {Object} func
+                         * @param {Object} keystrokeName        The shortcut name for keystroke combination
+                         */
+                        onSpecialKey : function( dialog, func, keystrokeName )
+                        {
+                                keystrokeHandlers[ keystrokeName.toUpperCase() ] = func;
+                                if ( !this._.specialKeyRegistered )
+                                {
+                                        dialog.on( 'load', function()
+                                        {
+                                                this.getInputElement().on( 'keyup', function( evt ){
+                                                        
+                                                        var keyStrikeCode = evt.data.getKeystroke();
+                                                        var i ;
+                                                        for( i in keystrokeEnum)
+                                                        {
+                                                                //Is special-keystroke?
+                                                                if( keystrokeEnum[ i ] == keyStrikeCode
+                                                                        //Is handler defined? 
+                                                                        && keystrokeHandlers[ i ])
+                                                                        keystrokeHandlers[ i ].call( this, evt );
+                                                        }
+                                                        
+                                                }, this );
+                                        }, this );
+                                        this._.specialKeyRegistered = true;
+                                }
                         }
                 }, true ),
         eventRegex = /^on([A-Z]\w+)/,
@@ -207 +248 @@
                                 if ( elementDefinition.size )
                                         attributes.size = elementDefinition.size;
 
-                                // If user presses Enter in a text box, it implies clicking OK for the dialog.
-                                var me = this;
-                                dialog.on( 'load', function()
-                                        {
-                                                me.getInputElement().on( 'keyup', function( evt )
-                                                        {
-                                                                if ( evt.data.$.keyCode == 13 )
-                                                                        dialog.getButton( 'ok' ) && dialog.getButton( 'ok' ).click();
-                                                        } );
-                                        } );
-
                                 /** @ignore */
                                 var innerHTML = function()
                                 {
@@ -230 +260 @@
                                         return html.join( '' );
                                 };
                                 CKEDITOR.ui.dialog.labeledElement.call( this, dialog, elementDefinition, htmlList, innerHTML );
+                                
+                                // If user presses Enter in a text box, it implies clicking OK for the dialog.
+                                var me = this;
+                                dialog.on( 'load', function()
+                                        {
+                                                me.getInputElement().on( 'keyup', function( evt )
+                                                        {
+                                                                if ( evt.data.$.keyCode == 13 )
+                                                                        dialog.getButton( 'ok' ) && dialog.getButton( 'ok' ).click();
+                                                        } );
+                                        } );
+
                         },
 
                         /**

_source/plugins/dialog/plugin.js

@@ -2036 +2036 @@
                 registerEvents : function( definition )
                 {
                         var regex = /^on([A-Z]\w+)/,
-                                match;
+                                match,
+                                        specialKeyRegex = /^(Enter|Esc)Key$/,
+                                        specialKeyMatch;
 
                         var registerDomEvent = function( uiElement, dialog, eventName, func )
                         {
@@ -2052 +2054 @@
                                         continue;
                                 if ( this.eventProcessors[i] )
                                         this.eventProcessors[i].call( this, this._.dialog, definition[i] );
+                                //seak for specialkey handler names
+                                else if ( specialKeyMatch  = match[1].match( specialKeyRegex ) )
+                                {
+                                        this.eventProcessors.onSpecialKey.call( this, this._.dialog, definition[i], specialKeyMatch[1] )
+                                }
                                 else
                                         registerDomEvent( this, this._.dialog, match[1].toLowerCase(), definition[i] );
                         }
@@ -2094 +2101 @@
                         onHide : function( dialog, func )
                         {
                                 dialog.on( 'hide', func );
+                        },
+                        /**
+                         * @see CKEDITOR.ui.dialog::eventProcessors.onSpecialKey
+                         */
+                        onSpecialKey : function( dialog,  func,  keystrokeName )
+                        {
                         }
                 },