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