Roo/form/HtmlEditor.js
[roojs1] / Roo / form / HtmlEditor.js
1 //<script type="text/javascript">
2
3 /*
4  * Ext JS Library 1.1.1
5  * Copyright(c) 2006-2007, Ext JS, LLC.
6  * Licence LGPL
7  * 
8  */
9  
10  
11 Roo.form.HtmlEditor = function(config){
12     
13     
14     
15     Roo.form.HtmlEditor.superclass.constructor.call(this, config);
16     
17     if (!this.toolbars) {
18         this.toolbars = [];
19     }
20     this.editorcore = new Roo.HtmlEditorCore(Roo.apply({ owner : this} , config));
21     
22     
23 };
24
25 /**
26  * @class Ext.form.HtmlEditor
27  * @extends Ext.form.Field
28  * Provides a lightweight HTML Editor component.
29  *
30  * This has been tested on Fireforx / Chrome.. IE may not be so great..
31  * 
32  * <br><br><b>Note: The focus/blur and validation marking functionality inherited from Ext.form.Field is NOT
33  * supported by this editor.</b><br/><br/>
34  * An Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within
35  * any element that has display set to 'none' can cause problems in Safari and Firefox.<br/><br/>
36  */
37 Roo.extend(Roo.form.HtmlEditor, Roo.form.Field, {
38       /**
39      * @cfg {Array} toolbars Array of toolbars. - defaults to just the Standard one
40      */
41     toolbars : false,
42    
43      /**
44      * @cfg {String} resizable  's' or 'se' or 'e' - wrapps the element in a
45      *                        Roo.resizable.
46      */
47     resizable : false,
48      /**
49      * @cfg {Number} height (in pixels)
50      */   
51     height: 300,
52    /**
53      * @cfg {Number} width (in pixels)
54      */   
55     width: 500,
56     
57     /**
58      * @cfg {Array} stylesheets url of stylesheets. set to [] to disable stylesheets.
59      * 
60      */
61     stylesheets: false,
62     
63     /**
64      * @cfg {Boolean} autosave Auto save the field as a file (default false)
65      */
66     
67     autosave : false,
68     
69     // id of frame..
70     frameId: false,
71     
72     // private properties
73     validationEvent : false,
74     deferHeight: true,
75     initialized : false,
76     activated : false,
77     
78     onFocus : Roo.emptyFn,
79     iframePad:3,
80     hideMode:'offsets',
81     
82     defaultAutoCreate : { // modified by initCompnoent..
83         tag: "textarea",
84         style:"width:500px;height:300px;",
85         autocomplete: "off"
86     },
87
88     // private
89     initComponent : function(){
90         this.addEvents({
91             /**
92              * @event initialize
93              * Fires when the editor is fully initialized (including the iframe)
94              * @param {HtmlEditor} this
95              */
96             initialize: true,
97             /**
98              * @event activate
99              * Fires when the editor is first receives the focus. Any insertion must wait
100              * until after this event.
101              * @param {HtmlEditor} this
102              */
103             activate: true,
104              /**
105              * @event beforesync
106              * Fires before the textarea is updated with content from the editor iframe. Return false
107              * to cancel the sync.
108              * @param {HtmlEditor} this
109              * @param {String} html
110              */
111             beforesync: true,
112              /**
113              * @event beforepush
114              * Fires before the iframe editor is updated with content from the textarea. Return false
115              * to cancel the push.
116              * @param {HtmlEditor} this
117              * @param {String} html
118              */
119             beforepush: true,
120              /**
121              * @event sync
122              * Fires when the textarea is updated with content from the editor iframe.
123              * @param {HtmlEditor} this
124              * @param {String} html
125              */
126             sync: true,
127              /**
128              * @event push
129              * Fires when the iframe editor is updated with content from the textarea.
130              * @param {HtmlEditor} this
131              * @param {String} html
132              */
133             push: true,
134              /**
135              * @event editmodechange
136              * Fires when the editor switches edit modes
137              * @param {HtmlEditor} this
138              * @param {Boolean} sourceEdit True if source edit, false if standard editing.
139              */
140             editmodechange: true,
141             /**
142              * @event editorevent
143              * Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.
144              * @param {HtmlEditor} this
145              */
146             editorevent: true,
147             /**
148              * @event firstfocus
149              * Fires when on first focus - needed by toolbars..
150              * @param {HtmlEditor} this
151              */
152             firstfocus: true
153         });
154         this.defaultAutoCreate =  {
155             tag: "textarea",
156             style:'width: ' + this.width + 'px;height: ' + this.height + 'px;',
157             autocomplete: "off"
158         };
159     },
160
161     /**
162      * Protected method that will not generally be called directly. It
163      * is called when the editor creates its toolbar. Override this method if you need to
164      * add custom toolbar buttons.
165      * @param {HtmlEditor} editor
166      */
167     createToolbar : function(editor){
168         Roo.log("create toolbars");
169         if (!editor.toolbars || !editor.toolbars.length) {
170             editor.toolbars = [ new Roo.form.HtmlEditor.ToolbarStandard() ]; // can be empty?
171         }
172         
173         for (var i =0 ; i < editor.toolbars.length;i++) {
174             editor.toolbars[i] = Roo.factory(
175                     typeof(editor.toolbars[i]) == 'string' ?
176                         { xtype: editor.toolbars[i]} : editor.toolbars[i],
177                 Roo.form.HtmlEditor);
178             editor.toolbars[i].init(editor);
179         }
180          
181         
182     },
183
184      
185     // private
186     onRender : function(ct, position)
187     {
188         var _t = this;
189         Roo.form.HtmlEditor.superclass.onRender.call(this, ct, position);
190         
191         this.wrap = this.el.wrap({
192             cls:'x-html-editor-wrap', cn:{cls:'x-html-editor-tb'}
193         });
194         
195         this.editorcore.onRender(ct, position);
196          
197         if (this.resizable) {
198             this.resizeEl = new Roo.Resizable(this.wrap, {
199                 pinned : true,
200                 wrap: true,
201                 dynamic : true,
202                 minHeight : this.height,
203                 height: this.height,
204                 handles : this.resizable,
205                 width: this.width,
206                 listeners : {
207                     resize : function(r, w, h) {
208                         _t.onResize(w,h); // -something
209                     }
210                 }
211             });
212             
213         }
214         this.createToolbar(this);
215        
216         
217         if(!this.width){
218             this.setSize(this.wrap.getSize());
219         }
220         if (this.resizeEl) {
221             this.resizeEl.resizeTo.defer(100, this.resizeEl,[ this.width,this.height ] );
222             // should trigger onReize..
223         }
224         
225         if(this.autosave){
226             var _this = this;
227             _this.autoSaveFn = setInterval(function(){
228                 _this.syncValue();
229                 if(!_this.isDirty()){
230                     Roo.log('not dirty');
231                     return;
232                 }
233                 Roo.log('dirty, auto save!');
234     //
235     //            _this.form.findField('body').originalValue = _this.form.findField('body').getValue();
236             }, 1000);
237         }
238     },
239
240     // private
241     onResize : function(w, h)
242     {
243         //Roo.log('resize: ' +w + ',' + h );
244         Roo.form.HtmlEditor.superclass.onResize.apply(this, arguments);
245         var ew = false;
246         var eh = false;
247         
248         if(this.el ){
249             if(typeof w == 'number'){
250                 var aw = w - this.wrap.getFrameWidth('lr');
251                 this.el.setWidth(this.adjustWidth('textarea', aw));
252                 ew = aw;
253             }
254             if(typeof h == 'number'){
255                 var tbh = 0;
256                 for (var i =0; i < this.toolbars.length;i++) {
257                     // fixme - ask toolbars for heights?
258                     tbh += this.toolbars[i].tb.el.getHeight();
259                     if (this.toolbars[i].footer) {
260                         tbh += this.toolbars[i].footer.el.getHeight();
261                     }
262                 }
263                 
264                 
265                 
266                 
267                 var ah = h - this.wrap.getFrameWidth('tb') - tbh;// this.tb.el.getHeight();
268                 ah -= 5; // knock a few pixes off for look..
269                 this.el.setHeight(this.adjustWidth('textarea', ah));
270                 var eh = ah;
271             }
272         }
273         Roo.log('onResize:' + [w,h,ew,eh].join(',') );
274         this.editorcore.onResize(ew,eh);
275         
276     },
277
278     /**
279      * Toggles the editor between standard and source edit mode.
280      * @param {Boolean} sourceEdit (optional) True for source edit, false for standard
281      */
282     toggleSourceEdit : function(sourceEditMode)
283     {
284         this.editorcore.toggleSourceEdit(sourceEditMode);
285         
286         if(this.editorcore.sourceEditMode){
287             Roo.log('editor - showing textarea');
288             
289 //            Roo.log('in');
290 //            Roo.log(this.syncValue());
291             this.editorcore.syncValue();
292             this.el.removeClass('x-hidden');
293             this.el.dom.removeAttribute('tabIndex');
294             this.el.focus();
295         }else{
296             Roo.log('editor - hiding textarea');
297 //            Roo.log('out')
298 //            Roo.log(this.pushValue()); 
299             this.editorcore.pushValue();
300             
301             this.el.addClass('x-hidden');
302             this.el.dom.setAttribute('tabIndex', -1);
303             //this.deferFocus();
304         }
305          
306         this.setSize(this.wrap.getSize());
307         this.fireEvent('editmodechange', this, this.editorcore.sourceEditMode);
308     },
309  
310     // private (for BoxComponent)
311     adjustSize : Roo.BoxComponent.prototype.adjustSize,
312
313     // private (for BoxComponent)
314     getResizeEl : function(){
315         return this.wrap;
316     },
317
318     // private (for BoxComponent)
319     getPositionEl : function(){
320         return this.wrap;
321     },
322
323     // private
324     initEvents : function(){
325         this.originalValue = this.getValue();
326     },
327
328     /**
329      * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
330      * @method
331      */
332     markInvalid : Roo.emptyFn,
333     /**
334      * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
335      * @method
336      */
337     clearInvalid : Roo.emptyFn,
338
339     setValue : function(v){
340         Roo.form.HtmlEditor.superclass.setValue.call(this, v);
341         this.editorcore.pushValue();
342     },
343
344      
345     // private
346     deferFocus : function(){
347         this.focus.defer(10, this);
348     },
349
350     // doc'ed in Field
351     focus : function(){
352         this.editorcore.focus();
353         
354     },
355       
356
357     // private
358     onDestroy : function(){
359         
360         
361         
362         if(this.rendered){
363             
364             for (var i =0; i < this.toolbars.length;i++) {
365                 // fixme - ask toolbars for heights?
366                 this.toolbars[i].onDestroy();
367             }
368             
369             this.wrap.dom.innerHTML = '';
370             this.wrap.remove();
371         }
372     },
373
374     // private
375     onFirstFocus : function(){
376         //Roo.log("onFirstFocus");
377         this.editorcore.onFirstFocus();
378          for (var i =0; i < this.toolbars.length;i++) {
379             this.toolbars[i].onFirstFocus();
380         }
381         
382     },
383     
384     // private
385     syncValue : function()
386     {
387         this.editorcore.syncValue();
388     }
389      
390     
391     // hide stuff that is not compatible
392     /**
393      * @event blur
394      * @hide
395      */
396     /**
397      * @event change
398      * @hide
399      */
400     /**
401      * @event focus
402      * @hide
403      */
404     /**
405      * @event specialkey
406      * @hide
407      */
408     /**
409      * @cfg {String} fieldClass @hide
410      */
411     /**
412      * @cfg {String} focusClass @hide
413      */
414     /**
415      * @cfg {String} autoCreate @hide
416      */
417     /**
418      * @cfg {String} inputType @hide
419      */
420     /**
421      * @cfg {String} invalidClass @hide
422      */
423     /**
424      * @cfg {String} invalidText @hide
425      */
426     /**
427      * @cfg {String} msgFx @hide
428      */
429     /**
430      * @cfg {String} validateOnBlur @hide
431      */
432 });
433  
434