_source/plugins/editingblock/plugin.js

   1 /*\r
   2 Copyright (c) 2003-2009, 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 default editing block plugin, which holds the editing area\r
   8  *              and source view.\r
   9  */\r
  10 \r
  11 (function()\r
  12 {\r
  13         var getMode = function( editor, mode )\r
  14         {\r
  15                 return editor._.modes && editor._.modes[ mode || editor.mode ];\r
  16         };\r
  17 \r
  18         // This is a semaphore used to avoid recursive calls between\r
  19         // the following data handling functions.\r
  20         var isHandlingData;\r
  21 \r
  22         CKEDITOR.plugins.add( 'editingblock',\r
  23         {\r
  24                 init : function( editor )\r
  25                 {\r
  26                         if ( !editor.config.editingBlock )\r
  27                                 return;\r
  28 \r
  29                         editor.on( 'themeSpace', function( event )\r
  30                                 {\r
  31                                         if ( event.data.space == 'contents' )\r
  32                                                 event.data.html += '<br>';\r
  33                                 });\r
  34 \r
  35                         editor.on( 'themeLoaded', function()\r
  36                                 {\r
  37                                         editor.fireOnce( 'editingBlockReady' );\r
  38                                 });\r
  39 \r
  40                         editor.on( 'uiReady', function()\r
  41                                 {\r
  42                                         editor.setMode( editor.config.startupMode );\r
  43                                 });\r
  44 \r
  45                         editor.on( 'afterSetData', function()\r
  46                                 {\r
  47                                         if ( !isHandlingData )\r
  48                                         {\r
  49                                                 function setData()\r
  50                                                 {\r
  51                                                         isHandlingData = true;\r
  52                                                         getMode( editor ).loadData( editor.getData() );\r
  53                                                         isHandlingData = false;\r
  54                                                 }\r
  55 \r
  56                                                 if ( editor.mode )\r
  57                                                         setData();\r
  58                                                 else\r
  59                                                 {\r
  60                                                         editor.on( 'mode', function()\r
  61                                                                 {\r
  62                                                                         setData();\r
  63                                                                         editor.removeListener( 'mode', arguments.callee );\r
  64                                                                 });\r
  65                                                 }\r
  66                                         }\r
  67                                 });\r
  68 \r
  69                         editor.on( 'beforeGetData', function()\r
  70                                 {\r
  71                                         if ( !isHandlingData && editor.mode )\r
  72                                         {\r
  73                                                 isHandlingData = true;\r
  74                                                 editor.setData( getMode( editor ).getData() );\r
  75                                                 isHandlingData = false;\r
  76                                         }\r
  77                                 });\r
  78 \r
  79                         editor.on( 'getSnapshot', function( event )\r
  80                                 {\r
  81                                         if ( editor.mode )\r
  82                                                 event.data = getMode( editor ).getSnapshotData();\r
  83                                 });\r
  84 \r
  85                         editor.on( 'loadSnapshot', function( event )\r
  86                                 {\r
  87                                         if ( editor.mode )\r
  88                                                 getMode( editor ).loadSnapshotData( event.data );\r
  89                                 });\r
  90 \r
  91                         // For the first "mode" call, we'll also fire the "instanceReady"\r
  92                         // event.\r
  93                         editor.on( 'mode', function( event )\r
  94                                 {\r
  95                                         // Do that once only.\r
  96                                         event.removeListener();\r
  97 \r
  98                                         // Grab editor focus if the editor container is focused. (#3104)\r
  99                                         var focusGrabber = editor.container;\r
 100 \r
 101                                         // Safari 3 can't handle tabindex in all elements, so we do\r
 102                                         // a trick to make it move the focus to the editor on TAB.\r
 103                                         if ( CKEDITOR.env.webkit && CKEDITOR.env.version < 528 )\r
 104                                         {\r
 105                                                 var tabIndex = editor.config.tabIndex || editor.element.getAttribute( 'tabindex' ) || 0;\r
 106                                                 focusGrabber = focusGrabber.append( CKEDITOR.dom.element.createFromHtml(\r
 107                                                         '<input' +\r
 108                                                                 ' tabindex="' + tabIndex + '"' +\r
 109                                                                 ' style="position:absolute; left:-10000">' ) );\r
 110                                         }\r
 111 \r
 112                                         focusGrabber.on( 'focus', function()\r
 113                                                 {\r
 114                                                         editor.focus();\r
 115                                                 });\r
 116 \r
 117                                         if ( editor.config.startupFocus )\r
 118                                                 editor.focus();\r
 119 \r
 120                                         // Fire instanceReady for both the editor and CKEDITOR, but\r
 121                                         // defer this until the whole execution has completed\r
 122                                         // to guarantee the editor is fully responsible.\r
 123                                         setTimeout( function(){\r
 124                                                 editor.fireOnce( 'instanceReady' );\r
 125                                                 CKEDITOR.fire( 'instanceReady', null, editor );\r
 126                                         } );\r
 127                                 });\r
 128                 }\r
 129         });\r
 130 \r
 131         /**\r
 132          * The current editing mode. An editing mode is basically a viewport for\r
 133          * editing or content viewing. By default the possible values for this\r
 134          * property are "wysiwyg" and "source".\r
 135          * @type String\r
 136          * @example\r
 137          * alert( CKEDITOR.instances.editor1.mode );  // "wysiwyg" (e.g.)\r
 138          */\r
 139         CKEDITOR.editor.prototype.mode = '';\r
 140 \r
 141         /**\r
 142          * Registers an editing mode. This function is to be used mainly by plugins.\r
 143          * @param {String} mode The mode name.\r
 144          * @param {Object} modeEditor The mode editor definition.\r
 145          * @example\r
 146          */\r
 147         CKEDITOR.editor.prototype.addMode = function( mode, modeEditor )\r
 148         {\r
 149                 modeEditor.name = mode;\r
 150                 ( this._.modes || ( this._.modes = {} ) )[ mode ] = modeEditor;\r
 151         };\r
 152 \r
 153         /**\r
 154          * Sets the current editing mode in this editor instance.\r
 155          * @param {String} mode A registered mode name.\r
 156          * @example\r
 157          * // Switch to "source" view.\r
 158          * CKEDITOR.instances.editor1.setMode( 'source' );\r
 159          */\r
 160         CKEDITOR.editor.prototype.setMode = function( mode )\r
 161         {\r
 162                 var data,\r
 163                         holderElement = this.getThemeSpace( 'contents' ),\r
 164                         isDirty = this.checkDirty();\r
 165 \r
 166                 // Unload the previous mode.\r
 167                 if ( this.mode )\r
 168                 {\r
 169                         if ( mode == this.mode )\r
 170                                 return;\r
 171 \r
 172                         this.fire( 'beforeModeUnload' );\r
 173 \r
 174                         var currentMode = getMode( this );\r
 175                         data = currentMode.getData();\r
 176                         currentMode.unload( holderElement );\r
 177                         this.mode = '';\r
 178                 }\r
 179 \r
 180                 holderElement.setHtml( '' );\r
 181 \r
 182                 // Load required mode.\r
 183                 var modeEditor = getMode( this, mode );\r
 184                 if ( !modeEditor )\r
 185                         throw '[CKEDITOR.editor.setMode] Unknown mode "' + mode + '".';\r
 186 \r
 187                 if ( !isDirty )\r
 188                 {\r
 189                         this.on( 'mode', function()\r
 190                                 {\r
 191                                         this.resetDirty();\r
 192                                         this.removeListener( 'mode', arguments.callee );\r
 193                                 });\r
 194                 }\r
 195 \r
 196                 modeEditor.load( holderElement, ( typeof data ) != 'string'  ? this.getData() : data);\r
 197         };\r
 198 \r
 199         /**\r
 200          * Moves the selection focus to the editing are space in the editor.\r
 201          */\r
 202         CKEDITOR.editor.prototype.focus = function()\r
 203         {\r
 204                 var mode = getMode( this );\r
 205                 if ( mode )\r
 206                         mode.focus();\r
 207         };\r
 208 })();\r
 209 \r
 210 /**\r
 211  * The mode to load at the editor startup. It depends on the plugins\r
 212  * loaded. By default, the "wysiwyg" and "source" modes are available.\r
 213  * @type String\r
 214  * @default 'wysiwyg'\r
 215  * @example\r
 216  * config.startupMode = 'source';\r
 217  */\r
 218 CKEDITOR.config.startupMode = 'wysiwyg';\r
 219 \r
 220 /**\r
 221  * Sets whether the editor should have the focus when the page loads.\r
 222  * @type Boolean\r
 223  * @default false\r
 224  * @example\r
 225  * config.startupFocus = true;\r
 226  */\r
 227 CKEDITOR.config.startupFocus = false;\r
 228 \r
 229 /**\r
 230  * Whether to render or not the editing block area in the editor interface.\r
 231  * @type Boolean\r
 232  * @default true\r
 233  * @example\r
 234  * config.editingBlock = false;\r
 235  */\r
 236 CKEDITOR.config.editingBlock = true;\r