Documentation Bugs - Ext 2.x

[dhurlburtusa]

Documentation for methods in Ext.ComponentMgr are missing.

registerType(xtype, cls) and create(config, defaultType).

The shorthand for Ext.ComponentMgr.registerType = Ext.reg is not documented.

Maybe these are intended to be private methods and shorthands although registerType seems essential to adding new components and user extensions.

[treffer]

Same applies to the local Ext 2.0a1 installation. Clicking a link targeting Ext source code leads to a four-oh-four, since the folder "src" only exists in SVN, not in the build.

Ok, but we have a source/ folder, right? I used the following script (fixdoc.sh)

#!/bin/bash
filename=`grep 'Defined In:.*<a.*href="\.\./src/' "${1}"|sed 's:.*href="\.\./src/\([^"]*\).*:\1:'`
form=`echo ${1}|grep '\.form\.'|sed 's:.*form.*:form:'`
if [ "x${filename}" == "x" ]; then
        echo "${1} No reference to ../src"
        exit
fi
echo "${1} Fix reference to ${filename}"
file=`find source -regex ".*${form}.*/${filename}"|grep -v 'source/legacy'|head -n1`
if [ "x${file}" == "x" ]; then
        file=`find source -regex ".*${form}.*/${filename}"|head -n1`
fi
if [ "x${file}" == "x" ]; then
        echo "${1} No valid fix found"
else
        echo "${1} substitution with ${file}, running sed"
        sed -i "s:href=\"\.\./src/${filename}\":href=\"../${file}\":" ${1}
        echo "${1} fixed"
fi

And ran it with

find docs/output/ -type f -exec ./fixdoc.sh '{}' ';'

and it seems to work. It substitutes all ../src/ references with the equvilant in ../source. No need for the "src" folder. Worked with my local apache server. The code should work on the extjs redhat/apache server, too...

BTW: The local doc's don't work without a webserver, at least for me. I've tried FF-2.0.0.7 and Opera 9.23.

[mystix]

BTW: The local doc's don't work without a webserver, at least for me. I've tried FF-2.0.0.7 and Opera 9.23.

pls refer to http://www.sencha.com/forum/showthread.php?p=68401 (and its related post) above.

[steve.neill]

In Panel docs...

autoLoad : Object/String/Function
A valid url spec according to the Updater Ext.Updater.update method. If autoLoad is not null, the panel will attempt to laod its contents immediately upon render.

[christocracy]

The docs say:

header : Boolean
True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if...
True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if a title is set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the header will not be rendered.

* closable overrides header: false.
* to hide header, one must set closable to false.

[PFM]

When clicking to view the source of any *.js file (Defined In link), I am always taken to the extJs home page instead of the JS source code.

[aparajita]

FireFox 2.0.0.7
Mac OS X 10.4

Link: http://extjs.com/deploy/ext-2.0-alph...ber=addBinding

Clicking on the row expander for Ext.KeyMap.addBinding causes all of the row expanders in the methods section to disappear.

[mystix]

2.0 alpha 1 docs - http://extjs.com/deploy/ext-2.0-alph...s=Ext.TabPanel
TabPanel does not list its own members.
ie click on the "hide inherited members" and the only one that shows up is the constructor.

added to the list under Class Ext.TabPanel.

In form.Action.load:

Huh?

Maybe:

"A response packet must contain a boolean success property, and if successful also a non-null data property used to fill fields via the Ext.form.Field.setValue method."

already updated in SVN. not added to the list.

Hi,

The PropertyGrid has no documentation - although you may not have got to it yet if you are still working on docs.

Thanks,

Dan

already updated in SVN. not added to the list.

Though you guys probably know, the /tips directory is missing from the documentation.

added to the list under Ext.Tip/ToolTip/QuickTip/QuickTips.

In extjs2.0 the grid autoSizeColumns property has been removed.

An explanation in the introduction of the grid, about using the view for this (instead) would be in place I think.

