JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.5.3
[ckeditor.git] / _source / plugins / elementspath / plugin.js
index 75fc4ee..4b90c80 100644 (file)
@@ -1,5 +1,5 @@
 /*\r
-Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 */\r
 \r
@@ -14,13 +14,15 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
        {\r
                toolbarFocus :\r
                {\r
+                       editorFocus : false,\r
                        exec : function( editor )\r
                        {\r
                                var idBase = editor._.elementsPath.idBase;\r
                                var element = CKEDITOR.document.getById( idBase + '0' );\r
 \r
-                               if ( element )\r
-                                       element.focus();\r
+                               // Make the first button focus accessible for IE. (#3417)\r
+                               // Adobe AIR instead need while of delay.\r
+                               element && element.focus( CKEDITOR.env.ie || CKEDITOR.env.air );\r
                        }\r
                }\r
        };\r
@@ -44,62 +46,137 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 \r
                        var idBase = 'cke_elementspath_' + CKEDITOR.tools.getNextNumber() + '_';\r
 \r
-                       editor._.elementsPath = { idBase : idBase };\r
+                       editor._.elementsPath = { idBase : idBase, filters : [] };\r
 \r
                        editor.on( 'themeSpace', function( event )\r
                                {\r
                                        if ( event.data.space == 'bottom' )\r
-                                               event.data.html += '<div id="' + spaceId + '" class="cke_path">' + emptyHtml + '</div>';\r
+                                       {\r
+                                               event.data.html +=\r
+                                                       '<span id="' + spaceId + '_label" class="cke_voice_label">' + editor.lang.elementsPath.eleLabel + '</span>' +\r
+                                                       '<div id="' + spaceId + '" class="cke_path" role="group" aria-labelledby="' + spaceId + '_label">' + emptyHtml + '</div>';\r
+                                       }\r
                                });\r
 \r
