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 Roo.form.HtmlEditor
27  * @extends Roo.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 {Boolean} clearUp
40      */
41     clearUp : true,
42       /**
43      * @cfg {Array} toolbars Array of toolbars. - defaults to just the Standard one
44      */
45     toolbars : false,
46    
47      /**
48      * @cfg {String} resizable  's' or 'se' or 'e' - wrapps the element in a
49      *                        Roo.resizable.
50      */
51     resizable : false,
52      /**
53      * @cfg {Number} height (in pixels)
54      */   
55     height: 300,
56    /**
57      * @cfg {Number} width (in pixels)
58      */   
59     width: 500,
60     
61     /**
62      * @cfg {Array} stylesheets url of stylesheets. set to [] to disable stylesheets.
63      * 
64      */
65     stylesheets: false,
66     
67     
68      /**
69      * @cfg {Array} blacklist of css styles style attributes (blacklist overrides whitelist)
70      * 
71      */
72     cblack: false,
73     /**
74      * @cfg {Array} whitelist of css styles style attributes (blacklist overrides whitelist)
75      * 
76      */
77     cwhite: false,
78     
79      /**
80      * @cfg {Array} blacklist of html tags - in addition to standard blacklist.
81      * 
82      */
83     black: false,
84     /**
85      * @cfg {Array} whitelist of html tags - in addition to statndard whitelist
86      * 
87      */
88     white: false,
89     
90     // id of frame..
91     frameId: false,
92     
93     // private properties
94     validationEvent : false,
95     deferHeight: true,
96     initialized : false,
97     activated : false,
98     
99     onFocus : Roo.emptyFn,
100     iframePad:3,
101     hideMode:'offsets',
102     
103     actionMode : 'container', // defaults to hiding it...
104     
105     defaultAutoCreate : { // modified by initCompnoent..
106         tag: "textarea",
107         style:"width:500px;height:300px;",
108         autocomplete: "off"
109     },
110
111     // private
112     initComponent : function(){
113         this.addEvents({
114             /**
115              * @event initialize
116              * Fires when the editor is fully initialized (including the iframe)
117              * @param {HtmlEditor} this
118              */
119             initialize: true,
120             /**
121              * @event activate
122              * Fires when the editor is first receives the focus. Any insertion must wait
123              * until after this event.
124              * @param {HtmlEditor} this
125              */
126             activate: true,
127              /**
128              * @event beforesync
129              * Fires before the textarea is updated with content from the editor iframe. Return false
130              * to cancel the sync.
131              * @param {HtmlEditor} this
132              * @param {String} html
133              */
134             beforesync: true,
135              /**
136              * @event beforepush
137              * Fires before the iframe editor is updated with content from the textarea. Return false
138              * to cancel the push.
139              * @param {HtmlEditor} this
140              * @param {String} html
141              */
142             beforepush: true,
143              /**
144              * @event sync
145              * Fires when the textarea is updated with content from the editor iframe.
146              * @param {HtmlEditor} this
147              * @param {String} html
148              */
149             sync: true,
150              /**
151              * @event push
152              * Fires when the iframe editor is updated with content from the textarea.
153              * @param {HtmlEditor} this
154              * @param {String} html
155              */
156             push: true,
157              /**
158              * @event editmodechange
159              * Fires when the editor switches edit modes
160              * @param {HtmlEditor} this
161              * @param {Boolean} sourceEdit True if source edit, false if standard editing.
162              */
163             editmodechange: true,
164             /**
165              * @event editorevent
166              * Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.
167              * @param {HtmlEditor} this
168              */
169             editorevent: true,
170             /**
171              * @event firstfocus
172              * Fires when on first focus - needed by toolbars..
173              * @param {HtmlEditor} this
174              */
175             firstfocus: true,
176             /**
177              * @event autosave
178              * Auto save the htmlEditor value as a file into Events
179              * @param {HtmlEditor} this
180              */
181             autosave: true,
182             /**
183              * @event savedpreview
184              * preview the saved version of htmlEditor
185              * @param {HtmlEditor} this
186              */
187             savedpreview: true
188         });
189         this.defaultAutoCreate =  {
190             tag: "textarea",
191             style:'width: ' + this.width + 'px;height: ' + this.height + 'px;',
192             autocomplete: "off"
193         };
194     },
195
196     /**
197      * Protected method that will not generally be called directly. It
198      * is called when the editor creates its toolbar. Override this method if you need to
199      * add custom toolbar buttons.
200      * @param {HtmlEditor} editor
201      */
202     createToolbar : function(editor){
203         Roo.log("create toolbars");
204         if (!editor.toolbars || !editor.toolbars.length) {
205             editor.toolbars = [ new Roo.form.HtmlEditor.ToolbarStandard() ]; // can be empty?
206         }
207         
208         for (var i =0 ; i < editor.toolbars.length;i++) {
209             editor.toolbars[i] = Roo.factory(
210                     typeof(editor.toolbars[i]) == 'string' ?
211                         { xtype: editor.toolbars[i]} : editor.toolbars[i],
212                 Roo.form.HtmlEditor);
213             editor.toolbars[i].init(editor);
214         }
215          
216         
217     },
218
219      
220     // private
221     onRender : function(ct, position)
222     {
223         var _t = this;
224         Roo.form.HtmlEditor.superclass.onRender.call(this, ct, position);
225         
226         this.wrap = this.el.wrap({
227             cls:'x-html-editor-wrap', cn:{cls:'x-html-editor-tb'}
228         });
229         
230         this.editorcore.onRender(ct, position);
231          
232         if (this.resizable) {
233             this.resizeEl = new Roo.Resizable(this.wrap, {
234                 pinned : true,
235                 wrap: true,
236                 dynamic : true,
237                 minHeight : this.height,
238                 height: this.height,
239                 handles : this.resizable,
240                 width: this.width,
241                 listeners : {
242                     resize : function(r, w, h) {
243                         _t.onResize(w,h); // -something
244                     }
245                 }
246             });
247             
248         }
249         this.createToolbar(this);
250        
251         
252         if(!this.width){
253             this.setSize(this.wrap.getSize());
254         }
255         if (this.resizeEl) {
256             this.resizeEl.resizeTo.defer(100, this.resizeEl,[ this.width,this.height ] );
257             // should trigger onReize..
258         }
259         
260         this.keyNav = new Roo.KeyNav(this.el, {
261             
262             "tab" : function(e){
263                 
264                 e.preventDefault();
265                 Roo.log('TAB');
266                 
267                 var value = this.getValue();
268                 
269                 var start = this.el.dom.selectionStart;
270                 var end = this.el.dom.selectionEnd;
271                 
272                 if(!e.shiftKey){
273                     this.setValue(value.substring(0, start) + "\t" + value.substring(end));
274                 
275                     this.el.dom.setSelectionRange(end + 1, end + 1);
276                     return;
277                 }
278                 
279                 
280                 
281             },
282             
283             "home" : function(e){
284                 e.preventDefault();
285                 
286                 var curr = this.el.dom.selectionStart;
287                 var lines = this.getValue().split("\n");
288                 
289                 if(!lines.length){
290                     return;
291                 }
292                 var pos = 0;
293                 
294                 for (var i = 0; i < lines.length;i++) {
295                     pos += lines[i].length;
296                     
297                     if(i != 0){
298                         pos += 1;
299                     }
300                     
301                     if(pos < curr){
302                         continue;
303                     }
304                     
305                     pos -= lines[i].length;
306                     
307                     break;
308                 }
309                 
310                 this.el.dom.setSelectionRange(pos, pos);
311             },
312             
313             "end" : function(e){
314                 e.preventDefault();
315                 
316                 var curr = this.el.dom.selectionStart;
317                 var lines = this.getValue().split("\n");
318                 
319                 if(!lines.length){
320                     return;
321                 }
322                 var pos = 0;
323                 
324                 for (var i = 0; i < lines.length;i++) {
325                     
326                     pos += lines[i].length;
327                     
328                     if(i != 0){
329                         pos += 1;
330                     }
331                     
332                     if(pos < curr){
333                         continue;
334                     }
335                     
336                     break;
337                 }
338                 
339                 this.el.dom.setSelectionRange(pos, pos);
340             },
341
342             scope : this,
343
344             doRelay : function(foo, bar, hname){
345                 return Roo.KeyNav.prototype.doRelay.apply(this, arguments);
346             },
347
348             forceKeyDown: true
349         });
350         
351 //        if(this.autosave && this.w){
352 //            this.autoSaveFn = setInterval(this.autosave, 1000);
353 //        }
354     },
355
356     // private
357     onResize : function(w, h)
358     {
359         Roo.form.HtmlEditor.superclass.onResize.apply(this, arguments);
360         var ew = false;
361         var eh = false;
362         
363         if(this.el ){
364             if(typeof w == 'number'){
365                 var aw = w - this.wrap.getFrameWidth('lr');
366                 this.el.setWidth(this.adjustWidth('textarea', aw));
367                 ew = aw;
368             }
369             if(typeof h == 'number'){
370                 var tbh = 0;
371                 for (var i =0; i < this.toolbars.length;i++) {
372                     // fixme - ask toolbars for heights?
373                     tbh += this.toolbars[i].tb.el.getHeight();
374                     if (this.toolbars[i].footer) {
375                         tbh += this.toolbars[i].footer.el.getHeight();
376                     }
377                 }
378                 
379                 
380                 
381                 
382                 var ah = h - this.wrap.getFrameWidth('tb') - tbh;// this.tb.el.getHeight();
383                 ah -= 5; // knock a few pixes off for look..
384                 Roo.log(ah);
385                 this.el.setHeight(this.adjustWidth('textarea', ah));
386                 var eh = ah;
387             }
388         }
389         Roo.log('onResize:' + [w,h,ew,eh].join(',') );
390         this.editorcore.onResize(ew,eh);
391         
392     },
393
394     /**
395      * Toggles the editor between standard and source edit mode.
396      * @param {Boolean} sourceEdit (optional) True for source edit, false for standard
397      */
398     toggleSourceEdit : function(sourceEditMode)
399     {
400         this.editorcore.toggleSourceEdit(sourceEditMode);
401         
402         if(this.editorcore.sourceEditMode){
403             Roo.log('editor - showing textarea');
404             
405 //            Roo.log('in');
406 //            Roo.log(this.syncValue());
407             this.editorcore.syncValue();
408             this.el.removeClass('x-hidden');
409             this.el.dom.removeAttribute('tabIndex');
410             this.el.focus();
411             
412             for (var i = 0; i < this.toolbars.length; i++) {
413                 if(this.toolbars[i] instanceof Roo.form.HtmlEditor.ToolbarContext){
414                     this.toolbars[i].tb.hide();
415                     this.toolbars[i].footer.hide();
416                 }
417             }
418             
419         }else{
420             Roo.log('editor - hiding textarea');
421 //            Roo.log('out')
422 //            Roo.log(this.pushValue()); 
423             this.editorcore.pushValue();
424             
425             this.el.addClass('x-hidden');
426             this.el.dom.setAttribute('tabIndex', -1);
427             
428             for (var i = 0; i < this.toolbars.length; i++) {
429                 if(this.toolbars[i] instanceof Roo.form.HtmlEditor.ToolbarContext){
430                     this.toolbars[i].tb.show();
431                     this.toolbars[i].footer.show();
432                 }
433             }
434             
435             //this.deferFocus();
436         }
437         
438         this.setSize(this.wrap.getSize());
439         this.onResize(this.wrap.getSize().width, this.wrap.getSize().height);
440         
441         this.fireEvent('editmodechange', this, this.editorcore.sourceEditMode);
442     },
443  
444     // private (for BoxComponent)
445     adjustSize : Roo.BoxComponent.prototype.adjustSize,
446
447     // private (for BoxComponent)
448     getResizeEl : function(){
449         return this.wrap;
450     },
451
452     // private (for BoxComponent)
453     getPositionEl : function(){
454         return this.wrap;
455     },
456
457     // private
458     initEvents : function(){
459         this.originalValue = this.getValue();
460     },
461
462     /**
463      * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
464      * @method
465      */
466     markInvalid : Roo.emptyFn,
467     /**
468      * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
469      * @method
470      */
471     clearInvalid : Roo.emptyFn,
472
473     setValue : function(v){
474         Roo.form.HtmlEditor.superclass.setValue.call(this, v);
475         this.editorcore.pushValue();
476     },
477
478      
479     // private
480     deferFocus : function(){
481         this.focus.defer(10, this);
482     },
483
484     // doc'ed in Field
485     focus : function(){
486         this.editorcore.focus();
487         
488     },
489       
490
491     // private
492     onDestroy : function(){
493         
494         
495         
496         if(this.rendered){
497             
498             for (var i =0; i < this.toolbars.length;i++) {
499                 // fixme - ask toolbars for heights?
500                 this.toolbars[i].onDestroy();
501             }
502             
503             this.wrap.dom.innerHTML = '';
504             this.wrap.remove();
505         }
506     },
507
508     // private
509     onFirstFocus : function(){
510         //Roo.log("onFirstFocus");
511         this.editorcore.onFirstFocus();
512          for (var i =0; i < this.toolbars.length;i++) {
513             this.toolbars[i].onFirstFocus();
514         }
515         
516     },
517     
518     // private
519     syncValue : function()
520     {
521         this.editorcore.syncValue();
522     },
523     
524     pushValue : function()
525     {
526         this.editorcore.pushValue();
527     }
528      
529     
530     // hide stuff that is not compatible
531     /**
532      * @event blur
533      * @hide
534      */
535     /**
536      * @event change
537      * @hide
538      */
539     /**
540      * @event focus
541      * @hide
542      */
543     /**
544      * @event specialkey
545      * @hide
546      */
547     /**
548      * @cfg {String} fieldClass @hide
549      */
550     /**
551      * @cfg {String} focusClass @hide
552      */
553     /**
554      * @cfg {String} autoCreate @hide
555      */
556     /**
557      * @cfg {String} inputType @hide
558      */
559     /**
560      * @cfg {String} invalidClass @hide
561      */
562     /**
563      * @cfg {String} invalidText @hide
564      */
565     /**
566      * @cfg {String} msgFx @hide
567      */
568     /**
569      * @cfg {String} validateOnBlur @hide
570      */
571 });
572  
573