Documentation Bugs - Ext 2.x

[dreas]

[implemented]

Just in case that page went to /dev/null the internet archive is keeping a few copies of it. I attached the last copy of that page to this post since it took forever to load.

[mjlecomte]

[implemented]

Just a minor one...


Class Ext.DomHelper

"For more information and examples, see the original blog post."


That link to Jack's blog isn't valid anymore.

I thought I remember someone removing that link...oh well. I ported it to the wiki http://extjs.com/learn/TutorialomHelper_Blog

[Animal]

[implemented]

OK, I just brought that entry a couple of years up to date!

I'll add a link to it from the API docs. Thanks for saving that into the Wiki MJ.

[mjlecomte]

[implemented] - fixed closing tag

monitorValid

small formatting problem:

If true, the form monitors its valid state client-side and regularly fires the clientvalidation event passing that state.

When monitoring valid state, the FormPanel enables/disables any of its configured buttons which have been configured with formBind: true depending on whether the form is valid or not.

should be

If true, the form monitors its valid state client-side and regularly fires the clientvalidation event passing that state.

When monitoring valid state, the FormPanel enables/disables any of its configured buttons which have been configured with formBind: true depending on whether the form is valid or not.

Edit: I'm attaching a screenshot because the source code looks like it should format it like I'm suggesting already?!

[mjlecomte]

Ext.Layer undocumented properties.

I went looking for getZIndex, but there's probably a couple more that could be documented.

    getZIndex : function(){
        return this.zindex || parseInt(this.getStyle("z-index"), 10) || 11000;
    },

    getShim : function(){

    },

    hideShim : function(){

    },

    disableShadow : function(){

    },

    enableShadow : function(show){

    },

[mjlecomte]

Ext.Window

Suggest being more specific, the term "window" is confusing since this description is within the Ext.Window class.

    /**
     * Anchors this window to another element and realigns it when the browser window is resized or scrolled.
     * @param {Mixed} element The element to align to.
     * @param {String} position The position to align to (see {@link Ext.Element#alignTo} for more details)
     * @param {Array} offsets (optional) Offset the positioning by [x, y]
     * @param {Boolean/Number} monitorScroll (optional) true to monitor body scroll and reposition. If this parameter
     * is a number, it is used as the buffer delay (defaults to 50ms).
     * @return {Ext.Window} this
     */
    anchorTo

[mjlecomte]

/**
 * @class Ext.Layer
 * @extends Ext.Element
 * An extended {@link Ext.Element} object that supports a shadow and shim, constrain to viewport and
 * automatic maintaining of shadow/shim positions.
 * @cfg {Boolean} shim False to disable the iframe shim in browsers which need one (defaults to true)
 * @cfg {String/Boolean} shadow True to automatically create an {@link Ext.Shadow}, or a string indicating the 
 * shadow's display {@link Ext.Shadow#mode}. False to disable the shadow. (defaults to false)
 * @cfg {Object} dh DomHelper object config to create element with (defaults to {tag: "div", cls: "x-layer"}).
 * @cfg {Boolean} constrain False to disable constrain to viewport (defaults to true)
 * @cfg {String} cls CSS class to add to the element

 * @cfg {Number} id
 * @cfg {String} parentEl
 * @cfg {Boolean} useDisplay

 * @cfg {Number} zindex Starting z-index (defaults to 11000)
 * @cfg {Number} shadowOffset Number of pixels to offset the shadow (defaults to  3  4). Note that this option only applies when floating = true. 
 * @constructor
 * @param {Object} config An object with config options.
 * @param {String/HTMLElement} existingEl (optional) Uses an existing DOM element. If the element is not found it creates it.
 */
(function(){
Ext.Layer = function(config, existingEl){
    ...
    var cp = config.parentEl,
    ...
    if(config.id){
        this.id = this.dom.id = config.id;
    }else{
        this.id = Ext.id(this.dom);
    }

        this.shadowOffset = config.shadowOffset || 4;
    ...
    this.useDisplay = config.useDisplay;

[Animal]

On a matter of style, the documents frequently refer to a parameter which may be an Ext.Element, or the ID of an element, or an "HtmlElement".

I think I should do a mass edit and change all of these "HtmlElement" references to the more technically correct "DOMElement" to indicate that what is being referred to is a DOM node of nodeType 1: A DOM Element

"HTML" is the name for a textual description of what the proposed DOM structure is going to be.

Its the same as when people have a javascript object and they call it "JSON". JSON is a string representation, not the object. It's the same with HTML. HTML is the string representation. When in the browser, you are dealing with a Document Object Model.

Anyone against these changes in the 3.0 code branch?

[Condor]

DOMElement also isn't 100% correct. The DOM1 specs mentions Element and HTMLElement.

So the API docs should mention (DOM) Element in the context of DOM nodes (DomQuery, XmlReader) and HTMLElement when referencing elements in the HTML document.

[Animal]

I see, thanks for that info. So it's HTMLElement for elements of an HTML DOM, and DOMElement when dealing with XML. I will try to ensure consistency when I edit.