_source/plugins/bidi/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 (function()\r
   7 {\r
   8         var guardElements = { table:1, tbody: 1, ul:1, ol:1, blockquote:1, div:1, tr: 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 ( !selectedElement || selectedElement.getName() == 'body' )\r
  37                         return;\r
  38 \r
  39                 var selectionDir = useComputedState ?\r
  40                         selectedElement.getComputedStyle( 'direction' ) :\r
  41                         selectedElement.getStyle( 'direction' ) || selectedElement.getAttribute( 'dir' );\r
  42 \r
  43                 editor.getCommand( 'bidirtl' ).setState( selectionDir == 'rtl' ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF );\r
  44                 editor.getCommand( 'bidiltr' ).setState( selectionDir == 'ltr' ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF );\r
  45         }\r
  46 \r
  47         function handleMixedDirContent( evt )\r
  48         {\r
  49                 var editor = evt.editor,\r
  50                         chromeRoot = editor.container.getChild( 1 ),\r
  51                         directionNode = getElementForDirection( evt.data.path.lastElement );\r
  52 \r
  53                 if ( directionNode && editor.lang.dir != directionNode.getComputedStyle( 'direction' ) )\r
  54                         chromeRoot.addClass( 'cke_mixed_dir_content' );\r
  55                 else\r
  56                         chromeRoot.removeClass( 'cke_mixed_dir_content' );\r
  57         }\r
  58 \r
  59         /**\r
  60          * Returns element with possibility of applying the direction.\r
  61          * @param node\r
  62          */\r
  63         function getElementForDirection( node )\r
  64         {\r
  65                 while ( node && !( node.getName() in allGuardElements || node.is( 'body' ) ) )\r
  66                 {\r
  67                         var parent = node.getParent();\r
  68                         if ( !parent )\r
  69                                 break;\r
  70 \r
  71                         node = parent;\r
  72                 }\r
  73 \r
  74                 return node;\r
  75         }\r
  76 \r
  77         function switchDir( element, dir, editor, database )\r
  78         {\r
  79                 // Mark this element as processed by switchDir.\r
  80                 CKEDITOR.dom.element.setMarker( database, element, 'bidi_processed', 1 );\r
  81 \r
  82                 // Check whether one of the ancestors has already been styled.\r
  83                 var parent = element;\r
  84                 while ( ( parent = parent.getParent() ) && !parent.is( 'body' ) )\r
  85                 {\r
  86                         if ( parent.getCustomData( 'bidi_processed' ) )\r
  87                         {\r
  88                                 // Ancestor style must dominate.\r
  89                                 element.removeStyle( 'direction' );\r
  90                                 element.removeAttribute( 'dir' );\r
  91                                 return null;\r
  92                         }\r
  93                 }\r
  94 \r
  95                 var useComputedState = ( 'useComputedState' in editor.config ) ? editor.config.useComputedState : 1;\r
  96 \r
  97                 var elementDir = useComputedState ? element.getComputedStyle( 'direction' )\r
  98                         : element.getStyle( 'direction' ) || element.hasAttribute( 'dir' );\r
  99 \r
 100                 // Stop if direction is same as present.\r
 101                 if ( elementDir == dir )\r
 102                         return null;\r
 103 \r
 104                 // Reuse computedState if we already have it.\r
 105                 var dirBefore = useComputedState ? elementDir : element.getComputedStyle( 'direction' );\r
 106 \r
 107                 // Clear direction on this element.\r
 108                 element.removeStyle( 'direction' );\r
 109 \r
 110                 // Do the second check when computed state is ON, to check\r
 111                 // if we need to apply explicit direction on this element.\r
 112                 if ( useComputedState )\r
 113                 {\r
 114                         element.removeAttribute( 'dir' );\r
 115                         if ( dir != element.getComputedStyle( 'direction' ) )\r
 116                                 element.setAttribute( 'dir', dir );\r
 117                 }\r
 118                 else\r
 119                         // Set new direction for this element.\r
 120                         element.setAttribute( 'dir', dir );\r
 121 \r
 122                 // If the element direction changed, we need to switch the margins of\r
 123                 // the element and all its children, so it will get really reflected\r
 124                 // like a mirror. (#5910)\r
 125                 if ( dir != dirBefore )\r
 126                         editor.fire( 'dirChanged', element );\r
 127 \r
 128                 editor.forceNextSelectionCheck();\r
 129 \r
 130                 return null;\r
 131         }\r
 132 \r
 133         function getFullySelected( range, elements )\r
 134         {\r
 135                 var ancestor = range.getCommonAncestor( false, true );\r
 136 \r
 137                 range.enlarge( CKEDITOR.ENLARGE_BLOCK_CONTENTS );\r
 138 \r
 139                 if ( range.checkBoundaryOfElement( ancestor, CKEDITOR.START )\r
 140                                 && range.checkBoundaryOfElement( ancestor, CKEDITOR.END ) )\r
 141                 {\r
 142                         var parent;\r
 143                         while ( ancestor && ancestor.type == CKEDITOR.NODE_ELEMENT\r
 144                                         && ( parent = ancestor.getParent() )\r
 145                                         && parent.getChildCount() == 1\r
 146                                         && ( !( ancestor.getName() in elements ) || ( parent.getName() in elements ) )\r
 147                                         )\r
 148                                 ancestor = parent;\r
 149 \r
 150                         return ancestor.type == CKEDITOR.NODE_ELEMENT\r
 151                                         && ( ancestor.getName() in elements )\r
 152                                         && ancestor;\r
 153                 }\r
 154         }\r
 155 \r
 156         function bidiCommand( dir )\r
 157         {\r
 158                 return function( editor )\r
 159                 {\r
 160                         var selection = editor.getSelection(),\r
 161                                 enterMode = editor.config.enterMode,\r
 162                                 ranges = selection.getRanges();\r
 163 \r
 164                         if ( ranges && ranges.length )\r
 165                         {\r
 166                                 var database = {};\r
 167 \r
 168                                 // Creates bookmarks for selection, as we may split some blocks.\r
 169                                 var bookmarks = selection.createBookmarks();\r
 170 \r
 171                                 var rangeIterator = ranges.createIterator(),\r
 172                                         range,\r
 173                                         i = 0;\r
 174 \r
 175                                 while ( ( range = rangeIterator.getNextRange( 1 ) ) )\r
 176                                 {\r
 177                                         // Apply do directly selected elements from guardElements.\r
 178                                         var selectedElement = range.getEnclosedNode();\r
 179 \r
 180                                         // If this is not our element of interest, apply to fully selected elements from guardElements.\r
 181                                         if ( !selectedElement || selectedElement\r
 182                                                         && !( selectedElement.type == CKEDITOR.NODE_ELEMENT && selectedElement.getName() in directSelectionGuardElements )\r
 183                                                 )\r
 184                                                 selectedElement = getFullySelected( range, guardElements );\r
 185 \r
 186                                         if ( selectedElement && !selectedElement.isReadOnly() )\r
 187                                                 switchDir( selectedElement, dir, editor, database );\r
 188 \r
 189                                         var iterator,\r
 190                                                 block;\r
 191 \r
 192                                         // Walker searching for guardElements.\r
 193                                         var walker = new CKEDITOR.dom.walker( range );\r
 194 \r
 195                                         var start = bookmarks[ i ].startNode,\r
 196                                                 end = bookmarks[ i++ ].endNode;\r
 197 \r
 198                                         walker.evaluator = function( node )\r
 199                                         {\r
 200                                                 return !! ( node.type == CKEDITOR.NODE_ELEMENT\r
 201                                                                 && node.getName() in guardElements\r
 202                                                                 && !( node.getName() == ( enterMode == CKEDITOR.ENTER_P ) ? 'p' : 'div'\r
 203                                                                         && node.getParent().type == CKEDITOR.NODE_ELEMENT\r
 204                                                                         && node.getParent().getName() == 'blockquote' )\r
 205                                                                 // Element must be fully included in the range as well. (#6485).\r
 206                                                                 && node.getPosition( start ) & CKEDITOR.POSITION_FOLLOWING\r
 207                                                                 && ( ( node.getPosition( end ) & CKEDITOR.POSITION_PRECEDING + CKEDITOR.POSITION_CONTAINS ) == CKEDITOR.POSITION_PRECEDING ) );\r
 208                                         };\r
 209 \r
 210                                         while ( ( block = walker.next() ) )\r
 211                                                 switchDir( block, dir, editor, database );\r
 212 \r
 213                                         iterator = range.createIterator();\r
 214                                         iterator.enlargeBr = enterMode != CKEDITOR.ENTER_BR;\r
 215 \r
 216                                         while ( ( block = iterator.getNextParagraph( enterMode == CKEDITOR.ENTER_P ? 'p' : 'div' ) ) )\r
 217                                                 !block.isReadOnly() && switchDir( block, dir, editor, database );\r
 218                                 }\r
 219 \r
 220                                 CKEDITOR.dom.element.clearAllMarkers( database );\r
 221 \r
 222                                 editor.forceNextSelectionCheck();\r
 223                                 // Restore selection position.\r
 224                                 selection.selectBookmarks( bookmarks );\r
 225 \r
 226                                 editor.focus();\r
 227                         }\r
 228                 };\r
 229         }\r
 230 \r
 231         CKEDITOR.plugins.add( 'bidi',\r
 232         {\r
 233                 requires : [ 'styles', 'button' ],\r
 234 \r
 235                 init : function( editor )\r
 236                 {\r
 237                         // All buttons use the same code to register. So, to avoid\r
 238                         // duplications, let's use this tool function.\r
 239                         var addButtonCommand = function( buttonName, buttonLabel, commandName, commandExec )\r
 240                         {\r
 241                                 editor.addCommand( commandName, new CKEDITOR.command( editor, { exec : commandExec }) );\r
 242 \r
 243                                 editor.ui.addButton( buttonName,\r
 244                                         {\r
 245                                                 label : buttonLabel,\r
 246                                                 command : commandName\r
 247                                         });\r
 248                         };\r
 249 \r
 250                         var lang = editor.lang.bidi;\r
 251 \r
 252                         addButtonCommand( 'BidiLtr', lang.ltr, 'bidiltr', bidiCommand( 'ltr' ) );\r
 253                         addButtonCommand( 'BidiRtl', lang.rtl, 'bidirtl', bidiCommand( 'rtl' ) );\r
 254 \r
 255                         editor.on( 'selectionChange', onSelectionChange );\r
 256                 }\r
 257         });\r
 258 \r
 259 })();\r