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