Documentation Bugs - Ext 2.x

[Eric24]

[IMPLEMENTED]


Config option "closable" is missing from Panel.

[jove4015]

[IMPLEMENTED]


I just wanted to say, I finally stumbled across a hint about a "triggerConfig" option for TriggerField and it's a *wonderful* thing, it should definitely be added to the documentation!!

[carol.ext]

[IMPLEMENTED]


The documentation indicates the default value for the BasicForm.getValues() parameter "asString" is true (returns as string) :

@param {Boolean} asString (optional) false to return the values as an object (defaults to returning as a string)

In the code an object is returned unless asString is passed in === true:

    
getValues: function(asString) {
    var fs = Ext.lib.Ajax.serializeForm(this.el.dom);
    if (asString === true) {
        return fs;
    }
    return Ext.urlDecode(fs);
}

code and @param taken from my 2.2.1 download.

[Animal]

[IMPLEMENTED]

The documentation indicates the default value for the BasicForm.getValues() parameter "asString" is true (returns as string) :

@param {Boolean} asString (optional) false to return the values as an object (defaults to returning as a string)

In the code an object is returned unless asString is passed in === true:

    
getValues: function(asString) {
    var fs = Ext.lib.Ajax.serializeForm(this.el.dom);
    if (asString === true) {
        return fs;
    }
    return Ext.urlDecode(fs);
}

code and @param taken from my 2.2.1 download.

Ext.lib.Ajax.serializeForm returns a string.

Ext.urlDecode decodes the strig into an object.

[Animal]

[IMPLEMENTED]

I just wanted to say, I finally stumbled across a hint about a "triggerConfig" option for TriggerField and it's a *wonderful* thing, it should definitely be added to the documentation!!

Well spotted. I'll write that one up.

[carol.ext]

[IMPLEMENTED]

Ext.lib.Ajax.serializeForm returns a string.

Ext.urlDecode decodes the strig into an object.

My response is "exactly". I am seriously trying to figure out how I am reading this wrong:

@param {Boolean} asString (optional) false to return the values as an object (defaults to returning as a string)

Using the Checkbox / Radio Group example I set a breakpoint in the Save button's handler. Then in the console call fp.getForm().getValues(). If I do not pass in a value for asString it returns an object, see attached screen shot from firebug. Is that not what is meant by default?

basicForm.png

[mjlecomte]

[IMPLEMENTED]

Config option "closable" is missing from Panel.

I don't see where this config option is honored.

[watrboy00]

[IMPLEMENTED]

I don't see where this config option is honored.

In TabPanel.js...

initTab checks the closable config option which adds 'x-tab-strip-closable' to the tab's dom helper config.

initTab : function(item, index){
    var before = this.strip.dom.childNodes[index];
    var cls = item.closable ? 'x-tab-strip-closable' : '';
    if(item.disabled){
        cls += ' x-item-disabled';
    }
    if(item.iconCls){
        cls += ' x-tab-with-icon';
    }
    if(item.tabCls){
        cls += ' ' + item.tabCls;
    }

    var p = {
        id: this.id + this.idDelimiter + item.getItemId(),
        text: item.title,
        cls: cls,
        iconCls: item.iconCls || ''
    };
    var el = before ?
             this.itemTpl.insertBefore(before, p) :
             this.itemTpl.append(this.strip, p);

    Ext.fly(el).addClassOnOver('x-tab-strip-over');

    if(item.tabTip){
        Ext.fly(el).child('span.x-tab-strip-text', true).qtip = item.tabTip;
    }
    item.tabEl = el;

    item.on('disable', this.onItemDisabled, this);
    item.on('enable', this.onItemEnabled, this);
    item.on('titlechange', this.onItemTitleChanged, this);
    item.on('iconchange', this.onItemIconChanged, this);
    item.on('beforeshow', this.onBeforeShowItem, this);
}

In findTargets it then checks the presence of 'x-tab-strip-close' to determine if the tab is closable.

findTargets : function(e){
    var item = null;
    var itemEl = e.getTarget('li', this.strip);
    if(itemEl){
        item = this.getComponent(itemEl.id.split(this.idDelimiter)[1]);
        if(item.disabled){
            return {
                close : null,
                item : null,
                el : null
            };
        }
    }
    return {
        close : e.getTarget('.x-tab-strip-close', this.strip),
        item : item,
        el : itemEl
    };
}

IMO that closable should be a config of TabPanel's items but not of the TabPanel itself.

[mjlecomte]

[IMPLEMENTED]


Ok, adding this to Ext.Panel docs:

    /**
     * @cfg {Boolean} closable
     * Panels themselves do not directly support being closed, but some Panel
     * subclasses do (like {@link Ext.Window}) or a Panel Class within a Ext.TabPanel.
     * Specify <tt>true</tt> to enable closing in such situations. Defaults to <tt>false</tt>
     */

[watrboy00]

[no change made]


http://extjs.com/deploy/dev/docs/?class=Ext.Template

overwrite( Mixed el, Object/Array values, [Boolean returnElement] ) : HTMLElement/Ext.Element
Applies the supplied values to the template and overwrites the content of el with the new node(s).
Parameters:

    * el : Mixed
      The context element
    * values : Object/Array
      The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
    * returnElement : Boolean
      (optional) true to return a Ext.Element (defaults to undefined)

Returns:

    * HTMLElement/Ext.Element
      The new node or Element

Shouldn't that be '[0]'?