library/custom_template/ckeditor/_source/plugins/elementspath/plugin.js

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