dojox/editor/plugins/StatusBar.js

• Provides:

  • dojox.editor.plugins.StatusBar

• dojox.editor.plugins._StatusBar

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • mixins:
    • dijit._Templated.prototype: (prototype)
  • summary

• dojox.editor.plugins._StatusBar.templateString

  • type

    String

  • summary

    Template for the widget.  Currently using table to get the alignment behavior and
    bordering I wanted.  Would prefer not to use table, though.

• dojox.editor.plugins._StatusBar._getValueAttr

  • type

    Function

  • source: [view]
      return this.barContent.innerHTML;
  • summary

    Over-ride to get the value of the status bar from the widget.

  • tags:

• dojox.editor.plugins._StatusBar._setValueAttr

  • type

    Function

  • parameters:
    • str: (typeof String)

      The string to set as the status bar content.

  • source: [view]
      if(str){
       str = dojo.trim(str);
       if(!str){
        str = " ";
       }
      }else{
       str = " ";
      }
      this.barContent.innerHTML = str;
  • summary

    Over-ride to set the value of the status bar from the widget.
    If no value is set, it is replaced with a non-blocking space.

  • tags:

• dojox.editor.plugins._StatusBar.barContent.innerHTML

  • summary

• dojox.editor.plugins.StatusBar

  • type

    Function

  • chains:
    • dijit._editor._Plugin: (prototype)
    • dijit._editor._Plugin: (call)
  • summary

    This plugin provides StatusBar cabability to the editor.
    Basically a footer bar where status can be published.  It also
    puts a resize handle on the status bar, allowing you to resize the
    editor via mouse.

• dojox.editor.plugins.StatusBar.statusBar

  • tags: protected
  • type

    The

  • summary

    status bar and resizer.

• dojox.editor.plugins.StatusBar.resizer

  • tags: public
  • type

    Boolean

  • summary

    Flag indicating that a resizer should be shown or not.  Default is true.
    There are cases (such as using center pane border container to autoresize the editor
    That a resizer is not valued.

• dojox.editor.plugins.StatusBar.setEditor

  • type

    Function

  • parameters:
    • editor: (typeof Object)

      The editor to configure for this plugin to use.

  • source: [view]
      this.editor = editor;
      this.statusBar = new dojox.editor.plugins._StatusBar();
      if(this.resizer){
       this.resizeHandle = new dojox.layout.ResizeHandle({targetId: this.editor, activeResize: true}, this.statusBar.handle);
       this.resizeHandle.startup();
      }else{
       dojo.style(this.statusBar.handle.parentNode, "display", "none");
      }
      var pos = null;
      if(editor.footer.lastChild){
       pos = "after";
      }
      dojo.place(this.statusBar.domNode, editor.footer.lastChild || editor.footer, pos);
      this.statusBar.startup();
      this.editor.statusBar = this;
    
    
      // Register a pub-sub event to listen for status bar messages, in addition to being available off
      // the editor as a property 'statusBar'
      this._msgListener = dojo.subscribe(this.editor.id + "_statusBar", dojo.hitch(this, this._setValueAttr));
  • summary

    Over-ride for the setting of the editor.

• dojox.editor.plugins.StatusBar._getValueAttr

  • type

    Function

  • source: [view]
      return this.statusBar.get("value");
  • summary

    Over-ride to get the value of the status bar from the widget.

  • tags:

• dojox.editor.plugins.StatusBar._setValueAttr

  • type

    Function

  • parameters:
    • str: (typeof String)

      The String value to set in the bar.

  • source: [view]
      this.statusBar.set("value", str);
  • summary

    Over-ride to set the value of the status bar from the widget.
    If no value is set, it is replaced with a non-blocking space.

  • tags:

• dojox.editor.plugins.StatusBar.set

  • type

    Function

  • parameters:
    • attr: (typeof The)

      attribute to set.

    • val: (typeof The)

      value to set it to.

  • source: [view]
      if(attr){
       var fName = "_set" + attr.charAt(0).toUpperCase() + attr.substring(1, attr.length) + "Attr";
       if(dojo.isFunction(this[fName])){
        this[fName](val);
       }else{
        this[attr] = val;
       }
      }
  • summary

    Quick and dirty implementation of 'set' pattern

• dojox.editor.plugins.StatusBar.get

  • type

    Function

  • parameters:
    • attr: (typeof The)

      attribute to get.

  • source: [view]
      if(attr){
       var fName = "_get" + attr.charAt(0).toUpperCase() + attr.substring(1, attr.length) + "Attr";
       var f = this[fName];
       if(dojo.isFunction(f)){
        return this[fName]();
       }else{
        return this[attr];
       }
      }
      return null;
  • summary

    Quick and dirty implementation of 'get' pattern

• dojox.editor.plugins.StatusBar.destroy

  • type

    Function

  • source: [view]
      if(this.statusBar){
       this.statusBar.destroy();
       delete this.statusBar;
      }
      if(this.resizeHandle){
       this.resizeHandle.destroy();
       delete this.resizeHandle;
      }
      if(this._msgListener){
       dojo.unsubscribe(this._msgListener);
       delete this._msgListener;
      }
      delete this.editor.statusBar;
  • summary

    Over-ride to clean up the breadcrumb toolbar.

• dojox.editor.plugins.StatusBar.editor

  • summary

• dojox.editor.plugins.StatusBar.resizeHandle

  • summary

• dojox.editor.plugins.StatusBar.editor.statusBar

  • summary

• dojox.editor.plugins.StatusBar._msgListener

  • summary

• dojox.editor.plugins.StatusBar.setEditor.editor

  • type

    Object

  • summary

    The editor to configure for this plugin to use.

• name

  • summary

• resizer

  • summary

• o.plugin

  • summary

• dojox.editor.plugins

  • type

    Object

  • summary

• dojox.editor

  • type

    Object

  • summary

• dojox

  • type

    Object

  • summary