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 {Array} toolbars Array of toolbars. - defaults to just the Standard one
40      */
41     toolbars : false,
42    
43      /**
44      * @cfg {String} resizable  's' or 'se' or 'e' - wrapps the element in a
45      *                        Roo.resizable.
46      */
47     resizable : false,
48      /**
49      * @cfg {Number} height (in pixels)
50      */   
51     height: 300,
52    /**
53      * @cfg {Number} width (in pixels)
54      */   
55     width: 500,
56     
57     /**
58      * @cfg {Array} stylesheets url of stylesheets. set to [] to disable stylesheets.
59      * 
60      */
61     stylesheets: false,
62     
63     autosave : false,
64     
65     // id of frame..
66     frameId: false,
67     
68     // private properties
69     validationEvent : false,
70     deferHeight: true,
71     initialized : false,
72     activated : false,
73     
74     onFocus : Roo.emptyFn,
75     iframePad:3,
76     hideMode:'offsets',
77     
78     defaultAutoCreate : { // modified by initCompnoent..
79         tag: "textarea",
80         style:"width:500px;height:300px;",
81         autocomplete: "off"
82     },
83
84     // private
85     initComponent : function(){
86         this.addEvents({
87             /**
88              * @event initialize
89              * Fires when the editor is fully initialized (including the iframe)
90              * @param {HtmlEditor} this
91              */
92             initialize: true,
93             /**
94              * @event activate
95              * Fires when the editor is first receives the focus. Any insertion must wait
96              * until after this event.
97              * @param {HtmlEditor} this
98              */
99             activate: true,
100              /**
101              * @event beforesync
102              * Fires before the textarea is updated with content from the editor iframe. Return false
103              * to cancel the sync.
104              * @param {HtmlEditor} this
105              * @param {String} html
106              */
107             beforesync: true,
108              /**
109              * @event beforepush
110              * Fires before the iframe editor is updated with content from the textarea. Return false
111              * to cancel the push.
112              * @param {HtmlEditor} this
113              * @param {String} html
114              */
115             beforepush: true,
116              /**
117              * @event sync
118              * Fires when the textarea is updated with content from the editor iframe.
119              * @param {HtmlEditor} this
120              * @param {String} html
121              */
122             sync: true,
123              /**
124              * @event push
125              * Fires when the iframe editor is updated with content from the textarea.
126              * @param {HtmlEditor} this
127              * @param {String} html
128              */
129             push: true,
130              /**
131              * @event editmodechange
132              * Fires when the editor switches edit modes
133              * @param {HtmlEditor} this
134              * @param {Boolean} sourceEdit True if source edit, false if standard editing.
135              */
136             editmodechange: true,
137             /**
138              * @event editorevent
139              * Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.
140              * @param {HtmlEditor} this
141              */
142             editorevent: true,
143             /**
144              * @event firstfocus
145              * Fires when on first focus - needed by toolbars..
146              * @param {HtmlEditor} this
147              */
148             firstfocus: true,
149             /**
150              * @event focus
151              * Fires when this field receives input focus.
152              * @param {HtmlEditor} this
153              */
154             focus : true
155         });
156         this.defaultAutoCreate =  {
157             tag: "textarea",
158             style:'width: ' + this.width + 'px;height: ' + this.height + 'px;',
159             autocomplete: "off"
160         };
161     },
162
163     /**
164      * Protected method that will not generally be called directly. It
165      * is called when the editor creates its toolbar. Override this method if you need to
166      * add custom toolbar buttons.
167      * @param {HtmlEditor} editor
168      */
169     createToolbar : function(editor){
170         Roo.log("create toolbars");
171         if (!editor.toolbars || !editor.toolbars.length) {
172             editor.toolbars = [ new Roo.form.HtmlEditor.ToolbarStandard() ]; // can be empty?
173         }
174         
175         for (var i =0 ; i < editor.toolbars.length;i++) {
176             editor.toolbars[i] = Roo.factory(
177                     typeof(editor.toolbars[i]) == 'string' ?
178                         { xtype: editor.toolbars[i]} : editor.toolbars[i],
179                 Roo.form.HtmlEditor);
180             editor.toolbars[i].init(editor);
181         }
182          
183         
184     },
185
186      
187     // private
188     onRender : function(ct, position)
189     {
190         var _t = this;
191         Roo.form.HtmlEditor.superclass.onRender.call(this, ct, position);
192         
193         this.wrap = this.el.wrap({
194             cls:'x-html-editor-wrap', cn:{cls:'x-html-editor-tb'}
195         });
196         
197         this.editorcore.onRender(ct, position);
198          
199         if (this.resizable) {
200             this.resizeEl = new Roo.Resizable(this.wrap, {
201                 pinned : true,
202                 wrap: true,
203                 dynamic : true,
204                 minHeight : this.height,
205                 height: this.height,
206                 handles : this.resizable,
207                 width: this.width,
208                 listeners : {
209                     resize : function(r, w, h) {
210                         _t.onResize(w,h); // -something
211                     }
212                 }
213             });
214             
215         }
216         this.createToolbar(this);
217        
218         
219         if(!this.width){
220             this.setSize(this.wrap.getSize());
221         }
222         if (this.resizeEl) {
223             this.resizeEl.resizeTo.defer(100, this.resizeEl,[ this.width,this.height ] );
224             // should trigger onReize..
225         }
226         
227 //        if(this.autosave){
228 //            this.autoSaveFn = setInterval(this.autosave, 1000);
229 //        }
230     },
231
232     // private
233     onResize : function(w, h)
234     {
235         //Roo.log('resize: ' +w + ',' + h );
236         Roo.form.HtmlEditor.superclass.onResize.apply(this, arguments);
237         var ew = false;
238         var eh = false;
239         
240         if(this.el ){
241             if(typeof w == 'number'){
242                 var aw = w - this.wrap.getFrameWidth('lr');
243                 this.el.setWidth(this.adjustWidth('textarea', aw));
244                 ew = aw;
245             }
246             if(typeof h == 'number'){
247                 var tbh = 0;
248                 for (var i =0; i < this.toolbars.length;i++) {
249                     // fixme - ask toolbars for heights?
250                     tbh += this.toolbars[i].tb.el.getHeight();
251                     if (this.toolbars[i].footer) {
252                         tbh += this.toolbars[i].footer.el.getHeight();
253                     }
254                 }
255                 
256                 
257                 
258                 
259                 var ah = h - this.wrap.getFrameWidth('tb') - tbh;// this.tb.el.getHeight();
260                 ah -= 5; // knock a few pixes off for look..
261                 this.el.setHeight(this.adjustWidth('textarea', ah));
262                 var eh = ah;
263             }
264         }
265         Roo.log('onResize:' + [w,h,ew,eh].join(',') );
266         this.editorcore.onResize(ew,eh);
267         
268     },
269
270     /**
271      * Toggles the editor between standard and source edit mode.
272      * @param {Boolean} sourceEdit (optional) True for source edit, false for standard
273      */
274     toggleSourceEdit : function(sourceEditMode)
275     {
276         this.editorcore.toggleSourceEdit(sourceEditMode);
277         
278         if(this.editorcore.sourceEditMode){
279             Roo.log('editor - showing textarea');
280             
281 //            Roo.log('in');
282 //            Roo.log(this.syncValue());
283             this.editorcore.syncValue();
284             this.el.removeClass('x-hidden');
285             this.el.dom.removeAttribute('tabIndex');
286             this.el.focus();
287         }else{
288             Roo.log('editor - hiding textarea');
289 //            Roo.log('out')
290 //            Roo.log(this.pushValue()); 
291             this.editorcore.pushValue();
292             
293             this.el.addClass('x-hidden');
294             this.el.dom.setAttribute('tabIndex', -1);
295             //this.deferFocus();
296         }
297          
298         this.setSize(this.wrap.getSize());
299         this.fireEvent('editmodechange', this, this.editorcore.sourceEditMode);
300     },
301  
302     // private (for BoxComponent)
303     adjustSize : Roo.BoxComponent.prototype.adjustSize,
304
305     // private (for BoxComponent)
306     getResizeEl : function(){
307         return this.wrap;
308     },
309
310     // private (for BoxComponent)
311     getPositionEl : function(){
312         return this.wrap;
313     },
314
315     // private
316     initEvents : function(){
317         this.originalValue = this.getValue();
318     },
319
320     /**
321      * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
322      * @method
323      */
324     markInvalid : Roo.emptyFn,
325     /**
326      * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
327      * @method
328      */
329     clearInvalid : Roo.emptyFn,
330
331     setValue : function(v){
332         Roo.form.HtmlEditor.superclass.setValue.call(this, v);
333         this.editorcore.pushValue();
334     },
335
336      
337     // private
338     deferFocus : function(){
339         this.focus.defer(10, this);
340     },
341
342     // doc'ed in Field
343     focus : function(){
344         this.editorcore.focus();
345         
346     },
347       
348
349     // private
350     onDestroy : function(){
351         
352         
353         
354         if(this.rendered){
355             
356             for (var i =0; i < this.toolbars.length;i++) {
357                 // fixme - ask toolbars for heights?
358                 this.toolbars[i].onDestroy();
359             }
360             
361             this.wrap.dom.innerHTML = '';
362             this.wrap.remove();
363         }
364     },
365
366     // private
367     onFirstFocus : function(){
368         //Roo.log("onFirstFocus");
369         this.editorcore.onFirstFocus();
370          for (var i =0; i < this.toolbars.length;i++) {
371             this.toolbars[i].onFirstFocus();
372         }
373         
374     },
375     
376     // private
377     syncValue : function()
378     {
379         this.editorcore.syncValue();
380     }
381      
382     
383     // hide stuff that is not compatible
384     /**
385      * @event blur
386      * @hide
387      */
388     /**
389      * @event change
390      * @hide
391      */
392     /**
393      * @event focus
394      * @hide
395      */
396     /**
397      * @event specialkey
398      * @hide
399      */
400     /**
401      * @cfg {String} fieldClass @hide
402      */
403     /**
404      * @cfg {String} focusClass @hide
405      */
406     /**
407      * @cfg {String} autoCreate @hide
408      */
409     /**
410      * @cfg {String} inputType @hide
411      */
412     /**
413      * @cfg {String} invalidClass @hide
414      */
415     /**
416      * @cfg {String} invalidText @hide
417      */
418     /**
419      * @cfg {String} msgFx @hide
420      */
421     /**
422      * @cfg {String} validateOnBlur @hide
423      */
424 });
425  
426