Missing and/or Incorrect Docs - Ext 1.1.x

[mystix]

This thread is solely for reporting bugs in the Ext 1.1.x documentation. (currently available here (extjs.com/deploy/ext/docs/index.html))

I'll be consolidating all the unresolved reports from the old 1.0 - 1.1RC1+ threads into this thread.
I'll officially say so (in here) when i've completed this task. in the meantime, be sure to search in the old doc bugs threads for issues before making a report here.

p.s. stupid me accidentally went and deleted the original 1.1 doc bugs thread instead of a post.
thankfully there was only 1 bug reported, and i've reposted that below.

[edit]
I've completed consolidating all unresolved doc issues from Ext 1.0 - 1.1RC1 into a single list, available below.
I've also checked all of them against the current Ext 1.1 docs to ensure they're still unresolved.
Where possible, i've included a [link] pointing to the original post / a place in the docs where the problem is evident.

Some things to note

post only documentation bugs
always CTRL+F BEFORE posting
i will regularly update the list below to reflect all verified doc issues reported in this thread
you might also want to take a look at this thread before posting


Ext Documentation Team members:
please mark any resolved issues in the list below with a strikethrough using the tags. thanks.

[edit]
as the list has grown really long, all classes with unresolved issues will be marked in red.

[mystix]

All Classes

main constructor in "Public Methods" section is not hyperlinked to
corresponding description in "Method Details" section - This will no longer be an issue in the 2.0 doc center and will not be fixed for 1.x


Class Ext

Old reference to Yahoo in description for method namespace [link]
"Creates namespaces but does not assume YAHOO is the root."
missing docs for method destroy
missing docs for method num


Class Ext.BorderLayout

missing method create [link]
missing all properties except monitorWindowResize [link] - Skipped - This must be referring to a different object because BorderLayout is fully doc'd
missing config factory


Class Ext.Component

