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                 e.preventDefault();
264                 Roo.log('TAB');
265                 
266                 var value = this.getValue();
267                 
268                 var start = this.el.dom.selectionStart;
269                 var end = this.el.dom.selectionEnd;
270                 
271                 this.setValue(value.substring(0, start) + "\t" + value.substring(end));
272                 
273                 this.el.dom.setSelectionRange(end + 1, end + 1);
274             },
275             
276             "home" : function(e){
277                 e.preventDefault();
278                 
279                 var curr = this.el.dom.selectionStart;
280                 var lines = this.getValue().split("\n");
281                 
282                 if(!lines.length){
283                     return;
284                 }
285                 var pos = 0;
286                 
287                 for (var i = 0; i < lines.length;i++) {
288                     pos += lines[i].length;
289                     
290                     if(i != 0){
291                         pos += 1;
292                     }
293                     
294                     if(pos < curr){
295                         continue;
296                     }
297                     
298                     pos -= lines[i].length;
299                     
300                     break;
301                 }
302                 
303                 this.el.dom.setSelectionRange(pos, pos);
304             },
305             
306             "end" : function(e){
307                 e.preventDefault();
308                 
309                 var curr = this.el.dom.selectionStart;
310                 var lines = this.getValue().split("\n");
311                 
312                 if(!lines.length){
313                     return;
314                 }
315                 var pos = 0;
316                 
317                 for (var i = 0; i < lines.length;i++) {
318                     
319                     pos += lines[i].length;
320                     
321                     if(i != 0){
322                         pos += 1;
323                     }
324                     
325                     if(pos < curr){
326                         continue;
327                     }
328                     
329                     break;
330                 }
331                 
332                 this.el.dom.setSelectionRange(pos, pos);
333             },
334
335             scope : this,
336
337             doRelay : function(foo, bar, hname){
338                 return Roo.KeyNav.prototype.doRelay.apply(this, arguments);
339             },
340
341             forceKeyDown: true
342         });
343         
344 //        if(this.autosave && this.w){
345 //            this.autoSaveFn = setInterval(this.autosave, 1000);
346 //        }
347     },
348
349     // private
350     onResize : function(w, h)
351     {
352         Roo.form.HtmlEditor.superclass.onResize.apply(this, arguments);
353         var ew = false;
354         var eh = false;
355         
356         if(this.el ){
357             if(typeof w == 'number'){
358                 var aw = w - this.wrap.getFrameWidth('lr');
359                 this.el.setWidth(this.adjustWidth('textarea', aw));
360                 ew = aw;
361             }
362             if(typeof h == 'number'){
363                 var tbh = 0;
364                 for (var i =0; i < this.toolbars.length;i++) {
365                     // fixme - ask toolbars for heights?
366                     tbh += this.toolbars[i].tb.el.getHeight();
367                     if (this.toolbars[i].footer) {
368                         tbh += this.toolbars[i].footer.el.getHeight();
369                     }
370                 }
371                 
372                 
373                 
374                 
375                 var ah = h - this.wrap.getFrameWidth('tb') - tbh;// this.tb.el.getHeight();
376                 ah -= 5; // knock a few pixes off for look..
377                 Roo.log(ah);
378                 this.el.setHeight(this.adjustWidth('textarea', ah));
379                 var eh = ah;
380             }
381         }
382         Roo.log('onResize:' + [w,h,ew,eh].join(',') );
383         this.editorcore.onResize(ew,eh);
384         
385     },
386
387     /**
388      * Toggles the editor between standard and source edit mode.
389      * @param {Boolean} sourceEdit (optional) True for source edit, false for standard
390      */
391     toggleSourceEdit : function(sourceEditMode)
392     {
393         this.editorcore.toggleSourceEdit(sourceEditMode);
394         
395         if(this.editorcore.sourceEditMode){
396             Roo.log('editor - showing textarea');
397             
398 //            Roo.log('in');
399 //            Roo.log(this.syncValue());
400             this.editorcore.syncValue();
401             this.el.removeClass('x-hidden');
402             this.el.dom.removeAttribute('tabIndex');
403             this.el.focus();
404             
405             for (var i = 0; i < this.toolbars.length; i++) {
406                 if(this.toolbars[i] instanceof Roo.form.HtmlEditor.ToolbarContext){
407                     this.toolbars[i].tb.hide();
408                     this.toolbars[i].footer.hide();
409                 }
410             }
411             
412         }else{
413             Roo.log('editor - hiding textarea');
414 //            Roo.log('out')
415 //            Roo.log(this.pushValue()); 
416             this.editorcore.pushValue();
417             
418             this.el.addClass('x-hidden');
419             this.el.dom.setAttribute('tabIndex', -1);
420             
421             for (var i = 0; i < this.toolbars.length; i++) {
422                 if(this.toolbars[i] instanceof Roo.form.HtmlEditor.ToolbarContext){
423                     this.toolbars[i].tb.show();
424                     this.toolbars[i].footer.show();
425                 }
426             }
427             
428             //this.deferFocus();
429         }
430         
431         this.setSize(this.wrap.getSize());
432         this.onResize(this.wrap.getSize().width, this.wrap.getSize().height);
433         
434         this.fireEvent('editmodechange', this, this.editorcore.sourceEditMode);
435     },
436  
437     // private (for BoxComponent)
438     adjustSize : Roo.BoxComponent.prototype.adjustSize,
439
440     // private (for BoxComponent)
441     getResizeEl : function(){
442         return this.wrap;
443     },
444
445     // private (for BoxComponent)
446     getPositionEl : function(){
447         return this.wrap;
448     },
449
450     // private
451     initEvents : function(){
452         this.originalValue = this.getValue();
453     },
454
455     /**
456      * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
457      * @method
458      */
459     markInvalid : Roo.emptyFn,
460     /**
461      * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
462      * @method
463      */
464     clearInvalid : Roo.emptyFn,
465
466     setValue : function(v){
467         Roo.form.HtmlEditor.superclass.setValue.call(this, v);
468         this.editorcore.pushValue();
469     },
470
471      
472     // private
473     deferFocus : function(){
474         this.focus.defer(10, this);
475     },
476
477     // doc'ed in Field
478     focus : function(){
479         this.editorcore.focus();
480         
481     },
482       
483
484     // private
485     onDestroy : function(){
486         
487         
488         
489         if(this.rendered){
490             
491             for (var i =0; i < this.toolbars.length;i++) {
492                 // fixme - ask toolbars for heights?
493                 this.toolbars[i].onDestroy();
494             }
495             
496             this.wrap.dom.innerHTML = '';
497             this.wrap.remove();
498         }
499     },
500
501     // private
502     onFirstFocus : function(){
503         //Roo.log("onFirstFocus");
504         this.editorcore.onFirstFocus();
505          for (var i =0; i < this.toolbars.length;i++) {
506             this.toolbars[i].onFirstFocus();
507         }
508         
509     },
510     
511     // private
512     syncValue : function()
513     {
514         this.editorcore.syncValue();
515     },
516     
517     pushValue : function()
518     {
519         this.editorcore.pushValue();
520     }
521      
522     
523     // hide stuff that is not compatible
524     /**
525      * @event blur
526      * @hide
527      */
528     /**
529      * @event change
530      * @hide
531      */
532     /**
533      * @event focus
534      * @hide
535      */
536     /**
537      * @event specialkey
538      * @hide
539      */
540     /**
541      * @cfg {String} fieldClass @hide
542      */
543     /**
544      * @cfg {String} focusClass @hide
545      */
546     /**
547      * @cfg {String} autoCreate @hide
548      */
549     /**
550      * @cfg {String} inputType @hide
551      */
552     /**
553      * @cfg {String} invalidClass @hide
554      */
555     /**
556      * @cfg {String} invalidText @hide
557      */
558     /**
559      * @cfg {String} msgFx @hide
560      */
561     /**
562      * @cfg {String} validateOnBlur @hide
563      */
564 });
565  
566