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