2 Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
7 * @fileOverview The default editing block plugin, which holds the editing area
\r
13 var getMode = function( editor, mode )
\r
15 return editor._.modes && editor._.modes[ mode || editor.mode ];
\r
18 // This is a semaphore used to avoid recursive calls between
\r
19 // the following data handling functions.
\r
22 CKEDITOR.plugins.add( 'editingblock',
\r
24 init : function( editor )
\r
26 if ( !editor.config.editingBlock )
\r
29 editor.on( 'themeSpace', function( event )
\r
31 if ( event.data.space == 'contents' )
\r
32 event.data.html += '<br>';
\r
35 editor.on( 'themeLoaded', function()
\r
37 editor.fireOnce( 'editingBlockReady' );
\r
40 editor.on( 'uiReady', function()
\r
42 editor.setMode( editor.config.startupMode );
\r
45 editor.on( 'afterSetData', function()
\r
47 if ( !isHandlingData )
\r
51 isHandlingData = true;
\r
52 getMode( editor ).loadData( editor.getData() );
\r
53 isHandlingData = false;
\r
60 editor.on( 'mode', function()
\r
63 editor.removeListener( 'mode', arguments.callee );
\r
69 editor.on( 'beforeGetData', function()
\r
71 if ( !isHandlingData && editor.mode )
\r
73 isHandlingData = true;
\r
74 editor.setData( getMode( editor ).getData() );
\r
75 isHandlingData = false;
\r
79 editor.on( 'getSnapshot', function( event )
\r
82 event.data = getMode( editor ).getSnapshotData();
\r
85 editor.on( 'loadSnapshot', function( event )
\r
88 getMode( editor ).loadSnapshotData( event.data );
\r
91 // For the first "mode" call, we'll also fire the "instanceReady"
\r
93 editor.on( 'mode', function( event )
\r
95 // Do that once only.
\r
96 event.removeListener();
\r
98 // Grab editor focus if the editor container is focused. (#3104)
\r
99 var focusGrabber = editor.container;
\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
105 var tabIndex = editor.config.tabIndex || editor.element.getAttribute( 'tabindex' ) || 0;
\r
106 focusGrabber = focusGrabber.append( CKEDITOR.dom.element.createFromHtml(
\r
108 ' tabindex="' + tabIndex + '"' +
\r
109 ' style="position:absolute; left:-10000">' ) );
\r
112 focusGrabber.on( 'focus', function()
\r
117 if ( editor.config.startupFocus )
\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
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
137 * alert( CKEDITOR.instances.editor1.mode ); // "wysiwyg" (e.g.)
\r
139 CKEDITOR.editor.prototype.mode = '';
\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
147 CKEDITOR.editor.prototype.addMode = function( mode, modeEditor )
\r
149 modeEditor.name = mode;
\r
150 ( this._.modes || ( this._.modes = {} ) )[ mode ] = modeEditor;
\r
154 * Sets the current editing mode in this editor instance.
\r
155 * @param {String} mode A registered mode name.
\r
157 * // Switch to "source" view.
\r
158 * CKEDITOR.instances.editor1.setMode( 'source' );
\r
160 CKEDITOR.editor.prototype.setMode = function( mode )
\r
163 holderElement = this.getThemeSpace( 'contents' ),
\r
164 isDirty = this.checkDirty();
\r
166 // Unload the previous mode.
\r
169 if ( mode == this.mode )
\r
172 this.fire( 'beforeModeUnload' );
\r
174 var currentMode = getMode( this );
\r
175 data = currentMode.getData();
\r
176 currentMode.unload( holderElement );
\r
180 holderElement.setHtml( '' );
\r
182 // Load required mode.
\r
183 var modeEditor = getMode( this, mode );
\r
185 throw '[CKEDITOR.editor.setMode] Unknown mode "' + mode + '".';
\r
189 this.on( 'mode', function()
\r
192 this.removeListener( 'mode', arguments.callee );
\r
196 modeEditor.load( holderElement, ( typeof data ) != 'string' ? this.getData() : data);
\r
200 * Moves the selection focus to the editing are space in the editor.
\r
202 CKEDITOR.editor.prototype.focus = function()
\r
204 var mode = getMode( this );
\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
214 * @default 'wysiwyg'
\r
216 * config.startupMode = 'source';
\r
218 CKEDITOR.config.startupMode = 'wysiwyg';
\r
221 * Sets whether the editor should have the focus when the page loads.
\r
225 * config.startupFocus = true;
\r
227 CKEDITOR.config.startupFocus = false;
\r
230 * Whether to render or not the editing block area in the editor interface.
\r
234 * config.editingBlock = false;
\r
236 CKEDITOR.config.editingBlock = true;
\r