JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.5
[ckeditor.git] / _source / plugins / menu / plugin.js
index 1ea12b2..5d37ffd 100644 (file)
@@ -53,6 +53,7 @@ CKEDITOR.plugins.add( 'menu',
 \r
                        this.editor = editor;\r
                        this.items = [];\r
+                       this._.listeners = [];\r
 \r
                        this._.level = definition.level || 1;\r
 \r
@@ -71,6 +72,84 @@ CKEDITOR.plugins.add( 'menu',
 \r
                _ :\r
                {\r
+                       onShow : function()\r
+                       {\r
+                               var selection = this.editor.getSelection();\r
+\r
+                               // Selection will be unavailable after menu shows up\r
+                               // in IE, lock it now.\r
+                               if ( CKEDITOR.env.ie )\r
+                                       selection && selection.lock();\r
+\r
+                               var element = selection && selection.getStartElement(),\r
+                                       listeners = this._.listeners,\r
+                                       includedItems = [];\r
+\r
+                               this.removeAll();\r
+                               // Call all listeners, filling the list of items to be displayed.\r
+                               for ( var i = 0 ; i < listeners.length ; i++ )\r
+                               {\r
+                                       var listenerItems = listeners[ i ]( element, selection );\r
+\r
+                                       if ( listenerItems )\r
+                                       {\r
+                                               for ( var itemName in listenerItems )\r
+                                               {\r
+                                                       var item = this.editor.getMenuItem( itemName );\r
+\r
+                                                       if ( item )\r
+                                                       {\r
+                                                               item.state = listenerItems[ itemName ];\r
+                                                               this.add( item );\r
+                                                       }\r
+                                               }\r
+                                       }\r
+                               }\r
+                       },\r
+\r
+                       onClick : function( item )\r
+                       {\r
+                               this.hide();\r
+\r
+                               if ( item.onClick )\r
+                                       item.onClick();\r
+                               else if ( item.command )\r
+                                       this.editor.execCommand( item.command );\r
+                       },\r
+\r
+                       onEscape : function( keystroke )\r
+                       {\r
+                               var parent = this.parent;\r
+                               // 1. If it's sub-menu, restore the last focused item\r
+                               // of upper level menu.\r
+                               // 2. In case of a top-menu, close it.\r
+                               if ( parent )\r
+                               {\r
+                                       parent._.panel.hideChild();\r
+                                       // Restore parent block item focus.\r
+                                       var parentBlock = parent._.panel._.panel._.currentBlock,\r
+                                               parentFocusIndex =  parentBlock._.focusIndex;\r
+                                       parentBlock._.markItem( parentFocusIndex );\r
+                               }\r
+                               else if ( keystroke == 27 )\r
+                               {\r
+                                       this.hide();\r
+                                       this.editor.focus();\r
+                               }\r
+                               return false;\r
+                       },\r
+\r
+                       onHide : function()\r
+                       {\r
+                               if ( CKEDITOR.env.ie )\r
+                               {\r
+                                       var selection = this.editor.getSelection();\r
+                                       selection && selection.unlock();\r
+                               }\r
+\r
+                               this.onHide && this.onHide();\r
+                       },\r
+\r
                        showSubMenu : function( index )\r
                        {\r
                                var menu = this._.subMenu,\r
@@ -98,9 +177,7 @@ CKEDITOR.plugins.add( 'menu',
                                        menu = this._.subMenu = new CKEDITOR.menu( this.editor,\r
                                                                   CKEDITOR.tools.extend( {}, this._.definition, { level : this._.level + 1 }, true ) );\r
                                        menu.parent = this;\r
-                                       menu.onClick = CKEDITOR.tools.bind( this.onClick, this );\r
-                                       // Sub menu use their own scope for binding onEscape.\r
-                                       menu.onEscape = this.onEscape;\r
+                                       menu._.onClick = CKEDITOR.tools.bind( this._.onClick, this );\r
                                }\r
 \r
                                // Add all submenu items to the menu.\r
@@ -142,6 +219,17 @@ CKEDITOR.plugins.add( 'menu',
 \r
                        show : function( offsetParent, corner, offsetX, offsetY )\r
                        {\r
+                               // Not for sub menu.\r
+                               if ( !this.parent )\r
+                               {\r
+                                       this._.onShow();\r
+                                       // Don't menu with zero items.\r
+                                       if ( ! this.items.length )\r
+                                               return;\r
+                               }\r
+\r
+                               corner = corner || ( this.editor.lang.dir == 'rtl' ? 2 : 1 );\r
+\r
                                var items = this.items,\r
                                        editor = this.editor,\r
                                        panel = this._.panel,\r
@@ -157,14 +245,14 @@ CKEDITOR.plugins.add( 'menu',
 \r
                                        panel.onEscape = CKEDITOR.tools.bind( function( keystroke )\r
                                        {\r
-                                               if ( this.onEscape && this.onEscape( keystroke ) === false )\r
+                                               if ( this._.onEscape( keystroke ) === false )\r
                                                        return false;\r
                                        },\r
                                        this );\r
 \r
                                        panel.onHide = CKEDITOR.tools.bind( function()\r
                                        {\r
-                                               this.onHide && this.onHide();\r
+                                               this._.onHide && this._.onHide();\r
                                        },\r
                                        this );\r
 \r
@@ -213,7 +301,7 @@ CKEDITOR.plugins.add( 'menu',
                                                        if ( item.getItems )\r
                                                                this._.showSubMenu( index );\r
                                                        else\r
-                                                               this.onClick && this.onClick( item );\r
+                                                               this._.onClick( item );\r
                                                },\r
                                                this );\r
                                }\r
@@ -247,6 +335,8 @@ CKEDITOR.plugins.add( 'menu',
                                // Inject the HTML inside the panel.\r
                                element.setHtml( output.join( '' ) );\r
 \r
+                               CKEDITOR.ui.fire( 'ready', this );\r
+\r
                                // Show the panel.\r
                                if ( this.parent )\r
                                        this.parent._.panel.showAsChild( panel, this.id, offsetParent, corner, offsetX, offsetY );\r
@@ -256,8 +346,14 @@ CKEDITOR.plugins.add( 'menu',
                                editor.fire( 'menuShow', [ panel ] );\r
                        },\r
 \r
+                       addListener : function( listenerFn )\r
+                       {\r
+                               this._.listeners.push( listenerFn );\r
+                       },\r
+\r
                        hide : function()\r
                        {\r
+                               this._.onHide && this._.onHide();\r
                                this._.panel && this._.panel.hide();\r
                        }\r
                }\r
@@ -277,42 +373,40 @@ CKEDITOR.plugins.add( 'menu',
                                        0;\r
                        });\r
        }\r
-})();\r
-\r
-CKEDITOR.menuItem = CKEDITOR.tools.createClass(\r
-{\r
-       $ : function( editor, name, definition )\r
+       CKEDITOR.menuItem = CKEDITOR.tools.createClass(\r
        {\r
-               CKEDITOR.tools.extend( this, definition,\r
-                       // Defaults\r
-                       {\r
-                               order : 0,\r
-                               className : 'cke_button_' + name\r
-                       });\r
+               $ : function( editor, name, definition )\r
+               {\r
+                       CKEDITOR.tools.extend( this, definition,\r
+                               // Defaults\r
+                               {\r
+                                       order : 0,\r
+                                       className : 'cke_button_' + name\r
+                               });\r
 \r
-               // Transform the group name into its order number.\r
-               this.group = editor._.menuGroups[ this.group ];\r
+                       // Transform the group name into its order number.\r
+                       this.group = editor._.menuGroups[ this.group ];\r
 \r
-               this.editor = editor;\r
-               this.name = name;\r
-       },\r
+                       this.editor = editor;\r
+                       this.name = name;\r
+               },\r
 \r
-       proto :\r
-       {\r
-               render : function( menu, index, output )\r
+               proto :\r
                {\r
-                       var id = menu.id + String( index ),\r
-                               state = ( typeof this.state == 'undefined' ) ? CKEDITOR.TRISTATE_OFF : this.state;\r
+                       render : function( menu, index, output )\r
+                       {\r
+                               var id = menu.id + String( index ),\r
+                                       state = ( typeof this.state == 'undefined' ) ? CKEDITOR.TRISTATE_OFF : this.state;\r
 \r
-                       var classes = ' cke_' + (\r
-                               state == CKEDITOR.TRISTATE_ON ? 'on' :\r
-                               state == CKEDITOR.TRISTATE_DISABLED ? 'disabled' :\r
-                               'off' );\r
+                               var classes = ' cke_' + (\r
+                                       state == CKEDITOR.TRISTATE_ON ? 'on' :\r
+                                       state == CKEDITOR.TRISTATE_DISABLED ? 'disabled' :\r
+                                       'off' );\r
 \r
-                       var htmlLabel = this.label;\r
+                               var htmlLabel = this.label;\r
 \r
-                       if ( this.className )\r
-                               classes += ' ' + this.className;\r
+                               if ( this.className )\r
+                                       classes += ' ' + this.className;\r
 \r
                        var hasSubMenu = this.getItems;\r
 \r
@@ -329,25 +423,25 @@ CKEDITOR.menuItem = CKEDITOR.tools.createClass(
                                        ( state == CKEDITOR.TRISTATE_DISABLED ? 'aria-disabled="true"' : '' ) +\r
                                        ( state == CKEDITOR.TRISTATE_ON ? 'aria-pressed="true"' : '' ) );\r
 \r
-                       // Some browsers don't cancel key events in the keydown but in the\r
-                       // keypress.\r
-                       // TODO: Check if really needed for Gecko+Mac.\r
-                       if ( CKEDITOR.env.opera || ( CKEDITOR.env.gecko && CKEDITOR.env.mac ) )\r
-                       {\r
-                               output.push(\r
-                                       ' onkeypress="return false;"' );\r
-                       }\r
+                               // Some browsers don't cancel key events in the keydown but in the\r
+                               // keypress.\r
+                               // TODO: Check if really needed for Gecko+Mac.\r
+                               if ( CKEDITOR.env.opera || ( CKEDITOR.env.gecko && CKEDITOR.env.mac ) )\r
+                               {\r
+                                       output.push(\r
+                                               ' onkeypress="return false;"' );\r
+                               }\r
 \r
-                       // With Firefox, we need to force the button to redraw, otherwise it\r
-                       // will remain in the focus state.\r
-                       if ( CKEDITOR.env.gecko )\r
-                       {\r
-                               output.push(\r
-                                       ' onblur="this.style.cssText = this.style.cssText;"' );\r
-                       }\r
+                               // With Firefox, we need to force the button to redraw, otherwise it\r
+                               // will remain in the focus state.\r
+                               if ( CKEDITOR.env.gecko )\r
+                               {\r
+                                       output.push(\r
+                                               ' onblur="this.style.cssText = this.style.cssText;"' );\r
+                               }\r
 \r
-                       var offset = ( this.iconOffset || 0 ) * -16;\r
-                       output.push(\r
+                               var offset = ( this.iconOffset || 0 ) * -16;\r
+                               output.push(\r
 //                                     ' onkeydown="return CKEDITOR.ui.button._.keydown(', index, ', event);"' +\r
                                        ' onmouseover="CKEDITOR.tools.callFunction(', menu._.itemOverFn, ',', index, ');"' +\r
                                        ' onmouseout="CKEDITOR.tools.callFunction(', menu._.itemOutFn, ',', index, ');"' +\r
@@ -371,14 +465,17 @@ CKEDITOR.menuItem = CKEDITOR.tools.createClass(
                                                        '</span>' );\r
                        }\r
 \r
-                       output.push(\r
-                                                       htmlLabel,\r
-                                               '</span>' +\r
-                               '</a>' +\r
-                               '</span>' );\r
+                               output.push(\r
+                                                               htmlLabel,\r
+                                                       '</span>' +\r
+                                       '</a>' +\r
+                                       '</span>' );\r
                }\r
-       }\r
-});\r
+               }\r
+       });\r
+\r
+})();\r
+\r
 \r
 /**\r
  * The amount of time, in milliseconds, the editor waits before showing submenu\r