-                       editor.on( 'selectionChange', function( ev )\r
+                       function onClick( elementIndex )\r
+                       {\r
+                               editor.focus();\r
+                               var element = editor._.elementsPath.list[ elementIndex ];\r
+                               if ( element.is( 'body' ) )\r
                                {\r
-                                       var env = CKEDITOR.env;\r
+                                       var range = new CKEDITOR.dom.range( editor.document );\r
+                                       range.selectNodeContents( element );\r
+                                       range.select();\r
+                               }\r
+                               else\r
+                                       editor.getSelection().selectElement( element );\r
+                       }\r
 \r
-                                       var selection = ev.data.selection;\r
+                       var onClickHanlder = CKEDITOR.tools.addFunction( onClick );\r
+\r
+                       var onKeyDownHandler = CKEDITOR.tools.addFunction( function( elementIndex, ev )\r
+                               {\r
+                                       var idBase = editor._.elementsPath.idBase,\r
+                                               element;\r
 \r
-                                       var element = selection.getStartElement(),\r
+                                       ev = new CKEDITOR.dom.event( ev );\r
+\r
+                                       var rtl = editor.lang.dir == 'rtl';\r
+                                       switch ( ev.getKeystroke() )\r
+                                       {\r
+                                               case rtl ? 39 : 37 :            // LEFT-ARROW\r
+                                               case 9 :                                        // TAB\r
+                                                       element = CKEDITOR.document.getById( idBase + ( elementIndex + 1 ) );\r
+                                                       if ( !element )\r
+                                                               element = CKEDITOR.document.getById( idBase + '0' );\r
+                                                       element.focus();\r
+                                                       return false;\r
+\r
+                                               case rtl ? 37 : 39 :            // RIGHT-ARROW\r
+                                               case CKEDITOR.SHIFT + 9 :       // SHIFT + TAB\r
+                                                       element = CKEDITOR.document.getById( idBase + ( elementIndex - 1 ) );\r
+                                                       if ( !element )\r
+                                                               element = CKEDITOR.document.getById( idBase + ( editor._.elementsPath.list.length - 1 ) );\r
+                                                       element.focus();\r
+                                                       return false;\r
+\r
+                                               case 27 :                                       // ESC\r
+                                                       editor.focus();\r
+                                                       return false;\r
+\r
+                                               case 13 :                                       // ENTER        // Opera\r
+                                               case 32 :                                       // SPACE\r
+                                                       onClick( elementIndex );\r
+                                                       return false;\r
+                                       }\r
+                                       return true;\r
+                               });\r
+\r
+                       editor.on( 'selectionChange', function( ev )\r
+                               {\r
+                                       var env = CKEDITOR.env,\r
+                                               selection = ev.data.selection,\r
+                                               element = selection.getStartElement(),\r
                                                html = [],\r
-                                               elementsList = this._.elementsPath.list = [];\r
+                                               editor = ev.editor,\r
+                                               elementsList = editor._.elementsPath.list = [],\r
+                                               filters = editor._.elementsPath.filters;\r
 \r
                                        while ( element )\r
                                        {\r
-                                               var index = elementsList.push( element ) - 1;\r
-                                               var name;\r
-                                               if ( element.getAttribute( '_cke_real_element_type' ) )\r
-                                                       name = element.getAttribute( '_cke_real_element_type' );\r
-                                               else\r
-                                                       name = element.getName();\r
-\r
-                                               // Use this variable to add conditional stuff to the\r
-                                               // HTML (because we are doing it in reverse order... unshift).\r
-                                               var extra = '';\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 ( env.opera || ( env.gecko && env.mac ) )\r
-                                                       extra += ' onkeypress="return false;"';\r
-\r
-                                               // With Firefox, we need to force the button to redraw, otherwise it\r
-                                               // will remain in the focus state.\r
-                                               if ( env.gecko )\r
-                                                       extra += ' onblur="this.style.cssText = this.style.cssText;"';\r
-\r
-                                               html.unshift(\r
-                                                       '<a' +\r
-                                                               ' id="', idBase, index, '"' +\r
-                                                               ' href="javascript:void(\'', name, '\')"' +\r
-                                                               ' tabindex="-1"' +\r
-                                                               ' title="', editor.lang.elementsPath.eleTitle.replace( /%1/, name ), '"' +\r
-                                                               ( ( CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 ) ?\r
-                                                               ' onfocus="event.preventBubble();"' : '' ) +\r
-                                                               ' hidefocus="true" ' +\r
-                                                               ' onkeydown="return CKEDITOR._.elementsPath.keydown(\'', this.name, '\',', index, ', event);"' +\r
-                                                               extra ,\r
-                                                               ' onclick="return CKEDITOR._.elementsPath.click(\'', this.name, '\',', index, ');">',\r
-                                                                       name,\r
-                                                       '</a>' );\r
+                                               var ignore = 0;\r
+                                               for ( var i = 0; i < filters.length; i++ )\r
+                                               {\r
+                                                       if ( filters[ i ]( element ) === false )\r
+                                                       {\r
+                                                               ignore = 1;\r
+                                                               break;\r
+                                                       }\r
+                                               }\r
+\r
+                                               if ( !ignore )\r
+                                               {\r
+                                                       var index = elementsList.push( element ) - 1;\r
+                                                       var name;\r
+                                                       if ( element.data( 'cke-real-element-type' ) )\r
+                                                               name = element.data( 'cke-real-element-type' );\r
+                                                       else\r
+                                                               name = element.getName();\r
+\r
+                                                       // Use this variable to add conditional stuff to the\r
+                                                       // HTML (because we are doing it in reverse order... unshift).\r
+                                                       var extra = '';\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 ( env.opera || ( env.gecko && env.mac ) )\r
+                                                               extra += ' onkeypress="return false;"';\r
+\r
+                                                       // With Firefox, we need to force the button to redraw, otherwise it\r
+                                                       // will remain in the focus state.\r
+                                                       if ( env.gecko )\r
+                                                               extra += ' onblur="this.style.cssText = this.style.cssText;"';\r
+\r
+                                                       var label = editor.lang.elementsPath.eleTitle.replace( /%1/, name );\r
+                                                       html.unshift(\r
+                                                               '<a' +\r
+                                                                       ' id="', idBase, index, '"' +\r
+                                                                       ' href="javascript:void(\'', name, '\')"' +\r
+                                                                       ' tabindex="-1"' +\r
+                                                                       ' title="', label, '"' +\r
+                                                                       ( ( CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 ) ?\r
+                                                                       ' onfocus="event.preventBubble();"' : '' ) +\r
+                                                                       ' hidefocus="true" ' +\r
+                                                                       ' onkeydown="return CKEDITOR.tools.callFunction(', onKeyDownHandler, ',', index, ', event );"' +\r
+                                                                       extra ,\r
+                                                                       ' onclick="CKEDITOR.tools.callFunction('+ onClickHanlder, ',', index, '); return false;"',\r
+                                                                       ' role="button" aria-labelledby="' + idBase + index + '_label">',\r
+                                                                               name,\r
+                                                                               '<span id="', idBase, index, '_label" class="cke_label">' + label + '</span>',\r
+                                                               '</a>' );\r
+\r
+                                               }\r
 \r
                                                if ( name == 'body' )\r
                                                        break;\r
@@ -107,12 +184,16 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                                element = element.getParent();\r
                                        }\r
 \r
-                                       getSpaceElement().setHtml( html.join('') + emptyHtml );\r
+                                       var space = getSpaceElement();\r
+                                       space.setHtml( html.join('') + emptyHtml );\r
+                                       editor.fire( 'elementsPathUpdate', { space : space } );\r
                                });\r
 \r
                        editor.on( 'contentDomUnload', function()\r
                                {\r
-                                       getSpaceElement().setHtml( emptyHtml );\r
+                                       // If the spaceElement hasn't been initialized, don't try to do it at this time\r
+                                       // Only reuse existing reference.\r
+                                       spaceElement && spaceElement.setHtml( emptyHtml );\r
                                });\r
 \r
                        editor.addCommand( 'elementsPathFocus', commands.toolbarFocus );\r
@@ -121,62 +202,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 })();\r
 \r
 /**\r
- * Handles the click on an element in the element path.\r
- * @private\r
+ * Fired when the contents of the elementsPath are changed\r
+ * @name CKEDITOR.editor#elementsPathUpdate\r
+ * @event\r
+ * @param {Object} eventData.space The elementsPath container\r
  */\r