An example:
this.grid = new Ext.grid.EditorGridPanel({
ds: this.ds,
cm: this.cm,
view: new Ext.grid.GridView({
forceFit: true,
autoFill: true
}),
.....

not added to the list. this and other similar issues should be covered in the planned Ext 1.1.1-to-2.0 migration guide which is slated for release soon.

Besides autoSizeColumns is still mentioned in: http://extjs.com/deploy/ext-2.0-alph...dPanel-configs

at maxRowsToMeasure : Boolean
If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of rows measured to get a columns size - defaults to 0 (all rows).

added to the list under Class Ext.grid.GridPanel.

The documentation about the PagingToolbar misses the config option store, which is pretty important... And the text below the config option displayMsg is incorrect.

added to the list under Class Ext.PagingToolbar.

CollapseMode isn't mentioned in the docs, with its possible values, like: mini.

i've searched the source, and collapseMode isn't referred to throughout the whole of Ext.Panel.
it's a config option used by both Ext.layout.BorderLayout.Region and Ext.layout.BorderLayout.SplitRegion, and has already been documented in both classes.
this bug report will thus not be added to the list.

The 2.0 TreePanel appears to use the 'el' option which doesn't exist in the documentation.

the 'el' option / attribute holds the TreePanel's underlying container Element, and is, i believe, meant to be private.
this explains the existence of a public getEl() method allowing you to get at the underlying 'el' option / attribute.
this bug report will thus not be added to the list.

Also, what is the difference between 'applyTo' and 'renderTo' and how are they different from the 'el' option? I tried both of these and received errors.

added to the list under Class Ext.tree.TreePanel.

Additional Tree-related issues: (these are from an Ext newbie trying to learn this stuff)
1. There's no description at all for the TreeNode and AsyncTreeNode (same in version 1.x docs). Describe the use and difference between the two. Please don't leave it to the user to figure it out for themselves.
2. The description of AsynchTreeLoader.loader says that it 'defaults to the loader defined on the tree'. How do you define a loader for the tree? There's no options, properties, or methods of a Tree to do that.
3. If you can create a checkbox for a tree node, how can you assign a value to that checkbox?

added to the list under the Misc/Request section.

The docs about the TabPanel contain no info about the method setActiveTab()

added to the list under Class Ext.TabPanel.

TabPanel documentation:

- autoLoad: "If autoLoad is not null, the panel will attempt to laod its contents immediately upon render."

- keys: "A KeyMap config object (in the format expected by in the format expected by {@link Ext.KeyMap#addBinding) used to assign custom key handling..."

- shadow: "[...] Note that this option opnly applies when floating = true."

Cheers,
JC

these typos originate from Ext.Panel, the superclass of Ext.TabPanel.
i've added them to the list under Class Ext.Panel.

"collapsed" property documentation appears to be missing.

sorry... border layout panels.

the config collapsed belongs to the Ext.Panels being added to the Ext.layout.BorderLayout, and this is already documented.
there is no accessible 'collapsed' property for Ext.layout.BorderLayout.
not added to the list.

The online version of ext2.0a1 does not have a src/ folder. All links to the source code are redirected to the front page.

Reproduce:
open FormLayout and clicking on FormLayout.js

Here is the exact server response:

treffer@rtlaptop:~$ nc extjs.com 80
GET /deploy/ext-2.0-alpha1/src/FormLayout.js HTTP/1.0
Host: extjs.com

HTTP/1.0 404 Not Found

Normal pages (e.g. /deploy/ext-2.0-alpha1/docs) result in "HTTP/1.0 200 OK"

added to the top of the list.

Same applies to the local Ext 2.0a1 installation. Clicking a link targeting Ext source code leads to a four-oh-four, since the folder "src" only exists in SVN, not in the build.

identical to the issue mentioned in @treffer's post above. already added to the top of list.

Ext.util.Observable.addListener
Link: http://extjs.com/deploy/ext-2.0-alph...er=addListener

The description of the delay parameter of the options object has a typo:

At the end an "h" is missing in the word "te".

added to the list under Class Ext.util.Observable.

Documentation for methods in Ext.ComponentMgr are missing.

registerType(xtype, cls) and create(config, defaultType).

The shorthand for Ext.ComponentMgr.registerType = Ext.reg is not documented.

Maybe these are intended to be private methods and shorthands although registerType seems essential to adding new components and user extensions.

added to the list under the Misc/Requests section.

In Panel docs...

autoLoad : Object/String/Function
A valid url spec according to the Updater Ext.Updater.update method. If autoLoad is not null, the panel will attempt to laod its contents immediately upon render.

identical to the issue mentioned in @J.C's earlier post. already added to the list under Class Ext.Panel.

When clicking to view the source of any *.js file (Defined In link), I am always taken to the extJs home page instead of the JS source code.

identical to the issue mentioned in @treffer's & @willydee's posts above. already added to the top of the list.

[mystix]

FireFox 2.0.0.7
Mac OS X 10.4

Link: http://extjs.com/deploy/ext-2.0-alph...ber=addBinding

Clicking on the row expander for Ext.KeyMap.addBinding causes all of the row expanders in the methods section to disappear.

could you post a screencast displaying this problem (see this thread for some suggested software)?
or get another OSX+FF2.0.07 user to confirm this?

[aparajita]

Before and after screenshots are attached along with the Layout of the td in FireBug. I can confirm the same problem with Safari, although the expander cells do not collapse completely.

BTW, the same problem happens with Ext.form.BasicForm.addBinding.