_source/plugins/elementspath/plugin.js

   1 /*\r
   2 Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
   3 For licensing, see LICENSE.html or http://ckeditor.com/license\r
   4 */\r
   5 \r
   6 /**\r
   7  * @fileOverview The "elementspath" plugin. It shows all elements in the DOM\r
   8  *              parent tree relative to the current selection in the editing area.\r
   9  */\r
  10 \r
  11 (function()\r
  12 {\r
  13         var commands =\r
  14         {\r
  15                 toolbarFocus :\r
  16                 {\r
  17                         exec : function( editor )\r
  18                         {\r
  19                                 var idBase = editor._.elementsPath.idBase;\r
  20                                 var element = CKEDITOR.document.getById( idBase + '0' );\r
  21 \r
  22                                 if ( element )\r
  23                                         element.focus();\r
  24                         }\r
  25                 }\r
  26         };\r
  27 \r
  28         var emptyHtml = '<span class="cke_empty">&nbsp;</span>';\r
  29 \r
  30         CKEDITOR.plugins.add( 'elementspath',\r
  31         {\r
  32                 requires : [ 'selection' ],\r
  33 \r
  34                 init : function( editor )\r
  35                 {\r
  36                         var spaceId = 'cke_path_' + editor.name;\r
  37                         var spaceElement;\r
  38                         var getSpaceElement = function()\r
  39                         {\r
  40                                 if ( !spaceElement )\r
  41                                         spaceElement = CKEDITOR.document.getById( spaceId );\r
  42                                 return spaceElement;\r
  43                         };\r
  44 \r
  45                         var idBase = 'cke_elementspath_' + CKEDITOR.tools.getNextNumber() + '_';\r
  46 \r
  47                         editor._.elementsPath = { idBase : idBase, filters : [] };\r
  48 \r
  49                         editor.on( 'themeSpace', function( event )\r
  50                                 {\r
  51                                         if ( event.data.space == 'bottom' )\r
  52                                         {\r
  53                                                 event.data.html +=\r
  54                                                         '<span id="' + spaceId + '_label" class="cke_voice_label">' + editor.lang.elementsPath.eleLabel + '</span>' +\r
  55                                                         '<div id="' + spaceId + '" class="cke_path" role="group" aria-labelledby="' + spaceId + '_label">' + emptyHtml + '</div>';\r
  56                                         }\r
  57                                 });\r
  58 \r
  59                         editor.on( 'selectionChange', function( ev )\r
  60                                 {\r
  61                                         var env = CKEDITOR.env,\r
  62                                                 selection = ev.data.selection,\r
  63                                                 element = selection.getStartElement(),\r
  64                                                 html = [],\r
  65                                                 editor = ev.editor,\r
  66                                                 elementsList = editor._.elementsPath.list = [],\r
  67                                                 filters = editor._.elementsPath.filters;\r
  68 \r
  69                                         while ( element )\r
  70                                         {\r
  71                                                 var ignore = 0;\r
  72                                                 for ( var i = 0; i < filters.length; i++ )\r
  73                                                 {\r
  74                                                         if ( filters[ i ]( element ) === false )\r
  75                                                         {\r
  76                                                                 ignore = 1;\r
  77                                                                 break;\r
  78                                                         }\r
  79                                                 }\r
  80 \r
  81                                                 if ( !ignore )\r
  82                                                 {\r
  83                                                         var index = elementsList.push( element ) - 1;\r
  84                                                         var name;\r
  85                                                         if ( element.getAttribute( '_cke_real_element_type' ) )\r
  86                                                                 name = element.getAttribute( '_cke_real_element_type' );\r
  87                                                         else\r
  88                                                                 name = element.getName();\r
  89 \r
  90                                                         // Use this variable to add conditional stuff to the\r
  91                                                         // HTML (because we are doing it in reverse order... unshift).\r
  92                                                         var extra = '';\r
  93 \r
  94                                                         // Some browsers don't cancel key events in the keydown but in the\r
  95                                                         // keypress.\r
  96                                                         // TODO: Check if really needed for Gecko+Mac.\r
  97                                                         if ( env.opera || ( env.gecko && env.mac ) )\r
  98                                                                 extra += ' onkeypress="return false;"';\r
  99 \r
 100                                                         // With Firefox, we need to force the button to redraw, otherwise it\r
 101                                                         // will remain in the focus state.\r
 102                                                         if ( env.gecko )\r
 103                                                                 extra += ' onblur="this.style.cssText = this.style.cssText;"';\r
 104 \r
 105                                                         var label = editor.lang.elementsPath.eleTitle.replace( /%1/, name );\r
 106                                                         html.unshift(\r
 107                                                                 '<a' +\r
 108                                                                         ' id="', idBase, index, '"' +\r
 109                                                                         ' href="javascript:void(\'', name, '\')"' +\r
 110                                                                         ' tabindex="-1"' +\r
 111                                                                         ' title="', label, '"' +\r
 112                                                                         ( ( CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 ) ?\r
 113                                                                         ' onfocus="event.preventBubble();"' : '' ) +\r
 114                                                                         ' hidefocus="true" ' +\r
 115                                                                         ' onkeydown="return CKEDITOR._.elementsPath.keydown(\'', editor.name, '\',', index, ', event);"' +\r
 116                                                                         extra ,\r
 117                                                                         ' onclick="return CKEDITOR._.elementsPath.click(\'', editor.name, '\',', index, ');"',\r
 118                                                                         ' role="button" aria-labelledby="' + idBase + index + '_label">',\r
 119                                                                                 name,\r
 120                                                                                 '<span id="', idBase, index, '_label" class="cke_label">' + label + '</span>',\r
 121                                                                 '</a>' );\r
 122 \r
 123                                                 }\r
 124 \r
 125                                                 if ( name == 'body' )\r
 126                                                         break;\r
 127 \r
 128                                                 element = element.getParent();\r
 129                                         }\r
 130 \r
 131                                         getSpaceElement().setHtml( html.join('') + emptyHtml );\r
 132                                 });\r
 133 \r
 134                         editor.on( 'contentDomUnload', function()\r
 135                                 {\r
 136                                         // If the spaceElement hasn't been initialized, don't try to do it at this time\r
 137                                         // Only reuse existing reference.\r
 138                                         spaceElement && spaceElement.setHtml( emptyHtml );\r
 139                                 });\r
 140 \r
 141                         editor.addCommand( 'elementsPathFocus', commands.toolbarFocus );\r
 142                 }\r
 143         });\r
 144 })();\r
 145 \r
 146 /**\r
 147  * Handles the click on an element in the element path.\r
 148  * @private\r
 149  */\r
 150 CKEDITOR._.elementsPath =\r
 151 {\r
 152         click : function( instanceName, elementIndex )\r
 153         {\r
 154                 var editor = CKEDITOR.instances[ instanceName ];\r
 155                 editor.focus();\r
 156 \r
 157                 var element = editor._.elementsPath.list[ elementIndex ];\r
 158                 editor.getSelection().selectElement( element );\r
 159 \r
 160                 return false;\r
 161         },\r
 162 \r
 163         keydown : function( instanceName, elementIndex, ev )\r
 164         {\r
 165                 var instance = CKEDITOR.ui.button._.instances[ elementIndex ];\r
 166                 var editor = CKEDITOR.instances[ instanceName ];\r
 167                 var idBase = editor._.elementsPath.idBase;\r
 168 \r
 169                 var element;\r
 170 \r
 171                 ev = new CKEDITOR.dom.event( ev );\r
 172 \r
 173                 var rtl = editor.lang.dir == 'rtl';\r
 174                 switch ( ev.getKeystroke() )\r
 175                 {\r
 176                         case rtl ? 39 : 37 :                                    // LEFT-ARROW\r
 177                         case 9 :                                        // TAB\r
 178                                 element = CKEDITOR.document.getById( idBase + ( elementIndex + 1 ) );\r
 179                                 if ( !element )\r
 180                                         element = CKEDITOR.document.getById( idBase + '0' );\r
 181                                 element.focus();\r
 182                                 return false;\r
 183 \r
 184                         case rtl ? 37 : 39 :                                    // RIGHT-ARROW\r
 185                         case CKEDITOR.SHIFT + 9 :       // SHIFT + TAB\r
 186                                 element = CKEDITOR.document.getById( idBase + ( elementIndex - 1 ) );\r
 187                                 if ( !element )\r
 188                                         element = CKEDITOR.document.getById( idBase + ( editor._.elementsPath.list.length - 1 ) );\r
 189                                 element.focus();\r
 190                                 return false;\r
 191 \r
 192                         case 27 :                                       // ESC\r
 193                                 editor.focus();\r
 194                                 return false;\r
 195 \r
 196                         case 13 :                                       // ENTER        // Opera\r
 197                         case 32 :                                       // SPACE\r
 198                                 this.click( instanceName, elementIndex );\r
 199                                 return false;\r
 200 \r
 201                         //default :\r
 202                         //      alert( ev.getKeystroke() );\r
 203                 }\r
 204                 return true;\r
 205         }\r
 206 };\r