_source/plugins/bidi/plugin.js

   1 /*\r
   2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.\r
   3 For licensing, see LICENSE.html or http://ckeditor.com/license\r
   4 */\r
   5 \r
   6 (function()\r
   7 {\r
   8         var guardElements = { table:1, ul:1, ol:1, blockquote:1, div:1 },\r
   9                 directSelectionGuardElements = {},\r
  10                 // All guard elements which can have a direction applied on them.\r
  11                 allGuardElements = {};\r
  12         CKEDITOR.tools.extend( directSelectionGuardElements, guardElements, { tr:1, p:1, div:1, li:1 } );\r
  13         CKEDITOR.tools.extend( allGuardElements, directSelectionGuardElements, { td:1 } );\r
  14 \r
  15         function onSelectionChange( e )\r
  16         {\r
  17                 setToolbarStates( e );\r
  18                 handleMixedDirContent( e );\r
  19         }\r
  20 \r
  21         function setToolbarStates( evt )\r
  22         {\r
  23                 var editor = evt.editor,\r
  24                         path = evt.data.path;\r
  25                 var useComputedState = editor.config.useComputedState,\r
  26                         selectedElement;\r
  27 \r
  28                 useComputedState = useComputedState === undefined || useComputedState;\r
  29 \r
  30                 // We can use computedState provided by the browser or traverse parents manually.\r
  31                 if ( !useComputedState )\r
  32                         selectedElement = getElementForDirection( path.lastElement );\r
  33 \r
  34                 selectedElement = selectedElement || path.block || path.blockLimit;\r
  35 \r
  36                 // If we're having BODY here, user probably done CTRL+A, let's try to get the enclosed node, if any.\r
  37                 selectedElement.is( 'body' ) &&\r
  38                         ( selectedElement = editor.getSelection().getRanges()[ 0 ].getEnclosedNode() );\r
  39 \r
  40                 if ( !selectedElement )\r
  41                         return;\r
  42 \r
  43                 var selectionDir = useComputedState ?\r
  44                         selectedElement.getComputedStyle( 'direction' ) :\r
  45                         selectedElement.getStyle( 'direction' ) || selectedElement.getAttribute( 'dir' );\r
  46 \r
  47                 editor.getCommand( 'bidirtl' ).setState( selectionDir == 'rtl' ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF );\r
  48                 editor.getCommand( 'bidiltr' ).setState( selectionDir == 'ltr' ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF );\r
  49         }\r
  50 \r
  51         function handleMixedDirContent( evt )\r
  52         {\r
  53                 var editor = evt.editor,\r
  54                         chromeRoot = editor.container.getChild( 1 ),\r
  55                         directionNode = evt.data.path.block || evt.data.path.blockLimit;\r
  56 \r
  57                 if ( directionNode && editor.lang.dir != directionNode.getComputedStyle( 'direction' ) )\r
  58                         chromeRoot.addClass( 'cke_mixed_dir_content' );\r
  59                 else\r
  60                         chromeRoot.removeClass( 'cke_mixed_dir_content' );\r
  61         }\r
  62 \r
  63         /**\r
  64          * Returns element with possibility of applying the direction.\r
  65          * @param node\r
  66          */\r
  67         function getElementForDirection( node )\r
  68         {\r
  69                 while ( node && !( node.getName() in allGuardElements || node.is( 'body' ) ) )\r
  70                 {\r
  71                         var parent = node.getParent();\r
  72                         if ( !parent )\r
  73                                 break;\r
  74 \r
  75                         node = parent;\r
  76                 }\r
  77 \r
  78                 return node;\r
  79         }\r
  80 \r
  81         function switchDir( element, dir, editor, database )\r
  82         {\r
  83                 // Mark this element as processed by switchDir.\r
  84                 CKEDITOR.dom.element.setMarker( database, element, 'bidi_processed', 1 );\r
  85 \r
  86                 // Check whether one of the ancestors has already been styled.\r
  87                 var parent = element;\r
  88                 while ( ( parent = parent.getParent() ) && !parent.is( 'body' ) )\r
  89                 {\r
  90                         if ( parent.getCustomData( 'bidi_processed' ) )\r
  91                         {\r
  92                                 // Ancestor style must dominate.\r
  93                                 element.removeStyle( 'direction' );\r
  94                                 element.removeAttribute( 'dir' );\r
  95                                 return null;\r
  96                         }\r
  97                 }\r
  98 \r
  99                 var useComputedState = ( 'useComputedState' in editor.config ) ? editor.config.useComputedState : 1;\r
 100 \r
 101                 var elementDir = useComputedState ? element.getComputedStyle( 'direction' )\r
 102                         : element.getStyle( 'direction' ) || element.hasAttribute( 'dir' );\r
 103 \r
 104                 // Stop if direction is same as present.\r
 105                 if ( elementDir == dir )\r
 106                         return null;\r
 107 \r
 108                 // Reuse computedState if we already have it.\r
 109                 var dirBefore = useComputedState ? elementDir : element.getComputedStyle( 'direction' );\r
 110 \r
 111                 // Clear direction on this element.\r
 112                 element.removeStyle( 'direction' );\r
 113 \r
 114                 // Do the second check when computed state is ON, to check\r
 115                 // if we need to apply explicit direction on this element.\r
 116                 if ( useComputedState )\r
 117                 {\r
 118                         element.removeAttribute( 'dir' );\r
 119                         if ( dir != element.getComputedStyle( 'direction' ) )\r
 120                                 element.setAttribute( 'dir', dir );\r
 121                 }\r
 122                 else\r
 123                         // Set new direction for this element.\r
 124                         element.setAttribute( 'dir', dir );\r
 125 \r
 126                 // If the element direction changed, we need to switch the margins of\r
 127                 // the element and all its children, so it will get really reflected\r
 128                 // like a mirror. (#5910)\r
 129                 if ( dir != dirBefore )\r
 130                 {\r
 131                         editor.fire( 'dirChanged',\r
 132                                 {\r
 133                                         node : element,\r
 134                                         dir : dir\r
 135                                 } );\r
 136                 }\r
 137 \r
 138                 editor.forceNextSelectionCheck();\r
 139 \r
 140                 return null;\r
 141         }\r
 142 \r
 143         function getFullySelected( range, elements, enterMode )\r
 144         {\r
 145                 var ancestor = range.getCommonAncestor( false, true );\r
 146 \r
 147                 range = range.clone();\r
 148                 range.enlarge( enterMode == CKEDITOR.ENTER_BR ?\r
 149                                 CKEDITOR.ENLARGE_LIST_ITEM_CONTENTS\r
 150                                 : CKEDITOR.ENLARGE_BLOCK_CONTENTS );\r
 151 \r
 152                 if ( range.checkBoundaryOfElement( ancestor, CKEDITOR.START )\r
 153                                 && range.checkBoundaryOfElement( ancestor, CKEDITOR.END ) )\r
 154                 {\r
 155                         var parent;\r
 156                         while ( ancestor && ancestor.type == CKEDITOR.NODE_ELEMENT\r
 157                                         && ( parent = ancestor.getParent() )\r
 158                                         && parent.getChildCount() == 1\r
 159                                         && !( ancestor.getName() in elements ) )\r
 160                                 ancestor = parent;\r
 161 \r
 162                         return ancestor.type == CKEDITOR.NODE_ELEMENT\r
 163                                         && ( ancestor.getName() in elements )\r
 164                                         && ancestor;\r
 165                 }\r
 166         }\r
 167 \r
 168         function bidiCommand( dir )\r
 169         {\r
 170                 return function( editor )\r
 171                 {\r
 172                         var selection = editor.getSelection(),\r
 173                                 enterMode = editor.config.enterMode,\r
 174                                 ranges = selection.getRanges();\r
 175 \r
 176                         if ( ranges && ranges.length )\r
 177                         {\r
 178                                 var database = {};\r
 179 \r
 180                                 // Creates bookmarks for selection, as we may split some blocks.\r
 181                                 var bookmarks = selection.createBookmarks();\r
 182 \r
 183                                 var rangeIterator = ranges.createIterator(),\r
 184                                         range,\r
 185                                         i = 0;\r
 186 \r
 187                                 while ( ( range = rangeIterator.getNextRange( 1 ) ) )\r
 188                                 {\r
 189                                         // Apply do directly selected elements from guardElements.\r
 190                                         var selectedElement = range.getEnclosedNode();\r
 191 \r
 192                                         // If this is not our element of interest, apply to fully selected elements from guardElements.\r
 193                                         if ( !selectedElement || selectedElement\r
 194                                                         && !( selectedElement.type == CKEDITOR.NODE_ELEMENT && selectedElement.getName() in directSelectionGuardElements )\r
 195                                                 )\r
 196                                                 selectedElement = getFullySelected( range, guardElements, enterMode );\r
 197 \r
 198                                         if ( selectedElement && !selectedElement.isReadOnly() )\r
 199                                                 switchDir( selectedElement, dir, editor, database );\r
 200 \r
 201                                         var iterator,\r
 202                                                 block;\r
 203 \r
 204                                         // Walker searching for guardElements.\r
 205                                         var walker = new CKEDITOR.dom.walker( range );\r
 206 \r
 207                                         var start = bookmarks[ i ].startNode,\r
 208                                                 end = bookmarks[ i++ ].endNode;\r
 209 \r
 210                                         walker.evaluator = function( node )\r
 211                                         {\r
 212                                                 return !! ( node.type == CKEDITOR.NODE_ELEMENT\r
 213                                                                 && node.getName() in guardElements\r
 214                                                                 && !( node.getName() == ( enterMode == CKEDITOR.ENTER_P ? 'p' : 'div' )\r
 215                                                                         && node.getParent().type == CKEDITOR.NODE_ELEMENT\r
 216                                                                         && node.getParent().getName() == 'blockquote' )\r
 217                                                                 // Element must be fully included in the range as well. (#6485).\r
 218                                                                 && node.getPosition( start ) & CKEDITOR.POSITION_FOLLOWING\r
 219                                                                 && ( ( node.getPosition( end ) & CKEDITOR.POSITION_PRECEDING + CKEDITOR.POSITION_CONTAINS ) == CKEDITOR.POSITION_PRECEDING ) );\r
 220                                         };\r
 221 \r
 222                                         while ( ( block = walker.next() ) )\r
 223                                                 switchDir( block, dir, editor, database );\r
 224 \r
 225                                         iterator = range.createIterator();\r
 226                                         iterator.enlargeBr = enterMode != CKEDITOR.ENTER_BR;\r
 227 \r
 228                                         while ( ( block = iterator.getNextParagraph( enterMode == CKEDITOR.ENTER_P ? 'p' : 'div' ) ) )\r
 229                                                 !block.isReadOnly() && switchDir( block, dir, editor, database );\r
 230                                         }\r
 231 \r
 232                                 CKEDITOR.dom.element.clearAllMarkers( database );\r
 233 \r
 234                                 editor.forceNextSelectionCheck();\r
 235                                 // Restore selection position.\r
 236                                 selection.selectBookmarks( bookmarks );\r
 237 \r
 238                                 editor.focus();\r
 239                         }\r
 240                 };\r
 241         }\r
 242 \r
 243         CKEDITOR.plugins.add( 'bidi',\r
 244         {\r
 245                 requires : [ 'styles', 'button' ],\r
 246 \r
 247                 init : function( editor )\r
 248                 {\r
 249                         // All buttons use the same code to register. So, to avoid\r
 250                         // duplications, let's use this tool function.\r
 251                         var addButtonCommand = function( buttonName, buttonLabel, commandName, commandExec )\r
 252                         {\r
 253                                 editor.addCommand( commandName, new CKEDITOR.command( editor, { exec : commandExec }) );\r
 254 \r
 255                                 editor.ui.addButton( buttonName,\r
 256                                         {\r
 257                                                 label : buttonLabel,\r
 258                                                 command : commandName\r
 259                                         });\r
 260                         };\r
 261 \r
 262                         var lang = editor.lang.bidi;\r
 263 \r
 264                         addButtonCommand( 'BidiLtr', lang.ltr, 'bidiltr', bidiCommand( 'ltr' ) );\r
 265                         addButtonCommand( 'BidiRtl', lang.rtl, 'bidirtl', bidiCommand( 'rtl' ) );\r
 266 \r
 267                         editor.on( 'selectionChange', onSelectionChange );\r
 268                 }\r
 269         });\r
 270 \r
 271 })();\r
 272 \r
 273 /**\r
 274  * Fired when the language direction of an element is changed\r
 275  * @name CKEDITOR.editor#dirChanged\r
 276  * @event\r
 277  * @param {CKEDITOR.editor} editor This editor instance.\r
 278  * @param {Object} eventData.node The element that is being changed.\r
 279  * @param {String} eventData.dir The new direction.\r
 280  */\r