API Documentation Content Bugs

[dstarr@allofe.com]

Ext.view.AbstractView
*emptyText: Has the note that deferEmptyText needs to be set to true if the data is locally loaded for emptyText to be shown. This isn't the case.

[44gatti]

API DOCS for Component, xtype for ProgressBar is 'progressbar' not 'progress'
http://docs.sencha.com/ext-js/4-0/#/api/Ext.Component

the duration of frame effect is in millisecs, not in seconds
http://docs.sencha.com/ext-js/4-0/#/api/Ext.Element-method-frame

[Justin Noel]

Please see : http://www.sencha.com/forum/showthre...n-Architecture

[Justin Noel]

No JSON example of http://dev.sencha.com/deploy/ext-4.0.../xml-form.html

The XML example says:

For a similar example using JSON rather than XML, see the JSON Form example

Unfortunately, there is no such demo.

Since this is the ONLY form on the entire demo site that ACTUALLY submits a form, it sure would be nice to have a working JSON example.

[renku]

Sorry for so little feedback in this thread. Thanks to everybody for reporting, it's been a great help in making the docs better.

The bugs mentioned so far have mostly been fixed, remaining issues have been noted.

Things are getting better, but a lot of holes in the docs still remain, so keep these posts coming

[tomb@ibcos.co.uk]

On Ext.form.field.ComboBox the following are private and shouldn't be.... they are really useful methods.

    /**
     * Find the record by searching for a specific field/value combination
     * Returns an Ext.data.Record or false
     * @private
     */
    findRecord: function(field, value) {
        var ds = this.store,
            idx = ds.findExact(field, value);
        return idx !== -1 ? ds.getAt(idx) : false;
    },
    findRecordByValue: function(value) {
        return this.findRecord(this.valueField, value);
    },
    findRecordByDisplay: function(value) {
        return this.findRecord(this.displayField, value);
    },

I've also added an extra very useful method

Ext.override(Ext.form.field.ComboBox, {
	getSelectedRecord: function() {
		return this.findRecordByValue(this.getValue());
	}
});

[bodyboarder20]

Please include documentation re: the ability to use "named" arguments for Ext.Direct via the use of the "params" attribute for the method description in the API.

This can be done by fully documenting Ext.direct.RemoteMethod and exposing its documentation....

Also, paramsAsHash might also provide insight that it is necessary to specific your params explicitly in your API if you want the params to be sent as a hash properly.

For example, if you specify paramsAsHash as true, but DONT specify the params in your API, then what will get send to the server is a single element array containing the hash of values..... rather than just the hash.....

[halcwb]

As I understand every object in Javascript has a constructor property, that refers to the constructor function of that object. So if I just create the most simple object like:

var temp = {};
var temp2 = temp.constructor({name: 'temp2'});
console.log(temp2); 

So now I have a second object temp2 with a property name = 'temp2'. This is because the constructor function returns an new instance of temp, applying the config object. However, this code will not work:

var temp = {};
temp.constructor = function () { alert('I am not a constructor anymore')};
var temp2 = temp.constructor({name: 'temp2'});
console.log(temp2); 

Should not any override of constructor return the object? I refer to the documentation of Ext.Base:

Ext.define('My.own.A', {
    constructor: function(test) {
        alert(test);
    }
});

Ext.define('My.own.B', {
    extend: 'My.own.A',

    constructor: function(test) {
        alert(test);

        this.callParent([test + 1]);
    }
});

Ext.define('My.own.C', {
    extend: 'My.own.B',

    constructor: function() {
        alert("Going to call parent's overriden constructor...");

        this.callParent(arguments);
    }
});

var a = new My.own.A(1); // alerts '1'
var b = new My.own.B(1); // alerts '1', then alerts '2'
var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
                         // alerts '2', then alerts '3' 

[halcwb]

This example directly copy pasted from the api doc of the class system does not work:

Ext.define('My.own.Window', {
   /** @readonly */
    isWindow: true,

    config: {
        title: 'Title Here',

        bottomBar: {
            enabled: true,
            height: 50,
            resizable: false
        }
    },

    constructor: function(config) {
        this.initConfig(config);

        return this;
    },

    applyTitle: function(title) {
        if (!Ext.isString(title) || title.length === 0) {
            alert('Error: Title must be a valid non-empty string');
        }
        else {
            return title;
        }
    },

    applyBottomBar: function(bottomBar) {
        if (bottomBar && bottomBar.enabled) {
            if (!this.bottomBar) {
                return Ext.create('My.own.WindowBottomBar', bottomBar);
            }
            else {


                this.bottomBar.setConfig(bottomBar);
            }
        }
    }
});

var myWindow = Ext.create('My.own.Window', {
    title: 'Hello World',
    bottomBar: {
        height: 60
    }
}); 

I get a TypeError: c is not a constructor error.

[halcwb]

I cannot find the api documentation for Ext.form.FormPanel. Yet, if I check Ext in for example firebug, Ext.form.FormPanel does still exist.

Ha, found it Ext.form.FormPanel is an alias for Ext.form.Panel