_source/plugins/elementspath/plugin.js

   1 /*\r
   2 Copyright (c) 2003-2012, 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                         editorFocus : false,\r
  18                         readOnly : 1,\r
  19                         exec : function( editor )\r
  20                         {\r
  21                                 var idBase = editor._.elementsPath.idBase;\r
  22                                 var element = CKEDITOR.document.getById( idBase + '0' );\r
  23 \r
  24                                 // Make the first button focus accessible for IE. (#3417)\r
  25                                 // Adobe AIR instead need while of delay.\r
  26                                 element && element.focus( CKEDITOR.env.ie || CKEDITOR.env.air );\r
  27                         }\r
  28                 }\r
  29         };\r
  30 \r
  31         var emptyHtml = '<span class="cke_empty">&nbsp;</span>';\r
  32 \r
  33         CKEDITOR.plugins.add( 'elementspath',\r
  34         {\r
  35                 requires : [ 'selection' ],\r
  36 \r
  37                 init : function( editor )\r
  38                 {\r
  39                         var spaceId = 'cke_path_' + editor.name;\r
  40                         var spaceElement;\r
  41                         var getSpaceElement = function()\r
  42                         {\r
  43                                 if ( !spaceElement )\r
  44                                         spaceElement = CKEDITOR.document.getById( spaceId );\r
  45                                 return spaceElement;\r
  46                         };\r
  47 \r
  48                         var idBase = 'cke_elementspath_' + CKEDITOR.tools.getNextNumber() + '_';\r
  49 \r
  50                         editor._.elementsPath = { idBase : idBase, filters : [] };\r
  51 \r
  52                         editor.on( 'themeSpace', function( event )\r
  53                                 {\r
  54                                         if ( event.data.space == 'bottom' )\r
  55                                         {\r
  56                                                 event.data.html +=\r
  57                                                         '<span id="' + spaceId + '_label" class="cke_voice_label">' + editor.lang.elementsPath.eleLabel + '</span>' +\r
  58                                                         '<div id="' + spaceId + '" class="cke_path" role="group" aria-labelledby="' + spaceId + '_label">' + emptyHtml + '</div>';\r
  59                                         }\r
  60                                 });\r
  61 \r
  62                         function onClick( elementIndex )\r
  63                         {\r
  64                                 editor.focus();\r
  65                                 var element = editor._.elementsPath.list[ elementIndex ];\r
  66                                 if ( element.is( 'body' ) )\r
  67                                 {\r
  68                                         var range = new CKEDITOR.dom.range( editor.document );\r
  69                                         range.selectNodeContents( element );\r
  70                                         range.select();\r
  71                                 }\r
  72                                 else\r
  73                                         editor.getSelection().selectElement( element );\r
  74                         }\r
  75 \r
  76                         var onClickHanlder = CKEDITOR.tools.addFunction( onClick );\r
  77 \r
  78                         var onKeyDownHandler = CKEDITOR.tools.addFunction( function( elementIndex, ev )\r
  79                                 {\r
  80                                         var idBase = editor._.elementsPath.idBase,\r
  81                                                 element;\r
  82 \r
  83                                         ev = new CKEDITOR.dom.event( ev );\r
  84 \r
  85                                         var rtl = editor.lang.dir == 'rtl';\r
  86                                         switch ( ev.getKeystroke() )\r
  87                                         {\r
  88                                                 case rtl ? 39 : 37 :            // LEFT-ARROW\r
  89                                                 case 9 :                                        // TAB\r
  90                                                         element = CKEDITOR.document.getById( idBase + ( elementIndex + 1 ) );\r
  91                                                         if ( !element )\r
  92                                                                 element = CKEDITOR.document.getById( idBase + '0' );\r
  93                                                         element.focus();\r
  94                                                         return false;\r
  95 \r
  96                                                 case rtl ? 37 : 39 :            // RIGHT-ARROW\r
  97                                                 case CKEDITOR.SHIFT + 9 :       // SHIFT + TAB\r
  98                                                         element = CKEDITOR.document.getById( idBase + ( elementIndex - 1 ) );\r
  99                                                         if ( !element )\r
 100                                                                 element = CKEDITOR.document.getById( idBase + ( editor._.elementsPath.list.length - 1 ) );\r
 101                                                         element.focus();\r
 102                                                         return false;\r
 103 \r
 104                                                 case 27 :                                       // ESC\r
 105                                                         editor.focus();\r
 106                                                         return false;\r
 107 \r
 108                                                 case 13 :                                       // ENTER        // Opera\r
 109                                                 case 32 :                                       // SPACE\r
 110                                                         onClick( elementIndex );\r
 111                                                         return false;\r
 112                                         }\r
 113                                         return true;\r
 114                                 });\r
 115 \r
 116                         editor.on( 'selectionChange', function( ev )\r
 117                                 {\r
 118                                         var env = CKEDITOR.env,\r
 119                                                 selection = ev.data.selection,\r
 120                                                 element = selection.getStartElement(),\r
 121                                                 html = [],\r
 122                                                 editor = ev.editor,\r
 123                                                 elementsList = editor._.elementsPath.list = [],\r
 124                                                 filters = editor._.elementsPath.filters;\r
 125 \r
 126                                         while ( element )\r
 127                                         {\r
 128                                                 var ignore = 0,\r
 129                                                         name;\r
 130 \r
 131                                                 if ( element.data( 'cke-display-name' ) )\r
 132                                                         name = element.data( 'cke-display-name' );\r
 133                                                 else if ( element.data( 'cke-real-element-type' ) )\r
 134                                                         name = element.data( 'cke-real-element-type' );\r
 135                                                 else\r
 136                                                         name = element.getName();\r
 137 \r
 138                                                 for ( var i = 0; i < filters.length; i++ )\r
 139                                                 {\r
 140                                                         var ret = filters[ i ]( element, name );\r
 141                                                         if ( ret === false )\r
 142                                                         {\r
 143                                                                 ignore = 1;\r
 144                                                                 break;\r
 145                                                         }\r
 146                                                         name = ret || name;\r
 147                                                 }\r
 148 \r
 149                                                 if ( !ignore )\r
 150                                                 {\r
 151                                                         var index = elementsList.push( element ) - 1;\r
 152 \r
 153                                                         // Use this variable to add conditional stuff to the\r
 154                                                         // HTML (because we are doing it in reverse order... unshift).\r
 155                                                         var extra = '';\r
 156 \r
 157                                                         // Some browsers don't cancel key events in the keydown but in the\r
 158                                                         // keypress.\r
 159                                                         // TODO: Check if really needed for Gecko+Mac.\r
 160                                                         if ( env.opera || ( env.gecko && env.mac ) )\r
 161                                                                 extra += ' onkeypress="return false;"';\r
 162 \r
 163                                                         // With Firefox, we need to force the button to redraw, otherwise it\r
 164                                                         // will remain in the focus state.\r
 165                                                         if ( env.gecko )\r
 166                                                                 extra += ' onblur="this.style.cssText = this.style.cssText;"';\r
 167 \r
 168                                                         var label = editor.lang.elementsPath.eleTitle.replace( /%1/, name );\r
 169                                                         html.unshift(\r
 170                                                                 '<a' +\r
 171                                                                         ' id="', idBase, index, '"' +\r
 172                                                                         ' href="javascript:void(\'', name, '\')"' +\r
 173                                                                         ' tabindex="-1"' +\r
 174                                                                         ' title="', label, '"' +\r
 175                                                                         ( ( CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 ) ?\r
 176                                                                         ' onfocus="event.preventBubble();"' : '' ) +\r
 177                                                                         ' hidefocus="true" ' +\r
 178                                                                         ' onkeydown="return CKEDITOR.tools.callFunction(', onKeyDownHandler, ',', index, ', event );"' +\r
 179                                                                         extra ,\r
 180                                                                         ' onclick="CKEDITOR.tools.callFunction('+ onClickHanlder, ',', index, '); return false;"',\r
 181                                                                         ' role="button" aria-labelledby="' + idBase + index + '_label">',\r
 182                                                                                 name,\r
 183                                                                                 '<span id="', idBase, index, '_label" class="cke_label">' + label + '</span>',\r
 184                                                                 '</a>' );\r
 185 \r
 186                                                 }\r
 187 \r
 188                                                 if ( name == 'body' )\r
 189                                                         break;\r
 190 \r
 191                                                 element = element.getParent();\r
 192                                         }\r
 193 \r
 194                                         var space = getSpaceElement();\r
 195                                         space.setHtml( html.join('') + emptyHtml );\r
 196                                         editor.fire( 'elementsPathUpdate', { space : space } );\r
 197                                 });\r
 198 \r
 199                         function empty()\r
 200                         {\r
 201                                 spaceElement && spaceElement.setHtml( emptyHtml );\r
 202                                 delete editor._.elementsPath.list;\r
 203                         }\r
 204 \r
 205                         editor.on( 'readOnly', empty );\r
 206                         editor.on( 'contentDomUnload', empty );\r
 207 \r
 208                         editor.addCommand( 'elementsPathFocus', commands.toolbarFocus );\r
 209                 }\r
 210         });\r
 211 })();\r
 212 \r
 213 /**\r
 214  * Fired when the contents of the elementsPath are changed\r
 215  * @name CKEDITOR.editor#elementsPathUpdate\r
 216  * @event\r
 217  * @param {Object} eventData.space The elementsPath container\r
 218  */\r