-CKEDITOR._.elementsPath =\r
-{\r
-       click : function( instanceName, elementIndex )\r
-       {\r
-               var editor = CKEDITOR.instances[ instanceName ];\r
-               editor.focus();\r
-\r
-               var element = editor._.elementsPath.list[ elementIndex ];\r
-               editor.getSelection().selectElement( element );\r
-\r
-               return false;\r
-       },\r
-\r
-       keydown : function( instanceName, elementIndex, ev )\r
-       {\r
-               var instance = CKEDITOR.ui.button._.instances[ elementIndex ];\r
-               var editor = CKEDITOR.instances[ instanceName ];\r
-               var idBase = editor._.elementsPath.idBase;\r
-\r
-               var element;\r
-\r
-               ev = new CKEDITOR.dom.event( ev );\r
-\r
-               switch ( ev.getKeystroke() )\r
-               {\r
-                       case 37 :                                       // LEFT-ARROW\r
-                       case 9 :                                        // TAB\r
-                               element = CKEDITOR.document.getById( idBase + ( elementIndex + 1 ) );\r
-                               if ( !element )\r
-                                       element = CKEDITOR.document.getById( idBase + '0' );\r
-                               element.focus();\r
-                               return false;\r
-\r
-                       case 39 :                                       // RIGHT-ARROW\r
-                       case CKEDITOR.SHIFT + 9 :       // SHIFT + TAB\r
-                               element = CKEDITOR.document.getById( idBase + ( elementIndex - 1 ) );\r
-                               if ( !element )\r
-                                       element = CKEDITOR.document.getById( idBase + ( editor._.elementsPath.list.length - 1 ) );\r
-                               element.focus();\r
-                               return false;\r
-\r
-                       case 27 :                                       // ESC\r
-                               editor.focus();\r
-                               return false;\r
-\r
-                       case 13 :                                       // ENTER        // Opera\r
-                       case 32 :                                       // SPACE\r
-                               this.click( instanceName, elementIndex );\r
-                               return false;\r
-\r
-                       //default :\r
-                       //      alert( ev.getKeystroke() );\r
-               }\r
-               return true;\r
-       }\r
-};\r