PDA

View Full Version : Missing and/or Incorrect Docs - Ext 1.1 (rc1)+



tryanDLS
29 Jun 2007, 8:39 AM
Starting a new thread for documentation bugs. Please report issues based on the 1.1RC1 version of the documentation.

EDIT: revised to reflect release of RC1

mystix
29 Jun 2007, 9:30 AM
reported by yogurtearl in this thread (http://extjs.com/forum/showthread.php?t=8489)


the documentation (http://extjs.com/deploy/ext-1.1-beta2/docs/output/Date.html#getDayOfYear) for Date.getDayOfYear says:
"returns: 0 through 365 (366 in leap years)"

That is one too many days. It should say "returns: 0 through 364 (365 in leap years)"

tryanDLS
29 Jun 2007, 9:42 AM
reported by yogurtearl in this thread (http://extjs.com/forum/showthread.php?t=8489)
the documentation for Date.getDayOfYear says:
"returns: 0 through 365 (366 in leap years)"

That is one too many days. It should say "returns: 0 through 364 (365 in leap years)"
Fixed.

sjivan
29 Jun 2007, 11:41 AM
Menu events 'click', 'mouseover ' and 'mouseout' have callbacks arguments that return the actual menuitem object and not the menuItemId String as documented.

I also often get callbacks for 'mouseover' and 'mouseover' with null passed for in this callback argument (presently menuItemId but should be menuItem) so might help if its documented that the user should check for null values for this. Is this supposed to be when the user mouseover's a region of the menu that doesn't have a menu item? Or is it a bug?

=======================================================

GridView hasnt been documented. If the only methods of interest are in View, mabye the docs for Grid.getView() should just state that a View is returned (presently says GridView is returned).

=======================================================

DomQuery.select(selector) should state that selector can be a comma separated list of multiple separators.

=======================================================

Constructor of ArrayReader says 'Create a new JsonReader'

=======================================================

Remove "nocache" config option from ScriptTagProxy since ScriptTagProxy calls are never cached.

See http://extjs.com/forum/showthread.php?t=7096

======================================================

ColumnModel#isFixed and #isResizable missing colIndex param in docs

ColumnModel config missing "id" property

======================================================

Thanks,
Sanjiv

mystix
30 Jun 2007, 8:33 AM
hi sanjiv, if i recall correctly i didn't see the "ArrayReader", "nocache" and "ColumnModel" reports there this morning.
if you're editing your threads it would help if you placed new entries under an "[edit]" block or something, like so:
old stuff

[edit]
new stuffso the documentation team knows new stuff was added and can focus their attention on that, or simply create new posts in this thread.
thanks.:)

sjivan
30 Jun 2007, 10:08 AM
I was editing the same thread until I saw a reponse from the dev team indicating that the changes have been incorporated and only then was planning on starting a new post for subsequent issues. I'll mark the edits or create new posts in the future.

Thanks,
Sanjiv

sjivan
30 Jun 2007, 2:42 PM
Documentation for TreeNodeUI missing (accessed by calling TreeNode.getUI() )

prophet
2 Jul 2007, 1:39 PM
It seems as if the HtmlEditor does not have a "change" event, but the docs say otherwise.

mystix
3 Jul 2007, 3:07 AM
Class Ext.Element (Element.js)

currently
{@link EventManager#addListener}should be
{@link Ext.EventManager#addListener}

rtannert2
3 Jul 2007, 4:39 AM
In the doc for Ext.data.Record.create() the description of parameter o is mangled ("and a mapping for an The name by which..."), as is the code block under "usage."

bone
3 Jul 2007, 5:25 AM
http://extjs.com/deploy/ext/docs/output/Ext.form.Form.html#config-monitorValid

this bugger says use the config value bindForm:true in the button....

and i did just that, and spent an hour hating on everyone untill i saw this one
http://extjs.com/forum/showthread.php?t=5108&highlight=formBind

rtannert2
3 Jul 2007, 5:42 AM
Typo in Ext.data.Store, Config Options, "data": Inline data to be l;oaded when the store is initialized.

tryanDLS
3 Jul 2007, 6:47 AM
It seems as if the HtmlEditor does not have a "change" event, but the docs say otherwise.


Class Ext.Element (Element.js)
currently
Code:
{@link EventManager#addListener}

should be
Code:
{@link Ext.EventManager#addListener}




http://extjs.com/deploy/ext/docs/out...g-monitorValid

this bugger says use the config value bindForm:true in the button....

and i did just that, and spent an hour hating on everyone untill i saw this one
http://extjs.com/forum/showthread.ph...light=formBind



Typo in Ext.data.Store, Config Options, "data": Inline data to be l;oaded when the store is initialized.

Fixed

jay@moduscreate.com
3 Jul 2007, 10:20 AM
Would it be smart to add what the form.submit is looking for from the server? IE: "{success: true, mydata : { xxx : 'yyy' }}"?

I was searching this for about an hour before i came upon an old thread here.

jay@moduscreate.com
3 Jul 2007, 10:33 AM
Would it be smart to add what the form.submit is looking for from the server? IE: "{success: true, mydata : { xxx : 'yyy' }}"?

I was searching this for about an hour before i came upon an old thread here.

For that matter, what Options do we pass to the submit function?


http://extjs.com/deploy/ext/docs/output/Ext.form.Form.html#submit

mystix
4 Jul 2007, 4:29 AM
Class Ext.grid.Grid / Ext.grid.EditorGrid
* missing reconfigure public method

EDIT: fixed

mystix
4 Jul 2007, 9:00 PM
Class Ext.form.ComboBox

currently

setEditable
public function setEditable()
Allow or prevent the user from directly editing the field text. If false is passed in, the user will only be able to select from the items defined in the dropdown list. This method is the runtime equivalent of setting the editable config option at config time.
Parameters:

* None.

Returns:

* void

This method is defined by ComboBox.

should be

setEditable
public function setEditable([Boolean editable])
Allow or prevent the user from directly editing the field text. If false is passed in, the user will only be able to select from the items defined in the dropdown list. This method is the runtime equivalent of setting the editable config option at config time.
Parameters:

* editable: Boolean.
(optional) Allow or prevent the user from directly editing the field text (defaults to false)

Returns:

* void

This method is defined by ComboBox.

EDIT: fixed - Note the value is not optional

MaxT
6 Jul 2007, 1:29 AM
Quicktips unregister method is missing the passed "el" parameter.



unregister() : void QuickTips
Removes this quick tip from its element and destroys it


Max

EDIT: fixed

mystix
6 Jul 2007, 2:04 AM
Class Ext.Component
* missing config option allowDomMove (defaults to true)

EDIT: fixed

mystix
7 Jul 2007, 8:16 AM
Class Ext.form.Field (and all its subclasses)
* missing config option tabIndex

[edit]
config option should only be applicable for dynamically created Ext.form.Fields

EDIT:fixed

Wolfgang
8 Jul 2007, 12:36 AM
Class Ext.Ajax / Public Events

Description of event requestcomplete seems wrong.


beforerequest : (Connection conn, Object options)
Fires before a network request is made to retrieve a data object.

requestcomplete : (Connection conn, Object response, Object options)
Fires before a network request is made to retrieve a data object.

efege
8 Jul 2007, 5:25 AM
Class Ext.Ajax / Public Events

Description of event requestcomplete seems wrong.


beforerequest : (Connection conn, Object options)
Fires before a network request is made to retrieve a data object.

requestcomplete : (Connection conn, Object response, Object options)
Fires before a network request is made to retrieve a data object.


Thanks, it's fixed in SVN now.

New description: Fires if the request was successfully completed.

mystix
9 Jul 2007, 7:18 AM
Class Ext.Element
* missing method uncache
* missing method garbageCollect

Jul
9 Jul 2007, 8:09 AM
Class Ext.Shadow
* config option mode - Options for this config option not formatted correctly - text does not wrap.

Many Classes (Ext.Ajax, Ext.BasicDialog, etc.)
The sample code in addListner is badly formatted. The section titled "Attaching multiple handlers in 1 call" is incorrectly indented and the code in that section does not wrap.

sjivan
10 Jul 2007, 3:50 AM
MessageBox.show

Following config options not documented:

minWidth
maxWidth
minProgressWidth
defaultTextHeight
animEl
fn

tookoo
10 Jul 2007, 6:46 AM
Grid/EditorGrid
the "autoWidth" config option is not documented. It can be found in Line 1442 of GridView.js. (1.1 beta 2).

mystix
11 Jul 2007, 9:03 AM
Class Ext.LayoutRegion
* missing config option autoTabs

Jul
11 Jul 2007, 10:28 AM
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.

MaxT
12 Jul 2007, 5:23 AM
Ext.form.Action

No documentation at all in ext-1.1-rc1 but referenced by other Form components.

Max

mystix
12 Jul 2007, 6:36 AM
Class Ext.tree.TreeFilter
missing documentation (it's in the source, but it's not in the docs)

danh2000
12 Jul 2007, 2:46 PM
Hi,

GridView is not documented and you actually have an invalid link in the docs:

This page:
http://extjs.com/deploy/ext/docs/output/Ext.grid.Grid.html

links to http://extjs.com/deploy/ext/docs/output/Ext.grid.GridView.html

But when clicked, the Home Page is loaded into the documentation.

Regards,

Dan

danh2000
12 Jul 2007, 8:59 PM
Hi,

The ColumnModel 'fixed' config option is also not documented.

Regards,

Dan

fjanon
16 Jul 2007, 2:46 AM
A few corrections tagged in red and a suggestion:
Could the event handler call format be documented? I can't figure out how to get something like the "forumId" as in the example...


addListenerpublic function addListener(String eventName, Function handler, [Object scope], [Object options])
Appends an event handler to this component
Parameters:

eventName : String
The type of event to listen for
handler : Function
The method the event invokes * <= what are the function arguments? *
scope : Object
(optional) The scope in which to execute the handler function. The handler function's "this" context.
options : Object
(optional) An object containing handler configuration properties. This may contain any of the following properties:
scope {Object} The scope in which to execute the handler function. The handler function's "this" context.
delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
buffer {Number} Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
* no mention of/how custom param(s?) passed to the event handler *

Combining Options
Using the options argument, it is possible to combine different types of listeners:

A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) * <= How do we get "forumId" in the event handler? *

Code:
el.on('click', this.onClick, this, { single: true, delay: 100, forumId: 4 });Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. * which is which which is does to which? ;) *

Code:

foo.on({ 'click' : { fn: this.onClick * missing comma here * scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver * missing comma here * scope: this }, 'mouseout' : { fn: this.onMouseOut * missing comma here * scope: this } });Or a shorthand syntax:
Code:

foo.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut * missing comma here * scope: this });

tryanDLS
16 Jul 2007, 7:10 AM
@fjanon
Please refer to the latest docs when reporting issues (in this case RC1). While there are still some formatting issues with the Observable.addListener doc, a number of your issues are already addressed.

mystix
17 Jul 2007, 6:15 AM
Looking at the source of Toolbar it seems that Toolbar.add() supports the following shorthand:

"separator" or "-" is equivalent to addSeparator()
" " is equivalent to addSpacer()
"-> is the equivalent of addFill()


It would be great if the doco for Toolbar.add() could mention these (currently, 1.1-rc1, it only mentions "separator").

Cheers,

Scott

.

Overlord
17 Jul 2007, 6:23 AM
Under Ext.data.ArrayReader, some of the HTML is garbled with the text. The constructor details appear as the following:

Either an Array of field definition objects as specified to Ext.data.Record.create, or an Ext.data.Record" href="Ext.data.Record object created using Ext.data.Record" href="Ext.data.Record.html#create">Ext.data.Record.html">Ext.data.Record.html#create">Ext.data.Record object created using {@link Ext.data.Record.create.

artythesmarty
19 Jul 2007, 10:18 AM
Not necessarily a "bug," but I noticed in the API for Textfield, the msgTarget config property has all the values and descriptions on one long continuous line that doesn't wrap, making it impossible to read.

Just thought I would let someone know.

mystix
20 Jul 2007, 10:17 AM
reporting on behalf of @tbarstow & jack:

The API docs for Ext.data.Store.getModifiedRecords says "Get all records modified since the last load, or since the last commit." This isn't the case though - when you load a data store, its modified records do NOT get cleared. This is true in Ext 1.0.1a and the 1.1RC1.

I am currently using a subclass to get around this, with the following:



load: function() {
wbd.ext.data.Store.superclass.load.apply(this, arguments);
this.modified = [];
}



This is a documentation error, not a bug in the code. Please report it in the doc error thread. Thanks!

sjivan
21 Jul 2007, 3:30 AM
Element#getAnchorXY

Code has arguments in order : anchor, local, s
but doc has arguments in order anchor, s, local

Wolfgang
21 Jul 2007, 5:42 AM
Undocumented option 'tpl' for combobox

sjivan
21 Jul 2007, 9:58 AM
Element#setLeftTop : arguments not documented

sjivan
21 Jul 2007, 10:53 AM
Element#translatePoints

@param {Object} An object with left and top properties. e.g. {left: (value), top: (value)}

should be

@return {Object} An object with left and top properties. e.g. {left: (value), top: (value)}

sjivan
21 Jul 2007, 5:00 PM
KeyNav config options not documented.

sjivan
21 Jul 2007, 7:45 PM
Ext.View's emptyText config property not documented.

Ext.View's multiSelect config property not documented.

mystix
22 Jul 2007, 4:18 AM
Class Ext.data.Store

currently


metachange : ( Store this, Object meta ) Store
Fires when this stores reader provides new meta data (fields). This is currently only support for JsonReaders.

should be


metachange : ( Store this, Object meta ) Store
Fires when this store's reader provides new meta data (fields). This is currently only supported for JsonReaders.

sjivan
22 Jul 2007, 4:41 AM
XTemplate not documented.

BaseItem showDelay config not documented

Grid#reconfigure not documnted

jay@moduscreate.com
22 Jul 2007, 5:10 PM
Class Ext.data.Store
Package: Ext.data
Class: Store
Extends: Observable
Subclasses: SimpleStore
Defined In: Store.js
The Store class encapsulates a client side cache of Ext.data.Record objects which provide input data for widgets such as the Ext.grid.Grid, or the Ext.form.ComboBox.

A Store object uses an implementation of Ext.data.DataProxy to access a data object unless you call loadData() directly and pass in your data. The Store object has no knowledge of the format of the data returned by the Proxy.

A Store object uses its configured implementation of Ext.data.DataReader to create Ext.data.Record instances from the data object. These records are cached and made available through accessor functions.

Properties - Methods - Events - Config Options
Public Properties
This class has no public properties.



that's not true

ds.data is an important object that i use all of the time.
There are loads of other properties

There are a few undocumented methods such as:
loadRecords
storeOptions
onMetaChange
createFilterFn
afterCommit
afterReject
afterEdit

mystix
23 Jul 2007, 1:24 AM
Class Date
*incorrect description for method getLastDateOfMonth

current description

Get a Date of the late day of this date's month

should be

Get a Date of the last day of this date's month

sjivan
23 Jul 2007, 2:58 AM
EditorGrid - property clicksToEdit not documented

Wolfgang
23 Jul 2007, 10:57 AM
Borderlayout:
missing nearly all properties
except: monitorWindowResize

cgi-bin
25 Jul 2007, 7:11 AM
Class Ext.data.Record

The documentation for the create() method is messed up. It gets down to dateformat and appears to recursively link back to itself and starts over with name...

mystix
25 Jul 2007, 8:00 AM
Class Ext.data.Record

The documentation for the create() method is messed up. It gets down to dateformat and appears to recursively link back to itself and starts over with name...

was already reported (http://extjs.com/forum/showthread.php?p=43379#post43379) earlier in this very thread.
pls CTRL+F before posting. ;)

karantir
25 Jul 2007, 10:01 PM
I think JSON response format (http://extjs.com/learn/Manual:Forms:Result_Format) should be included in docs.

fjanon
27 Jul 2007, 1:56 AM
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?

Thanks

Fred

jay@moduscreate.com
28 Jul 2007, 6:06 AM
hiddenName
hiddenName : String
If specified, a hidden form field with this name is dynamically generated to store the field's data value (defaults to the underlying DOM element's name)
This config option is defined by ComboBox.



^^^^^^^^^^^^

Can we have this state a word smith'ed version of "required for form.submit"?

sjivan
28 Jul 2007, 7:39 AM
TabPanelItem textEl property not documented

Wolfgang
28 Jul 2007, 8:19 AM
MixedCollection:
The difference beween those methods is not really clear. When to use key?

item( String/Number key ) : Object MixedCollection
Returns the item associated with the passed key OR index. Key has priority over index.

key( String/Number key ) : Object MixedCollection
Returns the item associated with the passed key.

fjanon
29 Jul 2007, 1:35 AM
Could you add a link to the CSS3 Simple Selector chapter in DomQuery for:

E:not(S)...E:prev(S) S being a Simple Selector

http://www.w3.org/TR/2005/WD-css3-selectors-20051215/#simple-selectors

Could you also include some working examples with E:not(S), E:next(S) and E:has(S)?

Thanks

Fred

Jul
29 Jul 2007, 11:13 AM
Class Ext.TabPanel
There's an old reference to YUI in the introduction text: "Creates a lightweight TabPanel component using Yahoo! UI. "

Class Ext.UpdateManager formUpdate
There is a reference to YUI in the formUpdate method of UpdateManager: "See YUI docs for more info." Since YUI is no longer required, this seems like it doesn't belong.

fjanon
29 Jul 2007, 7:33 PM
Is there going to be some indication of what has been added (i.e. classes or methods) or changed (i.e. behavior or arguments if any) in the JSDoc API 1.1 compared to 1.0.1?

The book "JAVA in a nutshell" has a great format: it has a version number where the class was first introduced and then for methods added later on there is the version number in front of the method definition. It would be a lot better that all this information packed in the release notes.

Thanks

Fred

mystix
30 Jul 2007, 5:40 PM
Class Ext.data.Store
* undocumented method startAutoRefresh
(mentioned by rberger in this post (http://extjs.com/forum/showthread.php?p=50402#post50402))

mystix
30 Jul 2007, 5:41 PM
[edit]
Class Ext.TaskMgr (which is an instance of Ext.util.TaskRunner)
* undocumented
(mentioned by jack in this post (http://extjs.com/forum/showthread.php?p=35643#post35643))