invalid reference to "Ext.Container" in description for method destroy [link (http://extjs.com/deploy/ext/docs/output/Ext.Component.html#destroy)]
(all subclasses of Ext.Component are also affected)


Class Ext.data.DataReader

missing docs [link] - This is a base class that is not intended to be used directly, so private comments were added to that effect.


Class Ext.data.Record

config dateFormat for method create shows "{@link Date#Date.parseDate}" [link (http://extjs.com/deploy/ext/docs/output/Ext.data.Record.html#create)] - (removed link)
incorrect return type for method create [link]
-- should be Ext.data.Record, not void
missing square brackets in example for method create [link]
-- should be


var TopicRecord = Ext.data.Record.create([
{name: 'title', mapping: 'topic_title'},
{name: 'author', mapping: 'username'},
{name: 'totalPosts', mapping: 'topic_replies', type: 'int'},
{name: 'lastPost', mapping: 'post_time', type: 'date'},
{name: 'lastPoster', mapping: 'user2'},
{name: 'excerpt', mapping: 'post_text'}
]);



Class Ext.data.Store

incorrect description for method getModifiedRecords.
"...when you load a data store, its modified records do NOT get cleared" [link]
incorrect punctuation for description of event metachange [link]
missing method startAutoRefresh [link] - Skipped - This is not a method of Store. The OP was referring to Animal's Store override which I think he mistakenly thought had been added to Ext (?)
incorrect description for event remove [link]
-- should say "Fires when a Record has been removed from the Store"
incorrect description for event update [link]
-- should say "Fires when a Record has been updated"
incorrect description [link (http://extjs.com/deploy/ext/docs/output/Ext.data.Store.html#event-metachange)]
-- "This is currently only support for JsonReaders." should be "This is currently only supported for JsonReaders."


Class Ext.data.Tree

missing method proxyNodeEvent - (marked private)
missing method registerNode - (marked private)
missing method unregisterNode - (marked private)
missing method toString - (marked private)
missing config pathSeparator [link]


Class Ext.data.XmlReader

invalid sample xml "<occupation>Gardener</name>" [link]


Class Ext.DatePicker

missing config value [link] - Skipped - This is not a config -- it's a private variable that can only be set/retrieved via its accessor methods


Class Ext.dd.DragDrop

incorrect return type of String for property groups [link]
-- should be an Object of type {groupName1 : true, groupName2 : true}
incorrect return type of void for method padding [link]
-- should be an Object with array values 0, 1, 2 or 3 denoting the padding
missing configs (as with all subclasses of Ext.dd.DragDrop)


Class Ext.DialogManager

should be marked as a singleton [link]


Class Ext.DomHelper

method createTemplate [link (http://extjs.com/deploy/ext/docs/output/Ext.DomHelper.html#createTemplate)]
-- incorrect description:- should be "Creates a new Ext.Template from the DOM object spec"
-- incorrect return type:- should be Ext.Template


Class Ext.Editor

invalid constructor argument "@link Ext.form.Field}" [link (http://extjs.com/deploy/ext/docs/output/Ext.Editor.html)]


Class Ext.Element

invalid return type /HTMLElementElement for method wrap[link]
missing method uncache [link] - (Marked private)
missing method garbageCollect [link] - (Marked private)
method setLeftTop missing arguments [link]
method translatePoints -- param An should be the return object instead [link]
incorrect description for method boxWrap [link]
-- currently says "class: A base CSS class to apply to the containing wrapper element (defaults to 'x-box')"
-- should be "class: A class name for the containing wrapper element, and a class name prefix for it's related child elements. (defaults to 'x-box')"
-- docs should also give an example usage as outlined in this post.


Class Ext.EventManager

missing function fireResize [link] - (Marked private)
missing property textResizeInterval [link]


Class Ext.form.Action

missing docs [link]


Class Ext.form.BasicForm

missing config options for method load [link]
missing property el [link] - el is private. Public method getEl() was added for this purpose
method doAction
-- options object missing config success [link]


Class Ext.form.Checkbox

incorrect description for config autoCreate's default value. [link (http://extjs.com/deploy/ext/docs/output/Ext.form.Checkbox.html#config-autoCreate)]
should be "(defaults to {tag: "input", type: 'checkbox', autocomplete: "off"})".


Class Ext.form.ComboBox

missing config store
missing config title
missing config tpl [link] - Skipped - This is not really a config. It's more like a protected property that can be overridden by subclasses.
incorrect state name abbreviations in states.js - (also changed Tennessee TE -> TN :) )


Connecticut, has CN, should be CT
Hawaii, has HW, should be HI
Maine, has MA, should be ME
Massachusetts, has MS, should be MA
Rhode Island, has RH, should be RI
Vermont, has VE, should be VT

There could be others, but I think that's it. You can cross check here: http://www.usps.com/ncsc/lookups/usp...eviations.html

incorrect signature for event beforequery [link]
-- currently "beforequery : ( Ext.form.ComboBox combo, String query, Boolean forceAll, Boolean cancel, Object e )", should be "beforequery : ( Ext.form.ComboBox combo, Object qe )"
-- currently "Fires before all queries are processed. Return false to cancel the query or set cancel to true. The event object passed has these properties:...", should be "Fires before all queries are processed. Return false to cancel the query or set cancel to true. The query event object passed has these properties:...".
also note that the actual qe object only has four attributes, namely

combo
query
forceAll
cancel

while the docs list 5, with e:Object - The query event object being the addition erroneous attribute.
config minChars - "The docs say that it defaults to 4. In the code if mode is local and minChars is undefined it gets set to 0. Hence, docs need modifying to take this into account." [link]


Class Ext.form.DateField

method formatDate should be marked public & doc'ed? [link] - Skipped - The post by Jack that was referred to mentions these methods in the context of being able to override them if necessary to implement custom parsing. In that sense, they could be considered protected, but they are definitely not public (should never be called directly from external code).
method parseDate should be marked public & doc'ed? [link] - Skipped - Ditto.


Class Ext.form.Field

missing config fieldLabel [link]


Class Ext.form.Form

missing property el [link] - Added getEl() method instead


Class Ext.form.HtmlEditor

"it's not written in doc that there is a limit of one editor per page" [link] - (added note to header)
missing config autoCreate - Skipped - This is explicitly hidden at the bottom of the class as an unsupported property


Class Ext.form.Layout

missing config labelStyle [link]


Class Ext.form.TextArea

incorrect description for config autoCreate's default value. [link (http://extjs.com/deploy/ext/docs/output/Ext.form.TextArea.html#config-autoCreate)]
should be "(defaults to {tag: "textarea", style:"width:300px;height:60px;", autocomplete: "off"})".


Class Ext.form.TextField

missing config vtypeText (all subclasses of TextField also suffer from the same problem) [link]
incorrect type for config maskRe [link]
-- should be RegExp, not String


Class Ext.form.TriggerField

incorrect description for config autoCreate's default value. [link (http://extjs.com/deploy/ext/docs/output/Ext.form.TriggerField.html#config-autoCreate)]
should be "(defaults to {tag: "input", type: "text", size: "16", autocomplete: "off"})".
the following incompatible configs are marked as hidden,
but still appear in the docs (also affects all subclasses of TriggerField): [link] - Doc parse issue, should be fixed for 2.0 beta 1

grow
growMax
growMin



Class Ext.form.TwinTriggerField

missing docs - Skipped - This is an abstract base class that can be extended, not a public component to be used directly. Comments have been added to that effect, but this class will not show up in the API docs.


Class Ext.grid.CellSelectionModel

incorrect event beforerowselect [link]
-- should be beforecellselect


Class Ext.grid.ColumnModel

missing config fixed [link]
incorrect description for config sortable [link]
-- "Defaults to true." should instead read "Defaults to the value of the defaultSortable property."
missing config css [link]
(and possibly missing configs attr, cellId, id and value too) - See note below...
method setRenderer > parameter fn > cell metadata description
-- missing the following parameters (refer to /ext/src/widgets/grid/GridView.js lines 834-837) [link (http://extjs.com/deploy/ext/docs/output/Ext.grid.ColumnModel.html#setRenderer)]

cellId
id
value

-- description for parameter css is incorrect:- [link]
"I assumed it meant a style like 'width:195px', but the code in GridView adds the CSS to the cell's class list, not the style." - See note below...
event columnlockchange is missing the "n". [link]
event headerchange - param newText should be a String, not a Number. [link]
missing method isLocked [link] - Added in 1.1, but not 2.0 since it is no longer supported


Notes regarding CM configs: The css column property is supported (and I added it), but probably NOT for the reason you think. The GridView class is fairly complex, and you cannot simply look at everything in the cell template enclosed by a {} and assume that it's a valid config placeholder. E.g., even though there is a {css} in the template, it is in the class="" part of the template, so it is a class name, not a style config (as noted above in the setRenderer function, which I have updated). You have to dig into the actual rendering code to find the line that applies a .css property from the column object directly onto the style attribute of the cell -- the template has nothing to do with it and the css template token is only overwritten by the cell renderer. Likewise, attr is not a valid column config value, but it IS a valid parameter to setRenderer (as already noted). Column id is a supported config option, and is already on the CM config list -- it is not a valid param to setRenderer however. cellId and value, while in the template, are only set internally by GridView code and are not valid config options.

Class Ext.grid.EditorGrid

missing config clicksToEdit [link]
missing config autoWidth [link] - (Not actually added, as it will be inherited from Grid)


Class Ext.grid.Grid

missing config autoWidth [link]
missing config enableCtxMenu [link]
missing config enableColLock [link]
missing config enableColumnResize [link]
missing config sm or selModel (or both) [link]
missing config ds or dataSource (or both) [link]
missing config cm or colModel (or both) [link]
incorrect return type for method getDataSource [link]
-- should be Store, not DataSource
ambiguous parameter name for 2nd argument of method reconfigure [link]
-- should be colModel, not The


Class Ext.grid.GridView

missing configs like:

rowClass
cellClass
tdClass
hdClass

etc (found in source but not in docs)
missing method getRow [link]
(and possibly a whole host of other methods, all found in source but not in docs) - Most are private


Class Ext.grid.PropertyColumnModel
Class Ext.grid.PropertyGrid
Class Ext.grid.PropertyRecord
Class Ext.grid.PropertyStore

missing docs [link]


Class Ext.grid.RowSelectionModel

invalid type "@link Ext.data.Record" for parameter r [link (http://extjs.com/deploy/ext/docs/output/Ext.grid.RowSelectionModel.html#event-rowselect)]


Class Ext.JsonView

missing config docs [link (http://extjs.com/deploy/ext/docs/output/Ext.JsonView.html)]


Class Ext.KeyNav

missing config docs [link]


Class Ext.LayoutManager

missing config allowScroll


Class Ext.LayoutRegion

incorrect default value for config collapsible -- should be false, not true. [link]


Class Ext.menu.Adapter

incorrect constructor signature [link]
-- should be Adapter(Ext.Component component, Object config)


Class Ext.menu.BaseItem

missing config showDelay [link] - (actually added in Item not BaseItem)


Class Ext.menu.CheckItem

missing config checkHandler [link]


Class Ext.menu.Item

missing property text [link] - Also added iconCls, href and hrefTarget


Class Ext.menu.Menu

missing property items [link]


Class Ext.menu.MenuMgr

incorrect return type [link]
-- should return Ext.menu.Menu


Class Ext.MessageBox

method show missing the following config options:

width (as seen in the example)
minWidth [link]
maxWidth [link]
minProgressWidth [link] - Skipped - This is not a general config option, only a property that is used as the minWidth within progress() and wait(). Passing it into show() directly would have no effect (minWidth should always be used).
defaultTextHeight [link]
animEl [link]
fn [link]



Class Ext.PagingToolbar

missing config displayInfo [link]


Class Ext.QuickTips

missing config target for method register [link]
incorrect reference to config option "True" [link]
- should be autoDismiss
- source code comment should be "@cfg {Boolean} autoDismiss"
missing config autoDismissDelay [link]
- source code comment should be "@cfg {Number} autoDismissDelay"


Class Ext.Shadow

incorrectly formatted config mode [link]


Class Ext.state.CookieProvider

error in example [link]


var cp = new Ext.state.CookieProvider({
path: "/cgi-bin/",
expires: new Date(new Date().getTime()+(1000*60*60*24*30)); // should be a comma, not a semicolon
domain: "extjs.com"
}) // missing semicolon



Class Ext.SplitLayoutRegion

missing config splitTip
missing config collapsibleSplitTip
missing config useSplitTips
missing various methods (no indication of private methods, although Ext.SplitLayoutRegion description alludes to this: "Adds a splitbar and other (private) useful functionality to a {@link Ext.LayoutRegion}.")


Class Ext.TabPanel

"old reference to YUI in the introduction text: 'Creates a lightweight TabPanel component using Yahoo! UI.'" [link]
missing config disableTooltips [link]
missing config docs


Class Ext.TabPanelItem

missing property textEl - Skipped - This is a private property
missing config docs?


Class Ext.TaskMgr

missing docs [link]


Class Ext.Toolbar

method add missing the following shorthand arguments - (Rewrote the entire doc for add)

"-" is equivalent to "separator" / method addSeparator [link]
" " is equivalent to method addSpacer [link]
"->" is the equivalent of method addFill [link]



Class Ext.tree.AsyncTreeNode

missing class description [link]


Class Ext.tree.TreeDragZone
Class Ext.tree.TreeDropZone

missing docs


Class Ext.tree.TreeEditor

missing config editDelay


Class Ext.tree.TreeLoader

"children option not documented in description of the 'node definition object' at the beginning of the description of the TreeLoader class. This option allows child nodes to be preloaded via JSON either dynamically or statically." [link]
typo in description for config dataUrl [link]
- should read "The URL from which to request a Json string which specifies an array of node definition objects representing the child nodes to be loaded."


Class Ext.tree.TreeNode

missing config checked [link]
missing config draggable [link]
missing config allowChildren
missing config isTarget
missing class description [link]


Class Ext.tree.TreeNodeUI

missing docs [link]


Class Ext.tree.TreePanel

missing config pathSeparator [link]
missing method getTreeEl
incorrect type for config loader [link]
-- should be an Ext.tree.TreeLoader, or an object with a load method with params identical to Ext.tree.TreeLoader's load method
missing class description [link]


Class Ext.tree.RootTreeNodeUI

missing docs [link]


Class Ext.UpdateManager

description for method formUpdate still says "See YUI docs for more info." [link]


Class Ext.util.Observable

missing config listeners [link]


Class Ext.View

missing config emptyText [link]
missing config multiSelect [link]
incorrect reference to dataModel in the example at the top [link]


dataModel.load("foobar.xml"); // incorrect

store.load("foobar.xml"); // correct

double quotes in the note below the example should be single quotes


Note: The root of your template must be a single node. Table/row implementations may work but are not supported due to IE"s limited insertion support with tables and Opera"s faulty event bubbling.

-- the phrase "root of your template" might also be clearer if backed by an appropriate example.
-- this note should also appear in Ext.JsonView, and should also explicitly mention "select/option" implementations
i.e. "...Table/row or select/option implementations may work but..." [link]


Class Ext.XTemplate

missing docs [link]


__________________________________________________

Class Date

incorrect description for method getLastDateOfMonth [link]
incorrect Date.parseDate examples


// incorrect
dt = Date.parseDate("2006-1-15", "Y-m-d");
dt = Date.parseDate("2006-1-15 3:20:01 PM", "Y-m-d h:i:s A" );

// should be
dt = Date.parseDate("2006-01-15", "Y-m-d");
dt = Date.parseDate("2006-01-15 03:20:01 PM", "Y-m-d h:i:s A");



Note: The following are documented correctly. There appears to be an issue with the documentation parser's ability to distinguish these as separate classes for some reason. We are looking into it, but no doc changes are necessary.

Class Array

missing docs (see notes on the String class below) - Skipped


Class Number

missing docs (see notes on the String class below) - Skipped


Class String

methods indexOf and remove are incorrectly listed as belonging to Class String. [link]
these methods should belong to the Array class [link] (refer to src\core\Ext.js) - Skipped
method constrain is incorrectly listed as belonging to Class String. [link]
this methd should belong to the Number class (refer to src\core\Ext.js) - Skipped


__________________________________________________

Misc/Requests

"Would it be possible to specify the return value (null, undefined, this?) when finder methods don't find the element(s) like Element.fly, Element.get, Ext.CompositeElement.query, Ext.CompositeElement.select?" [link] - Added for El.get/fly, CompEl.select/query always return a valid CompEl that may contain 0 or more elements internally, so they are already correct.

"I can't find any documentation that describes the CSS file(s) to use. There's good descriptions of the JS files to include but nothing about CSS at all." [link] - Skipped - This is not an API doc issue. Perhaps a page in the wiki manual would be more appropriate, although I'm not sure exactly what the contents would be ("use ext-all.css"?)

Class Ext.Ajax
"Suggest adding the code example and other info from Jack found here to the description of this class. An explicit example like this would help tremendously in my opinion to see how to use what is likely to be a popular class." [link]

Class Ext.ContentPanel
"The doco for [ContentPanel] should include information about or a reference to the IE scroll position relative bug as outlined in http://extjs.com/forum/showthread.php?t=10726" [link] - Skipped - We can't post every possible workaround to the API docs. This one is a bit too general to document effectively in the API and only affects certain cases, so it will remain in the forums.

Class Ext.data.DataReader
"There is no documentation-browser-friendly documentation for the DataReader class." [link]


Ok, I just noticed the sticky-thread about documentation issues and the comment in there to the effect that this is not-documented on purpose, because no one is supposed to instantiate one of these.

Reconsider this!

This would be like having all abstract Java or .NET classes be undocumented, with developers told "Go find the source code and read it, and you'll be told this is abstract!". Surely it makes sense to have documentation telling people not to use something directly, instead of leaving them to wonder "Why isnt this documented?" and to question the quality of Ext for it. (Which was my reaction at the time.)"

"Also, just to throw this in. Is the structure of the object-data returned by readRecords() actually documented anywhere? That also might be a good thing to document in DataReader."

Class Ext.data.JsonReader
"'After any data loads, the raw JSON data is available for further custom processing.'
The docs are not clear on this. This property only exists if there is valid JSON data. If there is a data store load exception, for example, the property does not exist, rather than being null or undefined. If this is the correct intention, then it should be made clear for those making use of the load exception event so that they can apply the correct programming logic." [link]

Class Ext.DomQuery
"Could you add a link to the CSS3 Simple Selector chapter in DomQuery..." [link]

Class Ext.Element
"I've recently run into an issue with the Ext.Element.alignTo animation config docs and Ext.Fx, both refer to animation config objects, though Ext.Element.alignTo doesn't specify which properties of the animation config object the method actually uses..." [link] - It is somewhat confusing, but the headers of both Element and Fx discuss the differences. I added a little more explanation in the Element header to try and clarify the difference, but I'm not going to add additional comments to every single Element method that can take an anim argument.

Ext.form.BasicForm/Form
"I think JSON response format (http://extjs.com/learn/Manual:Forms:Result_Format) should be included in docs." [link] - Skipped - The existing explanations and example code for Ext.form.Action.Submit and Load seem to be sufficient

Class Ext.grid.Grid
"I spent a couple hours figuring out that the reason DnD from a grid to a tree failed with a rather obscure error was because I needed to set the selection model for the grid..." [link] - Skipped - This seems like possibly a bug, but not something that would go into the API docs?

Class Ext.form.ComboBox
ComboBox config hiddenName - "Can we have this state a word smith'ed version of "required for form.submit"?" [link]

Class Ext.MessageBox

"It would save people a lot of grief if the documentation for the alert and confirm methods would highlight that the message boxes are displayed asynchronously (they are not a direct substitute for the regular javascript alert and confirm methods) and to provide examples of how to use these in the most common scenarios (e.g. do something after an alert(), potentially cancel a form submit following a confirm())..." [link]

"it is important that the docs indicate this" -- that "there is nothing in javascript land that can replace the blocking js alert() and confirm() methods." [link]

"the docs should show how to emulate this [blocking alert / confirm] - i.e. by having Ext.Msg.alert() invoke a callback function. I can see how to do this for a simple alert - where I came unstuck was with a confirm() that needed to control whether or not a form would be submitted." [link]

"...The alert() case is pretty trivial though, just pass a function as the third argument to Ext.Msg.alert() that triggers the activity to occur after after OK is clicked." [link]

"...The simple form submission using confirm() is trivial also - as for alert but with something like the following in the 3rd arg function..." -- example posted in thread [link]


Class Ext.util.MixedCollection
"The difference beween those methods is not really clear. When to use key?" [link]

Class Ext.util.Observable

sample code for method addListener is now correctly formatted, but misaligned

"In the addListener method, there is an explanation for Combining Options. The examples in this section use the el.on() shortcut method. I think there needs to be an introduction describing exactly what on() is just before the source code block that uses it to avoid confusion. Another possibility is that maybe this example is misplaced. Should it instead be in the on() method and a link to the on() shortcut method be placed in addListener?" [link]

"Perhaps a mention in the docs that if you use a logger to monitor the progress of your application you must create a null function reference to the Ext.log() function when you remove the -debug from the script call otherwise your application will break." [link] - Skipped - There's not really anywhere in the API docs where this would go. How about a FAQ entry or wiki page?

[Wolfgang]

Class Ext.form.BasicForm
Missing method: addButton

[mystix]

Class Ext.form.BasicForm
Missing method: addButton

looking at the source, the addButton method belongs to Class Ext.form.Form, which extends Class Ext.form.BasicForm.
there's no addButton method in the Class Ext.form.BasicForm.

[Jul]

Class Ext.tree.TreeLoader
Missing documentation for checked in baseAttrs config option

More details from aconran in this post (http://extjs.com/forum/showthread.php?p=51592#post51592).

[mystix]

Class Ext.tree.TreeLoader
Missing documentation for checked in baseAttrs config option

More details from aconran in this post (http://extjs.com/forum/showthread.php?p=51592#post51592).

thanks for reporting. i've added it to the list above. it's actually the Ext.tree.TreeNode class that's missing a checked config.

[Jul]

Ah, OK, I see that in the code now.

Thanks for keeping the list updated and in alpha order... it makes it much easier to see what's been reported.

[mystix]

Ah, OK, I see that in the code now.

Thanks for keeping the list updated and in alpha order... it makes it much easier to see what's been reported.

you're welcome :)

this makes it much easier for me to monitor too. ;)

[Phenothiasine]

Class Ext.grid.ColumnModel

Incorrect sortable config option description: really defaults to false, but described as "Defaults to true".

[mystix]

Class Ext.grid.ColumnModel

Incorrect sortable config option description: really defaults to false, but described as "Defaults to true".


thanks for reporting this.

the value of sortable, however, shouldn't default to false though.
it should default instead to the value of the ColumnModel's defaultSortable (http://extjs.com/deploy/ext/docs/output/Ext.grid.ColumnModel.html#defaultSortable) property.

i've updated the doc bug list accordingly.

[edit]
i've moved your question to the Help forum.
here's the link (http://extjs.com/forum/showthread.php?p=52692#post52692)

[Phenothiasine]

Thank you and sorry for last off-topic post...

[mystix]

added the following to the list:

Class Ext.TabPanel
* missing config disableTooltips
* missing config docs (in the source, but not in the generated docs)

Class Ext.TabPanel
* missing config docs? (only saw 1 - 2 configs. not sure if there's more)

[mystix]

Class Ext.grid.ColumnModel
* added report for missing config css to the list
* added report for missing cell metadata to the list (for the setRenderer method's fn parameter)

[Jul]

Class Ext.tree.TreePanel

Would it be worthwhile to mention this unofficial configuration option for a TreePanel's path separator character? I've seen several people (including me) stumble upon this problem and it might be helpful to have something in the docs about it.


tree.pathSeparator = '>';

http://extjs.com/forum/showthread.php?p=20492#post20492

[mystix]

Class Ext.tree.TreePanel

Would it be worthwhile to mention this unofficial configuration option for a TreePanel's path separator character? I've seen several people (including me) stumble upon this problem and it might be helpful to have something in the docs about it.


tree.pathSeparator = '>';

http://extjs.com/forum/showthread.php?p=20492#post20492

the pathSeparator config originates from the Ext.data.Tree class actually.

good catch though. i've added it to the list above under Ext.data.Tree and Ext.tree.TreePanel, along with some undocumented methods for both.

[OneManArmy]

It looks like Ext.data.DataReader is missing from the documentation
http://extjs.com/deploy/ext/docs/index.html (http://extjs.com/forum/../deploy/ext/docs/index.html)

Apologizes if this was mentioned before. Cheers.

[mystix]

It looks like Ext.data.DataReader is missing from the documentation
http://extjs.com/deploy/ext/docs/index.html (http://extjs.com/forum/../deploy/ext/docs/index.html)

Apologizes if this was mentioned before. Cheers.

added to the list above.

[MaxT]

Ext.grid.ColumnModel

1. Event columnlockchange is missing the "n".

2. Event headerchange - newText param should be a String, not a Number.


Ext.data.JsonReader

3. jsonData property.

"After any data loads, the raw JSON data is available for further custom processing."

The docs are not clear on this. This property only exists if there is valid JSON data. If there is a data store load exception, for example, the property does not exist, rather than being null or undefined. If this is the correct intention, then it should be made clear for those making use of the load exception event so that they can apply the correct programming logic.

Max

[mystix]

Ext.grid.ColumnModel

1. Event columnlockchange is missing the "n".

2. Event headerchange - newText param should be a String, not a Number.
added these to the list.


Ext.data.JsonReader
3. jsonData property.

"After any data loads, the raw JSON data is available for further custom processing."

The docs are not clear on this. This property only exists if there is valid JSON data. If there is a data store load exception, for example, the property does not exist, rather than being null or undefined. If this is the correct intention, then it should be made clear for those making use of the load exception event so that they can apply the correct programming logic.

Maxadded this to the Misc/Requests section of the list

[dolittle]

The usage example of Class Ext.state.CookieProvider (http://extjs.com/deploy/ext/docs/output/Ext.state.CookieProvider.html)on the top of the page says:

var cp = new Ext.state.CookieProvider({
path: "/cgi-bin/",
expires: new Date(new Date().getTime()+(1000*60*60*24*30)); //30 days
domain: "extjs.com"
})
Ext.state.Manager.setProvider(cp);

the ";" on the third row should be ",".

Thanks

[K0bo]

Don't know if it is intentionally left away...

Class Ext.EventManager
Missing function: fireResize
Missing property: textResizeInterval ?

[MarkT]

The ColumnModel setRenderer doc describes the CSS attribute of the Cell meta data as:
"css A CSS style string to apply to the table cell."

I assumed it meant a style like "width:195px", but the code in GridView adds the CSS to the cell's class list, not the style.

Perhaps it should read something like: "css A CSS class name string to apply to the table cell."

The more I think about this, it is clear this is more than a typo in the docs. Maybe both CLS and CSS support is needed in the code and docs? :)

[mystix]

The usage example of Class Ext.state.CookieProvider (http://extjs.com/deploy/ext/docs/output/Ext.state.CookieProvider.html)on the top of the page says:

var cp = new Ext.state.CookieProvider({
path: "/cgi-bin/",
expires: new Date(new Date().getTime()+(1000*60*60*24*30)); //30 days
domain: "extjs.com"
})
Ext.state.Manager.setProvider(cp);

the ";" on the third row should be ",".

Thanksadded report for Class Ext.state.CookieProvider to the list


Don't know if it is intentionally left away...

Class Ext.EventManager
Missing function: fireResize
Missing property: textResizeInterval ?added report for Class Ext.EventManager to the list


The ColumnModel setRenderer doc describes the CSS attribute of the Cell meta data as:
"css A CSS style string to apply to the table cell."

I assumed it meant a style like "width:195px", but the code in GridView adds the CSS to the cell's class list, not the style.

Perhaps it should read something like: "css A CSS class name string to apply to the table cell."

The more I think about this, it is clear this is more than a typo in the docs. Maybe both CLS and CSS support is needed in the code and docs? :)added this report to the list, under Class Ext.grid.ColumnModel. let me know if it's unclear.

[sjivan]

Would it be possible to push out these updates to the documentation on the Ext site? I'm guessing that with Ext 1.1 final out, it could be a while before the next revision of 1.1 is out.

Thanks,
Sanjiv

[mystix]

Would it be possible to push out these updates to the documentation on the Ext site? I'm guessing that with Ext 1.1 final out, it could be a while before the next revision of 1.1 is out.

Thanks,
Sanjiv

items marked as done in the doc bug list above are already in SVN, and are slated for release with the next Ext build (IIRC, Ext 1.1.1).

however, the official docs (included in each downloadable Ext release) are generated by a custom doc parser created by jack, and these are generated only once per Ext build. until the next release of Ext, we'll all just have to keep checking back in this thread. :(

[sjivan]

The ColumnModel setRenderer doc describes the CSS attribute of the Cell meta data as:
"css A CSS style string to apply to the table cell."

I assumed it meant a style like "width:195px", but the code in GridView adds the CSS to the cell's class list, not the style.

Perhaps it should read something like: "css A CSS class name string to apply to the table cell."

The more I think about this, it is clear this is more than a typo in the docs. Maybe both CLS and CSS support is needed in the code and docs? :)

Both are presently do-able but I agree the property name 'css' is a little ambiguous.



function myRenderer(value, cell, row, rowIndex, colIndex, ds) {
cell.css = 'someclass';
cell.attr = 'style="background:yellow;"';
return '...';
}


You can also get a handle to the Grid cell element from GridView#getCell(rowIndex, colIndex)

Sanjiv

[Jul]

Class Ext

Old reference to Yahoo in namespace public method:

"Creates namespaces but does not assume YAHOO is the root."

[mystix]

Class Ext

Old reference to Yahoo in namespace public method:

"Creates namespaces but does not assume YAHOO is the root."

added to the list.

[sjivan]

The following Grid config options are missing from the docs

enableCtxMenu: false, // turn off header context menu
enableColLock: false, // turn off column lock context items
enableColumnResize: false, // turn off column resize for whole grid

See http://extjs.com/forum/showthread.php?t=2833 for details.

Sanjiv

[mystix]

The following Grid config options are missing from the docs

enableCtxMenu: false, // turn off header context menu
enableColLock: false, // turn off column lock context items
enableColumnResize: false, // turn off column resize for whole grid

See http://extjs.com/forum/showthread.php?t=2833 for details.

Sanjiv

added to the list. thanks for reporting.

[jsakalos]

The doc of invalidHandleTypes in DD says "associative array". Technically, there is no such thing in javascript so I think term object would be more appropriate.

Cheers,

[mystix]

The doc of invalidHandleTypes in DD says "associative array". Technically, there is no such thing in javascript so I think term object would be more appropriate.

Cheers,

not adding it 'cos i'm going to contest that. ;)

according to this wikipedia entry (http://en.wikipedia.org/wiki/Associative_array),


... An associative array (also map, hash, dictionary, finite map, lookup table, and in query-processing an index or index file) is an abstract data type composed of a collection of keys and a collection of values, where each key is associated with one value ...

[jsakalos]

not adding it 'cos i'm going to contest that. ;)

according to this wikipedia entry (http://en.wikipedia.org/wiki/Associative_array),

OK, no problem with me I have full concept of that. Just I thought that it might confuse beginners.

Cheers,

[cwells]

Ext.View

Example at top references dataModel.load("foobar.xml");, but it looks like it should be store.load("foobar.xml");

[mystix]

Ext.View

Example at top references dataModel.load("foobar.xml");, but it looks like it should be store.load("foobar.xml");

added to the list.

[thejoker101]

In the states.js file, which has the listing of state abbreviations, used in the dropdown example, there are a few incorrect abbrevations:

Connecticut, has CN, should be CT
Hawaii, has HW, should be HI
Maine, has MA, should be ME
Massachusetts, has MS, should be MA
Rhode Island, has RH, should be RI
Vermont, has VE, should be VT

There could be others, but I think that's it. You can cross check here: http://www.usps.com/ncsc/lookups/usps_abbreviations.html

Just wanted to give you guys a heads up.

[mystix]

In the states.js file, which has the listing of state abbreviations, used in the dropdown example, there are a few incorrect abbrevations:

Connecticut, has CN, should be CT
Hawaii, has HW, should be HI
Maine, has MA, should be ME
Massachusetts, has MS, should be MA
Rhode Island, has RH, should be RI
Vermont, has VE, should be VT

There could be others, but I think that's it. You can cross check here: http://www.usps.com/ncsc/lookups/usps_abbreviations.html

Just wanted to give you guys a heads up.

added to the list, under Class Ext.form.ComboBox.

thanks.

[thejoker101]

added under Class Ext.form.ComboBox.

thanks.

Not sure what that's supposed to mean.

[Jul]

Class Ext.grid.Grid

It looks like the ds and cm config options are missing.

[Jul]

Class Ext.grid.Grid

reconfigure method parameter list is corrupted. The second parameter appears to be cut off.

getDataSource return data type appears to be incorrect. I think it should be Ext.data.Store

[mystix]

Not sure what that's supposed to mean.

it means i've added your report to the existing list of documentation bugs which can be found in post no. 2 of this thread, under the section containing all known reports for the class Ext.form.ComboBox.

[edit]
i've since edited all my previous posts in this thread to read "added to the list".
i hope it's less ambiguous now. let me know if it reads otherwise.

[mystix]

Class Ext.grid.Grid

It looks like the ds and cm config options are missing.


Class Ext.grid.Grid

reconfigure method parameter list is corrupted. The second parameter appears to be cut off.

getDataSource return data type appears to be incorrect. I think it should be Ext.data.Store

added to the list. thanks.

[Jul]

Class Ext.data.Store

For both the remove and update public events:

Currently says:
Fires when Records have been ...

Should say:
Fires when a Record has been ...

Looking at that source confirms that these events are thrown per Record ... not on multiple Records.

[Jul]

Ext.Ajax

Suggest adding the code example and other info from Jack found here (http://extjs.com/forum/showthread.php?p=35975#post35975)to the description of this class. An explicit example like this would help tremendously in my opinion to see how to use what is likely to be a popular class.

[mystix]

Class Ext.data.Store

For both the remove and update public events:

Currently says:
Fires when Records have been ...

Should say:
Fires when a Record has been ...

Looking at that source confirms that these events are thrown per Record ... not on multiple Records.
added to the list.


Ext.Ajax

Suggest adding the code example and other info from Jack found here (http://extjs.com/forum/showthread.php?p=35975#post35975)to the description of this class. An explicit example like this would help tremendously in my opinion to see how to use what is likely to be a popular class.
added to the list under the Misc/Requests section.

[Jul]

Ext.util.Observable

In the addListener method, there is an explanation for Combining Options. The examples in this section use the el.on() shortcut method. I think there needs to be an introduction describing exactly what on() is just before the source code block that uses it to avoid confusion. Another possibility is that maybe this example is misplaced. Should it instead be in the on() method and a link to the on() shortcut method be placed in addListener?

[mystix]

Ext.util.Observable

In the addListener method, there is an explanation for Combining Options. The examples in this section use the el.on() shortcut method. I think there needs to be an introduction describing exactly what on() is just before the source code block that uses it to avoid confusion. Another possibility is that maybe this example is misplaced. Should it instead be in the on() method and a link to the on() shortcut method be placed in addListener?

added to the list under Misc/Requests.

[seade]

Class Ext.MessageBox
It would save people a lot of grief if the documentation for the alert and confirm methods would highlight that the message boxes are displayed asynchronously (they are not a direct substitute for the regular javascript alert and confirm methods) and to provide examples of how to use these in the most common scenarios (e.g. do something after an alert(), potentially cancel a form submit following a confirm()). There are numerous threads on the forums where people are having problems understanding how these work and how to use them. I know I wasted a bunch of time on this today that could probably have been avoided with a little more detail in the doco.

Cheers,

Scott

[mystix]

Class Ext.MessageBox
It would save people a lot of grief if the documentation for the alert and confirm methods would highlight that the message boxes are displayed asynchronously (they are not a direct substitute for the regular javascript alert and confirm methods) and to provide examples of how to use these in the most common scenarios (e.g. do something after an alert(), potentially cancel a form submit following a confirm()). There are numerous threads on the forums where people are having problems understanding how these work and how to use them. I know I wasted a bunch of time on this today that could probably have been avoided with a little more detail in the doco.

Cheers,

Scott

added to the list under the Misc/Requests section.

AFAIK however, there is nothing in javascript land that can replace the blocking js alert() and confirm() methods.

[MaxT]

Can you double check the status of this in 1.1. Couldn't find it listed above, and have checked the code where it appears to still be disabled, but I could be wrong.

Thanks.

http://extjs.com/forum/showthread.php?t=6985&highlight=combobox+grow

[mystix]

Can you double check the status of this in 1.1. Couldn't find it listed above, and have checked the code where it appears to still be disabled, but I could be wrong.

Thanks.

http://extjs.com/forum/showthread.php?t=6985&highlight=combobox+grow

i've checked the source and it's like what you've said -- the line of code in TriggerField.js (and all it's subclasses) that's supposed to hide this is


/** @cfg {Boolean} grow @hide */

it's there for the config options growMin and growMax, and for the method autoSize too, so it's supposed to be covered.

we won't know for sure if the parser will get it right till the release of Ext 1.1.x though, unless there's a preliminary round of doc testing before the offical 1.1.x release.

[edit]
just checked the official 1.1.1 docs.
looks like the parser missed these hidden configs again...

[thejoker101]

As an addendum to my list of incorrect state abbreviations in the states.js example, it appears that Tennessee is also incorrect, it should be 'TN', not 'TE'.

[seade]

AFAIK however, there is nothing in javascript land that can replace the blocking js alert() and confirm() methods.

Well firstly, it is important that the docs indicate this (hence this is a documentation issue rather than something else).
Secondly, the docs should show how to emulate this - i.e. by having Ext.Msg.alert() invoke a callback function. I can see how to do this for a simple alert - where I came unstuck was with a confirm() that needed to control whether or not a form would be submitted. If I want to convert my app to use Ext it should be easier than it currently is to figure out how to get from

<form onsubmit="validateForm()">
// where validateForm() performs some validation and then returns true or false
// depending on whether or not the submission should continue
to somehow achieving a similar result with Ext.Msg.confirm(). I can imagine how to make this work also, but I was stumped when I happened to be looking at a form with multiple submit buttons (i.e. with different values).

Details of these issues are IMO required in the doco or the same questions will keep being asked.

Cheers,

Scott

[mystix]

As an addendum to my list of incorrect state abbreviations in the states.js example, it appears that Tennessee is also incorrect, it should be 'TN', not 'TE'.

no worries. brian caught that one already. :)

[mystix]

Well firstly, it is important that the docs indicate this (hence this is a documentation issue rather than something else).
Secondly, the docs should show how to emulate this - i.e. by having Ext.Msg.alert() invoke a callback function. I can see how to do this for a simple alert - where I came unstuck was with a confirm() that needed to control whether or not a form would be submitted. If I want to convert my app to use Ext it should be easier than it currently is to figure out how to get from

<form onsubmit="validateForm()">
// where validateForm() performs some validation and then returns true or false
// depending on whether or not the submission should continue
to somehow achieving a similar result with Ext.Msg.confirm(). I can imagine how to make this work also, but I was stumped when I happened to be looking at a form with multiple submit buttons (i.e. with different values).

Details of these issues are IMO required in the doco or the same questions will keep being asked.

Cheers,

Scott

hmmm... if you wanna try your hand at whipping something up to describe all that in a real short, sweet and informative way, just post something back here and i'll add it to your existing report (point 12 under the Misc/Requests section of the list).

[seade]

hmmm... if you wanna try your hand at whipping something up to describe all that in a real short, sweet and informative way, just post something back here and i'll add it to your existing report (point 12 under the Misc/Requests section of the list).
Ah, the old "this is open source, patches welcome" response - love it.

I am unable to provide anything polished just now - a little pushed for time (who isn't) and truth be told I have decided to stick with regular javascript alert() and confirm()'s for now.

The alert() case is pretty trivial though, just pass a function as the third argument to Ext.Msg.alert() that triggers the activity to occur after after OK is clicked.

The simple form submission using confirm() is trivial also - as for alert but with something like the following in the 3rd arg function:

if (btn == 'ok') {
document.myform.submit();
}Multiple submit buttons? Would love to see some suggestions.

Scott

[seade]

Ext.Element.boxWrap()

The doco for boxWrap() should include information about or a reference to the IE scroll position relative bug as outlined in http://extjs.com/forum/showthread.php?t=10726

Another time saver.

Cheers,

Scott

[MaxT]

ComboBox

The before query event is called as :

this.fireEvent('beforequery', qe)

i.e. there is is a single query event parameter passed.
The current docs make it look like all the listed parameters are passed as input params to the event function.


The docs should say something along the lines of:

Subscribers will be called with the following parameter:

e : Object
The query event object


The event object e contains the following parameters:

combo : Ext.form.ComboBox
This combo box
query : String
The query
forceAll : Boolean
true to force "all" query
cancel : Boolean
true to cancel the query


What do you think?

[ksachdeva]

Missing documentation about Ext.menu.Menu items property.

[ksachdeva]

Missing documentation about Ext.menu.Item 'text' property or may be getText() method is missing or not documented.

[mystix]

Ah, the old "this is open source, patches welcome" response - love it.

I am unable to provide anything polished just now - a little pushed for time (who isn't) and truth be told I have decided to stick with regular javascript alert() and confirm()'s for now.

The alert() case is pretty trivial though, just pass a function as the third argument to Ext.Msg.alert() that triggers the activity to occur after after OK is clicked.

The simple form submission using confirm() is trivial also - as for alert but with something like the following in the 3rd arg function:

appended to point 12 in the Misc/Requests section of the list.



Ext.Element.boxWrap()

The doco for boxWrap() should include information about or a reference to the IE scroll position relative bug as outlined in http://extjs.com/forum/showthread.php?t=10726

added to the list under the Misc/Requests section under Class Ext.ContentPanel, not under Class Ext.Element.

boxWrap has nothing to do with the IE scroll position relative bug in the thread you mentioned. the OP was talking about the IE scoll position relative bug in relation to a ContentPanel within a BorderLayout.

I'm creating a Ext.form inside the center of a BorderLayout and applying a Ext.boxWrap on the form div.
invoking boxWrap (with no arguments) on an Ext.Element merely wraps that Ext.Element in a nested <div> structure like so


<div class="x-box">
<div class="x-box-tl">
<div class="x-box-tr">
<div class="x-box-tc"></div>
</div>
</div>
<div class="x-box-ml">
<div class="x-box-mr">
<div class="x-box-mc">
<!-- HTMLElement / Ext.Element to be wrapped -->
</div>
</div>
</div>
<div class="x-box-bl">
<div class="x-box-br">
<div class="x-box-bc"></div>
</div>
</div>
</div>

[mystix]

ComboBox

The before query event is called as :

this.fireEvent('beforequery', qe)

i.e. there is is a single query event parameter passed.
The current docs make it look like all the listed parameters are passed as input params to the event function.


The docs should say something along the lines of:

Subscribers will be called with the following parameter:

e : Object
The query event object


The event object e contains the following parameters:

combo : Ext.form.ComboBox
This combo box
query : String
The query
forceAll : Boolean
true to force "all" query
cancel : Boolean
true to cancel the query


What do you think?

added to the list under Class Ext.form.ComboBox

[mystix]

Missing documentation about Ext.menu.Menu items property.
added to the list.



Missing documentation about Ext.menu.Item 'text' property or may be getText() method is missing or not documented.
added report for missing property text to the list. there's currently no getText() method in Ext.menu.Item, so if you feel a need to have one, feel free to put it up in the Feature Requests forum.

[mscdex]

One minor grammatical error in the TreeLoader's dataUrl description.

"The URL from which to request a Json string which specifies an array of node definition object representing the child nodes to be loaded."

should be

"The URL from which to request a Json string which specifies an array of node definition objects representing the child nodes to be loaded."

[Troy Wolf]

http://extjs.com/deploy/ext/docs/out...s.html#configs

I think the second config option should be "autoDismiss" instead of "True". I'm basing this on the fact I would not think you'd create a boolean config option with the name of "True". Also, the Delay option references an "autoDismiss" option that is not listed....and the description of the second ("True") option seems to fit "autoDismiss".

If I'm wrong, my apologies.

[mystix]

One minor grammatical error in the TreeLoader's dataUrl description.

"The URL from which to request a Json string which specifies an array of node definition object representing the child nodes to be loaded."

should be

"The URL from which to request a Json string which specifies an array of node definition objects representing the child nodes to be loaded."

added to the list.

[mystix]

http://extjs.com/deploy/ext/docs/out...s.html#configs

I think the second config option should be "autoDismiss" instead of "True". I'm basing this on the fact I would not think you'd create a boolean config option with the name of "True". Also, the Delay option references an "autoDismiss" option that is not listed....and the description of the second ("True") option seems to fit "autoDismiss".

If I'm wrong, my apologies.

no worries. you're right. ;)
also missing was the docs for the autoDismissDelay config.

added both to the list.

[thejoker101]

Form elements can have the 'vtypeText' as a config option if you want to override the default text for vtype messages. This isn't currently listed in the docs. FYI.

[mystix]

Form elements can have the 'vtypeText' as a config option if you want to override the default text for vtype messages. This isn't currently listed in the docs. FYI.

only Ext.form.TextField and its subclasses will inherit the vtypeText config.

added to the list under Ext.form.TextField.

[Jul]

Ext.form.BasicForm

Per this thread (http://extjs.com/forum/showthread.php?p=61368#post61368), it looks like there are some options missing for the doAction() method.

[Jul]

Class Ext.tree.TreePanel

loader config option incorrect. Should be either a Ext.tree.TreeLoader or an Object with custom parameters as described here (http://extjs.com/forum/showthread.php?p=58969#post58969).

[aconran]

Config option of checkHandler not documented in Ext.menu.CheckItem

Aaron

[mscdex]

Ext.tree.AsyncTreeNode doc is missing the "draggable" config option. It is used in the "Two Trees" example.

[gimler]

Ext.LayoutRegion
default for collapsible is false not true

http://extjs.com/deploy/ext/docs/output/Ext.LayoutRegion.html#config-collapsible

[MaxT]

The signature doesn't match the code:

Docs:
Adapter( Object config ) Adapter
Creates a new Adapter

Code:
Ext.menu.Adapter = function(component, config){


Max

[eneko]

In method details for Method get:

public function get( String/Object menu )
Returns a Ext.menu.Menu object
Parameters:

* menu : String/Object
The string menu id, an existing menu object reference, or a Menu config that will be used to generate and return a new Menu instance.

Returns:

* void



---> Inconsistency between returning object (downer return should not return void)

[sjivan]

ColumnModel isLocked API missing from docs.

[mystix]

Ext.form.BasicForm

Per this thread (http://extjs.com/forum/showthread.php?p=61368#post61368), it looks like there are some options missing for the doAction() method.


Class Ext.tree.TreePanel

loader config option incorrect. Should be either a Ext.tree.TreeLoader or an Object with custom parameters as described here (http://extjs.com/forum/showthread.php?p=58969#post58969).


Config option of checkHandler not documented in Ext.menu.CheckItem

Aaron
the above 3 reports have been added to the list.

_____________________


Ext.tree.AsyncTreeNode doc is missing the "draggable" config option. It is used in the "Two Trees" example.
this has been added to the list under Class Ext.tree.TreeNode, as Ext.tree.AsyncTreeNode is a subclass of TreeNode. Also added reports for what i think are missing configs allowChildren and isTarget.

_____________________


Ext.LayoutRegion
default for collapsible is false not true


http://extjs.com/deploy/ext/docs/output/Ext.LayoutRegion.html#config-collapsible


The signature doesn't match the code:

Docs:
Adapter( Object config ) Adapter
Creates a new Adapter

Code:
Ext.menu.Adapter = function(component, config){


Max


In method details for Method get:

public function get( String/Object menu )
Returns a Ext.menu.Menu object
Parameters:

* menu : String/Object
The string menu id, an existing menu object reference, or a Menu config that will be used to generate and return a new Menu instance.

Returns:

* void



---> Inconsistency between returning object (downer return should not return void)


ColumnModel isLocked API missing from docs.
added the above 4 reports to the list.

[keeper]

Class Ext.grid.CellSelectionModel()
The event beforerowselect doesn't get fired.
The real event is beforecellselect

[mystix]

Class Ext.grid.CellSelectionModel()
The event beforerowselect doesn't get fired.
The real event is beforecellselect
added to the list.

[FritFrut]

class Ext.data.Record, method create returns Record constructor, not 'void'.

[mystix]

class Ext.data.Record, method create returns Record constructor, not 'void'.

added to the list.

[andrei.neculau]

In relation to http://extjs.com/forum/showthread.php?t=13249

It should be stated the columns need to be wrapped in a container, and not let lose.

The reason is that anything that would follow the columns, except a container, would float to the right of the columns (there is not clearing element after the last column).

[LATER EDIT]
comment inside the Dynamic Forms example of the ExtDocs

// apply custom css, clear:true means it is the last column

[FritFrut]

Ext.DialogManager should be marked as singleton.

[baroncelli]

maskre is marked as String, should be RegExp

[sjivan]

DragDrop#groups returns an object with {groupName1 : true, groupName2 : true} and not String as presently documented by Ext.

See http://developer.yahoo.com/yui/docs/YAHOO.util.DragDrop.html#groups

DragDrop#padding incorrectly documented. It returns an object with array vales 0, 1, 2 and 3 to denote the padding.

[MaxT]

Ext.form.ComboBox

minChars config parameter.

The docs say that it defaults to 4.

In the code if mode is local and minChars is undefined it gets set to 0.

Hence, docs need modifying to take this into account.



if(this.mode == 'local'){
if(config.queryDelay === undefined){
this.queryDelay = 10;
}
if(config.minChars === undefined){
this.minChars = 0;
}
}

[Jul]

Ext.form.Field

fieldLabel config option missing. It is described in the add method of Ext.form.Form and here (http://extjs.com/forum/showthread.php?p=33754#post33754).

Ext.form.Layout

labelStyle config option missing. Post from Tim Ryan describing this option here (http://extjs.com/forum/showthread.php?p=39083#post39083).

[GArrow]

There is no documentation-browser-friendly documentation for the DataReader class. Someone has to look at the DataReader.js source code.

Suggested documentation:


/**
* @class Ext.data.DataReader
*
* Abstract base class for reading structured data from a data source and converting
* it into an object containing {@link Ext.data.Record} objects and metadata for use
* by an {@link Ext.data.Store}. This class is intended to be extended and should not
* be created directly. (See ArrayReader, JsonReader and XmlReader).
*
* @constructor Create a new DataReader
* @param {Object} meta Metadata configuration options.
* @param {Object} recordType Either an Array of field definition objects as specified
* to {@link Ext.data.Record#create}, or an {@link Ext.data.Record} object created
* using {@link Ext.data.Record#create}.
*/

Also, I said:


Ok, I just noticed the sticky-thread about documentation issues and the comment in there to the effect that this is not-documented on purpose, because no one is supposed to instantiate one of these.

Reconsider this!

This would be like having all abstract Java or .NET classes be undocumented, with developers told "Go find the source code and read it, and you'll be told this is abstract!". Surely it makes sense to have documentation telling people not to use something directly, instead of leaving them to wonder "Why isnt this documented?" and to question the quality of Ext for it. (Which was my reaction at the time.)

Also, just to throw this in. Is the structure of the object-data returned by readRecords() actually documented anywhere? That also might be a good thing to document in DataReader.

[GArrow]

The documentation for Ext.data.Store.load's params argument reads


params {Object} An object containing properties to pass as HTTP parameters to a remote data source.
This describes the Store class as being closely tied to HTTP transport, which need not be the case.

Also, the exact content of these parameters does not seem to be defined. In some cases, params contains 'start' and 'limit', but it is not clear if this is all an implementation of load() should have to handle.

[Animal]

The documentation for Ext.data.Store.load's params argument reads


This describes the Store class as being closely tied to HTTP transport, which need not be the case.

Well, for a remote datra source it is really tied to HTTP because that's the only way remote data can be retrieved. Whether it's a ScriptTagProxy, or an HttpProxy, if the data is coming from a server, those parameters will be passed via HTTP.

[dolittle]

Textfield.blur() method works but is not documented.
I`m not sure if it should. If it does then it`s probably missing from other fields as well.

[mystix]

Ext.DialogManager should be marked as singleton.


maskre is marked as String, should be RegExp


DragDrop#groups returns an object with {groupName1 : true, groupName2 : true} and not String as presently documented by Ext.

See http://developer.yahoo.com/yui/docs/YAHOO.util.DragDrop.html#groups

DragDrop#padding incorrectly documented. It returns an object with array vales 0, 1, 2 and 3 to denote the padding.


Ext.form.ComboBox

minChars config parameter.

The docs say that it defaults to 4.

In the code if mode is local and minChars is undefined it gets set to 0.

Hence, docs need modifying to take this into account.



if(this.mode == 'local'){
if(config.queryDelay === undefined){
this.queryDelay = 10;
}
if(config.minChars === undefined){
this.minChars = 0;
}
}



Ext.form.Field

fieldLabel config option missing. It is described in the add method of Ext.form.Form and here (http://extjs.com/forum/showthread.php?p=33754#post33754).

Ext.form.Layout

labelStyle config option missing. Post from Tim Ryan describing this option here (http://extjs.com/forum/showthread.php?p=39083#post39083).
added to the list.


There is no documentation-browser-friendly documentation for the DataReader class. Someone has to look at the DataReader.js source code.

Suggested documentation:


/**
* @class Ext.data.DataReader
*
* Abstract base class for reading structured data from a data source and converting
* it into an object containing {@link Ext.data.Record} objects and metadata for use
* by an {@link Ext.data.Store}. This class is intended to be extended and should not
* be created directly. (See ArrayReader, JsonReader and XmlReader).
*
* @constructor Create a new DataReader
* @param {Object} meta Metadata configuration options.
* @param {Object} recordType Either an Array of field definition objects as specified
* to {@link Ext.data.Record#create}, or an {@link Ext.data.Record} object created
* using {@link Ext.data.Record#create}.
*/

Also, I said:



Also, just to throw this in. Is the structure of the object-data returned by readRecords() actually documented anywhere? That also might be a good thing to document in DataReader.
added to the list under the Misc/Requests section.



The documentation for Ext.data.Store.load's params argument reads


This describes the Store class as being closely tied to HTTP transport, which need not be the case.

Also, the exact content of these parameters does not seem to be defined. In some cases, params contains 'start' and 'limit', but it is not clear if this is all an implementation of load() should have to handle.
not added to the list as per @Animal's explanation.


Textfield.blur() method works but is not documented.
I`m not sure if it should. If it does then it`s probably missing from other fields as well.
the blur method is implemented in Class Ext.Component and all it's subclasses, and is currently marked private.
not added to the list.

[brian.moeskau]

Ext.form.ComboBox

minChars config parameter.

The docs say that it defaults to 4.

In the code if mode is local and minChars is undefined it gets set to 0.

Hence, docs need modifying to take this into account.



if(this.mode == 'local'){
if(config.queryDelay === undefined){
this.queryDelay = 10;
}
if(config.minChars === undefined){
this.minChars = 0;
}
}


I do not see this block of code in the latest source. Are you sure you have the latest? According to the current code, the docs are correct.

EDIT: Found it in the constructor -- I was looking in doQuery.

[Greenosity]

I can't find any documentation that describes the CSS file(s) to use. There's good descriptions of the JS files to include but nothing about CSS at all.

[Greenosity]

There's no descriptions at all of the TreePanel, TreeNode, and AsyncTreeNode in the API docs.
And please, something more than just "A tree node".

[mystix]

There's no descriptions at all of the TreePanel, TreeNode, and AsyncTreeNode in the API docs.
And please, something more than just "A tree node".

you're referring to the 1-liner that's present in most of the other classes?
any suggestions before i adopt "A tree node"? cos i think it's kinda cute ;)

too slow. ;)
added to the list anyways under Class Ext.tree.AsyncTreeNode/TreeNode/TreePanel.

[mystix]

I can't find any documentation that describes the CSS file(s) to use. There's good descriptions of the JS files to include but nothing about CSS at all.

added to the list under Misc/Requests.

[GArrow]

Well, for a remote datra source it is really tied to HTTP because that's the only way remote data can be retrieved. Whether it's a ScriptTagProxy, or an HttpProxy, if the data is coming from a server, those parameters will be passed via HTTP.

This simply is not true. JavaScript may call Java code which speaks some other protocol or which accesses data on the local system. There are many ways to access data -- and it need not even be "remote" in the normal sense of the word.

[evant]

It doesn't matter what your java code calls, that is completely irrelevant. As Animal said, to access whatever in the server side, you need to use HTTP.

[balou]

var TopicRecord = Ext.data.Record.create(
{name: 'title', mapping: 'topic_title'},
{name: 'author', mapping: 'username'},
{name: 'totalPosts', mapping: 'topic_replies', type: 'int'},
{name: 'lastPost', mapping: 'post_time', type: 'date'},
{name: 'lastPoster', mapping: 'user2'},
{name: 'excerpt', mapping: 'post_text'}
);

[mystix]

var TopicRecord = Ext.data.Record.create(
{name: 'title', mapping: 'topic_title'},
{name: 'author', mapping: 'username'},
{name: 'totalPosts', mapping: 'topic_replies', type: 'int'},
{name: 'lastPost', mapping: 'post_time', type: 'date'},
{name: 'lastPoster', mapping: 'user2'},
{name: 'excerpt', mapping: 'post_text'}
);


/:) what's that supposed to mean...

[balou]

It is an example of use Ext.data.Record.create from your Docs.
Where an array-parameter?

[mystix]

It is an example of use Ext.data.Record.create from your Docs.
Where an array-parameter?

bingo - this information was missing from your previous post.

it's considered good practice to give a brief description of the problem.

[edit]


var TopicRecord = Ext.data.Record.create(
{name: 'title', mapping: 'topic_title'},
{name: 'author', mapping: 'username'},
{name: 'totalPosts', mapping: 'topic_replies', type: 'int'},
{name: 'lastPost', mapping: 'post_time', type: 'date'},
{name: 'lastPoster', mapping: 'user2'},
{name: 'excerpt', mapping: 'post_text'}
);


added to the list under Class Ext.data.Record

[dolittle]

Couldn`t find docs for TaskMgr in 1.1

[mystix]

Couldn`t find docs for TaskMgr in 1.1
thanks for reporting this. the docs for Ext.TaskMgr have already been updated in SVN.
not added to the list.

[asgillett]

Ext.Resizable has these public methods that are described in the source code but not in the documentation (1.1.1 and 2.0RC1):
resizeTo(width, height)
getEl()
getResizeChild()
destroy(removeEl)

The 2.0RC1 documentation for Resizable also lists this non-existent method:
el(Number width, Number height)

[gimbles]

Class Ext.tree.TreeLoader
uiProviders : Object
(optional) An object containing properties which specify custom Ext.tree.TreeNodeUI implementations. If the optional uiProvider attribute of a returned child node is a string rather than a reference to a TreeNodeUI implementation, this that string value is used as a property name in the uiProviders object.

possibly meant to write "then"

[Comma]

dragConfig : Object TreePanel
Custom config to pass to the Ext.tree.TreeDragZone instance

dropConfig : Object TreePanel
Custom config to pass to the Ext.tree.TreeDropZone instance

links to Ext.tree.TreeDropZone / Ext.tree.TreeDragZone are incorect =\