Documentation Bugs - Ext 2.x

[mjlecomte]

[IMPLEMENTED]


Class Ext.Panel

floating should be indicated as Mixed instead of Boolean. You can also specify an object which will then be used as a config object for Ext.Layer.

floating : Boolean Mixed

True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered (defaults to false). Note that by default, setting floating to true will cause the panel to display at negative offsets so that it is hidden -- because the panel is absolute positioned, the position must be set explicitly after render (e.g., myPanel.setPosition(100,100). Also, when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the right edge of the viewport.

Perhaps:

floating : Boolean Mixed

True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered (defaults to false). Note that by default, Setting floating to true will create an Ext.Layer for this panel and display the panel at negative offsets so that it is hidden -- because the panel is absolute positioned, the position must be set explicitly after render (e.g., myPanel.setPosition(100,100). Also, when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the right edge of the viewport. This property may also be configured with an object to be used as the configuration object for the Ext.Layer (create link to Ext.Layer) that will be created.

[jmcneese]

[closed]

in reference to http://extjs.com/forum/showthread.php?t=59757:

in Ext.grid.GridPanel, the recent inclusion of the config property 'fieldLabel' states that when the grid is contained by a component using FormLayout, this property will instruct the container to render the grid as a form field, with the fieldLabel appearing to the side as other form fields are rendered.

there should be:

1. something in the text for this config property stating that it also requires the 'isFormField' configure option to be set to true
2. the config property 'isFormField' should be documented, as it is required to allow 'fieldLabel' to be used.

[Condor]

[closed]

in reference to http://extjs.com/forum/showthread.php?t=59757:

in Ext.grid.GridPanel, the recent inclusion of the config property 'fieldLabel' states that when the grid is contained by a component using FormLayout, this property will instruct the container to render the grid as a form field, with the fieldLabel appearing to the side as other form fields are rendered.

there should be:

1. something in the text for this config property stating that it also requires the 'isFormField' configure option to be set to true
2. the config property 'isFormField' should be documented, as it is required to allow 'fieldLabel' to be used.

It's much more complex than simply including isFormField:true! A BasicForm expects all kinds of methods to be present for a Component with isFormField:true.
So simply adding isFormField:true and a fieldLabel to a GridPanel will cause javascript errors in form processing.

ps. In Ext 3.0 simply adding a fieldLabel is enough, no need to set isFormField:true.

[jililv]

Hi All

I am new to ExtJS and I am not sure if the bug has been reported here or not. Below is what I find.

The current annotation for Ext.Container.doLayout( [Boolean shallow] ) in Ext 2.2 Api Documentation is shown below:

doLayout( [Boolean shallow] ) : void
Force this container's layout to be recalculated. A call to this function is required after adding a new component to an already rendered container, or possibly after changing sizing/position properties of child components.

Parameters:

shallow : Boolean
(optional) True to only calc the layout of this component, and let child components auto calc layouts as required (defaults to false, which calls doLayout recursively for each subcontainer)

Returns:
void

I think the annotation of the True & false vaule for the shallow parameter is reversed. It should be changed as follows:

shallow : Boolean
(optional) false to only calc the layout of this component, and let child components auto calc layouts as required (defaults to true, which calls doLayout recursively for each subcontainer)

Here is the source code in the class Ext.Container:

doLayout : function(shallow){
if(this.rendered && this.layout){
this.layout.layout();
}
if(shallow !== false && this.items){
var cs = this.items.items;
for(var i = 0, len = cs.length; i < len; i++) {
var c = cs;
if(c.doLayout){
c.doLayout();
}
}
}
},

You can see only when shallow == true makes the method start the recursion to subcontainers.

[i]And the word "shallow" also confuse me a little bit. I think using "deep" may be more appropriate if what I'd written above is correct.


Thanks!

[evant]

I think it's fine, the intent is clear and it's explained well.

[mjlecomte]

Please check if the config options indicated here
http://extjs.com/deploy/dev/docs/?cl...data.HttpProxy
are valid

Additional discussion here:
http://extjs.com/forum/showthread.ph...721#post287721

[tryanDLS]

You can see only when shallow == true makes the method start the recursion to subcontainers.

Yes, it's correct as written. You misunderstand the difference betweeen

shallow !== false

and

shallow == true

[jililv]

I think it's fine, the intent is clear and it's explained well.

Hi evant

Do you think the API's annotation need to be changed or not? Sorry my English is not very good and I can not tell from your reply if you agree with me or not.

Hi All

Let me explain my opinion in another way.

When I call doLayout(true) or doLayout() on my toplevel container, such as an Ext.Window, I find that it will recursively layout the subcontainers within that Ext.Window object. Contrarily, when I call doLayout(false) on my toplevel container, the subcontainers will not be refreshed. This is what I find through practice.

But when I first use the doLayout method, after reading the current annotation of this method in the Api Documentation makes me think that calling doLayout(false) on the toplevel container will recursively layout the subcontainers which I finally find is not correct through practice.

I am not sure if you guys have the same experience or not?

Thanks!

[mjlecomte]

Annotation of Ext.Container.doLayout()

I think the docs need touch up. I agree that the default does a recursive layout.

If shallow =

1. true.
   

   (true !== false) => true, therefore does recursive layout

2. false.
   

   (false !== false) => false, therefore layout only this container, no children

3. undefined (the default).
   

   (undefined !== false) => true, therefore does recursive layout

Suggested revision:

(optional) Specify false to only calc the layout of this component, and let child components auto calc layouts as required.  The default is true, which calls doLayout recursively for each subcontainer item.

Not a doc change, but I'd also agree that "shallow" is contradictory to the behavior.

[mjlecomte]

[implemented]

The argument type is not declared in Ext.Panel for toolTemplate.

This crashes oxymoron's js doc tool, so may well do the same to ExtJS's version.

    /**
     * @cfg toolTemplate
     * @type {Ext.Template/Ext.XTemplate}

Specifying the type fixes it:

    /**
     * @cfg {Object} toolTemplate
     * @type {Ext.Template/Ext.XTemplate}