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