From c498d339b4744447e99e97466d150a647f906971 Mon Sep 17 00:00:00 2001 From: Brian Kotek Date: Tue, 20 Aug 2013 23:22:17 -0400 Subject: [PATCH] Update Ext JS definition to work with the new TS 0.9.1 (Previous push actually was for TS 0.9.0.1) --- extjs/ExtJS.d.ts | 10537 +++++++++++++++++++++++++++------------------ 1 file changed, 6400 insertions(+), 4137 deletions(-) diff --git a/extjs/ExtJS.d.ts b/extjs/ExtJS.d.ts index 570942e32b..1c85967a74 100644 --- a/extjs/ExtJS.d.ts +++ b/extjs/ExtJS.d.ts @@ -111,23 +111,19 @@ declare module Ext { addChildEls?(): void; /** [Method] Adds a CSS class to the top level element representing this component * @param cls String/String[] The CSS class name to add. + * @returns Ext.Component Returns the Component to allow method chaining. */ - addClass?( cls?:any ): any; - addClass?( cls?:string ): Ext.IComponent; - addClass?( cls?:string[] ): Ext.IComponent; + addClass?( cls?:any ): Ext.IComponent; /** [Method] Adds a CSS class to the top level element representing this component * @param cls String/String[] The CSS class name to add. + * @returns Ext.Component Returns the Component to allow method chaining. */ - addCls?( cls?:any ): any; - addCls?( cls?:string ): Ext.IComponent; - addCls?( cls?:string[] ): Ext.IComponent; + addCls?( cls?:any ): Ext.IComponent; /** [Method] Adds a cls to the uiCls array which will also call addUIClsToElement and adds to all elements of this component * @param classes String/String[] A string or an array of strings to add to the uiCls. * @param skip Object (Boolean) skip true to skip adding it to the class and do it later (via the return). */ - addClsWithUI?( classes?:any, skip?:any ): any; - addClsWithUI?( classes?:string, skip?:any ): void; - addClsWithUI?( classes?:string[], skip?:any ): void; + addClsWithUI?( classes?:any, skip?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true. For example: this.addEvents({ storeloaded: true, storecleared: true }); Or any number of event names as separate parameters. For example: this.addEvents('storeloaded', 'storecleared'); */ @@ -137,6 +133,7 @@ declare module Ext { * @param listeners Object * @param scope Object * @param options Object + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( element?:any, listeners?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -145,22 +142,20 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Save a property to the given state object if it is not its default or configured value * @param state Object The state object. * @param propName String The name of the property on this object to save. * @param value String The value of the state property (defaults to this[propName]). + * @returns Boolean The state object or a new object if state was null and the property was saved. */ addPropertyToState?( state?:any, propName?:string, value?:string ): boolean; /** [Method] Add events that will trigger the state to be saved * @param events String/String[] The event name or an array of event names. */ - addStateEvents?( events?:any ): any; - addStateEvents?( events?:string ): void; - addStateEvents?( events?:string[] ): void; + addStateEvents?( events?:any ): void; /** [Method] Method which adds a specified UI uiCls to the components element * @param ui String The UI to remove from the element. */ @@ -171,10 +166,6 @@ declare module Ext { * @param oldWidth Number/undefined The old width, or undefined if this was the initial layout. * @param oldHeight Number/undefined The old height, or undefined if this was the initial layout. */ - afterComponentLayout?( width?:any, height?:any, oldWidth?:any, oldHeight?:any ): any; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:number ): void; - afterComponentLayout?( width?:number, height?:number, oldWidth?:number, oldHeight?:any ): void; afterComponentLayout?( width?:number, height?:number, oldWidth?:any, oldHeight?:any ): void; /** [Method] Allows addition of behavior after rendering is complete */ afterRender?(): void; @@ -188,11 +179,9 @@ declare module Ext { * @param position String The position to align to * @param offsets Number[] Offset the positioning by [x, y] * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ - alignTo?( element?:any, position?:any, offsets?:any, animate?:any ): any; - alignTo?( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; - alignTo?( element?:HTMLElement, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; - alignTo?( element?:string, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; + alignTo?( element?:any, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; /** [Method] Anchors an element to another element and realigns it when the window is resized * @param element Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or id of the element to align to. * @param position String The position to align to @@ -200,14 +189,9 @@ declare module Ext { * @param animate Boolean/Object true for the default animation or a standard Element animation config object * @param monitorScroll Boolean/Number True to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay in milliseconds. * @param callback Function The function to call after the animation finishes + * @returns Ext.util.Positionable this */ - anchorTo?( element?:any, position?:any, offsets?:any, animate?:any, monitorScroll?:any, callback?:any ): any; - anchorTo?( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - anchorTo?( element?:HTMLElement, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - anchorTo?( element?:string, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - anchorTo?( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; - anchorTo?( element?:HTMLElement, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; - anchorTo?( element?:string, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; + anchorTo?( element?:any, position?:string, offsets?:number[], animate?:any, monitorScroll?:any, callback?:any ): Ext.util.IPositionable; /** [Method] Performs custom animation on this object. ... */ animate?: any; /** [Method] Applies the state to the object @@ -236,12 +220,9 @@ declare module Ext { * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to coerce into constraints instead of using this Positionable's current position. * @param local Boolean The proposedPosition is local (relative to floatParent if a floating Component) * @param proposedSize Number[] A proposed [width, height] size to use when calculating constraints instead of using this Positionable's current size. + * @returns Number[] If the element needs to be translated, the new [X, Y] position within constraints if possible, giving priority to keeping the top and left edge in the constrain region. Otherwise, false. */ - calculateConstrainedPosition?( constrainTo?:any, proposedPosition?:any, local?:any, proposedSize?:any ): any; - calculateConstrainedPosition?( constrainTo?:string, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - calculateConstrainedPosition?( constrainTo?:HTMLElement, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - calculateConstrainedPosition?( constrainTo?:Ext.IElement, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - calculateConstrainedPosition?( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; + calculateConstrainedPosition?( constrainTo?:any, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -254,7 +235,9 @@ declare module Ext { disable?( silent?:boolean ): void; /** [Method] Handles autoRender */ doAutoRender?(): void; - /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t */ + /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t + * @returns Ext.container.Container this + */ doComponentLayout?(): Ext.container.IContainer; /** [Method] Enable the component * @param silent Boolean Passing true will suppress the enable event from being fired. @@ -263,141 +246,165 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Ensures that this component is attached to document body * @param runLayout Boolean True to run the component's layout. */ ensureAttachedToBody?( runLayout?:boolean ): void; /** [Method] Retrieves plugin from this component s collection by its ptype * @param ptype String The Plugin's ptype as specified by the class's alias configuration. + * @returns Ext.AbstractPlugin plugin instance. */ findPlugin?( ptype?:string ): Ext.IAbstractPlugin; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Forces this component to redo its componentLayout */ forceComponentLayout?(): void; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - getActiveAnimation?(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - getActiveAnimation?(): boolean; + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + getActiveAnimation?(): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or id of the element to align to. * @param position String The position to align to * @param offsets Number[] Offset the positioning by [x, y] + * @returns Number[] [x, y] */ - getAlignToXY?( element?:any, position?:any, offsets?:any ): any; - getAlignToXY?( element?:Ext.util.IPositionable, position?:string, offsets?:number[] ): number[]; - getAlignToXY?( element?:HTMLElement, position?:string, offsets?:number[] ): number[]; - getAlignToXY?( element?:string, position?:string, offsets?:number[] ): number[]; + getAlignToXY?( element?:any, position?:string, offsets?:number[] ): number[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. See alignTo for details on supported anchor positions. * @param local Boolean True to get the local (element top/left-relative) anchor position instead of page coordinates * @param size Object An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size) + * @returns Number[] [x, y] An array containing the element's x and y coordinates */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): number[]; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param contentBox Boolean If true a box for the content of the element is returned. * @param local Boolean If true the element's left and top relative to its offsetParent are returned instead of page x/y. + * @returns Object box An object in the format: { x: <Element's X position>, y: <Element's Y position>, left: <Element's X position (an alias for x)>, top: <Element's Y position (an alias for y)>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. The result may also be used for setXY */ getBox?( contentBox?:boolean, local?:boolean ): any; - /** [Method] Provides the link for Observable s fireEvent method to bubble up the ownership hierarchy */ + /** [Method] Provides the link for Observable s fireEvent method to bubble up the ownership hierarchy + * @returns Ext.container.Container the Container which owns this Component. + */ getBubbleTarget?(): Ext.container.IContainer; /** [Method] Returns the X Y vector by which this Positionable s element must be translated to make a best attempt to constrain * @param constrainTo Ext.util.Positionable/HTMLElement/String/Ext.util.Region The Positionable, HTMLElement, element id, or Region into which the element is to be constrained. * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position * @param proposedSize Number[] A proposed [width, height] size to constrain instead of using the element's current size + * @returns Number[]/Boolean If the element needs to be translated, an [X, Y] vector by which this element must be translated. Otherwise, false. */ - getConstrainVector?( constrainTo?:any, proposedPosition?:any, proposedSize?:any ): any; - getConstrainVector?( constrainTo?:Ext.util.IPositionable, proposedPosition?:number[], proposedSize?:number[] ): number[]; - getConstrainVector?( constrainTo?:HTMLElement, proposedPosition?:number[], proposedSize?:number[] ): number[]; - getConstrainVector?( constrainTo?:string, proposedPosition?:number[], proposedSize?:number[] ): number[]; - getConstrainVector?( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], proposedSize?:number[] ): number[]; - /** [Method] Returns the X Y vector by which this Positionable s element must be translated to make a best attempt to constrain - * @param constrainTo Ext.util.Positionable/HTMLElement/String/Ext.util.Region The Positionable, HTMLElement, element id, or Region into which the element is to be constrained. - * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position - * @param proposedSize Number[] A proposed [width, height] size to constrain instead of using the element's current size + getConstrainVector?( constrainTo?:any, proposedPosition?:number[], proposedSize?:number[] ): any; + /** [Method] Retrieves the top level element representing this component + * @returns Ext.dom.Element */ - getConstrainVector?( constrainTo?:Ext.util.IPositionable, proposedPosition?:number[], proposedSize?:number[] ): boolean; - getConstrainVector?( constrainTo?:HTMLElement, proposedPosition?:number[], proposedSize?:number[] ): boolean; - getConstrainVector?( constrainTo?:string, proposedPosition?:number[], proposedSize?:number[] ): boolean; - getConstrainVector?( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], proposedSize?:number[] ): boolean; - /** [Method] Retrieves the top level element representing this component */ getEl?(): Ext.dom.IElement; - /** [Method] Gets the current height of the component s underlying element */ + /** [Method] Gets the current height of the component s underlying element + * @returns Number + */ getHeight?(): number; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String + */ getId?(): string; /** [Method] This function takes the position argument passed to onRender and returns a DOM element that you can use in the insert * @param position String/Number/Ext.dom.Element/HTMLElement Index, element id or element you want to put this component before. + * @returns HTMLElement DOM element that you can use in the insertBefore + */ + getInsertPosition?( position?:any ): HTMLElement; + /** [Method] Returns the value of itemId assigned to this component or when that is not set returns the value of id + * @returns String */ - getInsertPosition?( position?:any ): any; - getInsertPosition?( position?:string ): HTMLElement; - getInsertPosition?( position?:number ): HTMLElement; - getInsertPosition?( position?:Ext.dom.IElement ): HTMLElement; - getInsertPosition?( position?:HTMLElement ): HTMLElement; - /** [Method] Returns the value of itemId assigned to this component or when that is not set returns the value of id */ getItemId?(): string; - /** [Method] Gets the Ext ComponentLoader for this Component */ + /** [Method] Gets the Ext ComponentLoader for this Component + * @returns Ext.ComponentLoader The loader instance, null if it doesn't exist. + */ getLoader?(): Ext.IComponentLoader; - /** [Method] Overridden in Ext rtl AbstractComponent */ + /** [Method] Overridden in Ext rtl AbstractComponent + * @returns Number The local x coordinate + */ getLocalX?(): number; - /** [Method] Overridden in Ext rtl AbstractComponent */ + /** [Method] Overridden in Ext rtl AbstractComponent + * @returns Number[] The local XY position of the element + */ getLocalXY?(): number[]; - /** [Method] Returns the y coordinate of this element reletive to its offsetParent */ + /** [Method] Returns the y coordinate of this element reletive to its offsetParent + * @returns Number The local y coordinate + */ getLocalY?(): number; /** [Method] Returns the offsets of this element from the passed element * @param offsetsTo Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or element id to get get the offsets from. + * @returns Number[] The XY page offsets (e.g. [100, -200]) */ - getOffsetsTo?( offsetsTo?:any ): any; - getOffsetsTo?( offsetsTo?:Ext.util.IPositionable ): number[]; - getOffsetsTo?( offsetsTo?:HTMLElement ): number[]; - getOffsetsTo?( offsetsTo?:string ): number[]; + getOffsetsTo?( offsetsTo?:any ): number[]; /** [Method] Retrieves a plugin from this component s collection by its pluginId * @param pluginId String + * @returns Ext.AbstractPlugin plugin instance. */ getPlugin?( pluginId?:string ): Ext.IAbstractPlugin; - /** [Method] Returns a region object that defines the area of this element */ + /** [Method] Returns a region object that defines the area of this element + * @returns Ext.util.Region A Region containing "top, left, bottom, right" properties. + */ getRegion?(): Ext.util.IRegion; - /** [Method] Gets the current size of the component s underlying element */ + /** [Method] Gets the current size of the component s underlying element + * @returns Object An object containing the element's size {width: (element width), height: (element height)} + */ getSize?(): any; /** [Method] Returns an object that describes how this component s width and height are managed * @param ownerCtSizeModel Object + * @returns Object The size model for this component. */ getSizeModel?( ownerCtSizeModel?:any ): any; - /** [Method] The supplied default state gathering method for the AbstractComponent class */ + /** [Method] The supplied default state gathering method for the AbstractComponent class + * @returns Object + */ getState?(): any; - /** [Method] Returns the content region of this element */ + /** [Method] Returns the content region of this element + * @returns Ext.util.Region A Region containing "top, left, bottom, right" member data. + */ getViewRegion?(): Ext.util.IRegion; - /** [Method] Gets the current width of the component s underlying element */ + /** [Method] Gets the current width of the component s underlying element + * @returns Number + */ getWidth?(): number; - /** [Method] Gets the current X position of the DOM element based on page coordinates */ + /** [Method] Gets the current X position of the DOM element based on page coordinates + * @returns Number The X position of the element + */ getX?(): number; - /** [Method] Returns this Component s xtype hierarchy as a slash delimited string */ + /** [Method] Returns this Component s xtype hierarchy as a slash delimited string + * @returns String The xtype hierarchy string + */ getXTypes?(): string; - /** [Method] Gets the current position of the DOM element based on page coordinates */ + /** [Method] Gets the current position of the DOM element based on page coordinates + * @returns Number[] The XY position of the element + */ getXY?(): number[]; - /** [Method] Gets the current Y position of the DOM element based on page coordinates */ + /** [Method] Gets the current Y position of the DOM element based on page coordinates + * @returns Number The Y position of the element + */ getY?(): number; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - hasActiveFx?(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - hasActiveFx?(): boolean; + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + hasActiveFx?(): any; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param className String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ hasCls?( className?:string ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Checks if there is currently a specified uiCls @@ -406,37 +413,55 @@ declare module Ext { hasUICls?( cls?:string ): void; /** [Method] Initialize any events on this component */ initEvents?(): void; - /** [Method] Initialized the renderData to be used when rendering the renderTpl */ + /** [Method] Initialized the renderData to be used when rendering the renderTpl + * @returns Object Object with keys and values that are going to be applied to the renderTpl + */ initRenderData?(): any; /** [Method] Tests whether this Component matches the selector string * @param selector String The selector string to test against. + * @returns Boolean true if this Component matches the selector. */ is?( selector?:string ): boolean; /** [Method] Determines whether this component is the descendant of a particular container * @param container Ext.Container + * @returns Boolean true if the component is the descendant of a particular container, otherwise false. */ isDescendantOf?( container?:Ext.IContainer ): boolean; - /** [Method] Method to determine whether this Component is currently disabled */ + /** [Method] Method to determine whether this Component is currently disabled + * @returns Boolean the disabled state of this Component. + */ isDisabled?(): boolean; - /** [Method] Method to determine whether this Component is draggable */ + /** [Method] Method to determine whether this Component is draggable + * @returns Boolean the draggable state of this component. + */ isDraggable?(): boolean; - /** [Method] Method to determine whether this Component is droppable */ + /** [Method] Method to determine whether this Component is droppable + * @returns Boolean the droppable state of this component. + */ isDroppable?(): boolean; - /** [Method] Method to determine whether this Component is floating */ + /** [Method] Method to determine whether this Component is floating + * @returns Boolean the floating state of this component. + */ isFloating?(): boolean; - /** [Method] Method to determine whether this Component is currently set to hidden */ + /** [Method] Method to determine whether this Component is currently set to hidden + * @returns Boolean the hidden state of this Component. + */ isHidden?(): boolean; /** [Method] Determines whether this Component is the root of a layout */ isLayoutRoot?(): void; - /** [Method] Returns true if layout is suspended for this component */ + /** [Method] Returns true if layout is suspended for this component + * @returns Boolean true layout of this component is suspended. + */ isLayoutSuspended?(): boolean; /** [Method] Returns true if this component is visible * @param deep Boolean Pass true to interrogate the visibility status of all parent Containers to determine whether this Component is truly visible to the user. Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating dynamically laid out UIs in a hidden Container before showing them. + * @returns Boolean true if this component is visible, false otherwise. */ isVisible?( deep?:boolean ): boolean; /** [Method] Tests whether or not this Component is of a specific xtype * @param xtype String The xtype to check for this Component * @param shallow Boolean true to check whether this Component is directly of the specified xtype, false to check whether this Component is descended from the xtype. + * @returns Boolean true if this component descends from the specified xtype, false otherwise. */ isXType?( xtype?:string, shallow?:boolean ): boolean; /** [Method] Shorthand for addManagedListener @@ -445,10 +470,9 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Move the element relative to its current position * @param direction String Possible values are: "l" (or "left") "r" (or "right") "t" (or "top", or "up") "b" (or "bottom", or "down") * @param distance Number How far to move the element in pixels @@ -461,15 +485,15 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Returns the next node in the Component tree in tree traversal order * @param selector String A ComponentQuery selector to filter the following nodes. + * @returns Ext.Component The next node (or the next node which matches the selector). Returns null if there is no matching node. */ nextNode?( selector?:string ): Ext.IComponent; /** [Method] Returns the next sibling of this Component * @param selector String A ComponentQuery selector to filter the following items. + * @returns Ext.Component The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling. */ nextSibling?( selector?:string ): Ext.IComponent; /** [Method] Shorthand for addListener @@ -477,6 +501,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Method to manage awareness of when components are added to their respective Container firing an added event @@ -515,10 +540,12 @@ declare module Ext { postBlur?( e?:Ext.IEventObject ): void; /** [Method] Returns the previous node in the Component tree in tree traversal order * @param selector String A ComponentQuery selector to filter the preceding nodes. + * @returns Ext.Component The previous node (or the previous node which matches the selector). Returns null if there is no matching node. */ previousNode?( selector?:string ): Ext.IComponent; /** [Method] Returns the previous sibling of this Component * @param selector String A ComponentQuery selector to filter the preceding items. + * @returns Ext.Component The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling. */ previousSibling?( selector?:string ): Ext.IComponent; /** [Method] Called by Component doAutoRender Register a Container configured floating true with this Component s ZIndexManager @@ -529,9 +556,12 @@ declare module Ext { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; - /** [Method] Remove any anchor to this element */ + /** [Method] Remove any anchor to this element + * @returns Ext.util.Positionable this + */ removeAnchor?(): Ext.util.IPositionable; /** [Method] Removes items in the childEls array based on the return value of a supplied test function * @param testFn Function The test function. @@ -539,16 +569,13 @@ declare module Ext { removeChildEls?( testFn?:any ): void; /** [Method] Removes a CSS class from the top level element representing this component * @param cls String/String[] The CSS class name to remove. + * @returns Ext.Component Returns the Component to allow method chaining. */ - removeCls?( cls?:any ): any; - removeCls?( cls?:string ): Ext.IComponent; - removeCls?( cls?:string[] ): Ext.IComponent; + removeCls?( cls?:any ): Ext.IComponent; /** [Method] Removes a cls to the uiCls array which will also call removeUIClsFromElement and removes it from all elements of thi * @param cls String/String[] A string or an array of strings to remove to the uiCls. */ - removeClsWithUI?( cls?:any ): any; - removeClsWithUI?( cls?:string ): void; - removeClsWithUI?( cls?:string[] ): void; + removeClsWithUI?( cls?:any ): void; /** [Method] Removes an event handler * @param eventName String The type of event the handler was associated with. * @param fn Function The handler to remove. This must be a reference to the function passed into the Ext.util.Observable.addListener call. @@ -561,9 +588,7 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Method which removes a specified UI uiCls from the components element * @param ui String The UI to add to the element. */ @@ -572,13 +597,7 @@ declare module Ext { * @param container Ext.Element/HTMLElement/String The element this Component should be rendered into. If it is being created from existing markup, this should be omitted. * @param position String/Number The element ID or DOM node index within the container before which this component will be inserted (defaults to appending to the end of the container) */ - render?( container?:any, position?:any ): any; - render?( container?:Ext.IElement, position?:string ): void; - render?( container?:HTMLElement, position?:string ): void; - render?( container?:string, position?:string ): void; - render?( container?:Ext.IElement, position?:number ): void; - render?( container?:HTMLElement, position?:number ): void; - render?( container?:string, position?:number ): void; + render?( container?:any, position?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -589,28 +608,29 @@ declare module Ext { * @param propName String The name of the property to save. * @param state Object The state object in to which to save the property. * @param stateName String The name to use for the property in state. + * @returns Boolean True if the property was saved, false if not. */ savePropToState?( propName?:string, state?:any, stateName?:string ): boolean; /** [Method] Gathers additional named properties of the instance and adds their current values to the passed state object * @param propNames String/String[] The name (or array of names) of the property to save. * @param state Object The state object in to which to save the property values. + * @returns Object state */ savePropsToState?( propNames?:any, state?:any ): any; - savePropsToState?( propNames?:string, state?:any ): any; - savePropsToState?( propNames?:string[], state?:any ): any; /** [Method] Saves the state of the object to the persistence store */ saveState?(): void; - /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence */ + /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence + * @returns Object this + */ sequenceFx?(): any; /** [Method] * @param border String/Number The border, see border. If a falsey value is passed the border will be removed. */ - setBorder?( border?:any ): any; - setBorder?( border?:string ): void; - setBorder?( border?:number ): void; + setBorder?( border?:any ): void; /** [Method] Sets the element s box * @param box Object The box to fill {x, y, width, height} * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ setBox?( box?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Enable or disable the component @@ -620,73 +640,85 @@ declare module Ext { /** [Method] Sets the dock position of this component in its parent panel * @param dock Object The dock position. * @param layoutParent Boolean true to re-layout parent. + * @returns Ext.Component this */ setDocked?( dock?:any, layoutParent?:boolean ): Ext.IComponent; /** [Method] Sets the height of the component * @param height Number The new height to set. This may be one of: A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS height style. undefined to leave the height unchanged. + * @returns Ext.Component this */ setHeight?( height?:number ): Ext.IComponent; /** [Method] Overridden in Ext rtl AbstractComponent * @param x Object + * @returns Ext.util.Positionable this */ setLocalX?( x?:any ): Ext.util.IPositionable; /** [Method] Overridden in Ext rtl AbstractComponent * @param x Object * @param y Object + * @returns Ext.util.Positionable this */ setLocalXY?( x?:any, y?:any ): Ext.util.IPositionable; /** [Method] Sets the local y coordinate of this element using CSS style * @param y Object + * @returns Ext.util.Positionable this */ setLocalY?( y?:any ): Ext.util.IPositionable; /** [Method] Sets the margin on the target element * @param margin Number/String The margin to set. See the margin config. */ - setMargin?( margin?:any ): any; - setMargin?( margin?:number ): void; - setMargin?( margin?:string ): void; + setMargin?( margin?:any ): void; /** [Method] Sets the element s position and size to the specified region * @param region Ext.util.Region The region to fill * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ setRegion?( region?:Ext.util.IRegion, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the width and height of this Component * @param width Number/String/Object The new width to set. This may be one of: A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS width style. A size object in the format {width: widthValue, height: heightValue}. undefined to leave the width unchanged. * @param height Number/String The new height to set (not required if a size object is passed as the first arg). This may be one of: A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS height style. Animation may not be used. undefined to leave the height unchanged. + * @returns Ext.Component this */ - setSize?( width?:any, height?:any ): any; - setSize?( width?:any, height?:number ): Ext.IComponent; - setSize?( width?:any, height?:string ): Ext.IComponent; + setSize?( width?:any, height?:any ): Ext.IComponent; /** [Method] Sets the UI for the component * @param ui String The new UI for the component. */ setUI?( ui?:string ): void; /** [Method] Convenience function to hide or show this component by Boolean * @param visible Boolean true to show, false to hide. + * @returns Ext.Component this */ setVisible?( visible?:boolean ): Ext.IComponent; /** [Method] Sets the width of the component * @param width Number The new width to setThis may be one of: A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS width style. + * @returns Ext.Component this */ setWidth?( width?:number ): Ext.IComponent; /** [Method] Sets the X position of the DOM element based on page coordinates * @param x Object * @param animate Object + * @returns Ext.util.Positionable this */ setX?( x?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the position of the DOM element in page coordinates * @param xy Object * @param animate Object + * @returns Ext.util.Positionable this */ setXY?( xy?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the Y position of the DOM element based on page coordinates * @param y Object * @param animate Object + * @returns Ext.util.Positionable this */ setY?( y?:any, animate?:any ): Ext.util.IPositionable; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ stopAnimation?(): Ext.IElement; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ stopFx?(): Ext.IElement; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. @@ -696,15 +728,16 @@ declare module Ext { * @param queueSuspended Boolean Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events. */ suspendEvents?( queueSuspended?:boolean ): void; - /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently */ + /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently + * @returns Object this + */ syncFx?(): any; /** [Method] Translates the passed page coordinates into left top css values for the element * @param x Number/Array The page x or an array containing [x, y] * @param y Number The page y, required if x is not an array + * @returns Object An object with left and top properties. e.g. {left: (value), top: (value)} */ - translatePoints?( x?:any, y?:any ): any; - translatePoints?( x?:number, y?:number ): any; - translatePoints?( x?:any[], y?:number ): any; + translatePoints?( x?:any, y?:number ): any; /** [Method] Shorthand for removeListener * @param eventName String The type of event the handler was associated with. * @param fn Function The handler to remove. This must be a reference to the function passed into the Ext.util.Observable.addListener call. @@ -714,14 +747,9 @@ declare module Ext { /** [Method] Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed simple selector or * @param selector String/Ext.Component The simple selector component or actual component to test. If not passed the immediate owner/activater is returned. * @param limit String/Number/Ext.Component This may be a selector upon which to stop the upward scan, or a limit of teh number of steps, or Component reference to stop on. + * @returns Ext.container.Container The matching ancestor Container (or undefined if no match was found). */ - up?( selector?:any, limit?:any ): any; - up?( selector?:string, limit?:string ): Ext.container.IContainer; - up?( selector?:Ext.IComponent, limit?:string ): Ext.container.IContainer; - up?( selector?:string, limit?:number ): Ext.container.IContainer; - up?( selector?:Ext.IComponent, limit?:number ): Ext.container.IContainer; - up?( selector?:string, limit?:Ext.IComponent ): Ext.container.IContainer; - up?( selector?:Ext.IComponent, limit?:Ext.IComponent ): Ext.container.IContainer; + up?( selector?:any, limit?:any ): Ext.container.IContainer; /** [Method] Update the content area of a component * @param htmlOrData String/Object If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. If this component was not configured with a template, the components content area will be updated via Ext.Element update. * @param loadScripts Boolean Only legitimate when using the html configuration. @@ -740,13 +768,16 @@ declare module Ext { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] Cancels layout of a component * @param comp Ext.Component */ static cancelLayout( comp?:Ext.IComponent ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -755,12 +786,15 @@ declare module Ext { static createAlias( alias?:any, origin?:any ): void; /** [Method] Performs all pending layouts that were scheduled while suspendLayouts was in effect */ static flushLayouts(): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Resumes layout activity in the whole framework @@ -783,6 +817,7 @@ declare module Ext { /** [Method] Creates and returns an instance of whatever this manager manages based on the supplied type and config object * @param config Object The config object * @param defaultType String If no type is discovered in the config object, we fall back to this type + * @returns Object The instance of whatever this manager is managing */ create?( config?:any, defaultType?:string ): any; /** [Method] Executes the specified function once for each item in the collection @@ -792,12 +827,16 @@ declare module Ext { each?( fn?:any, scope?:any ): void; /** [Method] Returns an item by id * @param id String The id of the item + * @returns Object The item, undefined if not found. */ get?( id?:string ): any; - /** [Method] Gets the number of items in the collection */ + /** [Method] Gets the number of items in the collection + * @returns Number The number of items in the collection. + */ getCount?(): number; /** [Method] Checks if an item type is registered * @param type String The mnemonic string by which the class may be looked up + * @returns Boolean Whether the type is registered. */ isRegistered?( type?:string ): boolean; /** [Method] Registers a function that will be called when an item with the specified id is added to the manager @@ -837,7 +876,9 @@ declare module Ext { disable?(): void; /** [Method] The base implementation just sets the plugin s disabled flag to false Plugin subclasses which need more complex proc */ enable?(): void; - /** [Method] Returns the component to which this plugin is attached */ + /** [Method] Returns the component to which this plugin is attached + * @returns Ext.Component Owner component. + */ getCmp?(): Ext.IComponent; /** [Method] The init method is invoked after initComponent method has been run for the client Component * @param client Ext.Component The client Component which owns this plugin. @@ -932,6 +973,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -940,25 +982,24 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ @@ -966,33 +1007,37 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Determines whether this object has a request outstanding * @param request Object Defaults to the last transaction + * @returns Boolean True if there is an outstanding request. */ static isLoading( request?:any ): boolean; /** [Method] Shorthand for addManagedListener @@ -1001,34 +1046,34 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Checks if the response status was successful * @param status Number The status code + * @returns Object An object containing success/status state */ static parseStatus( status?:number ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -1043,11 +1088,10 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Sends an HTTP request to a remote server * @param options Object An object which may contain the following properties: (The options object may also contain any other property which might be needed to perform postprocessing in a callback because it is passed to callback functions.) + * @returns Object The request object. This may be used to cancel the request. */ static request( options?:any ): any; /** [Method] Resumes firing of the named event s @@ -1059,9 +1103,12 @@ declare module Ext { /** [Method] Sets various options such as the url params for the request * @param options Object The initial options * @param scope Object The scope to execute in + * @returns Object The params for the request */ static setOptions( options?:any, scope?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. @@ -1083,10 +1130,7 @@ declare module Ext { * @param params String Any extra parameters to pass * @param options Object The initial options */ - static upload( form?:any, url?:any, params?:any, options?:any ): any; - static upload( form?:string, url?:string, params?:string, options?:any ): void; - static upload( form?:HTMLElement, url?:string, params?:string, options?:any ): void; - static upload( form?:Ext.IElement, url?:string, params?:string, options?:any ): void; + static upload( form?:any, url?:string, params?:string, options?:any ): void; } } declare module Ext.app { @@ -1109,14 +1153,18 @@ declare module Ext.app { paths?: any; /** [Config Option] (Object) */ scope?: any; - /** [Method] Returns the base Ext app Application for this controller */ + /** [Method] Returns the base Ext app Application for this controller + * @returns Ext.app.Application the application + */ getApplication?(): Ext.app.IApplication; /** [Method] Returns instance of a Controller with the given id * @param name Object + * @returns Ext.app.Controller controller instance or undefined. */ getController?( name?:any ): Ext.app.IController; /** [Method] Called automatically when the page has completely loaded * @param profile String The detected application profile + * @returns Boolean By default, the Application will dispatch to the configured startup controller and action immediately after running the launch function. Return false to prevent this behavior. */ launch?( profile?:string ): boolean; } @@ -1144,6 +1192,7 @@ declare module Ext.app { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -1152,10 +1201,9 @@ declare module Ext.app { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Registers one or more references * @param refs Object/Object[] */ @@ -1172,43 +1220,51 @@ declare module Ext.app { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the base Ext app Application for this controller */ + /** [Method] Returns the base Ext app Application for this controller + * @returns Ext.app.Application the application + */ getApplication?(): Ext.app.IApplication; /** [Method] Returns instance of a Controller with the given id * @param id String + * @returns Ext.app.Controller controller instance or undefined. */ getController?( id?:string ): Ext.app.IController; /** [Method] Returns a Model class with the given name * @param name String + * @returns Ext.data.Model a model class. */ getModel?( name?:string ): Ext.data.IModel; /** [Method] Returns instance of a Store with the given name * @param name String + * @returns Ext.data.Store a store instance. */ getStore?( name?:string ): Ext.data.IStore; /** [Method] Returns a View class with the given name * @param name String + * @returns Ext.Base a view class. */ getView?( name?:string ): Ext.IBase; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Returns true if a reference is registered * @param ref Object + * @returns Boolean */ hasRef?( ref?:any ): boolean; /** [Method] A template method that is called when your application boots @@ -1225,24 +1281,22 @@ declare module Ext.app { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] A template method like init but called after the viewport is created @@ -1253,6 +1307,7 @@ declare module Ext.app { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -1267,9 +1322,7 @@ declare module Ext.app { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -1298,37 +1351,42 @@ declare module Ext.app.domain { export class Component { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] This method matches the firer of the event the target to the given selector * @param target Object * @param selector Object + * @returns Boolean true if the target matches the selector. */ static match( target?:any, selector?:any ): boolean; /** [Method] This method is called by the derived class to monitor fireEvent calls * @param observable Ext.Class The Observable to monitor for events. */ static monitor( observable?:Ext.IClass ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -1338,37 +1396,42 @@ declare module Ext.app.domain { export class Controller { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] This method matches the firer of the event the target to the given selector * @param target Object The firer of the event. * @param selector String The selector to which to match the target. + * @returns Boolean true if the target matches the selector. */ static match( target?:any, selector?:string ): boolean; /** [Method] This method is called by the derived class to monitor fireEvent calls * @param observable Ext.Class The Observable to monitor for events. */ static monitor( observable?:Ext.IClass ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -1378,37 +1441,42 @@ declare module Ext.app.domain { export class Direct { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] This method matches the firer of the event the target to the given selector * @param target Object The firer of the event. * @param selector String The selector to which to match the target. + * @returns Boolean true if the target matches the selector. */ static match( target?:any, selector?:string ): boolean; /** [Method] This method is called by the derived class to monitor fireEvent calls * @param observable Ext.Class The Observable to monitor for events. */ static monitor( observable?:Ext.IClass ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -1418,34 +1486,40 @@ declare module Ext.app.domain { export class Global { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] This method matches the firer of the event the target to the given selector */ + /** [Method] This method matches the firer of the event the target to the given selector + * @returns Boolean true if the target matches the selector. + */ static match(): boolean; /** [Method] This method is called by the derived class to monitor fireEvent calls * @param observable Ext.Class The Observable to monitor for events. */ static monitor( observable?:Ext.IClass ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -1455,37 +1529,42 @@ declare module Ext.app.domain { export class Store { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] This method matches the firer of the event the target to the given selector * @param target Object The firer of the event. * @param selector String The selector to which to match the target. + * @returns Boolean true if the target matches the selector. */ static match( target?:any, selector?:string ): boolean; /** [Method] This method is called by the derived class to monitor fireEvent calls * @param observable Ext.Class The Observable to monitor for events. */ static monitor( observable?:Ext.IClass ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -1495,19 +1574,19 @@ declare module Ext.app { export class EventBus { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Adds a set of component event listeners for a controller * @param selectors Object Config object containing selectors and listeners. * @param controller Ext.app.Controller The listening controller instance. @@ -1515,10 +1594,12 @@ declare module Ext.app { static control( selectors?:any, controller?:Ext.app.IController ): void; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Adds a set of event domain listeners for a controller @@ -1526,7 +1607,9 @@ declare module Ext.app { * @param controller Ext.app.Controller The listening controller instance. */ static listen( to?:any, controller?:Ext.app.IController ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Removes all of a controller s attached listeners * @param controllerId String The id of the controller. @@ -1543,6 +1626,7 @@ declare module Ext.app { /** [Method] This method matches the firer of the event the target to the given selector * @param target Object The firer of the event. * @param selector String The selector to which to match the target. + * @returns Boolean true if the target matches the selector. */ match?( target?:any, selector?:string ): boolean; /** [Method] This method is called by the derived class to monitor fireEvent calls @@ -1557,20 +1641,24 @@ declare module Ext { export class Array { /** [Method] Filter through an array and remove empty item as defined in Ext isEmpty See filter * @param array Array + * @returns Array results */ static clean( array?:any[] ): any[]; /** [Method] Clone a flat array without referencing the previous one * @param array Array The array + * @returns Array The clone array */ static clone( array?:any[] ): any[]; /** [Method] Checks whether or not the given array contains the specified item * @param array Array The array to check * @param item Object The item to look for + * @returns Boolean True if the array contains the item, false otherwise */ static contains( array?:any[], item?:any ): boolean; /** [Method] Perform a set difference A B by subtracting all items in array B from array A * @param arrayA Array * @param arrayB Array + * @returns Array difference */ static difference( arrayA?:any[], arrayB?:any[] ): any[]; /** [Method] Iterates an array or an iterable value and invoke the given callback function for each item @@ -1578,39 +1666,46 @@ declare module Ext { * @param fn Function The callback function. If it returns false, the iteration stops and this method returns the current index. * @param scope Object The scope (this reference) in which the specified function is executed. * @param reverse Boolean Reverse the iteration order (loop from the end to the beginning) Defaults false + * @returns Boolean See description for the fn parameter. */ static each( iterable?:any, fn?:any, scope?:any, reverse?:boolean ): boolean; /** [Method] Shallow compares the contents of 2 arrays using strict equality * @param array1 Array * @param array2 Array + * @returns Boolean true if the arrays are equal. */ static equals( array1?:any[], array2?:any[] ): boolean; /** [Method] Removes items from an array * @param array Array The Array on which to replace. * @param index Number The index in the array at which to operate. * @param removeCount Number The number of items to remove at index. + * @returns Array The array passed. */ static erase( array?:any[], index?:number, removeCount?:number ): any[]; /** [Method] Executes the specified function for each array element until the function returns a falsy value * @param array Array * @param fn Function Callback function for each item * @param scope Object Callback function scope + * @returns Boolean True if no false value is returned by the callback function. */ static every( array?:any[], fn?:any, scope?:any ): boolean; /** [Method] Creates a new array with all of the elements of this array for which the provided filtering function returns true * @param array Array * @param fn Function Callback function for each item * @param scope Object Callback function scope + * @returns Array results */ static filter( array?:any[], fn?:any, scope?:any ): any[]; /** [Method] Returns the first item in the array which elicits a true return value from the passed selection function * @param array Array The array to search * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the array + * @returns Object The first item in the array which returned true from the selection function, or null if none was found. */ static findBy( array?:any[], fn?:any, scope?:any ): any; /** [Method] Recursively flattens into 1 d Array * @param array Array The array to flatten + * @returns Array The 1-d array. */ static flatten( array?:any[] ): any[]; /** [Method] Iterates an array and invoke the given callback function for each item @@ -1622,6 +1717,7 @@ declare module Ext { /** [Method] Converts a value to an array if it s not already an array returns An empty array if given value is undefined or n * @param value Object The value to convert to an array if it's not already is an array * @param newReference Boolean True to clone the given array and return a new reference if necessary, defaults to false + * @returns Array array */ static from( value?:any, newReference?:boolean ): any[]; /** [Method] Push an item into the array only if the array doesn t contain it yet @@ -1633,65 +1729,70 @@ declare module Ext { * @param array Array The array to check * @param item Object The item to look for * @param from Number The index at which to begin the search + * @returns Number The index of item in the array (or -1 if it is not found) */ static indexOf( array?:any[], item?:any, from?:number ): number; /** [Method] Inserts items in to an array * @param array Array The Array in which to insert. * @param index Number The index in the array at which to operate. * @param items Array The array of items to insert at index. + * @returns Array The array passed. */ static insert( array?:any[], index?:number, items?:any[] ): any[]; /** [Method] Merge multiple arrays into one with unique items that exist in all of the arrays * @param array1 Array * @param array2 Array * @param etc Array + * @returns Array intersect */ static intersect( array1?:any[], array2?:any[], etc?:any[] ): any[]; /** [Method] Creates a new array with the results of calling a provided function on every element in this array * @param array Array * @param fn Function Callback function for each item * @param scope Object Callback function scope + * @returns Array results */ static map( array?:any[], fn?:any, scope?:any ): any[]; /** [Method] Returns the maximum value in the Array * @param array Array/NodeList The Array from which to select the maximum value. * @param comparisonFn Function a function to perform the comparision which determines maximization. If omitted the ">" operator will be used. Note: gt = 1; eq = 0; lt = -1 + * @returns Object maxValue The maximum value */ static max( array?:any, comparisonFn?:any ): any; - static max( array?:any[], comparisonFn?:any ): any; - static max( array?:NodeList, comparisonFn?:any ): any; /** [Method] Calculates the mean of all items in the array * @param array Array The Array to calculate the mean value of. + * @returns Number The mean. */ static mean( array?:any[] ): number; /** [Method] Merge multiple arrays into one with unique items * @param array1 Array * @param array2 Array * @param etc Array + * @returns Array merged */ static merge( array1?:any[], array2?:any[], etc?:any[] ): any[]; /** [Method] Returns the minimum value in the Array * @param array Array/NodeList The Array from which to select the minimum value. * @param comparisonFn Function a function to perform the comparision which determines minimization. If omitted the "<" operator will be used. Note: gt = 1; eq = 0; lt = -1 + * @returns Object minValue The minimum value */ static min( array?:any, comparisonFn?:any ): any; - static min( array?:any[], comparisonFn?:any ): any; - static min( array?:NodeList, comparisonFn?:any ): any; /** [Method] Plucks the value of a property from each item in the Array * @param array Array/NodeList The Array of items to pluck the value from. * @param propertyName String The property name to pluck from each element. + * @returns Array The value from each item in the Array. */ - static pluck( array?:any, propertyName?:any ): any; - static pluck( array?:any[], propertyName?:string ): any[]; - static pluck( array?:NodeList, propertyName?:string ): any[]; + static pluck( array?:any, propertyName?:string ): any[]; /** [Method] Pushes new items onto the end of an Array * @param target Array The Array onto which to push new items * @param elements Object... The elements to add to the array. Each parameter may be an Array, in which case all the elements of that Array will be pushed into the end of the destination Array. + * @returns Array An array containing all the new items push onto the end. */ static push( target:any[], ...elements:any[] ): any[]; /** [Method] Removes the specified item from the array if it exists * @param array Array The array * @param item Object The item to remove + * @returns Array The passed array itself */ static remove( array?:any[], item?:any ): any[]; /** [Method] Replaces items in an array @@ -1699,23 +1800,27 @@ declare module Ext { * @param index Number The index in the array at which to operate. * @param removeCount Number The number of items to remove at index (can be 0). * @param insert Array An array of items to insert at index. + * @returns Array The array passed. */ static replace( array?:any[], index?:number, removeCount?:number, insert?:any[] ): any[]; /** [Method] Returns a shallow copy of a part of an array * @param array Array The array (or arguments object). * @param begin Number The index at which to begin. Negative values are offsets from the end of the array. * @param end Number The index at which to end. The copied items do not include end. Negative values are offsets from the end of the array. If end is omitted, all items up to the end of the array are copied. + * @returns Array The copied piece of the array. */ static slice( array?:any[], begin?:number, end?:number ): any[]; /** [Method] Executes the specified function for each array element until the function returns a truthy value * @param array Array * @param fn Function Callback function for each item * @param scope Object Callback function scope + * @returns Boolean True if the callback function returns a truthy value. */ static some( array?:any[], fn?:any, scope?:any ): boolean; /** [Method] Sorts the elements of an Array * @param array Array The array to sort. * @param sortFn Function The comparison function. + * @returns Array The sorted array. */ static sort( array?:any[], sortFn?:any ): any[]; /** [Method] Replaces items in an array @@ -1723,42 +1828,45 @@ declare module Ext { * @param index Number The index in the array at which to operate. * @param removeCount Number The number of items to remove at index (can be 0). * @param elements Object... The elements to add to the array. If you don't specify any elements, splice simply removes elements from the array. + * @returns Array An array containing the removed items. */ static splice( array:any[], index:number, removeCount:number, ...elements:any[] ): any[]; /** [Method] Calculates the sum of all items in the given array * @param array Array The Array to calculate the sum value of. + * @returns Number The sum. */ static sum( array?:any[] ): number; /** [Method] Converts any iterable numeric indices and a length property into a true array * @param iterable Object the iterable object to be turned into a true Array. * @param start Number a zero-based index that specifies the start of extraction. Defaults to 0 * @param end Number a 1-based index that specifies the end of extraction. Defaults to the last index of the iterable value + * @returns Array array */ static toArray( iterable?:any, start?:number, end?:number ): any[]; /** [Method] Creates a map object keyed by the elements of the given array * @param array Array The Array to create the map from. * @param getKey String/Function Name of the object property to use as a key or a function to extract the key. * @param scope Object Value of this inside callback. + * @returns Object The resulting map. */ - static toMap( array?:any, getKey?:any, scope?:any ): any; - static toMap( array?:any[], getKey?:string, scope?:any ): any; static toMap( array?:any[], getKey?:any, scope?:any ): any; /** [Method] Creates a map object keyed by a property of elements of the given array * @param array Array The Array to create the map from. * @param getKey String/Function Name of the object property to use as a key or a function to extract the key. * @param scope Object Value of this inside callback. + * @returns Object The resulting map. */ - static toValueMap( array?:any, getKey?:any, scope?:any ): any; - static toValueMap( array?:any[], getKey?:string, scope?:any ): any; static toValueMap( array?:any[], getKey?:any, scope?:any ): any; /** [Method] Merge multiple arrays into one with unique items * @param array1 Array * @param array2 Array * @param etc Array + * @returns Array merged */ static union( array1?:any[], array2?:any[], etc?:any[] ): any[]; /** [Method] Returns a new array with unique items * @param array Array + * @returns Array results */ static unique( array?:any[] ): any[]; } @@ -1769,25 +1877,27 @@ declare module Ext { self?: Ext.IClass; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ callOverridden?( args?:any ): any; - callOverridden?( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ callParent?( args?:any ): any; - callParent?( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ callSuper?( args?:any ): any; - callSuper?( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ getInitialConfig?( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ initConfig?( config?:any ): Ext.IBase; } @@ -1798,21 +1908,27 @@ declare module Ext { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter * @param origin String/Object The original method name */ static createAlias( alias?:any, origin?:any ): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -1915,31 +2031,37 @@ declare module Ext.button { template?: Ext.ITemplate; /** [Method] Retrieves the first direct child of this container which matches the passed selector or component * @param selector String/Ext.Component An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching child Ext.Component (or null if no match was found). */ child?( selector?:any ): any; - child?( selector?:string ): any; - child?( selector?:Ext.IComponent ): any; /** [Method] inherit docs * @param silent Object */ disable?( silent?:any ): void; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String/Ext.Component An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching descendant Ext.Component (or null if no match was found). */ down?( selector?:any ): any; - down?( selector?:string ): any; - down?( selector?:Ext.IComponent ): any; /** [Method] inherit docs * @param silent Object */ enable?( silent?:any ): void; - /** [Method] This method returns an object which provides substitution parameters for the XTemplate used to create this Button s D */ + /** [Method] This method returns an object which provides substitution parameters for the XTemplate used to create this Button s D + * @returns Object Substitution data for a Template. The default implementation which provides data for the default template returns an Object containing the following properties: + */ getTemplateArgs?(): any; - /** [Method] Gets the text for this Button */ + /** [Method] Gets the text for this Button + * @returns String The button text + */ getText?(): string; - /** [Method] Returns true if the button has a menu and it is visible */ + /** [Method] Returns true if the button has a menu and it is visible + * @returns Boolean + */ hasVisibleMenu?(): boolean; - /** [Method] Hides this button s menu if it has one */ + /** [Method] Hides this button s menu if it has one + * @returns Ext.button.Button this + */ hideMenu?(): Ext.button.IButton; /** [Method] inherit docs */ initComponent?(): void; @@ -1947,26 +2069,29 @@ declare module Ext.button { onDisable?(): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned. + * @returns Ext.Component[] Components which matched the selector */ query?( selector?:string ): Ext.IComponent[]; /** [Method] Retrieves all descendant components which match the passed function * @param fn Function The matcher function. It will be called with a single argument, the component being tested. * @param scope Object The scope in which to run the function. If not specified, it will default to the active component. + * @returns Ext.Component[] Components matched by the passed function */ queryBy?( fn?:any, scope?:any ): Ext.IComponent[]; /** [Method] Finds a component at any level under this container matching the id itemId * @param id String The id to find + * @returns Ext.Component The matching id, null if not found */ queryById?( id?:string ): Ext.IComponent; /** [Method] Sets this button s glyph * @param glyph Number/String the numeric charCode or string charCode/font-family. This parameter expects a format consistent with that of glyph + * @returns Ext.button.Button this */ - setGlyph?( glyph?:any ): any; - setGlyph?( glyph?:number ): Ext.button.IButton; - setGlyph?( glyph?:string ): Ext.button.IButton; + setGlyph?( glyph?:any ): Ext.button.IButton; /** [Method] Assigns this Button s click handler * @param handler Function The function to call when the button is clicked * @param scope Object The scope (this reference) in which the handler function is executed. Defaults to this Button. + * @returns Ext.button.Button this */ setHandler?( handler?:any, scope?:any ): Ext.button.IButton; /** [Method] Sets the href of the embedded anchor element to the passed URL @@ -1975,10 +2100,12 @@ declare module Ext.button { setHref?( href?:string ): void; /** [Method] Sets the background image inline style of the button * @param icon String The path to an image to display in the button + * @returns Ext.button.Button this */ setIcon?( icon?:string ): Ext.button.IButton; /** [Method] Sets the CSS class that provides a background image to use as the button s icon * @param cls String The CSS class providing the icon image + * @returns Ext.button.Button this */ setIconCls?( cls?:string ): Ext.button.IButton; /** [Method] Sets the href of the link dynamically according to the params passed and any baseParams configured @@ -1991,6 +2118,7 @@ declare module Ext.button { setScale?( scale?:string ): void; /** [Method] Sets this Button s text * @param text String The button text + * @returns Ext.button.Button this */ setText?( text?:string ): Ext.button.IButton; /** [Method] Sets the text alignment for this button @@ -1999,6 +2127,7 @@ declare module Ext.button { setTextAlign?( align?:string ): void; /** [Method] Sets the tooltip for this Button * @param tooltip String/Object This may be: String : A string to be used as innerHTML (html tags are accepted) to show in a tooltip Object : A configuration object for Ext.tip.QuickTipManager.register. + * @returns Ext.button.Button this */ setTooltip?( tooltip?:any ): Ext.button.IButton; /** [Method] inherit docs @@ -2012,6 +2141,7 @@ declare module Ext.button { /** [Method] If a state it passed it becomes the pressed state otherwise the current state is toggled * @param state Boolean Force a particular state * @param suppressEvent Boolean True to stop events being fired when calling this method. + * @returns Ext.button.Button this */ toggle?( state?:boolean, suppressEvent?:boolean ): Ext.button.IButton; } @@ -2114,31 +2244,37 @@ declare module Ext { template?: Ext.ITemplate; /** [Method] Retrieves the first direct child of this container which matches the passed selector or component * @param selector String/Ext.Component An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching child Ext.Component (or null if no match was found). */ child?( selector?:any ): any; - child?( selector?:string ): any; - child?( selector?:Ext.IComponent ): any; /** [Method] inherit docs * @param silent Object */ disable?( silent?:any ): void; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String/Ext.Component An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching descendant Ext.Component (or null if no match was found). */ down?( selector?:any ): any; - down?( selector?:string ): any; - down?( selector?:Ext.IComponent ): any; /** [Method] inherit docs * @param silent Object */ enable?( silent?:any ): void; - /** [Method] This method returns an object which provides substitution parameters for the XTemplate used to create this Button s D */ + /** [Method] This method returns an object which provides substitution parameters for the XTemplate used to create this Button s D + * @returns Object Substitution data for a Template. The default implementation which provides data for the default template returns an Object containing the following properties: + */ getTemplateArgs?(): any; - /** [Method] Gets the text for this Button */ + /** [Method] Gets the text for this Button + * @returns String The button text + */ getText?(): string; - /** [Method] Returns true if the button has a menu and it is visible */ + /** [Method] Returns true if the button has a menu and it is visible + * @returns Boolean + */ hasVisibleMenu?(): boolean; - /** [Method] Hides this button s menu if it has one */ + /** [Method] Hides this button s menu if it has one + * @returns Ext.button.Button this + */ hideMenu?(): Ext.button.IButton; /** [Method] inherit docs */ initComponent?(): void; @@ -2146,26 +2282,29 @@ declare module Ext { onDisable?(): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned. + * @returns Ext.Component[] Components which matched the selector */ query?( selector?:string ): Ext.IComponent[]; /** [Method] Retrieves all descendant components which match the passed function * @param fn Function The matcher function. It will be called with a single argument, the component being tested. * @param scope Object The scope in which to run the function. If not specified, it will default to the active component. + * @returns Ext.Component[] Components matched by the passed function */ queryBy?( fn?:any, scope?:any ): Ext.IComponent[]; /** [Method] Finds a component at any level under this container matching the id itemId * @param id String The id to find + * @returns Ext.Component The matching id, null if not found */ queryById?( id?:string ): Ext.IComponent; /** [Method] Sets this button s glyph * @param glyph Number/String the numeric charCode or string charCode/font-family. This parameter expects a format consistent with that of glyph + * @returns Ext.button.Button this */ - setGlyph?( glyph?:any ): any; - setGlyph?( glyph?:number ): Ext.button.IButton; - setGlyph?( glyph?:string ): Ext.button.IButton; + setGlyph?( glyph?:any ): Ext.button.IButton; /** [Method] Assigns this Button s click handler * @param handler Function The function to call when the button is clicked * @param scope Object The scope (this reference) in which the handler function is executed. Defaults to this Button. + * @returns Ext.button.Button this */ setHandler?( handler?:any, scope?:any ): Ext.button.IButton; /** [Method] Sets the href of the embedded anchor element to the passed URL @@ -2174,10 +2313,12 @@ declare module Ext { setHref?( href?:string ): void; /** [Method] Sets the background image inline style of the button * @param icon String The path to an image to display in the button + * @returns Ext.button.Button this */ setIcon?( icon?:string ): Ext.button.IButton; /** [Method] Sets the CSS class that provides a background image to use as the button s icon * @param cls String The CSS class providing the icon image + * @returns Ext.button.Button this */ setIconCls?( cls?:string ): Ext.button.IButton; /** [Method] Sets the href of the link dynamically according to the params passed and any baseParams configured @@ -2190,6 +2331,7 @@ declare module Ext { setScale?( scale?:string ): void; /** [Method] Sets this Button s text * @param text String The button text + * @returns Ext.button.Button this */ setText?( text?:string ): Ext.button.IButton; /** [Method] Sets the text alignment for this button @@ -2198,6 +2340,7 @@ declare module Ext { setTextAlign?( align?:string ): void; /** [Method] Sets the tooltip for this Button * @param tooltip String/Object This may be: String : A string to be used as innerHTML (html tags are accepted) to show in a tooltip Object : A configuration object for Ext.tip.QuickTipManager.register. + * @returns Ext.button.Button this */ setTooltip?( tooltip?:any ): Ext.button.IButton; /** [Method] inherit docs @@ -2211,6 +2354,7 @@ declare module Ext { /** [Method] If a state it passed it becomes the pressed state otherwise the current state is toggled * @param state Boolean Force a particular state * @param suppressEvent Boolean True to stop events being fired when calling this method. + * @returns Ext.button.Button this */ toggle?( state?:boolean, suppressEvent?:boolean ): Ext.button.IButton; } @@ -2231,7 +2375,9 @@ declare module Ext.button { showText?: boolean; /** [Property] (Ext.menu.Menu) */ menu?: Ext.menu.IMenu; - /** [Method] Gets the currently active menu item */ + /** [Method] Gets the currently active menu item + * @returns Ext.menu.CheckItem The active item + */ getActiveItem?(): Ext.menu.ICheckItem; /** [Method] Sets the button s active menu item * @param item Ext.menu.CheckItem The item to activate @@ -2258,7 +2404,9 @@ declare module Ext { showText?: boolean; /** [Property] (Ext.menu.Menu) */ menu?: Ext.menu.IMenu; - /** [Method] Gets the currently active menu item */ + /** [Method] Gets the currently active menu item + * @returns Ext.menu.CheckItem The active item + */ getActiveItem?(): Ext.menu.ICheckItem; /** [Method] Sets the button s active menu item * @param item Ext.menu.CheckItem The item to activate @@ -2275,28 +2423,32 @@ declare module Ext.button { export class Manager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -2306,28 +2458,32 @@ declare module Ext { export class ButtonToggleManager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -2580,6 +2736,7 @@ declare module Ext.chart { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -2588,10 +2745,9 @@ declare module Ext.chart { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Binds a store to this instance * @param store Object * @param initial Object @@ -2608,25 +2764,30 @@ declare module Ext.chart { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Gets the current store instance */ + /** [Method] Gets the current store instance + * @returns Ext.data.AbstractStore The store, null if one does not exist. + */ getStore?(): Ext.data.IAbstractStore; - /** [Method] Gets the listeners to bind to a new store */ + /** [Method] Gets the listeners to bind to a new store + * @returns Object The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance. + */ getStoreListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] The initComponent template method is an important initialization step for a Component */ @@ -2637,24 +2798,22 @@ declare module Ext.chart { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Template method it is called when a new store is bound to the current instance @@ -2677,6 +2836,7 @@ declare module Ext.chart { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -2691,9 +2851,7 @@ declare module Ext.chart { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Restores the zoom to the original value */ restoreZoom?(): void; /** [Method] Resumes firing of the named event s @@ -2704,6 +2862,7 @@ declare module Ext.chart { resumeEvents?(): void; /** [Method] Saves the chart by either triggering a download or returning a string containing the chart data as SVG * @param config Object The configuration to be passed to the exporter. See the export method for the appropriate exporter for the relevant configuration options + * @returns Object See the return types for the appropriate exporter */ save?( config?:any ): any; /** [Method] Zooms the chart to the specified selection range @@ -2753,6 +2912,7 @@ declare module Ext.chart { * @param item Object The item related to the sprite. An item is an object containing the position of the shape used to describe the visualization and also pointing to the actual shape (circle, rectangle, path, etc). * @param i Number The index of the element created (i.e the first created label, second created label, etc). * @param display String The label.display type. May be false if the label is hidden + * @returns Ext.draw.Sprite The created sprite that will draw the label. */ onCreateLabel?( storeItem?:Ext.data.IModel, item?:any, i?:number, display?:string ): Ext.draw.ISprite; /** [Method] Called for updating the position of the label @@ -3009,13 +3169,21 @@ declare module Ext.chart.series { * @param scope Object */ eachYValue?( record?:Ext.data.IModel, fn?:any, scope?:any ): void; - /** [Method] Calculate the min and max values for this series s xField */ + /** [Method] Calculate the min and max values for this series s xField + * @returns Array [min, max] + */ getMinMaxXValues?(): any[]; - /** [Method] Calculate the min and max values for this series s yField s */ + /** [Method] Calculate the min and max values for this series s yField s + * @returns Array [min, max] + */ getMinMaxYValues?(): any[]; - /** [Method] Returns an array of functions each of which returns the value of the yField corresponding to function s index in the */ + /** [Method] Returns an array of functions each of which returns the value of the yField corresponding to function s index in the + * @returns Array array of accessor functions + */ getYValueAccessors?(): any[]; - /** [Method] Returns the number of yField values taking into account fields combined via legend drag drop */ + /** [Method] Returns the number of yField values taking into account fields combined via legend drag drop + * @returns Number + */ getYValueCount?(): number; } } @@ -3033,13 +3201,21 @@ declare module Ext.chart { * @param scope Object */ eachYValue?( record?:Ext.data.IModel, fn?:any, scope?:any ): void; - /** [Method] Calculate the min and max values for this series s xField */ + /** [Method] Calculate the min and max values for this series s xField + * @returns Array [min, max] + */ getMinMaxXValues?(): any[]; - /** [Method] Calculate the min and max values for this series s yField s */ + /** [Method] Calculate the min and max values for this series s yField s + * @returns Array [min, max] + */ getMinMaxYValues?(): any[]; - /** [Method] Returns an array of functions each of which returns the value of the yField corresponding to function s index in the */ + /** [Method] Returns an array of functions each of which returns the value of the yField corresponding to function s index in the + * @returns Array array of accessor functions + */ getYValueAccessors?(): any[]; - /** [Method] Returns the number of yField values taking into account fields combined via legend drag drop */ + /** [Method] Returns the number of yField values taking into account fields combined via legend drag drop + * @returns Number + */ getYValueCount?(): number; } } @@ -3057,13 +3233,21 @@ declare module Ext.chart { * @param scope Object */ eachYValue?( record?:Ext.data.IModel, fn?:any, scope?:any ): void; - /** [Method] Calculate the min and max values for this series s xField */ + /** [Method] Calculate the min and max values for this series s xField + * @returns Array [min, max] + */ getMinMaxXValues?(): any[]; - /** [Method] Calculate the min and max values for this series s yField s */ + /** [Method] Calculate the min and max values for this series s yField s + * @returns Array [min, max] + */ getMinMaxYValues?(): any[]; - /** [Method] Returns an array of functions each of which returns the value of the yField corresponding to function s index in the */ + /** [Method] Returns an array of functions each of which returns the value of the yField corresponding to function s index in the + * @returns Array array of accessor functions + */ getYValueAccessors?(): any[]; - /** [Method] Returns the number of yField values taking into account fields combined via legend drag drop */ + /** [Method] Returns the number of yField values taking into account fields combined via legend drag drop + * @returns Number + */ getYValueCount?(): number; } } @@ -3384,6 +3568,7 @@ declare module Ext.chart.series { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -3392,10 +3577,9 @@ declare module Ext.chart.series { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -3408,22 +3592,23 @@ declare module Ext.chart.series { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] For a given x y point relative to the Surface find a corresponding item from this series if any * @param x Number * @param y Number + * @returns Object An object describing the item, or null if there is no matching item. The exact contents of this object will vary by series type, but should always contain the following: */ getItemForPoint?( x?:number, y?:number ): any; /** [Method] Returns a string with the color to be used for the series legend item @@ -3434,6 +3619,7 @@ declare module Ext.chart.series { getRecordCount?(): void; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Hides all the elements in the series */ @@ -3452,24 +3638,22 @@ declare module Ext.chart.series { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Called each time a new label is created @@ -3477,6 +3661,7 @@ declare module Ext.chart.series { * @param item Object The item related to the sprite. An item is an object containing the position of the shape used to describe the visualization and also pointing to the actual shape (circle, rectangle, path, etc). * @param i Number The index of the element created (i.e the first created label, second created label, etc). * @param display String The label.display type. May be false if the label is hidden + * @returns Ext.draw.Sprite The created sprite that will draw the label. */ onCreateLabel?( storeItem?:Ext.data.IModel, item?:any, i?:number, display?:string ): Ext.draw.ISprite; /** [Method] Called for updating the position of the label @@ -3493,6 +3678,7 @@ declare module Ext.chart.series { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -3507,9 +3693,7 @@ declare module Ext.chart.series { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -3547,28 +3731,32 @@ declare module Ext.chart { export class Shape { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -3618,10 +3806,12 @@ declare module Ext { export class ClassManager { /** [Method] Adds a batch of class name to alias mappings * @param aliases Object The set of mappings of the form className : [values...] + * @returns Ext.ClassManager this */ static addNameAliasMappings( aliases?:any ): Ext.IClassManager; /** [Method] * @param alternates Object The set of mappings of the form className : [values...] + * @returns Ext.ClassManager this */ static addNameAlternateMappings( alternates?:any ): Ext.IClassManager; /** [Method] Defines a class @@ -3632,61 +3822,72 @@ declare module Ext { static create( className?:any, data?:any, createdFn?:any ): void; /** [Method] Retrieve a class by its name * @param name String + * @returns Ext.Class class */ static get( name?:string ): Ext.IClass; /** [Method] Get the aliases of a class by the class name * @param name String + * @returns Array aliases */ static getAliasesByName( name?:string ): any[]; /** [Method] Get a reference to the class by its alias * @param alias String + * @returns Ext.Class class */ static getByAlias( alias?:string ): Ext.IClass; /** [Method] Get the class of the provided object returns null if it s not an instance of any class created with Ext define * @param object Object + * @returns Ext.Class class */ static getClass( object?:any ): Ext.IClass; /** [Method] Returns the displayName property or className or object * @param object Object + * @returns String */ static getDisplayName( object?:any ): string; /** [Method] Get the name of the class by its reference or its instance getName is usually invoked by the shorthand Ext getClass * @param object Ext.Class/Object + * @returns String className */ static getName( object?:any ): string; /** [Method] Get the name of a class by its alias * @param alias String + * @returns String className */ static getNameByAlias( alias?:string ): string; /** [Method] Get the name of a class by its alternate name * @param alternate String + * @returns String className */ static getNameByAlternate( alternate?:string ): string; /** [Method] Converts a string expression to an array of matching class names * @param expression String + * @returns String[] classNames */ static getNamesByExpression( expression?:string ): string[]; /** [Method] Instantiate a class by its alias * @param alias String * @param args Object... Additional arguments after the alias will be passed to the class constructor. + * @returns Object instance */ static instantiateByAlias( alias:string, ...args:any[] ): any; /** [Method] Checks if a class has already been created * @param className String + * @returns Boolean exist */ static isCreated( className?:string ): boolean; /** [Method] Sets a name reference to a class * @param name String * @param value Object + * @returns Ext.ClassManager this */ static set( name?:string, value?:any ): Ext.IClassManager; /** [Method] Register the alias for a class * @param cls Ext.Class/String a reference to a class or a className * @param alias String Alias to use when referring to this class + * @returns Ext.ClassManager this */ - static setAlias( cls?:any, alias?:any ): any; - static setAlias( cls?:Ext.IClass, alias?:string ): Ext.IClassManager; - static setAlias( cls?:string, alias?:string ): Ext.IClassManager; + static setAlias( cls?:any, alias?:string ): Ext.IClassManager; /** [Method] Creates a namespace and assign the value to the created object Ext ClassManager setNamespace MyCompany pkg Example * @param name String * @param value Object @@ -3749,9 +3950,7 @@ declare module Ext { * @param callback Function * @param scope Object */ - afterShow?( animateTarget?:any, callback?:any, scope?:any ): any; - afterShow?( animateTarget?:string, callback?:any, scope?:any ): void; - afterShow?( animateTarget?:Ext.IElement, callback?:any, scope?:any ): void; + afterShow?( animateTarget?:any, callback?:any, scope?:any ): void; /** [Method] Occurs before componentLayout is run */ beforeLayout?(): void; /** [Method] Invoked before the Component is shown */ @@ -3760,62 +3959,66 @@ declare module Ext { * @param fn Function The function to call * @param scope Object The scope of the function. Defaults to current node. * @param args Array The args to call the function with. Defaults to passing the current component. + * @returns Ext.Component this */ bubble?( fn?:any, scope?:any, args?:any[] ): Ext.IComponent; /** [Method] Cancel any deferred focus on this component */ cancelFocus?(): void; - /** [Method] Center this Component in its container */ + /** [Method] Center this Component in its container + * @returns Ext.Component this + */ center?(): Ext.IComponent; /** [Method] Clone the current component using the original config values passed into this instance by default * @param overrides Object A new config containing any properties to override in the cloned version. An id property can be passed on this object, otherwise one will be generated to avoid duplicates. + * @returns Ext.Component clone The cloned copy of this component */ cloneConfig?( overrides?:any ): Ext.IComponent; /** [Method] Moves this floating Component into a constrain region * @param constrainTo String/HTMLElement/Ext.Element/Ext.util.Region The Element or Region into which this Component is to be constrained. Defaults to the element into which this floating Component was rendered. */ - doConstrain?( constrainTo?:any ): any; - doConstrain?( constrainTo?:string ): void; - doConstrain?( constrainTo?:HTMLElement ): void; - doConstrain?( constrainTo?:Ext.IElement ): void; - doConstrain?( constrainTo?:Ext.util.IRegion ): void; + doConstrain?( constrainTo?:any ): void; /** [Method] Find a container above this component at any level by a custom function * @param fn Function The custom function to call with the arguments (container, this component). + * @returns Ext.container.Container The first Container for which the custom function returns true */ findParentBy?( fn?:any ): Ext.container.IContainer; /** [Method] Find a container above this component at any level by xtype or class See also the up method * @param xtype String/Ext.Class The xtype string for a component, or the class of the component directly + * @returns Ext.container.Container The first Container which matches the given xtype or class */ - findParentByType?( xtype?:any ): any; - findParentByType?( xtype?:string ): Ext.container.IContainer; - findParentByType?( xtype?:Ext.IClass ): Ext.container.IContainer; + findParentByType?( xtype?:any ): Ext.container.IContainer; /** [Method] Try to focus this component * @param selectText Boolean If applicable, true to also select the text in this component * @param delay Boolean/Number Delay the focus this number of milliseconds (true for 10 milliseconds). * @param callback Function Only needed if the delay parameter is used. A function to call upon focus. * @param scope Function Only needed if the delay parameter is used. The scope (this reference) in which to execute the callback. + * @returns Ext.Component The focused Component. Usually this Component. Some Containers may delegate focus to a descendant Component (Windows can do this through their defaultFocus config option. + */ + focus?( selectText?:boolean, delay?:any, callback?:any, scope?:any ): Ext.IComponent; + /** [Method] Retrieves the top level element representing this component + * @returns Ext.dom.Element */ - focus?( selectText?:any, delay?:any, callback?:any, scope?:any ): any; - focus?( selectText?:boolean, delay?:boolean, callback?:any, scope?:any ): Ext.IComponent; - focus?( selectText?:boolean, delay?:number, callback?:any, scope?:any ): Ext.IComponent; - /** [Method] Retrieves the top level element representing this component */ getEl?(): Ext.dom.IElement; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String + */ getId?(): string; /** [Method] Gets the current XY position of the component s underlying element * @param local Boolean If true the element's left and top are returned instead of page XY. + * @returns Number[] The XY position of the element (e.g., [100, 200]) */ getPosition?( local?:boolean ): number[]; - /** [Method] Gets the xtype for this component as registered with Ext ComponentManager */ + /** [Method] Gets the xtype for this component as registered with Ext ComponentManager + * @returns String The xtype + */ getXType?(): string; /** [Method] Hides this Component setting it to invisible using the configured hideMode * @param animateTarget String/Ext.Element/Ext.Component only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured with floating: true.. The target to which the Component should animate while hiding. * @param callback Function A callback function to call after the Component is hidden. * @param scope Object The scope (this reference) in which the callback is executed. Defaults to this Component. + * @returns Ext.Component this */ - hide?( animateTarget?:any, callback?:any, scope?:any ): any; - hide?( animateTarget?:string, callback?:any, scope?:any ): Ext.IComponent; - hide?( animateTarget?:Ext.IElement, callback?:any, scope?:any ): Ext.IComponent; - hide?( animateTarget?:Ext.IComponent, callback?:any, scope?:any ): Ext.IComponent; + hide?( animateTarget?:any, callback?:any, scope?:any ): Ext.IComponent; /** [Method] The initComponent template method is an important initialization step for a Component */ initComponent?(): void; /** [Method] Method to manage awareness of when components are added to their respective Container firing an added event */ @@ -3827,18 +4030,13 @@ declare module Ext { * @param callback Function * @param scope Object */ - onHide?( animateTarget?:any, callback?:any, scope?:any ): any; - onHide?( animateTarget?:string, callback?:any, scope?:any ): void; - onHide?( animateTarget?:Ext.IElement, callback?:any, scope?:any ): void; - onHide?( animateTarget?:Ext.IComponent, callback?:any, scope?:any ): void; + onHide?( animateTarget?:any, callback?:any, scope?:any ): void; /** [Method] Allows addition of behavior to the show operation * @param animateTarget String/Ext.Element * @param callback Function * @param scope Object */ - onShow?( animateTarget?:any, callback?:any, scope?:any ): any; - onShow?( animateTarget?:string, callback?:any, scope?:any ): void; - onShow?( animateTarget?:Ext.IElement, callback?:any, scope?:any ): void; + onShow?( animateTarget?:any, callback?:any, scope?:any ): void; /** [Method] Invoked after the afterShow method is complete * @param callback Function * @param scope Object @@ -3857,72 +4055,78 @@ declare module Ext { setActive?( active?:boolean, newActive?:Ext.IComponent ): void; /** [Method] Sets the overflow on the content element of the component * @param scroll Boolean True to allow the Component to auto scroll. + * @returns Ext.Component this */ setAutoScroll?( scroll?:boolean ): Ext.IComponent; /** [Method] This method changes the region config property for this border region * @param region String The new region value ("north", "south", "east" or "west"). + * @returns String The previous value of the region property. */ setBorderRegion?( region?:string ): string; /** [Method] This method allows you to show or hide a LoadMask on top of this component * @param load Boolean/Object/String True to show the default LoadMask, a config object that will be passed to the LoadMask constructor, or a message String to show. False to hide the current LoadMask. * @param targetEl Boolean True to mask the targetEl of this Component instead of the this.el. For example, setting this to true on a Panel will cause only the body to be masked. + * @returns Ext.LoadMask The LoadMask instance that has just been shown. */ setLoading?( load?:any, targetEl?:boolean ): Ext.ILoadMask; /** [Method] Sets the overflow x y on the content element of the component * @param overflowX String The overflow-x value. * @param overflowY String The overflow-y value. + * @returns Ext.Component this */ setOverflowXY?( overflowX?:string, overflowY?:string ): Ext.IComponent; /** [Method] Sets the page XY position of the component * @param x Number/Number[] The new x position or an array of [x,y]. * @param y Number The new y position. * @param animate Boolean/Object True to animate the Component into its new position. You may also pass an animation configuration. + * @returns Ext.Component this */ - setPagePosition?( x?:any, y?:any, animate?:any ): any; - setPagePosition?( x?:number, y?:number, animate?:any ): Ext.IComponent; - setPagePosition?( x?:number[], y?:number, animate?:any ): Ext.IComponent; + setPagePosition?( x?:any, y?:number, animate?:any ): Ext.IComponent; /** [Method] Sets the left and top of the component * @param x Number/Number[]/Object The new left, an array of [x,y], or animation config object containing x and y properties. * @param y Number The new top. * @param animate Boolean/Object If true, the Component is animated into its new position. You may also pass an animation configuration. + * @returns Ext.Component this */ setPosition?( x?:any, y?:number, animate?:any ): Ext.IComponent; /** [Method] Sets the weight config property for this component * @param weight Number The new weight value. + * @returns Number The previous value of the weight property. */ setRegionWeight?( weight?:number ): number; /** [Method] Shows this Component rendering it first if autoRender or floating are true * @param animateTarget String/Ext.Element only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured with floating: true. The target from which the Component should animate from while opening. * @param callback Function A callback function to call after the Component is displayed. Only necessary if animation was specified. * @param scope Object The scope (this reference) in which the callback is executed. Defaults to this Component. + * @returns Ext.Component this */ - show?( animateTarget?:any, callback?:any, scope?:any ): any; - show?( animateTarget?:string, callback?:any, scope?:any ): Ext.IComponent; - show?( animateTarget?:Ext.IElement, callback?:any, scope?:any ): Ext.IComponent; + show?( animateTarget?:any, callback?:any, scope?:any ): Ext.IComponent; /** [Method] Displays component at specific xy position * @param x Number/Number[] The new x position or array of [x,y]. * @param y Number The new y position * @param animate Boolean/Object True to animate the Component into its new position. You may also pass an animation configuration. + * @returns Ext.Component this */ - showAt?( x?:any, y?:any, animate?:any ): any; - showAt?( x?:number, y?:number, animate?:any ): Ext.IComponent; - showAt?( x?:number[], y?:number, animate?:any ): Ext.IComponent; + showAt?( x?:any, y?:number, animate?:any ): Ext.IComponent; /** [Method] Shows this component by the specified Component or Element * @param component Ext.Component/Ext.dom.Element The Ext.Component or Ext.Element to show the component by. * @param position String Alignment position as used by Ext.util.Positionable.getAlignToXY. Defaults to defaultAlign. * @param offsets Number[] Alignment offsets as used by Ext.util.Positionable.getAlignToXY. + * @returns Ext.Component this + */ + showBy?( component?:any, position?:string, offsets?:number[] ): Ext.IComponent; + /** [Method] Sends this Component to the back of lower z index than any other visible windows + * @returns Ext.Component this */ - showBy?( component?:any, position?:any, offsets?:any ): any; - showBy?( component?:Ext.IComponent, position?:string, offsets?:number[] ): Ext.IComponent; - showBy?( component?:Ext.dom.IElement, position?:string, offsets?:number[] ): Ext.IComponent; - /** [Method] Sends this Component to the back of lower z index than any other visible windows */ toBack?(): Ext.IComponent; /** [Method] Brings this floating Component to the front of any other visible floating Components managed by the same ZIndexManag * @param preventFocus Boolean Specify true to prevent the Component from being focused. + * @returns Ext.Component this */ toFront?( preventFocus?:boolean ): Ext.IComponent; /** [Method] Sets the current box measurements of the component s underlying element * @param box Object An object in the format {x, y, width, height} + * @returns Ext.Component this */ updateBox?( box?:any ): Ext.IComponent; } @@ -3938,9 +4142,7 @@ declare module Ext { /** [Method] Set a Ext Component as the target of this loader * @param target String/Ext.Component The component to be the target of this loader. If a string is passed it will be looked up via its id. */ - setTarget?( target?:any ): any; - setTarget?( target?:string ): void; - setTarget?( target?:Ext.IComponent ): void; + setTarget?( target?:any ): void; } } declare module Ext { @@ -3949,22 +4151,23 @@ declare module Ext { export class ComponentManager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a new Component from the specified config object using the config object s xtype to determine the class to in * @param config Object A configuration object for the Component you wish to create. * @param defaultType String The xtype to use if the config object does not contain a xtype. (Optional if the config contains a xtype). + * @returns Ext.Component The newly instantiated Component. */ static create( config?:any, defaultType?:string ): Ext.IComponent; /** [Method] Executes the specified function once for each item in the collection @@ -3974,20 +4177,26 @@ declare module Ext { static each( fn?:any, scope?:any ): void; /** [Method] Returns an item by id * @param id String The id of the item + * @returns Object The item, undefined if not found. */ static get( id?:string ): any; - /** [Method] Gets the number of items in the collection */ + /** [Method] Gets the number of items in the collection + * @returns Number The number of items in the collection. + */ static getCount(): number; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Checks if an item type is registered * @param type String The mnemonic string by which the class may be looked up + * @returns Boolean Whether the type is registered. */ static isRegistered( type?:string ): boolean; /** [Method] Registers a function that will be called when an item with the specified id is added to the manager @@ -4005,7 +4214,9 @@ declare module Ext { * @param cls Object */ static registerType( type?:any, cls?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters an item by removing it from this manager * @param item Object The item to unregister @@ -4019,22 +4230,23 @@ declare module Ext { export class ComponentMgr { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a new Component from the specified config object using the config object s xtype to determine the class to in * @param config Object A configuration object for the Component you wish to create. * @param defaultType String The xtype to use if the config object does not contain a xtype. (Optional if the config contains a xtype). + * @returns Ext.Component The newly instantiated Component. */ static create( config?:any, defaultType?:string ): Ext.IComponent; /** [Method] Executes the specified function once for each item in the collection @@ -4044,20 +4256,26 @@ declare module Ext { static each( fn?:any, scope?:any ): void; /** [Method] Returns an item by id * @param id String The id of the item + * @returns Object The item, undefined if not found. */ static get( id?:string ): any; - /** [Method] Gets the number of items in the collection */ + /** [Method] Gets the number of items in the collection + * @returns Number The number of items in the collection. + */ static getCount(): number; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Checks if an item type is registered * @param type String The mnemonic string by which the class may be looked up + * @returns Boolean Whether the type is registered. */ static isRegistered( type?:string ): boolean; /** [Method] Registers a function that will be called when an item with the specified id is added to the manager @@ -4075,7 +4293,9 @@ declare module Ext { * @param cls Object */ static registerType( type?:any, cls?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters an item by removing it from this manager * @param item Object The item to unregister @@ -4089,38 +4309,44 @@ declare module Ext { export class ComponentQuery { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Tests whether the passed Component matches the selector string * @param component Ext.Component The Component to test * @param selector String The selector string to test against. + * @returns Boolean True if the Component matches the selector. */ static is( component?:Ext.IComponent, selector?:string ): boolean; /** [Method] Returns an array of matched Components from within the passed root object * @param selector String The selector string to filter returned Components * @param root Ext.container.Container The Container within which to perform the query. If omitted, all Components within the document are included in the search. This parameter may also be an array of Components to filter according to the selector. + * @returns Ext.Component[] The matched Components. */ static query( selector?:string, root?:Ext.container.IContainer ): Ext.IComponent[]; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -4150,12 +4376,9 @@ declare module Ext.container { suspendLayout?: boolean; /** [Method] Adds Component s to this Container * @param component Ext.Component[]|Object[]/Ext.Component.../Object... Either one or more Components to add or an Array of Components to add. See items for additional information. + * @returns Ext.Component[]/Ext.Component The Components that were added. */ - add?( component?:any ): Ext.IComponent[]; - /** [Method] Adds Component s to this Container - * @param component Ext.Component[]|Object[]/Ext.Component.../Object... Either one or more Components to add or an Array of Components to add. See items for additional information. - */ - add?( component?:any ): Ext.IComponent; + add?( component?:any ): any; /** [Method] Called by the layout system after the Component has been laid out */ afterComponentLayout?(): void; /** [Method] Invoked after the Container has laid out and rendered if necessary its child Components @@ -4166,36 +4389,41 @@ declare module Ext.container { * @param fn Function The function to call * @param scope Object The scope of the function (defaults to current component) * @param args Array The args to call the function with. The current component always passed as the last argument. + * @returns Ext.Container this */ cascade?( fn?:any, scope?:any, args?:any[] ): Ext.IContainer; /** [Method] Retrieves the first direct child of this container which matches the passed selector or component * @param selector String/Ext.Component An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching child Ext.Component (or null if no match was found). */ child?( selector?:any ): any; - child?( selector?:string ): any; - child?( selector?:Ext.IComponent ): any; /** [Method] Determines whether the passed Component is either an immediate child of this Container or whether it is a descendant * @param comp Ext.Component The Component to test. * @param deep Boolean Pass true to test for the Component being a descendant at any level. + * @returns Boolean true if the passed Component is contained at the specified level. */ contains?( comp?:Ext.IComponent, deep?:boolean ): boolean; - /** [Method] Inherit docs Disable all immediate children that was previously disabled Override disable because onDisable only gets */ + /** [Method] Inherit docs Disable all immediate children that was previously disabled Override disable because onDisable only gets + * @returns Ext.container.AbstractContainer this + */ disable?(): Ext.container.IAbstractContainer; - /** [Method] Manually force this container s layout to be recalculated */ + /** [Method] Manually force this container s layout to be recalculated + * @returns Ext.container.Container this + */ doLayout?(): Ext.container.IContainer; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String/Ext.Component An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching descendant Ext.Component (or null if no match was found). */ down?( selector?:any ): any; - down?( selector?:string ): any; - down?( selector?:Ext.IComponent ): any; /** [Method] Examines this container s items property and gets a direct child component of this container * @param comp String/Number This parameter may be any of the following: a String : representing the itemId or id of the child component. a Number : representing the position of the child component within the items property For additional information see Ext.util.MixedCollection.get. + * @returns Ext.Component The component (if found). + */ + getComponent?( comp?:any ): Ext.IComponent; + /** [Method] Returns the layout instance currently associated with this Container + * @returns Ext.layout.container.Container The layout */ - getComponent?( comp?:any ): any; - getComponent?( comp?:string ): Ext.IComponent; - getComponent?( comp?:number ): Ext.IComponent; - /** [Method] Returns the layout instance currently associated with this Container */ getLayout?(): Ext.layout.container.IContainer; /** [Method] Used by ComponentQuery child and down to retrieve all of the items which can potentially be considered a child of th * @param deep Object @@ -4204,6 +4432,7 @@ declare module Ext.container { /** [Method] Inserts a Component into this Container at a specified index * @param index Number The index at which the Component will be inserted into the Container's items collection * @param component Ext.Component/Object The child Component to insert. Ext uses lazy rendering, and will only render the inserted Component should it become necessary. A Component config object may be passed in order to avoid the overhead of constructing a real Component object if lazy rendering might mean that the inserted Component will not be rendered immediately. To take advantage of this 'lazy instantiation', set the Ext.Component.xtype config property to the registered type of the Component wanted. For a list of all available xtypes, see Ext.enums.Widget. + * @returns Ext.Component component The Component (or config object) that was inserted with the Container's default config values applied. */ insert?( index?:number, component?:any ): Ext.IComponent; /** [Method] Determines whether this Container is an ancestor of the passed Component @@ -4213,10 +4442,9 @@ declare module Ext.container { /** [Method] Moves a Component within the Container * @param fromIdx Number/Ext.Component The index/component to move. * @param toIdx Number The new index for the Component. + * @returns Ext.Component component The Component that was moved. */ - move?( fromIdx?:any, toIdx?:any ): any; - move?( fromIdx?:number, toIdx?:number ): Ext.IComponent; - move?( fromIdx?:Ext.IComponent, toIdx?:number ): Ext.IComponent; + move?( fromIdx?:any, toIdx?:number ): Ext.IComponent; /** [Method] This method is invoked after a new Component has been added * @param component Ext.Component * @param position Number @@ -4237,26 +4465,29 @@ declare module Ext.container { onResize?(): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned. + * @returns Ext.Component[] Components which matched the selector */ query?( selector?:string ): Ext.IComponent[]; /** [Method] Retrieves all descendant components which match the passed function * @param fn Function The matcher function. It will be called with a single argument, the component being tested. * @param scope Object The scope in which to run the function. If not specified, it will default to the active component. + * @returns Ext.Component[] Components matched by the passed function */ queryBy?( fn?:any, scope?:any ): Ext.IComponent[]; /** [Method] Finds a component at any level under this container matching the id itemId * @param id String The id to find + * @returns Ext.Component The matching id, null if not found */ queryById?( id?:string ): Ext.IComponent; /** [Method] Removes a component from this container * @param component Ext.Component/String The component reference or id to remove. * @param autoDestroy Boolean True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config. + * @returns Ext.Component component The Component that was removed. */ - remove?( component?:any, autoDestroy?:any ): any; - remove?( component?:Ext.IComponent, autoDestroy?:boolean ): Ext.IComponent; - remove?( component?:string, autoDestroy?:boolean ): Ext.IComponent; + remove?( component?:any, autoDestroy?:boolean ): Ext.IComponent; /** [Method] Removes all components from this container * @param autoDestroy Boolean True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config. + * @returns Ext.Component[] Array of the removed components */ removeAll?( autoDestroy?:boolean ): Ext.IComponent[]; } @@ -4312,11 +4543,9 @@ declare module Ext.container { /** [Method] Return the immediate child Component in which the passed element is located * @param el Ext.Element/HTMLElement/String The element to test (or ID of element). * @param deep Boolean If true, returns the deepest descendant Component which contains the passed element. + * @returns Ext.Component The child item which contains the passed element. */ - getChildByElement?( el?:any, deep?:any ): any; - getChildByElement?( el?:Ext.IElement, deep?:boolean ): Ext.IComponent; - getChildByElement?( el?:HTMLElement, deep?:boolean ): Ext.IComponent; - getChildByElement?( el?:string, deep?:boolean ): Ext.IComponent; + getChildByElement?( el?:any, deep?:boolean ): Ext.IComponent; } } declare module Ext { @@ -4326,11 +4555,9 @@ declare module Ext { /** [Method] Return the immediate child Component in which the passed element is located * @param el Ext.Element/HTMLElement/String The element to test (or ID of element). * @param deep Boolean If true, returns the deepest descendant Component which contains the passed element. + * @returns Ext.Component The child item which contains the passed element. */ - getChildByElement?( el?:any, deep?:any ): any; - getChildByElement?( el?:Ext.IElement, deep?:boolean ): Ext.IComponent; - getChildByElement?( el?:HTMLElement, deep?:boolean ): Ext.IComponent; - getChildByElement?( el?:string, deep?:boolean ): Ext.IComponent; + getChildByElement?( el?:any, deep?:boolean ): Ext.IComponent; } } declare module Ext.container { @@ -4340,17 +4567,18 @@ declare module Ext.container { /** [Method] Adds docked item s to the container * @param component Object/Object[] The Component or array of components to add. The components must include a 'dock' parameter on each component to indicate where it should be docked ('top', 'right', 'bottom', 'left'). * @param pos Number The index at which the Component will be added + * @returns Ext.Component[] The added components. */ addDocked?( component?:any, pos?:number ): Ext.IComponent[]; /** [Method] Finds a docked component by id itemId or position * @param comp String/Number The id, itemId or position of the docked component (see getComponent for details) + * @returns Ext.Component The docked component (if found) */ - getDockedComponent?( comp?:any ): any; - getDockedComponent?( comp?:string ): Ext.IComponent; - getDockedComponent?( comp?:number ): Ext.IComponent; + getDockedComponent?( comp?:any ): Ext.IComponent; /** [Method] Retrieves an array of all currently docked Components * @param selector String A ComponentQuery selector string to filter the returned items. * @param beforeBody Boolean An optional flag to limit the set of items to only those before the body (true) or after the body (false). All components are returned by default. + * @returns Ext.Component[] The array of docked components meeting the specified criteria. */ getDockedItems?( selector?:string, beforeBody?:boolean ): Ext.IComponent[]; /** [Method] Inserts docked item s to the panel at the indicated position @@ -4438,6 +4666,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -4446,10 +4675,9 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -4457,43 +4685,59 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Returns a comparator function which compares two items and returns 1 0 or 1 depending on the currently defined set */ generateComparator?(): void; - /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place */ + /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place + * @returns Ext.util.Sorter The sorter, null if none exist + */ getFirstSorter?(): Ext.util.ISorter; - /** [Method] Gets all records added or updated since the last commit */ + /** [Method] Gets all records added or updated since the last commit + * @returns Ext.data.Model[] The added and updated Model instances + */ getModifiedRecords?(): Ext.data.IModel[]; - /** [Method] Returns all Model instances that are either currently a phantom e g */ + /** [Method] Returns all Model instances that are either currently a phantom e g + * @returns Ext.data.Model[] The Model instances + */ getNewRecords?(): Ext.data.IModel[]; - /** [Method] Returns the proxy currently attached to this proxy instance */ + /** [Method] Returns the proxy currently attached to this proxy instance + * @returns Ext.data.proxy.Proxy The Proxy instance + */ getProxy?(): Ext.data.proxy.IProxy; - /** [Method] Returns any records that have been removed from the store but not yet destroyed on the proxy */ + /** [Method] Returns any records that have been removed from the store but not yet destroyed on the proxy + * @returns Ext.data.Model[] The removed Model instances + */ getRemovedRecords?(): Ext.data.IModel[]; - /** [Method] Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy */ + /** [Method] Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy + * @returns Ext.data.Model[] The updated Model instances + */ getUpdatedRecords?(): Ext.data.IModel[]; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Performs initialization of this mixin */ initSortable?(): void; - /** [Method] Returns true if the Store is currently performing a load operation */ + /** [Method] Returns true if the Store is currently performing a load operation + * @returns Boolean True if the Store is currently loading + */ isLoading?(): boolean; /** [Method] Loads the Store using its configured proxy * @param options Object config object. This is passed into the Operation object that is created and then sent to the proxy's Ext.data.proxy.Proxy.read function + * @returns void this */ load?( options?:any ): void; /** [Method] Shorthand for addManagedListener @@ -4502,30 +4746,29 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Reloads the store using the last options passed to the load method @@ -4546,9 +4789,7 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes automatically syncing the Store with its Proxy */ resumeAutoSync?(): void; /** [Method] Resumes firing of the named event s @@ -4561,15 +4802,15 @@ declare module Ext.data { save?(): void; /** [Method] Sets the Store s Proxy by string config object or Proxy instance * @param proxy String/Object/Ext.data.proxy.Proxy The new Proxy, which can be either a type string, a configuration object or an Ext.data.proxy.Proxy instance + * @returns Ext.data.proxy.Proxy The attached Proxy object */ setProxy?( proxy?:any ): Ext.data.proxy.IProxy; /** [Method] Sorts the data in the Store by one or more of its properties * @param sorters String/Ext.util.Sorter[] Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations. * @param direction String The overall direction to sort the data by. + * @returns Ext.util.Sorter[] */ - sort?( sorters?:any, direction?:any ): any; - sort?( sorters?:string, direction?:string ): Ext.util.ISorter[]; - sort?( sorters?:Ext.util.ISorter[], direction?:string ): Ext.util.ISorter[]; + sort?( sorters?:any, direction?:string ): Ext.util.ISorter[]; /** [Method] Suspends automatically syncing the Store with its Proxy */ suspendAutoSync?(): void; /** [Method] Suspends firing of the named event s @@ -4582,6 +4823,7 @@ declare module Ext.data { suspendEvents?( queueSuspended?:boolean ): void; /** [Method] Synchronizes the store with its proxy * @param options Object Object containing one or more properties supported by the sync method (these get passed along to the underlying proxy's batch method): + * @returns Ext.data.Store this */ sync?( options?:any ): Ext.data.IStore; /** [Method] Shorthand for removeListener @@ -4598,10 +4840,12 @@ declare module Ext.data { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] Creates a store from config object * @param store Object/Ext.data.AbstractStore A config for the store to be created. It may contain a type field which defines the particular type of store to create. Alteratively passing an actual store to this method will just return it, no changes made. + * @returns Ext.data.AbstractStore The created store. */ static create( store?:any ): Ext.data.IAbstractStore; /** [Method] Create aliases for existing prototype methods @@ -4609,12 +4853,15 @@ declare module Ext.data { * @param origin String/Object The original method name */ static createAlias( alias?:any, origin?:any ): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -4646,7 +4893,9 @@ declare module Ext.data.association { associatedName?: string; /** [Property] (String) */ ownerName?: string; - /** [Method] Get a specialized reader for reading associated data */ + /** [Method] Get a specialized reader for reading associated data + * @returns Ext.data.reader.Reader The reader, null if not supplied + */ getReader?(): Ext.data.reader.IReader; } } @@ -4668,7 +4917,9 @@ declare module Ext.data { associatedName?: string; /** [Property] (String) */ ownerName?: string; - /** [Method] Get a specialized reader for reading associated data */ + /** [Method] Get a specialized reader for reading associated data + * @returns Ext.data.reader.Reader The reader, null if not supplied + */ getReader?(): Ext.data.reader.IReader; } } @@ -4774,6 +5025,7 @@ declare module Ext.data { total?: number; /** [Method] Adds a new operation to this batch at the end of the operations array * @param operation Object The Operation object + * @returns Ext.data.Batch this */ add?( operation?:any ): Ext.data.IBatch; /** [Method] Adds the specified events to the list of events which this Observable may fire @@ -4785,6 +5037,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -4793,10 +5046,9 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -4804,21 +5056,22 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -4827,32 +5080,33 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - /** [Method] Pauses execution of the batch but does not cancel the current operation */ + /** [Method] Pauses execution of the batch but does not cancel the current operation + * @returns Ext.data.Batch this + */ pause?(): Ext.data.IBatch; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -4867,23 +5121,25 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ resumeEvent?( ...eventName:any[] ): void; /** [Method] Resumes firing events see suspendEvents */ resumeEvents?(): void; - /** [Method] Kicks off execution of the batch continuing from the current operation */ + /** [Method] Kicks off execution of the batch continuing from the current operation + * @returns Ext.data.Batch this + */ retry?(): Ext.data.IBatch; /** [Method] Executes an operation by its numeric index in the operations array * @param index Number The operation index to run + * @returns Ext.data.Batch this */ runOperation?( index?:number ): Ext.data.IBatch; /** [Method] Kicks off execution of the batch continuing from the next operation if the previous operation encountered an excepti * @param index Object + * @returns Ext.data.Batch this */ start?( index?:any ): Ext.data.IBatch; /** [Method] Suspends firing of the named event s @@ -4947,6 +5203,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -4955,10 +5212,9 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -4966,25 +5222,27 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Determines whether this object has a request outstanding * @param request Object Defaults to the last transaction + * @returns Boolean True if there is an outstanding request. */ isLoading?( request?:any ): boolean; /** [Method] Shorthand for addManagedListener @@ -4993,34 +5251,34 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Checks if the response status was successful * @param status Number The status code + * @returns Object An object containing success/status state */ parseStatus?( status?:number ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -5035,11 +5293,10 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Sends an HTTP request to a remote server * @param options Object An object which may contain the following properties: (The options object may also contain any other property which might be needed to perform postprocessing in a callback because it is passed to callback functions.) + * @returns Object The request object. This may be used to cancel the request. */ request?( options?:any ): any; /** [Method] Resumes firing of the named event s @@ -5051,6 +5308,7 @@ declare module Ext.data { /** [Method] Sets various options such as the url params for the request * @param options Object The initial options * @param scope Object The scope to execute in + * @returns Object The params for the request */ setOptions?( options?:any, scope?:any ): any; /** [Method] Suspends firing of the named event s @@ -5073,10 +5331,7 @@ declare module Ext.data { * @param params String Any extra parameters to pass * @param options Object The initial options */ - upload?( form?:any, url?:any, params?:any, options?:any ): any; - upload?( form?:string, url?:string, params?:string, options?:any ): void; - upload?( form?:HTMLElement, url?:string, params?:string, options?:any ): void; - upload?( form?:Ext.IElement, url?:string, params?:string, options?:any ): void; + upload?( form?:any, url?:string, params?:string, options?:any ): void; } } declare module Ext.data { @@ -5087,9 +5342,12 @@ declare module Ext.data { export interface IErrors extends Ext.util.IMixedCollection { /** [Method] Returns all of the errors for the given field * @param fieldName String The field to get errors for + * @returns Object[] All errors for the given field */ getByField?( fieldName?:string ): any[]; - /** [Method] Returns true if there are no errors in the collection */ + /** [Method] Returns true if there are no errors in the collection + * @returns Boolean + */ isValid?(): boolean; } } @@ -5176,7 +5434,9 @@ declare module Ext.data { id?: string; /** [Property] (Boolean) */ isGenerator?: boolean; - /** [Method] Generates and returns the next id */ + /** [Method] Generates and returns the next id + * @returns String The next id. + */ generate?(): string; } export class IdGenerator { @@ -5186,9 +5446,12 @@ declare module Ext.data { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -5199,12 +5462,15 @@ declare module Ext.data { * @param config String/Object If this parameter is an IdGenerator instance, it is simply returned. If this is a string, it is first used as an id for lookup and then, if there is no match, as a type to create a new instance. This parameter can also be a config object that contains a type property (among others) that are used to create and configure the instance. */ static get( config?:any ): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -5219,32 +5485,37 @@ declare module Ext.data { static abort( request?:any ): void; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Makes a JSONP request * @param options Object An object which may contain the following properties. Note that options will take priority over any defaults that are specified in the class. url : String The URL to request. params : Object (Optional)An object containing a series of key value pairs that will be sent along with the request. timeout : Number (Optional) See timeout callbackKey : String (Optional) See callbackKey callbackName : String (Optional) The function name to use for this request. By default this name will be auto-generated: Ext.data.JsonP.callback1, Ext.data.JsonP.callback2, etc. Setting this option to "my_name" will force the function name to be Ext.data.JsonP.my_name. Use this if you want deterministic behavior, but be careful - the callbackName should be different in each JsonP request that you make. disableCaching : Boolean (Optional) See disableCaching disableCachingParam : String (Optional) See disableCachingParam success : Function (Optional) A function to execute if the request succeeds. failure : Function (Optional) A function to execute if the request fails. callback : Function (Optional) A function to execute when the request completes, whether it is a success or failure. scope : Object (Optional)The scope in which to execute the callbacks: The "this" object for the callback function. Defaults to the browser window. + * @returns Object request An object containing the request details. */ static request( options?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -5311,6 +5582,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -5319,10 +5591,9 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Begins an edit */ beginEdit?(): void; /** [Method] Cancels all changes made in the current edit operation */ @@ -5338,18 +5609,18 @@ declare module Ext.data { commit?( silent?:boolean, modifiedFieldNames?:string[] ): void; /** [Method] Creates a copy clone of this Model instance * @param id String A new id, defaults to the id of the instance being copied. See id. To generate a phantom instance with a new id use: var rec = record.copy(); // clone the record Ext.data.Model.id(rec); // automatically generate a unique sequential id + * @returns Ext.data.Model */ copy?( id?:string ): Ext.data.IModel; /** [Method] Destroys the model using the configured proxy * @param options Object Options to pass to the proxy. Config object for Ext.data.Operation. + * @returns Ext.data.Model The Model instance */ destroy?( options?:any ): Ext.data.IModel; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Ends an edit * @param silent Boolean True to not notify the store of the change * @param modifiedFieldNames String[] Array of field names changed during edit. @@ -5358,40 +5629,54 @@ declare module Ext.data { /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Returns the value of the given field * @param fieldName String The field to fetch the value for + * @returns Object The value */ get?( fieldName?:string ): any; - /** [Method] Gets all of the data from this Models loaded associations */ + /** [Method] Gets all of the data from this Models loaded associations + * @returns Object The nested data set for the Model's loaded associations + */ getAssociatedData?(): any; - /** [Method] Gets a hash of only the fields that have been modified since this Model was created or commited */ + /** [Method] Gets a hash of only the fields that have been modified since this Model was created or commited + * @returns Object + */ getChanges?(): any; /** [Method] Gets all values for each field in this model and returns an object containing the current data * @param includeAssociated Boolean True to also include associated data. Defaults to false. + * @returns Object An object hash containing all the values in this model */ getData?( includeAssociated?:boolean ): any; - /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty */ - getId?(): number; - /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty */ - getId?(): string; - /** [Method] Returns the configured Proxy for this Model */ + /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty + * @returns Number/String The id + */ + getId?(): any; + /** [Method] Returns the configured Proxy for this Model + * @returns Ext.data.proxy.Proxy The proxy + */ getProxy?(): Ext.data.proxy.IProxy; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Returns true if the passed field name has been modified since the load or last commit * @param fieldName String Ext.data.Field.name + * @returns Boolean */ isModified?( fieldName?:string ): boolean; - /** [Method] Checks if the model is valid */ + /** [Method] Checks if the model is valid + * @returns Boolean True if the model is valid. + */ isValid?(): boolean; /** [Method] Tells this model instance that it has been added to a store * @param store Ext.data.Store The store to which this model has been added. @@ -5403,24 +5688,22 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Usually called by the Ext data Store to which this model instance has been joined @@ -5431,6 +5714,7 @@ declare module Ext.data { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -5445,9 +5729,7 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -5456,11 +5738,13 @@ declare module Ext.data { resumeEvents?(): void; /** [Method] Saves the model instance using the configured proxy * @param options Object Options to pass to the proxy. Config object for Ext.data.Operation. + * @returns Ext.data.Model The Model instance */ save?( options?:any ): Ext.data.IModel; /** [Method] Sets the given field to the given value marks the instance as dirty * @param fieldName String/Object The field to set, or an object containing key/value pairs * @param newValue Object The value to set + * @returns String[] The array of modified field names or null if nothing was modified. */ set?( fieldName?:any, newValue?:any ): string[]; /** [Method] Marks this Record as dirty */ @@ -5468,11 +5752,10 @@ declare module Ext.data { /** [Method] Sets the model instance s id field to the given id * @param id Number/String The new id */ - setId?( id?:any ): any; - setId?( id?:number ): void; - setId?( id?:string ): void; + setId?( id?:any ): void; /** [Method] Sets the Proxy to use for this model * @param proxy String/Object/Ext.data.proxy.Proxy The proxy + * @returns Ext.data.proxy.Proxy */ setProxy?( proxy?:any ): Ext.data.proxy.IProxy; /** [Method] Suspends firing of the named event s @@ -5493,7 +5776,9 @@ declare module Ext.data { * @param store Ext.data.Store The store from which this model has been removed. */ unjoin?( store?:Ext.data.IStore ): void; - /** [Method] Validates the current data against all of its configured validations */ + /** [Method] Validates the current data against all of its configured validations + * @returns Ext.data.Errors The errors object + */ validate?(): Ext.data.IErrors; } export class Model { @@ -5503,23 +5788,33 @@ declare module Ext.data { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter * @param origin String/Object The original method name */ static createAlias( alias?:any, origin?:any ): void; - /** [Method] Returns an Array of Field definitions which define this Model s structure Fields are sorted upon Model class definit */ + /** [Method] Returns an Array of Field definitions which define this Model s structure Fields are sorted upon Model class definit + * @returns Ext.data.Field[] The defined Fields for this Model. + */ static getFields(): Ext.data.IField[]; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; - /** [Method] Returns the configured Proxy for this Model */ + /** [Method] Returns the configured Proxy for this Model + * @returns Ext.data.proxy.Proxy The proxy + */ static getProxy(): Ext.data.proxy.IProxy; /** [Method] Generates a sequential id * @param rec Ext.data.Model The record being created. The record does not exist, it's a phantom. + * @returns String auto-generated string id, "ext-record-i++"; */ static id( rec?:Ext.data.IModel ): string; /** [Method] Adds members to class */ @@ -5528,11 +5823,10 @@ declare module Ext.data { * @param id Number/String The id of the model to load * @param config Object config object containing success, failure and callback functions, plus optional scope */ - static load( id?:any, config?:any ): any; - static load( id?:number, config?:any ): void; - static load( id?:string, config?:any ): void; + static load( id?:any, config?:any ): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Apply a new set of field and or property definitions to the existing model @@ -5543,6 +5837,7 @@ declare module Ext.data { static setFields( fields?:any, idProperty?:any, clientIdProperty?:any ): void; /** [Method] Sets the Proxy to use for this model * @param proxy String/Object/Ext.data.proxy.Proxy The proxy + * @returns Ext.data.proxy.Proxy */ static setProxy( proxy?:any ): Ext.data.proxy.IProxy; } @@ -5602,6 +5897,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -5610,10 +5906,9 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Begins an edit */ beginEdit?(): void; /** [Method] Cancels all changes made in the current edit operation */ @@ -5629,18 +5924,18 @@ declare module Ext.data { commit?( silent?:boolean, modifiedFieldNames?:string[] ): void; /** [Method] Creates a copy clone of this Model instance * @param id String A new id, defaults to the id of the instance being copied. See id. To generate a phantom instance with a new id use: var rec = record.copy(); // clone the record Ext.data.Model.id(rec); // automatically generate a unique sequential id + * @returns Ext.data.Model */ copy?( id?:string ): Ext.data.IModel; /** [Method] Destroys the model using the configured proxy * @param options Object Options to pass to the proxy. Config object for Ext.data.Operation. + * @returns Ext.data.Model The Model instance */ destroy?( options?:any ): Ext.data.IModel; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Ends an edit * @param silent Boolean True to not notify the store of the change * @param modifiedFieldNames String[] Array of field names changed during edit. @@ -5649,40 +5944,54 @@ declare module Ext.data { /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Returns the value of the given field * @param fieldName String The field to fetch the value for + * @returns Object The value */ get?( fieldName?:string ): any; - /** [Method] Gets all of the data from this Models loaded associations */ + /** [Method] Gets all of the data from this Models loaded associations + * @returns Object The nested data set for the Model's loaded associations + */ getAssociatedData?(): any; - /** [Method] Gets a hash of only the fields that have been modified since this Model was created or commited */ + /** [Method] Gets a hash of only the fields that have been modified since this Model was created or commited + * @returns Object + */ getChanges?(): any; /** [Method] Gets all values for each field in this model and returns an object containing the current data * @param includeAssociated Boolean True to also include associated data. Defaults to false. + * @returns Object An object hash containing all the values in this model */ getData?( includeAssociated?:boolean ): any; - /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty */ - getId?(): number; - /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty */ - getId?(): string; - /** [Method] Returns the configured Proxy for this Model */ + /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty + * @returns Number/String The id + */ + getId?(): any; + /** [Method] Returns the configured Proxy for this Model + * @returns Ext.data.proxy.Proxy The proxy + */ getProxy?(): Ext.data.proxy.IProxy; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Returns true if the passed field name has been modified since the load or last commit * @param fieldName String Ext.data.Field.name + * @returns Boolean */ isModified?( fieldName?:string ): boolean; - /** [Method] Checks if the model is valid */ + /** [Method] Checks if the model is valid + * @returns Boolean True if the model is valid. + */ isValid?(): boolean; /** [Method] Tells this model instance that it has been added to a store * @param store Ext.data.Store The store to which this model has been added. @@ -5694,24 +6003,22 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Usually called by the Ext data Store to which this model instance has been joined @@ -5722,6 +6029,7 @@ declare module Ext.data { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -5736,9 +6044,7 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -5747,11 +6053,13 @@ declare module Ext.data { resumeEvents?(): void; /** [Method] Saves the model instance using the configured proxy * @param options Object Options to pass to the proxy. Config object for Ext.data.Operation. + * @returns Ext.data.Model The Model instance */ save?( options?:any ): Ext.data.IModel; /** [Method] Sets the given field to the given value marks the instance as dirty * @param fieldName String/Object The field to set, or an object containing key/value pairs * @param newValue Object The value to set + * @returns String[] The array of modified field names or null if nothing was modified. */ set?( fieldName?:any, newValue?:any ): string[]; /** [Method] Marks this Record as dirty */ @@ -5759,11 +6067,10 @@ declare module Ext.data { /** [Method] Sets the model instance s id field to the given id * @param id Number/String The new id */ - setId?( id?:any ): any; - setId?( id?:number ): void; - setId?( id?:string ): void; + setId?( id?:any ): void; /** [Method] Sets the Proxy to use for this model * @param proxy String/Object/Ext.data.proxy.Proxy The proxy + * @returns Ext.data.proxy.Proxy */ setProxy?( proxy?:any ): Ext.data.proxy.IProxy; /** [Method] Suspends firing of the named event s @@ -5784,7 +6091,9 @@ declare module Ext.data { * @param store Ext.data.Store The store from which this model has been removed. */ unjoin?( store?:Ext.data.IStore ): void; - /** [Method] Validates the current data against all of its configured validations */ + /** [Method] Validates the current data against all of its configured validations + * @returns Ext.data.Errors The errors object + */ validate?(): Ext.data.IErrors; } export class Record { @@ -5794,23 +6103,33 @@ declare module Ext.data { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter * @param origin String/Object The original method name */ static createAlias( alias?:any, origin?:any ): void; - /** [Method] Returns an Array of Field definitions which define this Model s structure Fields are sorted upon Model class definit */ + /** [Method] Returns an Array of Field definitions which define this Model s structure Fields are sorted upon Model class definit + * @returns Ext.data.Field[] The defined Fields for this Model. + */ static getFields(): Ext.data.IField[]; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; - /** [Method] Returns the configured Proxy for this Model */ + /** [Method] Returns the configured Proxy for this Model + * @returns Ext.data.proxy.Proxy The proxy + */ static getProxy(): Ext.data.proxy.IProxy; /** [Method] Generates a sequential id * @param rec Ext.data.Model The record being created. The record does not exist, it's a phantom. + * @returns String auto-generated string id, "ext-record-i++"; */ static id( rec?:Ext.data.IModel ): string; /** [Method] Adds members to class */ @@ -5819,11 +6138,10 @@ declare module Ext.data { * @param id Number/String The id of the model to load * @param config Object config object containing success, failure and callback functions, plus optional scope */ - static load( id?:any, config?:any ): any; - static load( id?:number, config?:any ): void; - static load( id?:string, config?:any ): void; + static load( id?:any, config?:any ): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Apply a new set of field and or property definitions to the existing model @@ -5834,6 +6152,7 @@ declare module Ext.data { static setFields( fields?:any, idProperty?:any, clientIdProperty?:any ): void; /** [Method] Sets the Proxy to use for this model * @param proxy String/Object/Ext.data.proxy.Proxy The proxy + * @returns Ext.data.proxy.Proxy */ static setProxy( proxy?:any ): Ext.data.proxy.IProxy; } @@ -5906,6 +6225,7 @@ declare module Ext.data { * @param node Ext.data.NodeInterface/Ext.data.NodeInterface[]/Object The node or Array of nodes to append * @param suppressEvents Boolean True to suppress firering of events. * @param commit Boolean + * @returns Ext.data.NodeInterface The appended node if single append, or null if an array was passed */ appendChild?( node?:any, suppressEvents?:boolean, commit?:boolean ): Ext.data.INodeInterface; /** [Method] Bubbles up the tree from this node calling the specified function with each node @@ -5934,15 +6254,18 @@ declare module Ext.data { collapseChildren?( recursive?:any, callback?:any, scope?:any ): void; /** [Method] Returns true if this node is an ancestor at any point of the passed node * @param node Ext.data.NodeInterface + * @returns Boolean */ contains?( node?:Ext.data.INodeInterface ): boolean; /** [Method] Creates a copy clone of this Node * @param id String A new id, defaults to this Node's id. * @param deep Boolean True to recursively copy all child Nodes into the new Node. False to copy without child Nodes. + * @returns Ext.data.NodeInterface A copy of this Node. */ copy?( id?:string, deep?:boolean ): Ext.data.INodeInterface; /** [Method] Ensures that the passed object is an instance of a Record with the NodeInterface applied * @param node Object + * @returns Ext.data.NodeInterface */ createNode?( node?:any ): Ext.data.INodeInterface; /** [Method] Destroys the node @@ -5971,81 +6294,114 @@ declare module Ext.data { * @param attribute String The attribute name * @param value Object The value to search for * @param deep Boolean True to search through nodes deeper than the immediate children + * @returns Ext.data.NodeInterface The found child or null if none was found */ findChild?( attribute?:string, value?:any, deep?:boolean ): Ext.data.INodeInterface; /** [Method] Finds the first child by a custom function * @param fn Function A function which must return true if the passed Node is the required Node. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Node being tested. * @param deep Boolean True to search through nodes deeper than the immediate children + * @returns Ext.data.NodeInterface The found child or null if none was found */ findChildBy?( fn?:any, scope?:any, deep?:boolean ): Ext.data.INodeInterface; /** [Method] Returns the child node at the specified index * @param index Number + * @returns Ext.data.NodeInterface */ getChildAt?( index?:number ): Ext.data.INodeInterface; - /** [Method] Returns depth of this node the root node has a depth of 0 */ + /** [Method] Returns depth of this node the root node has a depth of 0 + * @returns Number + */ getDepth?(): number; - /** [Method] Returns the tree this node is in */ + /** [Method] Returns the tree this node is in + * @returns Ext.tree.Panel The tree panel which owns this node. + */ getOwnerTree?(): Ext.tree.IPanel; /** [Method] Gets the hierarchical path from the root of the current node * @param field String The field to construct the path from. Defaults to the model idProperty. * @param separator String A separator to use. + * @returns String The node path */ getPath?( field?:string, separator?:string ): string; - /** [Method] Returns true if this node has one or more child nodes else false */ + /** [Method] Returns true if this node has one or more child nodes else false + * @returns Boolean + */ hasChildNodes?(): boolean; /** [Method] Returns the index of a child node * @param node Ext.data.NodeInterface + * @returns Number The index of the node or -1 if it was not found */ indexOf?( node?:Ext.data.INodeInterface ): number; /** [Method] Returns the index of a child node that matches the id * @param id String The id of the node to find + * @returns Number The index of the node or -1 if it was not found */ indexOfId?( id?:string ): number; /** [Method] Inserts the first node before the second node in this nodes childNodes collection * @param node Ext.data.NodeInterface The node to insert * @param refNode Ext.data.NodeInterface The node to insert before (if null the node is appended) + * @returns Ext.data.NodeInterface The inserted node */ insertBefore?( node?:Ext.data.INodeInterface, refNode?:Ext.data.INodeInterface ): Ext.data.INodeInterface; /** [Method] Inserts a node into this node * @param index Number The zero-based index to insert the node at * @param node Ext.data.NodeInterface The node to insert + * @returns Ext.data.NodeInterface The node you just inserted */ insertChild?( index?:number, node?:Ext.data.INodeInterface ): Ext.data.INodeInterface; /** [Method] Returns true if the passed node is an ancestor at any point of this node * @param node Ext.data.NodeInterface + * @returns Boolean */ isAncestor?( node?:Ext.data.INodeInterface ): boolean; - /** [Method] Returns true if this node has one or more child nodes or if the expandable node attribute is explicitly specified as */ + /** [Method] Returns true if this node has one or more child nodes or if the expandable node attribute is explicitly specified as + * @returns Boolean + */ isExpandable?(): boolean; - /** [Method] Returns true if this node is expaned */ + /** [Method] Returns true if this node is expaned + * @returns Boolean + */ isExpanded?(): boolean; - /** [Method] Returns true if this node is a leaf */ + /** [Method] Returns true if this node is a leaf + * @returns Boolean + */ isLeaf?(): boolean; - /** [Method] Returns true if this node is loaded */ + /** [Method] Returns true if this node is loaded + * @returns Boolean + */ isLoaded?(): boolean; - /** [Method] Returns true if this node is loading */ + /** [Method] Returns true if this node is loading + * @returns Boolean + */ isLoading?(): boolean; - /** [Method] Returns true if this node is the root node */ + /** [Method] Returns true if this node is the root node + * @returns Boolean + */ isRoot?(): boolean; - /** [Method] Returns true if this node is visible */ + /** [Method] Returns true if this node is visible + * @returns Boolean + */ isVisible?(): boolean; /** [Method] Removes this node from its parent * @param destroy Boolean True to destroy the node upon removal. + * @returns Ext.data.NodeInterface this */ remove?( destroy?:boolean ): Ext.data.INodeInterface; /** [Method] Removes all child nodes from this node * @param destroy Boolean True to destroy the node upon removal. + * @returns Ext.data.NodeInterface this */ removeAll?( destroy?:boolean ): Ext.data.INodeInterface; /** [Method] Removes a child node from this node * @param node Ext.data.NodeInterface The node to remove * @param destroy Boolean True to destroy the node upon removal. + * @returns Ext.data.NodeInterface The removed node */ removeChild?( node?:Ext.data.INodeInterface, destroy?:boolean ): Ext.data.INodeInterface; /** [Method] Replaces one child node in this node with another * @param newChild Ext.data.NodeInterface The replacement node * @param oldChild Ext.data.NodeInterface The node to replace + * @returns Ext.data.NodeInterface The replaced node */ replaceChild?( newChild?:Ext.data.INodeInterface, oldChild?:Ext.data.INodeInterface ): Ext.data.INodeInterface; /** [Method] Creates an object representation of this node including its children */ @@ -6069,9 +6425,12 @@ declare module Ext.data { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -6081,15 +6440,16 @@ declare module Ext.data { /** [Method] This method allows you to decorate a Model s class to implement the NodeInterface * @param modelClass Ext.Class/Ext.data.Model The Model class or an instance of the Model class you want to decorate the prototype of. */ - static decorate( modelClass?:any ): any; - static decorate( modelClass?:Ext.IClass ): void; - static decorate( modelClass?:Ext.data.IModel ): void; - /** [Method] Get the current class name in string format */ + static decorate( modelClass?:any ): void; + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -6108,7 +6468,9 @@ declare module Ext.data { isExpandingOrCollapsing?: number; /** [Property] (Boolean) */ isNodeStore?: boolean; - /** [Method] NodeStores are never buffered or paged */ + /** [Method] NodeStores are never buffered or paged + * @returns Number The total number of Model instances available via the Proxy. 0 returned if no value has been set via the reader. + */ getTotalCount?(): number; } } @@ -6140,25 +6502,41 @@ declare module Ext.data { actionCommitRecordsRe?: RegExp; /** [Property] (RegExp) */ actionSkipSyncRe?: RegExp; - /** [Method] Checks whether this operation should cause writing to occur */ + /** [Method] Checks whether this operation should cause writing to occur + * @returns Boolean Whether the operation should cause a write to occur. + */ allowWrite?(): boolean; /** [Method] This method is called to commit data to this instance s records given the records in the server response * @param serverRecords Ext.data.Model[] An array of Ext.data.Model objects returned by the server. */ commitRecords?( serverRecords?:Ext.data.IModel[] ): void; - /** [Method] Returns the error string or object that was set using setException */ + /** [Method] Returns the error string or object that was set using setException + * @returns String/Object The error object + */ getError?(): any; - /** [Method] Returns the records associated with this operation */ + /** [Method] Returns the records associated with this operation + * @returns Ext.data.Model[] + */ getRecords?(): Ext.data.IModel[]; - /** [Method] Returns the ResultSet object if set by the Proxy */ + /** [Method] Returns the ResultSet object if set by the Proxy + * @returns Ext.data.ResultSet The ResultSet object + */ getResultSet?(): Ext.data.IResultSet; - /** [Method] Returns true if this Operation encountered an exception see also getError */ + /** [Method] Returns true if this Operation encountered an exception see also getError + * @returns Boolean True if there was an exception + */ hasException?(): boolean; - /** [Method] Returns true if the Operation has been completed */ + /** [Method] Returns true if the Operation has been completed + * @returns Boolean True if the Operation is complete + */ isComplete?(): boolean; - /** [Method] Returns true if the Operation has been started but has not yet completed */ + /** [Method] Returns true if the Operation has been started but has not yet completed + * @returns Boolean True if the Operation is currently running + */ isRunning?(): boolean; - /** [Method] Returns true if the Operation has been started */ + /** [Method] Returns true if the Operation has been started + * @returns Boolean True if the Operation has started + */ isStarted?(): boolean; /** [Method] Marks the Operation as completed */ setCompleted?(): void; @@ -6170,7 +6548,9 @@ declare module Ext.data { setStarted?(): void; /** [Method] Marks the Operation as successful */ setSuccessful?(): void; - /** [Method] Returns true if the Operation has completed and was successful */ + /** [Method] Returns true if the Operation has completed and was successful + * @returns Boolean True if successful + */ wasSuccessful?(): boolean; } } @@ -6178,21 +6558,28 @@ declare module Ext.data { export interface IPageMap extends Ext.util.ILruCache { /** [Method] Maintain a generation counter so that the Store can reject incoming pages destined for the previous generation * @param initial Object + * @returns Ext.util.HashMap this */ clear?( initial?:any ): Ext.util.IHashMap; /** [Method] Returns the first record in this page map which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this PageMap. + * @returns Object The first record in this page map which returned true from the selection function, or null if none was found. */ findBy?( fn?:any, scope?:any ): any; /** [Method] Returns the index in the whole dataset of the first record in this page map which elicits a true return value from th * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this PageMap. + * @returns Number The index first record in this page map which returned true from the selection function, or -1 if none was found. */ findIndexBy?( fn?:any, scope?:any ): number; - /** [Method] Gets the number of items in the hash */ + /** [Method] Gets the number of items in the hash + * @returns Number The number of items in the hash. + */ getCount?(): number; - /** [Method] Remove an item from the hash */ + /** [Method] Remove an item from the hash + * @returns Boolean True if the item was successfully removed. + */ remove?(): boolean; } } @@ -6206,6 +6593,7 @@ declare module Ext.data.proxy { actionMethods?: any; /** [Method] Returns the HTTP method name for a given request * @param request Ext.data.Request The request object + * @returns String The HTTP method to use (should be one of 'GET', 'POST', 'PUT' or 'DELETE') */ getMethod?( request?:Ext.data.IRequest ): string; } @@ -6220,6 +6608,7 @@ declare module Ext.data { actionMethods?: any; /** [Method] Returns the HTTP method name for a given request * @param request Ext.data.Request The request object + * @returns String The HTTP method to use (should be one of 'GET', 'POST', 'PUT' or 'DELETE') */ getMethod?( request?:Ext.data.IRequest ): string; } @@ -6234,6 +6623,7 @@ declare module Ext.data { actionMethods?: any; /** [Method] Returns the HTTP method name for a given request * @param request Ext.data.Request The request object + * @returns String The HTTP method to use (should be one of 'GET', 'POST', 'PUT' or 'DELETE') */ getMethod?( request?:Ext.data.IRequest ): string; } @@ -6266,7 +6656,9 @@ declare module Ext.data.proxy { paramOrder?: any; /** [Config Option] (Boolean) */ paramsAsHash?: boolean; - /** [Method] inherit docs */ + /** [Method] inherit docs + * @returns String The url + */ buildUrl?(): string; /** [Method] In ServerProxy subclasses the create read update and destroy methods all pass through to doRequest * @param operation Object @@ -6288,7 +6680,9 @@ declare module Ext.data { paramOrder?: any; /** [Config Option] (Boolean) */ paramsAsHash?: boolean; - /** [Method] inherit docs */ + /** [Method] inherit docs + * @returns String The url + */ buildUrl?(): string; /** [Method] In ServerProxy subclasses the create read update and destroy methods all pass through to doRequest * @param operation Object @@ -6310,10 +6704,12 @@ declare module Ext.data.proxy { abort?(): void; /** [Method] Generates a url based on a given Ext data Request object * @param request Ext.data.Request The request object + * @returns String The url */ buildUrl?( request?:Ext.data.IRequest ): string; /** [Method] Encodes an array of records into a value suitable to be added to the request params as the recordParam parameter * @param records Ext.data.Model[] The records array + * @returns Array An array of record data objects */ encodeRecords?( records?:Ext.data.IModel[] ): any[]; } @@ -6330,10 +6726,12 @@ declare module Ext.data { abort?(): void; /** [Method] Generates a url based on a given Ext data Request object * @param request Ext.data.Request The request object + * @returns String The url */ buildUrl?( request?:Ext.data.IRequest ): string; /** [Method] Encodes an array of records into a value suitable to be added to the request params as the recordParam parameter * @param records Ext.data.Model[] The records array + * @returns Array An array of record data objects */ encodeRecords?( records?:Ext.data.IModel[] ): any[]; } @@ -6439,6 +6837,7 @@ declare module Ext.data.proxy { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -6447,12 +6846,12 @@ declare module Ext.data.proxy { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Performs a batch of Operations in the order specified by batchOrder * @param options Object Object containing one or more properties supported by the batch method: + * @returns Ext.data.Batch The newly created Batch */ batch?( options?:any ): Ext.data.IBatch; /** [Method] Removes all listeners for this object including the managed listeners */ @@ -6474,27 +6873,34 @@ declare module Ext.data.proxy { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the model attached to this Proxy */ + /** [Method] Returns the model attached to this Proxy + * @returns Ext.data.Model The model + */ getModel?(): Ext.data.IModel; - /** [Method] Returns the reader currently attached to this proxy instance */ + /** [Method] Returns the reader currently attached to this proxy instance + * @returns Ext.data.reader.Reader The Reader instance + */ getReader?(): Ext.data.reader.IReader; - /** [Method] Returns the writer currently attached to this proxy instance */ + /** [Method] Returns the writer currently attached to this proxy instance + * @returns Ext.data.writer.Writer The Writer instance + */ getWriter?(): Ext.data.writer.IWriter; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -6503,24 +6909,22 @@ declare module Ext.data.proxy { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Performs the given read operation @@ -6533,6 +6937,7 @@ declare module Ext.data.proxy { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -6547,9 +6952,7 @@ declare module Ext.data.proxy { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -6560,15 +6963,15 @@ declare module Ext.data.proxy { * @param model String/Ext.data.Model The new model. Can be either the model name string, or a reference to the model's constructor * @param setOnStore Boolean Sets the new model on the associated Store, if one is present */ - setModel?( model?:any, setOnStore?:any ): any; - setModel?( model?:string, setOnStore?:boolean ): void; - setModel?( model?:Ext.data.IModel, setOnStore?:boolean ): void; + setModel?( model?:any, setOnStore?:boolean ): void; /** [Method] Sets the Proxy s Reader by string config object or Reader instance * @param reader String/Object/Ext.data.reader.Reader The new Reader, which can be either a type string, a configuration object or an Ext.data.reader.Reader instance + * @returns Ext.data.reader.Reader The attached Reader object */ setReader?( reader?:any ): Ext.data.reader.IReader; /** [Method] Sets the Proxy s Writer by string config object or Writer instance * @param writer String/Object/Ext.data.writer.Writer The new Writer, which can be either a type string, a configuration object or an Ext.data.writer.Writer instance + * @returns Ext.data.writer.Writer The attached Writer object */ setWriter?( writer?:any ): Ext.data.writer.IWriter; /** [Method] Suspends firing of the named event s @@ -6618,6 +7021,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -6626,12 +7030,12 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Performs a batch of Operations in the order specified by batchOrder * @param options Object Object containing one or more properties supported by the batch method: + * @returns Ext.data.Batch The newly created Batch */ batch?( options?:any ): Ext.data.IBatch; /** [Method] Removes all listeners for this object including the managed listeners */ @@ -6653,27 +7057,34 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the model attached to this Proxy */ + /** [Method] Returns the model attached to this Proxy + * @returns Ext.data.Model The model + */ getModel?(): Ext.data.IModel; - /** [Method] Returns the reader currently attached to this proxy instance */ + /** [Method] Returns the reader currently attached to this proxy instance + * @returns Ext.data.reader.Reader The Reader instance + */ getReader?(): Ext.data.reader.IReader; - /** [Method] Returns the writer currently attached to this proxy instance */ + /** [Method] Returns the writer currently attached to this proxy instance + * @returns Ext.data.writer.Writer The Writer instance + */ getWriter?(): Ext.data.writer.IWriter; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -6682,24 +7093,22 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Performs the given read operation @@ -6712,6 +7121,7 @@ declare module Ext.data { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -6726,9 +7136,7 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -6739,15 +7147,15 @@ declare module Ext.data { * @param model String/Ext.data.Model The new model. Can be either the model name string, or a reference to the model's constructor * @param setOnStore Boolean Sets the new model on the associated Store, if one is present */ - setModel?( model?:any, setOnStore?:any ): any; - setModel?( model?:string, setOnStore?:boolean ): void; - setModel?( model?:Ext.data.IModel, setOnStore?:boolean ): void; + setModel?( model?:any, setOnStore?:boolean ): void; /** [Method] Sets the Proxy s Reader by string config object or Reader instance * @param reader String/Object/Ext.data.reader.Reader The new Reader, which can be either a type string, a configuration object or an Ext.data.reader.Reader instance + * @returns Ext.data.reader.Reader The attached Reader object */ setReader?( reader?:any ): Ext.data.reader.IReader; /** [Method] Sets the Proxy s Writer by string config object or Writer instance * @param writer String/Object/Ext.data.writer.Writer The new Writer, which can be either a type string, a configuration object or an Ext.data.writer.Writer instance + * @returns Ext.data.writer.Writer The attached Writer object */ setWriter?( writer?:any ): Ext.data.writer.IWriter; /** [Method] Suspends firing of the named event s @@ -6797,6 +7205,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -6805,12 +7214,12 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Performs a batch of Operations in the order specified by batchOrder * @param options Object Object containing one or more properties supported by the batch method: + * @returns Ext.data.Batch The newly created Batch */ batch?( options?:any ): Ext.data.IBatch; /** [Method] Removes all listeners for this object including the managed listeners */ @@ -6832,27 +7241,34 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the model attached to this Proxy */ + /** [Method] Returns the model attached to this Proxy + * @returns Ext.data.Model The model + */ getModel?(): Ext.data.IModel; - /** [Method] Returns the reader currently attached to this proxy instance */ + /** [Method] Returns the reader currently attached to this proxy instance + * @returns Ext.data.reader.Reader The Reader instance + */ getReader?(): Ext.data.reader.IReader; - /** [Method] Returns the writer currently attached to this proxy instance */ + /** [Method] Returns the writer currently attached to this proxy instance + * @returns Ext.data.writer.Writer The Writer instance + */ getWriter?(): Ext.data.writer.IWriter; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -6861,24 +7277,22 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Performs the given read operation @@ -6891,6 +7305,7 @@ declare module Ext.data { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -6905,9 +7320,7 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -6918,15 +7331,15 @@ declare module Ext.data { * @param model String/Ext.data.Model The new model. Can be either the model name string, or a reference to the model's constructor * @param setOnStore Boolean Sets the new model on the associated Store, if one is present */ - setModel?( model?:any, setOnStore?:any ): any; - setModel?( model?:string, setOnStore?:boolean ): void; - setModel?( model?:Ext.data.IModel, setOnStore?:boolean ): void; + setModel?( model?:any, setOnStore?:boolean ): void; /** [Method] Sets the Proxy s Reader by string config object or Reader instance * @param reader String/Object/Ext.data.reader.Reader The new Reader, which can be either a type string, a configuration object or an Ext.data.reader.Reader instance + * @returns Ext.data.reader.Reader The attached Reader object */ setReader?( reader?:any ): Ext.data.reader.IReader; /** [Method] Sets the Proxy s Writer by string config object or Writer instance * @param writer String/Object/Ext.data.writer.Writer The new Writer, which can be either a type string, a configuration object or an Ext.data.writer.Writer instance + * @returns Ext.data.writer.Writer The attached Writer object */ setWriter?( writer?:any ): Ext.data.writer.IWriter; /** [Method] Suspends firing of the named event s @@ -6961,10 +7374,6 @@ declare module Ext.data.proxy { format?: string; /** [Property] (Object) */ actionMethods?: any; - /** [Method] Specialized version of buildUrl that incorporates the appendId and format options into the generated url - * @param request Object - */ - buildUrl?( request?:any ): void; } } declare module Ext.data { @@ -6977,10 +7386,6 @@ declare module Ext.data { format?: string; /** [Property] (Object) */ actionMethods?: any; - /** [Method] Specialized version of buildUrl that incorporates the appendId and format options into the generated url - * @param request Object - */ - buildUrl?( request?:any ): void; } } declare module Ext.data.proxy { @@ -7026,10 +7431,12 @@ declare module Ext.data.proxy { afterRequest?( request?:Ext.data.IRequest, success?:boolean ): void; /** [Method] Creates an Request object from Operation * @param operation Ext.data.Operation The operation to execute + * @returns Ext.data.Request The request object */ buildRequest?( operation?:Ext.data.IOperation ): Ext.data.IRequest; /** [Method] Generates a url based on a given Ext data Request object * @param request Ext.data.Request The request object + * @returns String The url */ buildUrl?( request?:Ext.data.IRequest ): string; /** [Method] in a ServerProxy all four CRUD operations are executed in the same manner so we delegate to doRequest in each case */ @@ -7044,10 +7451,12 @@ declare module Ext.data.proxy { doRequest?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; /** [Method] Encodes the array of Ext util Filter objects into a string to be sent in the request url * @param filters Ext.util.Filter[] The array of Filter objects + * @returns String The encoded filters */ encodeFilters?( filters?:Ext.util.IFilter[] ): string; /** [Method] Encodes the array of Ext util Sorter objects into a string to be sent in the request url * @param sorters Ext.util.Sorter[] The array of Sorter objects + * @returns String The encoded sorters */ encodeSorters?( sorters?:Ext.util.ISorter[] ): string; /** [Method] Performs the given read operation */ @@ -7104,10 +7513,12 @@ declare module Ext.data { afterRequest?( request?:Ext.data.IRequest, success?:boolean ): void; /** [Method] Creates an Request object from Operation * @param operation Ext.data.Operation The operation to execute + * @returns Ext.data.Request The request object */ buildRequest?( operation?:Ext.data.IOperation ): Ext.data.IRequest; /** [Method] Generates a url based on a given Ext data Request object * @param request Ext.data.Request The request object + * @returns String The url */ buildUrl?( request?:Ext.data.IRequest ): string; /** [Method] in a ServerProxy all four CRUD operations are executed in the same manner so we delegate to doRequest in each case */ @@ -7122,10 +7533,12 @@ declare module Ext.data { doRequest?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; /** [Method] Encodes the array of Ext util Filter objects into a string to be sent in the request url * @param filters Ext.util.Filter[] The array of Filter objects + * @returns String The encoded filters */ encodeFilters?( filters?:Ext.util.IFilter[] ): string; /** [Method] Encodes the array of Ext util Sorter objects into a string to be sent in the request url * @param sorters Ext.util.Sorter[] The array of Sorter objects + * @returns String The encoded sorters */ encodeSorters?( sorters?:Ext.util.ISorter[] ): string; /** [Method] Performs the given read operation */ @@ -7255,10 +7668,12 @@ declare module Ext.data.reader { jsonData?: any; /** [Method] inherit docs * @param response Object + * @returns Ext.data.ResultSet A ResultSet object */ getResponseData?( response?:any ): Ext.data.IResultSet; /** [Method] Reads a JSON object and returns a ResultSet * @param data Object The raw JSON data + * @returns Ext.data.ResultSet A ResultSet containing model instances and meta data about the results */ readRecords?( data?:any ): Ext.data.IResultSet; } @@ -7277,10 +7692,12 @@ declare module Ext.data { jsonData?: any; /** [Method] inherit docs * @param response Object + * @returns Ext.data.ResultSet A ResultSet object */ getResponseData?( response?:any ): Ext.data.IResultSet; /** [Method] Reads a JSON object and returns a ResultSet * @param data Object The raw JSON data + * @returns Ext.data.ResultSet A ResultSet containing model instances and meta data about the results */ readRecords?( data?:any ): Ext.data.IResultSet; } @@ -7314,6 +7731,7 @@ declare module Ext.data.reader { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -7322,10 +7740,9 @@ declare module Ext.data.reader { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -7333,25 +7750,27 @@ declare module Ext.data.reader { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Takes a raw response object as passed to the read method and returns the useful data segment from it * @param response Object The response object + * @returns Ext.data.ResultSet A ResultSet object */ getResponseData?( response?:any ): Ext.data.IResultSet; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -7360,38 +7779,39 @@ declare module Ext.data.reader { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Reads the given response object * @param response Object The response object. This may be either an XMLHttpRequest object or a plain JS object + * @returns Ext.data.ResultSet The parsed or default ResultSet object */ read?( response?:any ): Ext.data.IResultSet; /** [Method] Abstracts common functionality used by all Reader subclasses * @param data Object The raw data object + * @returns Ext.data.ResultSet A ResultSet object */ readRecords?( data?:any ): Ext.data.IResultSet; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -7406,9 +7826,7 @@ declare module Ext.data.reader { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -7460,6 +7878,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -7468,10 +7887,9 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -7479,25 +7897,27 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Takes a raw response object as passed to the read method and returns the useful data segment from it * @param response Object The response object + * @returns Ext.data.ResultSet A ResultSet object */ getResponseData?( response?:any ): Ext.data.IResultSet; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -7506,38 +7926,39 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Reads the given response object * @param response Object The response object. This may be either an XMLHttpRequest object or a plain JS object + * @returns Ext.data.ResultSet The parsed or default ResultSet object */ read?( response?:any ): Ext.data.IResultSet; /** [Method] Abstracts common functionality used by all Reader subclasses * @param data Object The raw data object + * @returns Ext.data.ResultSet A ResultSet object */ readRecords?( data?:any ): Ext.data.IResultSet; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -7552,9 +7973,7 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -7606,6 +8025,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -7614,10 +8034,9 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -7625,25 +8044,27 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Takes a raw response object as passed to the read method and returns the useful data segment from it * @param response Object The response object + * @returns Ext.data.ResultSet A ResultSet object */ getResponseData?( response?:any ): Ext.data.IResultSet; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -7652,38 +8073,39 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Reads the given response object * @param response Object The response object. This may be either an XMLHttpRequest object or a plain JS object + * @returns Ext.data.ResultSet The parsed or default ResultSet object */ read?( response?:any ): Ext.data.IResultSet; /** [Method] Abstracts common functionality used by all Reader subclasses * @param data Object The raw data object + * @returns Ext.data.ResultSet A ResultSet object */ readRecords?( data?:any ): Ext.data.IResultSet; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -7698,9 +8120,7 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -7733,14 +8153,17 @@ declare module Ext.data.reader { xmlData?: any; /** [Method] Normalizes the data object * @param data Object The raw data object + * @returns Object The documentElement property of the data object if present, or the same object if not. */ getData?( data?:any ): any; /** [Method] inherit docs * @param response Object + * @returns Ext.data.ResultSet A ResultSet object */ getResponseData?( response?:any ): Ext.data.IResultSet; /** [Method] Parses an XML document and returns a ResultSet containing the model instances * @param doc Object Parsed XML document + * @returns Ext.data.ResultSet The parsed result set */ readRecords?( doc?:any ): Ext.data.IResultSet; } @@ -7755,14 +8178,17 @@ declare module Ext.data { xmlData?: any; /** [Method] Normalizes the data object * @param data Object The raw data object + * @returns Object The documentElement property of the data object if present, or the same object if not. */ getData?( data?:any ): any; /** [Method] inherit docs * @param response Object + * @returns Ext.data.ResultSet A ResultSet object */ getResponseData?( response?:any ): Ext.data.IResultSet; /** [Method] Parses an XML document and returns a ResultSet containing the model instances * @param doc Object Parsed XML document + * @returns Ext.data.ResultSet The parsed result set */ readRecords?( doc?:any ): Ext.data.IResultSet; } @@ -7801,7 +8227,9 @@ declare module Ext.data { prefix?: string; /** [Config Option] (Number) */ seed?: number; - /** [Method] Generates and returns the next id */ + /** [Method] Generates and returns the next id + * @returns String The next id. + */ generate?(): string; } } @@ -7811,56 +8239,67 @@ declare module Ext.data { export class SortTypes { /** [Method] Date sorting * @param s Object The value being converted + * @returns Number The comparison value */ static asDate( s?:any ): number; /** [Method] Float sorting * @param s Object The value being converted + * @returns Number The comparison value */ static asFloat( s?:any ): number; /** [Method] Integer sorting * @param s Object The value being converted + * @returns Number The comparison value */ static asInt( s?:any ): number; /** [Method] Strips all HTML tags to sort on text only * @param s Object The value being converted + * @returns String The comparison value */ static asText( s?:any ): string; /** [Method] Case insensitive string * @param s Object The value being converted + * @returns String The comparison value */ static asUCString( s?:any ): string; /** [Method] Strips all HTML tags to sort on text only Case insensitive * @param s Object The value being converted + * @returns String The comparison value */ static asUCText( s?:any ): string; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Default sort that does nothing * @param s Object The value being converted + * @returns Object The comparison value */ static none( s?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -7906,6 +8345,7 @@ declare module Ext.data { snapshot?: Ext.util.IMixedCollection; /** [Method] Adds Model instance to the Store * @param model Ext.data.Model[]/Ext.data.Model.../Object[]/Object... An array of Model instances or Model configuration objects, or variable number of Model instance or config arguments. + * @returns Ext.data.Model[] The model instances that were added */ add?( model?:any ): Ext.data.IModel[]; /** [Method] Adds a new Filter to this Store s filter set and by default applys the updated filter set to the Store s unfiltered @@ -7922,11 +8362,13 @@ declare module Ext.data { * @param scope Object The scope to execute the function in. Defaults to the store. * @param grouped Boolean True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the group average being the value. The grouped parameter is only honored if the store has a groupField. * @param args Array Any arguments to append to the function call + * @returns Object An object literal with the group names and their appropriate values. */ aggregate?( fn?:any, scope?:any, grouped?:boolean, args?:any[] ): any; /** [Method] Gets the average value in the store * @param field String The field in each record * @param grouped Boolean True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the group average being the value. The grouped parameter is only honored if the store has a groupField. + * @returns Object The average value, if no items exist, 0. */ average?( field?:string, grouped?:boolean ): any; /** [Method] Reverts to a view of the Record cache with no filtering applied @@ -7939,12 +8381,14 @@ declare module Ext.data { * @param dataIndex String The property to collect * @param allowNull Boolean Pass true to allow null, undefined or empty string values * @param bypassFilter Boolean Pass true to collect from all records, even ones which are filtered. + * @returns Object[] An array of the unique values */ collect?( dataIndex?:string, allowNull?:boolean, bypassFilter?:boolean ): any[]; /** [Method] Commits all Records with outstanding changes */ commitChanges?(): void; /** [Method] Gets the count of items in the store * @param grouped Boolean True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the count for each group being the value. The grouped parameter is only honored if the store has a groupField. + * @returns Number the count */ count?( grouped?:boolean ): number; /** [Method] Calls the specified function for each record in the store @@ -7969,20 +8413,21 @@ declare module Ext.data { * @param anyMatch Boolean True to match any part of the string, not just the beginning * @param caseSensitive Boolean True for case sensitive comparison * @param exactMatch Boolean True to force exact match (^ and $ characters added to the regex). + * @returns Number The matched index or -1 */ - find?( fieldName?:any, value?:any, startIndex?:any, anyMatch?:any, caseSensitive?:any, exactMatch?:any ): any; - find?( fieldName?:string, value?:string, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): number; - find?( fieldName?:string, value?:RegExp, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): number; + find?( fieldName?:string, value?:any, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): number; /** [Method] Find the index of the first matching Record in this Store by a function * @param fn Function The function to be called. It will be passed the following parameters: * @param scope Object The scope (this reference) in which the function is executed. Defaults to this Store. * @param startIndex Number The index to start searching at + * @returns Number The matched index or -1 */ findBy?( fn?:any, scope?:any, startIndex?:number ): number; /** [Method] Finds the index of the first matching Record in this store by a specific field value * @param fieldName String The name of the Record field to test. * @param value Object The value to match the field against. * @param startIndex Number The index to start searching at + * @returns Number The matched index or -1 */ findExact?( fieldName?:string, value?:any, startIndex?:number ): number; /** [Method] Finds the first matching Record in this store by a specific field value @@ -7992,51 +8437,61 @@ declare module Ext.data { * @param anyMatch Boolean True to match any part of the string, not just the beginning * @param caseSensitive Boolean True for case sensitive comparison * @param exactMatch Boolean True to force exact match (^ and $ characters added to the regex). + * @returns Ext.data.Model The matched record or null */ - findRecord?( fieldName?:any, value?:any, startIndex?:any, anyMatch?:any, caseSensitive?:any, exactMatch?:any ): any; - findRecord?( fieldName?:string, value?:string, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): Ext.data.IModel; - findRecord?( fieldName?:string, value?:RegExp, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): Ext.data.IModel; + findRecord?( fieldName?:string, value?:any, startIndex?:number, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): Ext.data.IModel; /** [Method] Convenience function for getting the first model instance in the store * @param grouped Boolean True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the first record being the value. The grouped parameter is only honored if the store has a groupField. + * @returns Ext.data.Model/undefined The first model instance in the store, or undefined */ - first?( grouped?:boolean ): Ext.data.IModel; - /** [Method] Convenience function for getting the first model instance in the store - * @param grouped Boolean True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the first record being the value. The grouped parameter is only honored if the store has a groupField. - */ - first?( grouped?:boolean ): void; + first?( grouped?:boolean ): any; /** [Method] Get the Record at the specified index * @param index Number The index of the Record to find. + * @returns Ext.data.Model The Record at the passed index. Returns undefined if not found. */ getAt?( index?:number ): Ext.data.IModel; /** [Method] Get the Record with the specified id * @param id Mixed The id of the Record to find. + * @returns Ext.data.Model The Record with the passed id. Returns null if not found. */ getById?( id?:any ): Ext.data.IModel; - /** [Method] Gets the number of records in store */ + /** [Method] Gets the number of records in store + * @returns Number The number of Records in the Store. + */ getCount?(): number; /** [Method] Returns the string to group on for a given model instance * @param instance Ext.data.Model The model instance + * @returns String The string to compare when forming groups */ getGroupString?( instance?:Ext.data.IModel ): string; /** [Method] Returns an array containing the result of applying grouping to the records in this store * @param groupName String Pass in an optional groupName argument to access a specific group as defined by getGroupString. + * @returns Object/Object[] The grouped data */ getGroups?( groupName?:string ): any; - /** [Method] inherit docs */ + /** [Method] inherit docs + * @returns Ext.data.Model[] The Model instances + */ getNewRecords?(): Ext.data.IModel[]; /** [Method] Determines the page from a record index * @param index Number The record index + * @returns Number The page the record belongs to */ getPageFromRecordIndex?( index?:number ): number; /** [Method] Gathers a range of Records between specified indices * @param start Number The starting index. Defaults to zero for non buffered Stores. * @param end Number The ending index. Defaults to the last Record for non buffered Stores. * @param options Object Used when the Store is {@link buffered] and the range may not be available synchronously. + * @returns Ext.data.Model[] An array of records if the records are immediately available. For buffered stores, you should pass the callback option unless you know that the range will be present - see rangeCached. */ getRange?( start?:number, end?:number, options?:any ): Ext.data.IModel[]; - /** [Method] Returns the total number of Model instances that the Proxy indicates exist */ + /** [Method] Returns the total number of Model instances that the Proxy indicates exist + * @returns Number The total number of Model instances available via the Proxy. 0 returned if no value has been set via the reader. + */ getTotalCount?(): number; - /** [Method] inherit docs */ + /** [Method] inherit docs + * @returns Ext.data.Model[] The updated Model instances + */ getUpdatedRecords?(): Ext.data.IModel[]; /** [Method] Groups data inside the store * @param groupers String/Object[] Either a string name of one of the fields in this Store's configured Model, or an Array of grouper configurations. @@ -8053,33 +8508,38 @@ declare module Ext.data { guaranteeRange?( start?:any, end?:any, callback?:any, scope?:any, options?:any ): void; /** [Method] Get the index of the record within the store * @param record Ext.data.Model The Ext.data.Model object to find. + * @returns Number The index of the passed Record. Returns -1 if not found. */ indexOf?( record?:Ext.data.IModel ): number; /** [Method] Get the index within the store of the Record with the passed id * @param id String The id of the Record to find. + * @returns Number The index of the Record. Returns -1 if not found. */ indexOfId?( id?:string ): number; /** [Method] Get the index within the entire dataset * @param record Ext.data.Model The Ext.data.Model object to find. + * @returns Number The index of the passed Record. Returns -1 if not found. */ indexOfTotal?( record?:Ext.data.IModel ): number; /** [Method] Inserts Model instances into the Store at the given index and fires the add event * @param index Number The start index at which to insert the passed Records. * @param records Ext.data.Model[] An Array of Ext.data.Model objects to add to the store. + * @returns Ext.data.Model[] records The added records */ insert?( index?:number, records?:Ext.data.IModel[] ): Ext.data.IModel[]; - /** [Method] Returns true if this store is currently filtered */ + /** [Method] Returns true if this store is currently filtered + * @returns Boolean + */ isFiltered?(): boolean; - /** [Method] Checks if the store is currently grouped */ + /** [Method] Checks if the store is currently grouped + * @returns Boolean true if the store is grouped. + */ isGrouped?(): boolean; /** [Method] Convenience function for getting the last model instance in the store * @param grouped Boolean True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the last record being the value. The grouped parameter is only honored if the store has a groupField. + * @returns Ext.data.Model/undefined The last model instance in the store, or undefined */ - last?( grouped?:boolean ): Ext.data.IModel; - /** [Method] Convenience function for getting the last model instance in the store - * @param grouped Boolean True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the last record being the value. The grouped parameter is only honored if the store has a groupField. - */ - last?( grouped?:boolean ): void; + last?( grouped?:boolean ): any; /** [Method] Loads data into the Store via the configured proxy * @param options Object/Function config object, passed into the Ext.data.Operation object before loading. Additionally addRecords: true can be specified to add these records to the existing records, default is to remove the Store's existing records first. */ @@ -8107,11 +8567,13 @@ declare module Ext.data { /** [Method] Gets the maximum value in the store * @param field String The field in each record * @param grouped Boolean True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the maximum in the group being the value. The grouped parameter is only honored if the store has a groupField. + * @returns Object The maximum value, if no items exist, undefined. */ max?( field?:string, grouped?:boolean ): any; /** [Method] Gets the minimum value in the store * @param field String The field in each record * @param grouped Boolean True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the minimum in the group being the value. The grouped parameter is only honored if the store has a groupField. + * @returns Object The minimum value, if no items exist, undefined. */ min?( field?:string, grouped?:boolean ): any; /** [Method] Loads the next page in the current data set @@ -8142,13 +8604,13 @@ declare module Ext.data { * @param anyMatch Boolean true if we don't care if the filter value is not the full value. * @param caseSensitive Boolean true to create a case-sensitive regex. * @param exactMatch Boolean true to force exact match (^ and $ characters added to the regex). Ignored if anyMatch is true. + * @returns Ext.util.MixedCollection Returns an Ext.util.MixedCollection of the matched records */ - query?( property?:any, value?:any, anyMatch?:any, caseSensitive?:any, exactMatch?:any ): any; - query?( property?:string, value?:string, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): Ext.util.IMixedCollection; - query?( property?:string, value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): Ext.util.IMixedCollection; + query?( property?:string, value?:any, anyMatch?:boolean, caseSensitive?:boolean, exactMatch?:boolean ): Ext.util.IMixedCollection; /** [Method] Query all the cached records in this Store using a filtering function * @param fn Function The function to be called. It will be passed the following parameters: * @param scope Object The scope (this reference) in which the function is executed Defaults to this Store. + * @returns Ext.util.MixedCollection Returns an Ext.util.MixedCollection of the matched records */ queryBy?( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Rejects outstanding changes on all modified records and re insert any records that were removed locally */ @@ -8160,11 +8622,7 @@ declare module Ext.data { /** [Method] Removes the specified record s from the Store firing the remove event for each instance that is removed * @param records Ext.data.Model/Ext.data.Model[]/Number/Number[] Model instance or array of instances to remove or an array of indices from which to remove records. */ - remove?( records?:any ): any; - remove?( records?:Ext.data.IModel ): void; - remove?( records?:Ext.data.IModel[] ): void; - remove?( records?:number ): void; - remove?( records?:number[] ): void; + remove?( records?:any ): void; /** [Method] Removes all items from the store * @param silent Boolean Pass true to prevent the record bulkremove and clear events from being fired. */ @@ -8179,11 +8637,14 @@ declare module Ext.data { * @param applyFilters Boolean Pass as false to remove the filter but not apply the updated filter set. If null is passed, all anonymous Filters (Filters with no id property) will be removed. */ removeFilter?( toRemove?:any, applyFilters?:boolean ): void; - /** [Method] because prefetchData is stored by index this invalidates all of the prefetchedData */ + /** [Method] because prefetchData is stored by index this invalidates all of the prefetchedData + * @returns Ext.util.Sorter[] + */ sort?(): Ext.util.ISorter[]; /** [Method] Sums the value of field for each record in store and returns the result * @param field String A field in each record * @param grouped Boolean True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the sum for that group being the value. The grouped parameter is only honored if the store has a groupField. + * @returns Number The sum */ sum?( field?:string, grouped?:boolean ): number; } @@ -8195,6 +8656,7 @@ declare module Ext.data { /** [Method] Adds an item to the collection * @param key String/Object The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param obj Object The item to add. + * @returns Object The item added. */ static add( key?:any, obj?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -8210,6 +8672,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -8218,45 +8681,49 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all items from the collection */ static clear(): void; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ static clearManagedListeners(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ static clone(): Ext.util.IMixedCollection; /** [Method] Collects unique values of a particular property in this MixedCollection * @param property String The property to collect on * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param allowBlank Boolean Pass true to allow null, undefined or empty string values + * @returns Array The unique values */ static collect( property?:string, root?:string, allowBlank?:boolean ): any[]; /** [Method] Returns true if the collection contains the passed Object as an item * @param o Object The Object to look for in the collection. + * @returns Boolean True if the collection contains the Object as an item. */ static contains( o?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean True if the collection contains the Object as a key. */ static containsKey( key?:string ): boolean; /** [Method] Executes the specified function once for every item in the collection @@ -8272,23 +8739,19 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Filters the objects in this collection by a set of Filters or by a single property value pair with optional paramete * @param property Ext.util.Filter[]/String A property on your objects, or an array of Filter objects * @param value String/RegExp Either string that the property values should start with or a RegExp to test against the property * @param anyMatch Boolean True to match any part of the string, not just the beginning * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Ext.util.MixedCollection The new filtered collection */ - static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any; - static filter( property?:Ext.util.IFilter[], value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:Ext.util.IFilter[], value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; + static filter( property?:any, value?:any, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ static filterBy( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function */ @@ -8296,6 +8759,7 @@ declare module Ext.data { /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function, or null if none was found. */ static findBy( fn?:any, scope?:any ): any; /** [Method] Finds the index of the first matching object in this collection by a specific property value @@ -8304,82 +8768,97 @@ declare module Ext.data { * @param start Number The index to start searching at. * @param anyMatch Boolean True to match any part of the string, not just the beginning. * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Number The matched index or -1 */ - static findIndex( property?:any, value?:any, start?:any, anyMatch?:any, caseSensitive?:any ): any; - static findIndex( property?:string, value?:string, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; - static findIndex( property?:string, value?:RegExp, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; + static findIndex( property?:string, value?:any, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index or -1 */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] Calculates the insertion index of the new item based upon the comparison function passed or the current sort order * @param newItem Object The new object to find the insertion position of. * @param sorterFn Function The function to sort by. This is the same as the sorting function passed to sortBy. It accepts 2 items from this MixedCollection, and returns -1 0, or 1 depending on the relative sort positions of the 2 compared items. If omitted, a function generated from the currently defined set of sorters will be used. + * @returns Number The insertion point to add the new item into this MixedCollection at using insert */ static findInsertionIndex( newItem?:any, sorterFn?:any ): number; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection.. + */ static first(): any; /** [Method] Returns a comparator function which compares two items and returns 1 0 or 1 depending on the currently defined set */ static generateComparator(): void; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ static get( key?:any ): any; - static get( key?:string ): any; - static get( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ static getAt( index?:number ): any; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ static getByKey( key?:any ): any; - static getByKey( key?:string ): any; - static getByKey( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ static getCount(): number; - /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place */ + /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place + * @returns Ext.util.Sorter The sorter, null if none exist + */ static getFirstSorter(): Ext.util.ISorter; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] getKey implementation for MixedCollection * @param o Object + * @returns Object The key for the passed item. */ static getKey( o?:any ): any; /** [Method] Returns a range of items in this collection * @param startIndex Number The starting index. Defaults to 0. * @param endIndex Number The ending index. Defaults to the last item. + * @returns Array An array of items */ static getRange( startIndex?:number, endIndex?:number ): any[]; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Returns index within the collection of the passed Object * @param o Object The item to find the index of. + * @returns Number index of the item. Returns -1 if not found. */ static indexOf( o?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number index of the key. */ static indexOfKey( key?:string ): number; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Performs initialization of this mixin */ @@ -8388,12 +8867,16 @@ declare module Ext.data { * @param index Number The index to insert the item at. * @param key String/Object/String[]/Object[] The key to associate with the new item, or the item itself. May also be an array of either to insert multiple items at once. * @param o Object/Object[] If the second parameter was a key, the new item. May also be an array to insert multiple items at once. + * @returns Object The item inserted or an array of items inserted. */ static insert( index?:number, key?:any, o?:any ): any; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection.. + */ static last(): any; /** [Method] Gets a registered Store by id * @param store String/Object The id of the Store, or a Store instance, or a store configuration + * @returns Ext.data.Store */ static lookup( store?:any ): Ext.data.IStore; /** [Method] Shorthand for addManagedListener @@ -8402,24 +8885,22 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Registers one or more Stores with the StoreManager @@ -8430,22 +8911,27 @@ declare module Ext.data { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Remove an item from the collection * @param o Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( o?:any ): any; /** [Method] Remove all items in the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ static removeAll( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ static removeAt( index?:number ): any; /** [Method] Removes an item associated with the passed key fom the collection * @param key String The key of the item to remove. If null is passed, all objects which yielded no key from the configured getKey function are removed. + * @returns Object Only returned if removing at a specified key. The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] Removes an event handler @@ -8460,12 +8946,11 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Remove a range of items starting at a specified index in the collection * @param index Number The index within the collection of the item to remove. * @param removeCount Number The nuber of items to remove beginning at the specified index. + * @returns Object The last item removed or false if no item was removed. */ static removeRange( index?:number, removeCount?:number ): any; /** [Method] Reorders each of the items based on a mapping from old index to new index @@ -8475,6 +8960,7 @@ declare module Ext.data { /** [Method] Replaces an item in the collection * @param key String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param o Object {Object} o (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( key?:string, o?:any ): any; /** [Method] Resumes firing of the named event s @@ -8486,10 +8972,9 @@ declare module Ext.data { /** [Method] Sorts the data in the Store by one or more of its properties * @param sorters String/Ext.util.Sorter[] Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations. * @param direction String The overall direction to sort the data by. + * @returns Ext.util.Sorter[] */ - static sort( sorters?:any, direction?:any ): any; - static sort( sorters?:string, direction?:string ): Ext.util.ISorter[]; - static sort( sorters?:Ext.util.ISorter[], direction?:string ): Ext.util.ISorter[]; + static sort( sorters?:any, direction?:string ): Ext.util.ISorter[]; /** [Method] Sorts the collection by a single sorter function * @param sorterFn Function The function to sort by */ @@ -8499,13 +8984,16 @@ declare module Ext.data { * @param fn Function Comparison function that defines the sort order. Defaults to sorting by case insensitive string. */ static sortByKey( direction?:string, fn?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Collects all of the values of the given property and returns their sum * @param property String The property to sum by * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param start Number The record index to start at * @param end Number The record index to end at + * @returns Number The total */ static sum( property?:string, root?:string, start?:number, end?:number ): number; /** [Method] Suspends firing of the named event s @@ -8540,6 +9028,7 @@ declare module Ext { /** [Method] Adds an item to the collection * @param key String/Object The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param obj Object The item to add. + * @returns Object The item added. */ static add( key?:any, obj?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -8555,6 +9044,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -8563,45 +9053,49 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all items from the collection */ static clear(): void; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ static clearManagedListeners(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ static clone(): Ext.util.IMixedCollection; /** [Method] Collects unique values of a particular property in this MixedCollection * @param property String The property to collect on * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param allowBlank Boolean Pass true to allow null, undefined or empty string values + * @returns Array The unique values */ static collect( property?:string, root?:string, allowBlank?:boolean ): any[]; /** [Method] Returns true if the collection contains the passed Object as an item * @param o Object The Object to look for in the collection. + * @returns Boolean True if the collection contains the Object as an item. */ static contains( o?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean True if the collection contains the Object as a key. */ static containsKey( key?:string ): boolean; /** [Method] Executes the specified function once for every item in the collection @@ -8617,23 +9111,19 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Filters the objects in this collection by a set of Filters or by a single property value pair with optional paramete * @param property Ext.util.Filter[]/String A property on your objects, or an array of Filter objects * @param value String/RegExp Either string that the property values should start with or a RegExp to test against the property * @param anyMatch Boolean True to match any part of the string, not just the beginning * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Ext.util.MixedCollection The new filtered collection */ - static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any; - static filter( property?:Ext.util.IFilter[], value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:Ext.util.IFilter[], value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; + static filter( property?:any, value?:any, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ static filterBy( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function */ @@ -8641,6 +9131,7 @@ declare module Ext { /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function, or null if none was found. */ static findBy( fn?:any, scope?:any ): any; /** [Method] Finds the index of the first matching object in this collection by a specific property value @@ -8649,82 +9140,97 @@ declare module Ext { * @param start Number The index to start searching at. * @param anyMatch Boolean True to match any part of the string, not just the beginning. * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Number The matched index or -1 */ - static findIndex( property?:any, value?:any, start?:any, anyMatch?:any, caseSensitive?:any ): any; - static findIndex( property?:string, value?:string, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; - static findIndex( property?:string, value?:RegExp, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; + static findIndex( property?:string, value?:any, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index or -1 */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] Calculates the insertion index of the new item based upon the comparison function passed or the current sort order * @param newItem Object The new object to find the insertion position of. * @param sorterFn Function The function to sort by. This is the same as the sorting function passed to sortBy. It accepts 2 items from this MixedCollection, and returns -1 0, or 1 depending on the relative sort positions of the 2 compared items. If omitted, a function generated from the currently defined set of sorters will be used. + * @returns Number The insertion point to add the new item into this MixedCollection at using insert */ static findInsertionIndex( newItem?:any, sorterFn?:any ): number; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection.. + */ static first(): any; /** [Method] Returns a comparator function which compares two items and returns 1 0 or 1 depending on the currently defined set */ static generateComparator(): void; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ static get( key?:any ): any; - static get( key?:string ): any; - static get( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ static getAt( index?:number ): any; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ static getByKey( key?:any ): any; - static getByKey( key?:string ): any; - static getByKey( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ static getCount(): number; - /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place */ + /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place + * @returns Ext.util.Sorter The sorter, null if none exist + */ static getFirstSorter(): Ext.util.ISorter; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] getKey implementation for MixedCollection * @param o Object + * @returns Object The key for the passed item. */ static getKey( o?:any ): any; /** [Method] Returns a range of items in this collection * @param startIndex Number The starting index. Defaults to 0. * @param endIndex Number The ending index. Defaults to the last item. + * @returns Array An array of items */ static getRange( startIndex?:number, endIndex?:number ): any[]; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Returns index within the collection of the passed Object * @param o Object The item to find the index of. + * @returns Number index of the item. Returns -1 if not found. */ static indexOf( o?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number index of the key. */ static indexOfKey( key?:string ): number; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Performs initialization of this mixin */ @@ -8733,12 +9239,16 @@ declare module Ext { * @param index Number The index to insert the item at. * @param key String/Object/String[]/Object[] The key to associate with the new item, or the item itself. May also be an array of either to insert multiple items at once. * @param o Object/Object[] If the second parameter was a key, the new item. May also be an array to insert multiple items at once. + * @returns Object The item inserted or an array of items inserted. */ static insert( index?:number, key?:any, o?:any ): any; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection.. + */ static last(): any; /** [Method] Gets a registered Store by id * @param store String/Object The id of the Store, or a Store instance, or a store configuration + * @returns Ext.data.Store */ static lookup( store?:any ): Ext.data.IStore; /** [Method] Shorthand for addManagedListener @@ -8747,24 +9257,22 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Registers one or more Stores with the StoreManager @@ -8775,22 +9283,27 @@ declare module Ext { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Remove an item from the collection * @param o Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( o?:any ): any; /** [Method] Remove all items in the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ static removeAll( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ static removeAt( index?:number ): any; /** [Method] Removes an item associated with the passed key fom the collection * @param key String The key of the item to remove. If null is passed, all objects which yielded no key from the configured getKey function are removed. + * @returns Object Only returned if removing at a specified key. The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] Removes an event handler @@ -8805,12 +9318,11 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Remove a range of items starting at a specified index in the collection * @param index Number The index within the collection of the item to remove. * @param removeCount Number The nuber of items to remove beginning at the specified index. + * @returns Object The last item removed or false if no item was removed. */ static removeRange( index?:number, removeCount?:number ): any; /** [Method] Reorders each of the items based on a mapping from old index to new index @@ -8820,6 +9332,7 @@ declare module Ext { /** [Method] Replaces an item in the collection * @param key String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param o Object {Object} o (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( key?:string, o?:any ): any; /** [Method] Resumes firing of the named event s @@ -8831,10 +9344,9 @@ declare module Ext { /** [Method] Sorts the data in the Store by one or more of its properties * @param sorters String/Ext.util.Sorter[] Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations. * @param direction String The overall direction to sort the data by. + * @returns Ext.util.Sorter[] */ - static sort( sorters?:any, direction?:any ): any; - static sort( sorters?:string, direction?:string ): Ext.util.ISorter[]; - static sort( sorters?:Ext.util.ISorter[], direction?:string ): Ext.util.ISorter[]; + static sort( sorters?:any, direction?:string ): Ext.util.ISorter[]; /** [Method] Sorts the collection by a single sorter function * @param sorterFn Function The function to sort by */ @@ -8844,13 +9356,16 @@ declare module Ext { * @param fn Function Comparison function that defines the sort order. Defaults to sorting by case insensitive string. */ static sortByKey( direction?:string, fn?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Collects all of the values of the given property and returns their sum * @param property String The property to sum by * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param start Number The record index to start at * @param end Number The record index to end at + * @returns Number The total */ static sum( property?:string, root?:string, start?:number, end?:number ): number; /** [Method] Suspends firing of the named event s @@ -8885,6 +9400,7 @@ declare module Ext.data { /** [Method] Adds an item to the collection * @param key String/Object The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param obj Object The item to add. + * @returns Object The item added. */ static add( key?:any, obj?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -8900,6 +9416,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -8908,45 +9425,49 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all items from the collection */ static clear(): void; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ static clearManagedListeners(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ static clone(): Ext.util.IMixedCollection; /** [Method] Collects unique values of a particular property in this MixedCollection * @param property String The property to collect on * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param allowBlank Boolean Pass true to allow null, undefined or empty string values + * @returns Array The unique values */ static collect( property?:string, root?:string, allowBlank?:boolean ): any[]; /** [Method] Returns true if the collection contains the passed Object as an item * @param o Object The Object to look for in the collection. + * @returns Boolean True if the collection contains the Object as an item. */ static contains( o?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean True if the collection contains the Object as a key. */ static containsKey( key?:string ): boolean; /** [Method] Executes the specified function once for every item in the collection @@ -8962,23 +9483,19 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Filters the objects in this collection by a set of Filters or by a single property value pair with optional paramete * @param property Ext.util.Filter[]/String A property on your objects, or an array of Filter objects * @param value String/RegExp Either string that the property values should start with or a RegExp to test against the property * @param anyMatch Boolean True to match any part of the string, not just the beginning * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Ext.util.MixedCollection The new filtered collection */ - static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any; - static filter( property?:Ext.util.IFilter[], value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:Ext.util.IFilter[], value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; + static filter( property?:any, value?:any, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ static filterBy( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function */ @@ -8986,6 +9503,7 @@ declare module Ext.data { /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function, or null if none was found. */ static findBy( fn?:any, scope?:any ): any; /** [Method] Finds the index of the first matching object in this collection by a specific property value @@ -8994,82 +9512,97 @@ declare module Ext.data { * @param start Number The index to start searching at. * @param anyMatch Boolean True to match any part of the string, not just the beginning. * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Number The matched index or -1 */ - static findIndex( property?:any, value?:any, start?:any, anyMatch?:any, caseSensitive?:any ): any; - static findIndex( property?:string, value?:string, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; - static findIndex( property?:string, value?:RegExp, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; + static findIndex( property?:string, value?:any, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index or -1 */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] Calculates the insertion index of the new item based upon the comparison function passed or the current sort order * @param newItem Object The new object to find the insertion position of. * @param sorterFn Function The function to sort by. This is the same as the sorting function passed to sortBy. It accepts 2 items from this MixedCollection, and returns -1 0, or 1 depending on the relative sort positions of the 2 compared items. If omitted, a function generated from the currently defined set of sorters will be used. + * @returns Number The insertion point to add the new item into this MixedCollection at using insert */ static findInsertionIndex( newItem?:any, sorterFn?:any ): number; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection.. + */ static first(): any; /** [Method] Returns a comparator function which compares two items and returns 1 0 or 1 depending on the currently defined set */ static generateComparator(): void; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ static get( key?:any ): any; - static get( key?:string ): any; - static get( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ static getAt( index?:number ): any; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ static getByKey( key?:any ): any; - static getByKey( key?:string ): any; - static getByKey( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ static getCount(): number; - /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place */ + /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place + * @returns Ext.util.Sorter The sorter, null if none exist + */ static getFirstSorter(): Ext.util.ISorter; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] getKey implementation for MixedCollection * @param o Object + * @returns Object The key for the passed item. */ static getKey( o?:any ): any; /** [Method] Returns a range of items in this collection * @param startIndex Number The starting index. Defaults to 0. * @param endIndex Number The ending index. Defaults to the last item. + * @returns Array An array of items */ static getRange( startIndex?:number, endIndex?:number ): any[]; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Returns index within the collection of the passed Object * @param o Object The item to find the index of. + * @returns Number index of the item. Returns -1 if not found. */ static indexOf( o?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number index of the key. */ static indexOfKey( key?:string ): number; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Performs initialization of this mixin */ @@ -9078,12 +9611,16 @@ declare module Ext.data { * @param index Number The index to insert the item at. * @param key String/Object/String[]/Object[] The key to associate with the new item, or the item itself. May also be an array of either to insert multiple items at once. * @param o Object/Object[] If the second parameter was a key, the new item. May also be an array to insert multiple items at once. + * @returns Object The item inserted or an array of items inserted. */ static insert( index?:number, key?:any, o?:any ): any; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection.. + */ static last(): any; /** [Method] Gets a registered Store by id * @param store String/Object The id of the Store, or a Store instance, or a store configuration + * @returns Ext.data.Store */ static lookup( store?:any ): Ext.data.IStore; /** [Method] Shorthand for addManagedListener @@ -9092,24 +9629,22 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Registers one or more Stores with the StoreManager @@ -9120,22 +9655,27 @@ declare module Ext.data { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Remove an item from the collection * @param o Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( o?:any ): any; /** [Method] Remove all items in the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ static removeAll( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ static removeAt( index?:number ): any; /** [Method] Removes an item associated with the passed key fom the collection * @param key String The key of the item to remove. If null is passed, all objects which yielded no key from the configured getKey function are removed. + * @returns Object Only returned if removing at a specified key. The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] Removes an event handler @@ -9150,12 +9690,11 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Remove a range of items starting at a specified index in the collection * @param index Number The index within the collection of the item to remove. * @param removeCount Number The nuber of items to remove beginning at the specified index. + * @returns Object The last item removed or false if no item was removed. */ static removeRange( index?:number, removeCount?:number ): any; /** [Method] Reorders each of the items based on a mapping from old index to new index @@ -9165,6 +9704,7 @@ declare module Ext.data { /** [Method] Replaces an item in the collection * @param key String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param o Object {Object} o (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( key?:string, o?:any ): any; /** [Method] Resumes firing of the named event s @@ -9176,10 +9716,9 @@ declare module Ext.data { /** [Method] Sorts the data in the Store by one or more of its properties * @param sorters String/Ext.util.Sorter[] Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations. * @param direction String The overall direction to sort the data by. + * @returns Ext.util.Sorter[] */ - static sort( sorters?:any, direction?:any ): any; - static sort( sorters?:string, direction?:string ): Ext.util.ISorter[]; - static sort( sorters?:Ext.util.ISorter[], direction?:string ): Ext.util.ISorter[]; + static sort( sorters?:any, direction?:string ): Ext.util.ISorter[]; /** [Method] Sorts the collection by a single sorter function * @param sorterFn Function The function to sort by */ @@ -9189,13 +9728,16 @@ declare module Ext.data { * @param fn Function Comparison function that defines the sort order. Defaults to sorting by case insensitive string. */ static sortByKey( direction?:string, fn?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Collects all of the values of the given property and returns their sum * @param property String The property to sum by * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param start Number The record index to start at * @param end Number The record index to end at + * @returns Number The total */ static sum( property?:string, root?:string, start?:number, end?:number ): number; /** [Method] Suspends firing of the named event s @@ -9230,6 +9772,7 @@ declare module Ext { /** [Method] Adds an item to the collection * @param key String/Object The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param obj Object The item to add. + * @returns Object The item added. */ static add( key?:any, obj?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -9245,6 +9788,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -9253,45 +9797,49 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all items from the collection */ static clear(): void; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ static clearManagedListeners(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ static clone(): Ext.util.IMixedCollection; /** [Method] Collects unique values of a particular property in this MixedCollection * @param property String The property to collect on * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param allowBlank Boolean Pass true to allow null, undefined or empty string values + * @returns Array The unique values */ static collect( property?:string, root?:string, allowBlank?:boolean ): any[]; /** [Method] Returns true if the collection contains the passed Object as an item * @param o Object The Object to look for in the collection. + * @returns Boolean True if the collection contains the Object as an item. */ static contains( o?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean True if the collection contains the Object as a key. */ static containsKey( key?:string ): boolean; /** [Method] Executes the specified function once for every item in the collection @@ -9307,23 +9855,19 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Filters the objects in this collection by a set of Filters or by a single property value pair with optional paramete * @param property Ext.util.Filter[]/String A property on your objects, or an array of Filter objects * @param value String/RegExp Either string that the property values should start with or a RegExp to test against the property * @param anyMatch Boolean True to match any part of the string, not just the beginning * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Ext.util.MixedCollection The new filtered collection */ - static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any; - static filter( property?:Ext.util.IFilter[], value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:Ext.util.IFilter[], value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; + static filter( property?:any, value?:any, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ static filterBy( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function */ @@ -9331,6 +9875,7 @@ declare module Ext { /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function, or null if none was found. */ static findBy( fn?:any, scope?:any ): any; /** [Method] Finds the index of the first matching object in this collection by a specific property value @@ -9339,82 +9884,97 @@ declare module Ext { * @param start Number The index to start searching at. * @param anyMatch Boolean True to match any part of the string, not just the beginning. * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Number The matched index or -1 */ - static findIndex( property?:any, value?:any, start?:any, anyMatch?:any, caseSensitive?:any ): any; - static findIndex( property?:string, value?:string, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; - static findIndex( property?:string, value?:RegExp, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; + static findIndex( property?:string, value?:any, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index or -1 */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] Calculates the insertion index of the new item based upon the comparison function passed or the current sort order * @param newItem Object The new object to find the insertion position of. * @param sorterFn Function The function to sort by. This is the same as the sorting function passed to sortBy. It accepts 2 items from this MixedCollection, and returns -1 0, or 1 depending on the relative sort positions of the 2 compared items. If omitted, a function generated from the currently defined set of sorters will be used. + * @returns Number The insertion point to add the new item into this MixedCollection at using insert */ static findInsertionIndex( newItem?:any, sorterFn?:any ): number; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection.. + */ static first(): any; /** [Method] Returns a comparator function which compares two items and returns 1 0 or 1 depending on the currently defined set */ static generateComparator(): void; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ static get( key?:any ): any; - static get( key?:string ): any; - static get( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ static getAt( index?:number ): any; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ static getByKey( key?:any ): any; - static getByKey( key?:string ): any; - static getByKey( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ static getCount(): number; - /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place */ + /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place + * @returns Ext.util.Sorter The sorter, null if none exist + */ static getFirstSorter(): Ext.util.ISorter; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] getKey implementation for MixedCollection * @param o Object + * @returns Object The key for the passed item. */ static getKey( o?:any ): any; /** [Method] Returns a range of items in this collection * @param startIndex Number The starting index. Defaults to 0. * @param endIndex Number The ending index. Defaults to the last item. + * @returns Array An array of items */ static getRange( startIndex?:number, endIndex?:number ): any[]; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Returns index within the collection of the passed Object * @param o Object The item to find the index of. + * @returns Number index of the item. Returns -1 if not found. */ static indexOf( o?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number index of the key. */ static indexOfKey( key?:string ): number; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Performs initialization of this mixin */ @@ -9423,12 +9983,16 @@ declare module Ext { * @param index Number The index to insert the item at. * @param key String/Object/String[]/Object[] The key to associate with the new item, or the item itself. May also be an array of either to insert multiple items at once. * @param o Object/Object[] If the second parameter was a key, the new item. May also be an array to insert multiple items at once. + * @returns Object The item inserted or an array of items inserted. */ static insert( index?:number, key?:any, o?:any ): any; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection.. + */ static last(): any; /** [Method] Gets a registered Store by id * @param store String/Object The id of the Store, or a Store instance, or a store configuration + * @returns Ext.data.Store */ static lookup( store?:any ): Ext.data.IStore; /** [Method] Shorthand for addManagedListener @@ -9437,24 +10001,22 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Registers one or more Stores with the StoreManager @@ -9465,22 +10027,27 @@ declare module Ext { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Remove an item from the collection * @param o Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( o?:any ): any; /** [Method] Remove all items in the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ static removeAll( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ static removeAt( index?:number ): any; /** [Method] Removes an item associated with the passed key fom the collection * @param key String The key of the item to remove. If null is passed, all objects which yielded no key from the configured getKey function are removed. + * @returns Object Only returned if removing at a specified key. The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] Removes an event handler @@ -9495,12 +10062,11 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Remove a range of items starting at a specified index in the collection * @param index Number The index within the collection of the item to remove. * @param removeCount Number The nuber of items to remove beginning at the specified index. + * @returns Object The last item removed or false if no item was removed. */ static removeRange( index?:number, removeCount?:number ): any; /** [Method] Reorders each of the items based on a mapping from old index to new index @@ -9510,6 +10076,7 @@ declare module Ext { /** [Method] Replaces an item in the collection * @param key String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param o Object {Object} o (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( key?:string, o?:any ): any; /** [Method] Resumes firing of the named event s @@ -9521,10 +10088,9 @@ declare module Ext { /** [Method] Sorts the data in the Store by one or more of its properties * @param sorters String/Ext.util.Sorter[] Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations. * @param direction String The overall direction to sort the data by. + * @returns Ext.util.Sorter[] */ - static sort( sorters?:any, direction?:any ): any; - static sort( sorters?:string, direction?:string ): Ext.util.ISorter[]; - static sort( sorters?:Ext.util.ISorter[], direction?:string ): Ext.util.ISorter[]; + static sort( sorters?:any, direction?:string ): Ext.util.ISorter[]; /** [Method] Sorts the collection by a single sorter function * @param sorterFn Function The function to sort by */ @@ -9534,13 +10100,16 @@ declare module Ext { * @param fn Function Comparison function that defines the sort order. Defaults to sorting by case insensitive string. */ static sortByKey( direction?:string, fn?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Collects all of the values of the given property and returns their sum * @param property String The property to sum by * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param start Number The record index to start at * @param end Number The record index to end at + * @returns Number The total */ static sum( property?:string, root?:string, start?:number, end?:number ): number; /** [Method] Suspends firing of the named event s @@ -9581,6 +10150,7 @@ declare module Ext.data { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -9589,10 +10159,9 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -9600,27 +10169,31 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Gets a node in this tree by its id * @param id String + * @returns Ext.data.NodeInterface The match node. */ getNodeById?( id?:string ): Ext.data.INodeInterface; - /** [Method] Returns the root node for this tree */ + /** [Method] Returns the root node for this tree + * @returns Ext.data.NodeInterface + */ getRootNode?(): Ext.data.INodeInterface; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -9629,30 +10202,29 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -9667,10 +10239,10 @@ declare module Ext.data { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; - /** [Method] Removes the root node from this tree */ + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; + /** [Method] Removes the root node from this tree + * @returns Ext.data.NodeInterface The root node + */ removeRootNode?(): Ext.data.INodeInterface; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. @@ -9680,6 +10252,7 @@ declare module Ext.data { resumeEvents?(): void; /** [Method] Sets the root node for this tree * @param node Ext.data.NodeInterface + * @returns Ext.data.NodeInterface The root node */ setRootNode?( node?:Ext.data.INodeInterface ): Ext.data.INodeInterface; /** [Method] Suspends firing of the named event s @@ -9720,15 +10293,22 @@ declare module Ext.data { nodeParam?: string; /** [Config Option] (Ext.data.Model/Ext.data.NodeInterface/Object) */ root?: any; - /** [Method] inherit docs */ + /** [Method] inherit docs + * @returns Ext.data.Model[] The Model instances + */ getNewRecords?(): Ext.data.IModel[]; /** [Method] Returns the record node by id * @param id Object + * @returns Ext.data.NodeInterface */ getNodeById?( id?:any ): Ext.data.INodeInterface; - /** [Method] Returns the root node for this tree */ + /** [Method] Returns the root node for this tree + * @returns Ext.data.NodeInterface + */ getRootNode?(): Ext.data.INodeInterface; - /** [Method] inherit docs */ + /** [Method] inherit docs + * @returns Ext.data.Model[] The updated Model instances + */ getUpdatedRecords?(): Ext.data.IModel[]; /** [Method] Loads the Store using its configured proxy * @param options Object config object. This is passed into the Operation object that is created and then sent to the proxy's Ext.data.proxy.Proxy.read function. The options can also contain a node, which indicates which node is to be loaded. If not specified, it will default to the root node. @@ -9738,10 +10318,12 @@ declare module Ext.data { removeAll?(): void; /** [Method] inherit docs * @param proxy Object + * @returns Ext.data.proxy.Proxy The attached Proxy object */ setProxy?( proxy?:any ): Ext.data.proxy.IProxy; /** [Method] Sets the root node for this store * @param root Ext.data.Model/Ext.data.NodeInterface/Object + * @returns Ext.data.NodeInterface The new root */ setRootNode?( root?:any ): Ext.data.INodeInterface; } @@ -9752,28 +10334,32 @@ declare module Ext.data { export class Types { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -9797,58 +10383,68 @@ declare module Ext.data { export class Validations { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Validates that an email string is in the correct format * @param config Object Config object * @param email String The email address + * @returns Boolean True if the value passes validation */ static email( config?:any, email?:string ): boolean; /** [Method] Validates that the given value is not present in the configured list * @param config Object Config object * @param value String The value to validate + * @returns Boolean True if the value is not present in the list */ static exclusion( config?:any, value?:string ): boolean; /** [Method] Returns true if the given value passes validation against the configured matcher regex * @param config Object Config object * @param value String The value to validate + * @returns Boolean True if the value passes the format validation */ static format( config?:any, value?:string ): boolean; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Validates that the given value is present in the configured list * @param config Object Config object * @param value String The value to validate + * @returns Boolean True if the value is present in the list */ static inclusion( config?:any, value?:string ): boolean; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Returns true if the given value is between the configured min and max values * @param config Object Config object * @param value String The value to validate + * @returns Boolean True if the value passes validation */ static length( config?:any, value?:string ): boolean; /** [Method] Validates that the given value is present * @param config Object Config object * @param value Object The value to validate + * @returns Boolean True if validation passed */ static presence( config?:any, value?:any ): boolean; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -9897,10 +10493,12 @@ declare module Ext.data.writer { /** [Method] Formats the data for each record before sending it to the server * @param record Ext.data.Model The record that we are writing to the server. * @param operation Ext.data.Operation An operation object. + * @returns Object An object literal of name/value keys to be written to the server. By default this method returns the data property on the record. */ getRecordData?( record?:Ext.data.IModel, operation?:Ext.data.IOperation ): any; /** [Method] Prepares a Proxy s Ext data Request object * @param request Ext.data.Request The request object + * @returns Ext.data.Request The modified request object */ write?( request?:Ext.data.IRequest ): Ext.data.IRequest; } @@ -9918,10 +10516,12 @@ declare module Ext.data { /** [Method] Formats the data for each record before sending it to the server * @param record Ext.data.Model The record that we are writing to the server. * @param operation Ext.data.Operation An operation object. + * @returns Object An object literal of name/value keys to be written to the server. By default this method returns the data property on the record. */ getRecordData?( record?:Ext.data.IModel, operation?:Ext.data.IOperation ): any; /** [Method] Prepares a Proxy s Ext data Request object * @param request Ext.data.Request The request object + * @returns Ext.data.Request The modified request object */ write?( request?:Ext.data.IRequest ): Ext.data.IRequest; } @@ -9939,10 +10539,12 @@ declare module Ext.data { /** [Method] Formats the data for each record before sending it to the server * @param record Ext.data.Model The record that we are writing to the server. * @param operation Ext.data.Operation An operation object. + * @returns Object An object literal of name/value keys to be written to the server. By default this method returns the data property on the record. */ getRecordData?( record?:Ext.data.IModel, operation?:Ext.data.IOperation ): any; /** [Method] Prepares a Proxy s Ext data Request object * @param request Ext.data.Request The request object + * @returns Ext.data.Request The modified request object */ write?( request?:Ext.data.IRequest ): Ext.data.IRequest; } @@ -9983,105 +10585,129 @@ declare module Ext { * @param date Date The date to modify * @param interval String A valid date interval enum value. * @param value Number The amount to add to the current date. + * @returns Date The new Date instance. */ static add( date?:any, interval?:string, value?:number ): any; /** [Method] Checks if a date falls on or between the given start and end dates * @param date Date The date to check * @param start Date Start date * @param end Date End date + * @returns Boolean true if this date falls on or between the given start and end dates. */ static between( date?:any, start?:any, end?:any ): boolean; /** [Method] Attempts to clear all time information from this Date by setting the time to midnight of the same day automatically * @param date Date The date * @param clone Boolean true to create a clone of this date, clear the time and return it. + * @returns Date this or the clone. */ static clearTime( date?:any, clone?:boolean ): any; /** [Method] Creates and returns a new Date instance with the exact same date value as the called instance * @param date Date The date. + * @returns Date The new Date instance. */ static clone( date?:any ): any; /** [Method] Formats a date given the supplied format string * @param date Date The date to format * @param format String The format string + * @returns String The formatted date or an empty string if date parameter is not a JavaScript Date object */ static format( date?:any, format?:string ): string; /** [Method] Checks if the specified format contains information about anything other than the time * @param format String The format to check + * @returns Boolean True if the format contains information about date/day information. */ static formatContainsDateInfo( format?:string ): boolean; /** [Method] Checks if the specified format contains hour information * @param format String The format to check + * @returns Boolean True if the format contains hour information */ static formatContainsHourInfo( format?:string ): boolean; /** [Method] Get the numeric day number of the year adjusted for leap year * @param date Date The date + * @returns Number 0 to 364 (365 in leap years). */ static getDayOfYear( date?:any ): number; /** [Method] Get the number of days in the current month adjusted for leap year * @param date Date The date + * @returns Number The number of days in the month. */ static getDaysInMonth( date?:any ): number; /** [Method] Returns the number of milliseconds between two dates * @param dateA Date The first date. * @param dateB Date The second date. + * @returns Number The difference in milliseconds */ static getElapsed( dateA?:any, dateB?:any ): number; /** [Method] Get the date of the first day of the month in which this date resides * @param date Date The date + * @returns Date */ static getFirstDateOfMonth( date?:any ): any; /** [Method] Get the first day of the current month adjusted for leap year * @param date Date The date + * @returns Number The day number (0-6). */ static getFirstDayOfMonth( date?:any ): number; /** [Method] Get the offset from GMT of the current date equivalent to the format specifier O * @param date Date The date * @param colon Boolean true to separate the hours and minutes with a colon. + * @returns String The 4-character offset string prefixed with + or - (e.g. '-0600'). */ static getGMTOffset( date?:any, colon?:boolean ): string; /** [Method] Get the date of the last day of the month in which this date resides * @param date Date The date + * @returns Date */ static getLastDateOfMonth( date?:any ): any; /** [Method] Get the last day of the current month adjusted for leap year * @param date Date The date + * @returns Number The day number (0-6). */ static getLastDayOfMonth( date?:any ): number; /** [Method] Get the zero based JavaScript month number for the given short full month name * @param name String The short/full month name. + * @returns Number The zero-based JavaScript month number. */ static getMonthNumber( name?:string ): number; /** [Method] Get the short day name for the given day number * @param day Number A zero-based JavaScript day number. + * @returns String The short day name. */ static getShortDayName( day?:number ): string; /** [Method] Get the short month name for the given month number * @param month Number A zero-based JavaScript month number. + * @returns String The short month name. */ static getShortMonthName( month?:number ): string; /** [Method] Get the English ordinal suffix of the current day equivalent to the format specifier S * @param date Date The date + * @returns String 'st, 'nd', 'rd' or 'th'. */ static getSuffix( date?:any ): string; /** [Method] Get the timezone abbreviation of the current date equivalent to the format specifier T * @param date Date The date + * @returns String The abbreviated timezone name (e.g. 'CST', 'PDT', 'EDT', 'MPST' ...). */ static getTimezone( date?:any ): string; /** [Method] Get the numeric ISO 8601 week number of the year * @param date Date The date + * @returns Number 1 to 53 */ static getWeekOfYear( date?:any ): number; /** [Method] Checks if the current date is affected by Daylight Saving Time DST * @param date Date The date + * @returns Boolean true if the current date is affected by DST. */ static isDST( date?:any ): boolean; /** [Method] Compares if two dates are equal by comparing their values * @param date1 Date * @param date2 Date + * @returns Boolean true if the date values are equal */ static isEqual( date1?:any, date2?:any ): boolean; /** [Method] Checks if the current date falls within a leap year * @param date Date The date + * @returns Boolean True if the current date falls within a leap year, false otherwise. */ static isLeapYear( date?:any ): boolean; /** [Method] Checks if the passed Date parameters will cause a JavaScript Date rollover @@ -10092,24 +10718,30 @@ declare module Ext { * @param minute Number Minute * @param second Number Second * @param millisecond Number Millisecond + * @returns Boolean true if the passed parameters do not cause a Date "rollover", false otherwise. */ static isValid( year?:number, month?:number, day?:number, hour?:number, minute?:number, second?:number, millisecond?:number ): boolean; - /** [Method] Returns the current timestamp */ + /** [Method] Returns the current timestamp + * @returns Number Milliseconds since UNIX epoch. + */ static now(): number; /** [Method] Parses the passed string using the specified date format * @param input String The raw date string. * @param format String The expected date string format. * @param strict Boolean true to validate date strings while parsing (i.e. prevents JavaScript Date "rollover"). Invalid date strings will return null when parsed. + * @returns Date The parsed Date. */ static parse( input?:string, format?:string, strict?:boolean ): any; /** [Method] Provides a convenient method for performing basic date arithmetic * @param date Date The date to modify * @param interval String A valid date interval enum value. * @param value Number The amount to subtract from the current date. + * @returns Date The new Date instance. */ static subtract( date?:any, interval?:string, value?:number ): any; /** [Method] Removes all escaping for a date format string * @param format String The format to unescape + * @returns String The unescaped format */ static unescapeFormat( format?:string ): string; } @@ -10154,7 +10786,9 @@ declare module Ext.dd { * @param iPageY Number the Y coordinate of the mousedown or drag event */ setDragElPos?( iPageX?:number, iPageY?:number ): void; - /** [Method] toString method */ + /** [Method] toString method + * @returns String string representation of the dd obj + */ toString?(): string; } } @@ -10180,67 +10814,17 @@ declare module Ext.dd { endDrag?( e?:any ): void; /** [Method] Initialization for the drag frame element */ initFrame?(): void; - /** [Method] toString method */ + /** [Method] toString method + * @returns String string representation of the dd obj + */ toString?(): string; } } declare module Ext.dd { export interface IDDTarget extends Ext.dd.IDragDrop { - /** [Method] Overridden and disabled */ - addInvalidHandleClass?(): void; - /** [Method] Overridden and disabled */ - addInvalidHandleId?(): void; - /** [Method] Overridden and disabled */ - addInvalidHandleType?(): void; - /** [Method] Overridden and disabled */ - clearConstraints?(): void; - /** [Method] Overridden and disabled */ - clearTicks?(): void; - /** [Method] Overridden and disabled */ - endDrag?(): void; - /** [Method] Overridden and disabled */ - getDragEl?(): void; - /** [Method] Overridden and disabled */ - isValidHandleChild?(): void; - /** [Method] Overridden and disabled */ - onDrag?(): void; - /** [Method] Overridden and disabled */ - onDragDrop?(): void; - /** [Method] Overridden and disabled */ - onDragEnter?(): void; - /** [Method] Overridden and disabled */ - onDragOut?(): void; - /** [Method] Overridden and disabled */ - onDragOver?(): void; - /** [Method] Overridden and disabled */ - onInvalidDrop?(): void; - /** [Method] Overridden and disabled */ - onMouseDown?(): void; - /** [Method] Overridden and disabled */ - onMouseUp?(): void; - /** [Method] Overridden and disabled */ - removeInvalidHandleClass?(): void; - /** [Method] Overridden and disabled */ - removeInvalidHandleId?(): void; - /** [Method] Overridden and disabled */ - removeInvalidHandleType?(): void; - /** [Method] Overridden and disabled */ - resetConstraints?(): void; - /** [Method] Overridden and disabled */ - setDragElId?(): void; - /** [Method] Overridden and disabled */ - setHandleElId?(): void; - /** [Method] Overridden and disabled */ - setInitPosition?(): void; - /** [Method] Overridden and disabled */ - setOuterHandleElId?(): void; - /** [Method] Overridden and disabled */ - setXConstraint?(): void; - /** [Method] Overridden and disabled */ - setYConstraint?(): void; - /** [Method] Overridden and disabled */ - startDrag?(): void; - /** [Method] toString method */ + /** [Method] toString method + * @returns String string representation of the dd obj + */ toString?(): string; } } @@ -10307,19 +10891,20 @@ declare module Ext.dd { * @param pad Object/Number Pad provides a way to specify "padding" of the constraints, and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or an object containing the sides to pad. For example: {right:10, bottom:10} * @param inContent Boolean Constrain the draggable in the content box of the element (inside padding and borders) */ - constrainTo?( constrainTo?:any, pad?:any, inContent?:any ): any; - constrainTo?( constrainTo?:string, pad?:any, inContent?:boolean ): void; - constrainTo?( constrainTo?:HTMLElement, pad?:any, inContent?:boolean ): void; - constrainTo?( constrainTo?:Ext.IElement, pad?:any, inContent?:boolean ): void; + constrainTo?( constrainTo?:any, pad?:any, inContent?:boolean ): void; /** [Method] Destroy this DragDrop instance */ destroy?(): void; /** [Method] Called when we are done dragging the object * @param e Event the mouseup event */ endDrag?( e?:Event ): void; - /** [Method] Returns a reference to the actual element to drag */ + /** [Method] Returns a reference to the actual element to drag + * @returns HTMLElement the html element + */ getDragEl?(): HTMLElement; - /** [Method] Returns a reference to the linked element */ + /** [Method] Returns a reference to the linked element + * @returns HTMLElement the html element + */ getEl?(): HTMLElement; /** [Method] Sets up the DragDrop object * @param id String the id of the linked element @@ -10333,10 +10918,13 @@ declare module Ext.dd { * @param config Object configuration attributes */ initTarget?( id?:string, sGroup?:string, config?:any ): void; - /** [Method] Returns true if this instance is locked or the drag drop mgr is locked meaning that all drag drop is disabled on th */ + /** [Method] Returns true if this instance is locked or the drag drop mgr is locked meaning that all drag drop is disabled on th + * @returns Boolean true if this obj or all drag/drop is locked, else false + */ isLocked?(): boolean; /** [Method] Checks the tag exclusion list to see if this click should be ignored * @param node HTMLElement the HTMLElement to evaluate + * @returns Boolean true if this is a valid tag type, false if not */ isValidHandleChild?( node?:HTMLElement ): boolean; /** [Method] Locks this instance */ @@ -10351,30 +10939,22 @@ declare module Ext.dd { * @param e Event the mouseup event * @param id String/Ext.dd.DragDrop[] In POINT mode, the element id this was dropped on. In INTERSECT mode, an array of dd items this was dropped on. */ - onDragDrop?( e?:any, id?:any ): any; - onDragDrop?( e?:Event, id?:string ): void; - onDragDrop?( e?:Event, id?:Ext.dd.IDragDrop[] ): void; + onDragDrop?( e?:Event, id?:any ): void; /** [Method] Abstract method called when this element fist begins hovering over another DragDrop obj * @param e Event the mousemove event * @param id String/Ext.dd.DragDrop[] In POINT mode, the element id this is hovering over. In INTERSECT mode, an array of one or more dragdrop items being hovered over. */ - onDragEnter?( e?:any, id?:any ): any; - onDragEnter?( e?:Event, id?:string ): void; - onDragEnter?( e?:Event, id?:Ext.dd.IDragDrop[] ): void; + onDragEnter?( e?:Event, id?:any ): void; /** [Method] Abstract method called when we are no longer hovering over an element * @param e Event the mousemove event * @param id String/Ext.dd.DragDrop[] In POINT mode, the element id this was hovering over. In INTERSECT mode, an array of dd items that the mouse is no longer over. */ - onDragOut?( e?:any, id?:any ): any; - onDragOut?( e?:Event, id?:string ): void; - onDragOut?( e?:Event, id?:Ext.dd.IDragDrop[] ): void; + onDragOut?( e?:Event, id?:any ): void; /** [Method] Abstract method called when this element is hovering over another DragDrop obj * @param e Event the mousemove event * @param id String/Ext.dd.DragDrop[] In POINT mode, the element id this is hovering over. In INTERSECT mode, an array of dd items being hovered over. */ - onDragOver?( e?:any, id?:any ): any; - onDragOver?( e?:Event, id?:string ): void; - onDragOver?( e?:Event, id?:Ext.dd.IDragDrop[] ): void; + onDragOver?( e?:Event, id?:any ): void; /** [Method] Abstract method called when this item is dropped on an area with no drop target * @param e Event the mouseup event */ @@ -10448,7 +11028,9 @@ declare module Ext.dd { * @param y Number Y click location */ startDrag?( x?:number, y?:number ): void; - /** [Method] toString method */ + /** [Method] toString method + * @returns String string representation of the dd obj + */ toString?(): string; /** [Method] Unlocks this instace */ unlock?(): void; @@ -10460,19 +11042,26 @@ declare module Ext.dd { export interface IDragDropElement { /** [Method] Returns the X position of an html element * @param el HTMLElement the element for which to get the position + * @returns Number the X coordinate */ getPosX?( el?:HTMLElement ): number; /** [Method] Returns the Y position of an html element * @param el HTMLElement the element for which to get the position + * @returns Number the Y coordinate */ getPosY?( el?:HTMLElement ): number; - /** [Method] Gets the scrollLeft */ + /** [Method] Gets the scrollLeft + * @returns Number the document's scrollTop + */ getScrollLeft?(): number; - /** [Method] Gets the scrollTop */ + /** [Method] Gets the scrollTop + * @returns Number the document's scrollTop + */ getScrollTop?(): number; /** [Method] Returns the specified element style property * @param el HTMLElement the element * @param styleProp String the style property + * @returns String The value of the style property */ getStyle?( el?:HTMLElement, styleProp?:string ): string; /** [Method] Recursively searches the immediate parent and all child nodes for the handle element in order to determine wheter or @@ -10487,6 +11076,7 @@ declare module Ext.dd { /** [Method] Numeric array sort function * @param a Number * @param b Number + * @returns Number positive, negative or 0 */ numericSort?( a?:number, b?:number ): number; /** [Method] Swap two nodes @@ -10512,69 +11102,83 @@ declare module Ext.dd { export class DragDropManager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Helper function for getting the best match from the list of drag and drop objects returned by the drag and drop event * @param dds Ext.dd.DragDrop[] The array of drag and drop objects targeted + * @returns Ext.dd.DragDrop The best single match */ static getBestMatch( dds?:Ext.dd.IDragDrop[] ): Ext.dd.IDragDrop; /** [Method] Returns the style property for the DOM element i e document getElById id style * @param id String the id of the elment to get + * @returns Object The style property of the element */ static getCss( id?:string ): any; /** [Method] Returns the DragDrop instance for a given id * @param id String the id of the DragDrop object + * @returns Ext.dd.DragDrop the drag drop object, null if it is not found */ static getDDById( id?:string ): Ext.dd.IDragDrop; /** [Method] Returns the actual DOM element * @param id String the id of the elment to get + * @returns Object The element */ static getElement( id?:string ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Returns a Region object containing the drag and drop element s position and size including the padding configured fo * @param oDD Ext.dd.DragDrop the drag and drop object to get the location for. + * @returns Ext.util.Region a Region object representing the total area the element occupies, including any padding the instance is configured for. */ static getLocation( oDD?:Ext.dd.IDragDrop ): Ext.util.IRegion; /** [Method] Returns the drag and drop instances that are in all groups the passed in instance belongs to * @param p_oDD Ext.dd.DragDrop the obj to get related data for * @param bTargetsOnly Boolean if true, only return targetable objs + * @returns Ext.dd.DragDrop[] the related instances */ static getRelated( p_oDD?:Ext.dd.IDragDrop, bTargetsOnly?:boolean ): Ext.dd.IDragDrop[]; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Utility function to determine if a given element has been registered as a drag drop item * @param id String the element id to check + * @returns Boolean true if this element is a DragDrop item, false otherwise */ static isDragDrop( id?:string ): boolean; /** [Method] Utility function to determine if a given element has been registered as a drag drop handle for the given Drag Drop ob * @param id String the element id to check + * @returns Boolean true if this element is a DragDrop handle, false otherwise */ static isHandle( id?:string ): boolean; /** [Method] Returns true if the specified dd target is a legal target for the specifice drag obj * @param oDD Ext.dd.DragDrop the drag obj * @param oTargetDD Ext.dd.DragDrop the target + * @returns Boolean true if the target is a legal target for the dd obj */ static isLegalTarget( oDD?:Ext.dd.IDragDrop, oTargetDD?:Ext.dd.IDragDrop ): boolean; - /** [Method] Is drag and drop locked */ + /** [Method] Is drag and drop locked + * @returns Boolean True if drag and drop is locked, false otherwise. + */ static isLocked(): boolean; /** [Method] My goal is to be able to transparently determine if an object is typeof DragDrop and the exact subclass of DragDrop * @param the Object object to evaluate + * @returns Boolean true if typeof oDD = DragDrop */ static isTypeOfDD( the?:any ): boolean; /** [Method] Lock all drag and drop functionality */ @@ -10598,7 +11202,9 @@ declare module Ext.dd { * @param y Number the Y position of the original mousedown */ static startDrag( x?:number, y?:number ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Utility to stop event propagation and event default if these features are turned on * @param e Event the event as returned by this.getEvent() @@ -10608,6 +11214,7 @@ declare module Ext.dd { static unlock(): void; /** [Method] This checks to make sure an element exists and is in the DOM * @param el HTMLElement the element to check + * @returns Boolean true if the element looks usable */ static verifyEl( el?:HTMLElement ): boolean; } @@ -10618,69 +11225,83 @@ declare module Ext.dd { export class DragDropMgr { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Helper function for getting the best match from the list of drag and drop objects returned by the drag and drop event * @param dds Ext.dd.DragDrop[] The array of drag and drop objects targeted + * @returns Ext.dd.DragDrop The best single match */ static getBestMatch( dds?:Ext.dd.IDragDrop[] ): Ext.dd.IDragDrop; /** [Method] Returns the style property for the DOM element i e document getElById id style * @param id String the id of the elment to get + * @returns Object The style property of the element */ static getCss( id?:string ): any; /** [Method] Returns the DragDrop instance for a given id * @param id String the id of the DragDrop object + * @returns Ext.dd.DragDrop the drag drop object, null if it is not found */ static getDDById( id?:string ): Ext.dd.IDragDrop; /** [Method] Returns the actual DOM element * @param id String the id of the elment to get + * @returns Object The element */ static getElement( id?:string ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Returns a Region object containing the drag and drop element s position and size including the padding configured fo * @param oDD Ext.dd.DragDrop the drag and drop object to get the location for. + * @returns Ext.util.Region a Region object representing the total area the element occupies, including any padding the instance is configured for. */ static getLocation( oDD?:Ext.dd.IDragDrop ): Ext.util.IRegion; /** [Method] Returns the drag and drop instances that are in all groups the passed in instance belongs to * @param p_oDD Ext.dd.DragDrop the obj to get related data for * @param bTargetsOnly Boolean if true, only return targetable objs + * @returns Ext.dd.DragDrop[] the related instances */ static getRelated( p_oDD?:Ext.dd.IDragDrop, bTargetsOnly?:boolean ): Ext.dd.IDragDrop[]; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Utility function to determine if a given element has been registered as a drag drop item * @param id String the element id to check + * @returns Boolean true if this element is a DragDrop item, false otherwise */ static isDragDrop( id?:string ): boolean; /** [Method] Utility function to determine if a given element has been registered as a drag drop handle for the given Drag Drop ob * @param id String the element id to check + * @returns Boolean true if this element is a DragDrop handle, false otherwise */ static isHandle( id?:string ): boolean; /** [Method] Returns true if the specified dd target is a legal target for the specifice drag obj * @param oDD Ext.dd.DragDrop the drag obj * @param oTargetDD Ext.dd.DragDrop the target + * @returns Boolean true if the target is a legal target for the dd obj */ static isLegalTarget( oDD?:Ext.dd.IDragDrop, oTargetDD?:Ext.dd.IDragDrop ): boolean; - /** [Method] Is drag and drop locked */ + /** [Method] Is drag and drop locked + * @returns Boolean True if drag and drop is locked, false otherwise. + */ static isLocked(): boolean; /** [Method] My goal is to be able to transparently determine if an object is typeof DragDrop and the exact subclass of DragDrop * @param the Object object to evaluate + * @returns Boolean true if typeof oDD = DragDrop */ static isTypeOfDD( the?:any ): boolean; /** [Method] Lock all drag and drop functionality */ @@ -10704,7 +11325,9 @@ declare module Ext.dd { * @param y Number the Y position of the original mousedown */ static startDrag( x?:number, y?:number ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Utility to stop event propagation and event default if these features are turned on * @param e Event the event as returned by this.getEvent() @@ -10714,6 +11337,7 @@ declare module Ext.dd { static unlock(): void; /** [Method] This checks to make sure an element exists and is in the DOM * @param el HTMLElement the element to check + * @returns Boolean true if the element looks usable */ static verifyEl( el?:HTMLElement ): boolean; } @@ -10724,69 +11348,83 @@ declare module Ext.dd { export class DDM { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Helper function for getting the best match from the list of drag and drop objects returned by the drag and drop event * @param dds Ext.dd.DragDrop[] The array of drag and drop objects targeted + * @returns Ext.dd.DragDrop The best single match */ static getBestMatch( dds?:Ext.dd.IDragDrop[] ): Ext.dd.IDragDrop; /** [Method] Returns the style property for the DOM element i e document getElById id style * @param id String the id of the elment to get + * @returns Object The style property of the element */ static getCss( id?:string ): any; /** [Method] Returns the DragDrop instance for a given id * @param id String the id of the DragDrop object + * @returns Ext.dd.DragDrop the drag drop object, null if it is not found */ static getDDById( id?:string ): Ext.dd.IDragDrop; /** [Method] Returns the actual DOM element * @param id String the id of the elment to get + * @returns Object The element */ static getElement( id?:string ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Returns a Region object containing the drag and drop element s position and size including the padding configured fo * @param oDD Ext.dd.DragDrop the drag and drop object to get the location for. + * @returns Ext.util.Region a Region object representing the total area the element occupies, including any padding the instance is configured for. */ static getLocation( oDD?:Ext.dd.IDragDrop ): Ext.util.IRegion; /** [Method] Returns the drag and drop instances that are in all groups the passed in instance belongs to * @param p_oDD Ext.dd.DragDrop the obj to get related data for * @param bTargetsOnly Boolean if true, only return targetable objs + * @returns Ext.dd.DragDrop[] the related instances */ static getRelated( p_oDD?:Ext.dd.IDragDrop, bTargetsOnly?:boolean ): Ext.dd.IDragDrop[]; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Utility function to determine if a given element has been registered as a drag drop item * @param id String the element id to check + * @returns Boolean true if this element is a DragDrop item, false otherwise */ static isDragDrop( id?:string ): boolean; /** [Method] Utility function to determine if a given element has been registered as a drag drop handle for the given Drag Drop ob * @param id String the element id to check + * @returns Boolean true if this element is a DragDrop handle, false otherwise */ static isHandle( id?:string ): boolean; /** [Method] Returns true if the specified dd target is a legal target for the specifice drag obj * @param oDD Ext.dd.DragDrop the drag obj * @param oTargetDD Ext.dd.DragDrop the target + * @returns Boolean true if the target is a legal target for the dd obj */ static isLegalTarget( oDD?:Ext.dd.IDragDrop, oTargetDD?:Ext.dd.IDragDrop ): boolean; - /** [Method] Is drag and drop locked */ + /** [Method] Is drag and drop locked + * @returns Boolean True if drag and drop is locked, false otherwise. + */ static isLocked(): boolean; /** [Method] My goal is to be able to transparently determine if an object is typeof DragDrop and the exact subclass of DragDrop * @param the Object object to evaluate + * @returns Boolean true if typeof oDD = DragDrop */ static isTypeOfDD( the?:any ): boolean; /** [Method] Lock all drag and drop functionality */ @@ -10810,7 +11448,9 @@ declare module Ext.dd { * @param y Number the Y position of the original mousedown */ static startDrag( x?:number, y?:number ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Utility to stop event propagation and event default if these features are turned on * @param e Event the event as returned by this.getEvent() @@ -10820,6 +11460,7 @@ declare module Ext.dd { static unlock(): void; /** [Method] This checks to make sure an element exists and is in the DOM * @param el HTMLElement the element to check + * @returns Boolean true if the element looks usable */ static verifyEl( el?:HTMLElement ): boolean; } @@ -10879,45 +11520,54 @@ declare module Ext.dd { * @param target Ext.dd.DragDrop The drop target * @param e Event The event object * @param id String The id of the dragged element + * @returns Boolean isValid True if the drag drop event is valid, else false to cancel */ beforeDragDrop?( target?:Ext.dd.IDragDrop, e?:Event, id?:string ): boolean; /** [Method] An empty function by default but provided so that you can perform a custom action before the dragged item enters the * @param target Ext.dd.DragDrop The drop target * @param e Event The event object * @param id String The id of the dragged element + * @returns Boolean isValid True if the drag event is valid, else false to cancel */ beforeDragEnter?( target?:Ext.dd.IDragDrop, e?:Event, id?:string ): boolean; /** [Method] An empty function by default but provided so that you can perform a custom action before the dragged item is dragged * @param target Ext.dd.DragDrop The drop target * @param e Event The event object * @param id String The id of the dragged element + * @returns Boolean isValid True if the drag event is valid, else false to cancel */ beforeDragOut?( target?:Ext.dd.IDragDrop, e?:Event, id?:string ): boolean; /** [Method] An empty function by default but provided so that you can perform a custom action while the dragged item is over the * @param target Ext.dd.DragDrop The drop target * @param e Event The event object * @param id String The id of the dragged element + * @returns Boolean isValid True if the drag event is valid, else false to cancel */ beforeDragOver?( target?:Ext.dd.IDragDrop, e?:Event, id?:string ): boolean; /** [Method] An empty function by default but provided so that you can perform a custom action after an invalid drop has occurred * @param target Ext.dd.DragDrop The drop target * @param e Event The event object * @param id String The id of the dragged element + * @returns Boolean isValid True if the invalid drop should proceed, else false to cancel */ beforeInvalidDrop?( target?:Ext.dd.IDragDrop, e?:Event, id?:string ): boolean; /** [Method] Destroy this DragDrop instance */ destroy?(): void; /** [Method] Returns the data object associated with this drag source * @param e Object + * @returns Object data An object containing arbitrary data */ getDragData?( e?:any ): any; - /** [Method] Returns the drag source s underlying Ext dd StatusProxy */ + /** [Method] Returns the drag source s underlying Ext dd StatusProxy + * @returns Ext.dd.StatusProxy proxy The StatusProxy + */ getProxy?(): Ext.dd.IStatusProxy; /** [Method] Hides the drag source s Ext dd StatusProxy */ hideProxy?(): void; /** [Method] An empty function by default but provided so that you can perform a custom action before the initial drag event begi * @param data Object An object containing arbitrary data to be shared with drop targets * @param e Event The event object + * @returns Boolean isValid True if the drag event is valid, else false to cancel */ onBeforeDrag?( data?:any, e?:Event ): boolean; /** [Method] An empty function by default but provided so that you can perform a custom action once the initial drag event has be @@ -10958,6 +11608,7 @@ declare module Ext.dd { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -10966,10 +11617,9 @@ declare module Ext.dd { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -10977,59 +11627,59 @@ declare module Ext.dd { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the drag target */ + /** [Method] Returns the drag target + * @returns Ext.Element The element currently being tracked. + */ getDragTarget?(): Ext.IElement; /** [Method] Returns the X Y offset of the current mouse position from the mousedown point * @param constrainMode String If omitted the true mouse position is returned. May be passed as point or dragTarget. See above. + * @returns Number[] The X, Y offset from the mousedown point, optionally constrained. */ getOffset?( constrainMode?:string ): number[]; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Initializes the DragTracker on a given element * @param el Ext.Element/HTMLElement The element */ - initEl?( el?:any ): any; - initEl?( el?:Ext.IElement ): void; - initEl?( el?:HTMLElement ): void; + initEl?( el?:any ): void; /** [Method] Shorthand for addManagedListener * @param item Ext.util.Observable/Ext.Element The item to which to add a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Template method which should be overridden by each DragTracker instance @@ -11052,6 +11702,7 @@ declare module Ext.dd { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -11066,9 +11717,7 @@ declare module Ext.dd { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -11101,15 +11750,18 @@ declare module Ext.dd { destroy?(): void; /** [Method] Called when a mousedown occurs in this container * @param e Event The mouse down event + * @returns Object The dragData */ getDragData?( e?:Event ): any; /** [Method] Called before a repair of an invalid drop to get the XY to animate to * @param e Event The mouse up event + * @returns Number[] The xy location (e.g. [100, 200]) */ getRepairXY?( e?:Event ): number[]; /** [Method] Called once drag threshold has been reached to initialize the proxy element * @param x Number The x position of the click on the dragged object * @param y Number The y position of the click on the dragged object + * @returns Boolean true to continue the drag, false to cancel */ onInitDrag?( x?:number, y?:number ): boolean; } @@ -11132,12 +11784,14 @@ declare module Ext.dd { * @param source Ext.dd.DragSource The drag source that was dragged over this drop target * @param e Event The event * @param data Object An object containing arbitrary data supplied by the drag source + * @returns Boolean False if the drop was invalid. */ notifyDrop?( source?:Ext.dd.IDragSource, e?:Event, data?:any ): boolean; /** [Method] The function a Ext dd DragSource calls once to notify this drop target that the source is now over the target * @param source Ext.dd.DragSource The drag source that was dragged over this drop target * @param e Event The event * @param data Object An object containing arbitrary data supplied by the drag source + * @returns String status The CSS class that communicates the drop status back to the source so that the underlying Ext.dd.StatusProxy can be updated */ notifyEnter?( source?:Ext.dd.IDragSource, e?:Event, data?:any ): string; /** [Method] The function a Ext dd DragSource calls once to notify this drop target that the source has been dragged out of the ta @@ -11150,6 +11804,7 @@ declare module Ext.dd { * @param source Ext.dd.DragSource The drag source that was dragged over this drop target * @param e Event The event * @param data Object An object containing arbitrary data supplied by the drag source + * @returns String status The CSS class that communicates the drop status back to the source so that the underlying Ext.dd.StatusProxy can be updated */ notifyOver?( source?:Ext.dd.IDragSource, e?:Event, data?:any ): string; } @@ -11158,18 +11813,21 @@ declare module Ext.dd { export interface IDropZone extends Ext.dd.IDropTarget { /** [Method] Returns a custom data object associated with the DOM node that is the target of the event * @param e Event The event + * @returns Object data The custom data */ getTargetFromEvent?( e?:Event ): any; /** [Method] The function a Ext dd DragSource calls once to notify this drop zone that the dragged item has been dropped on it * @param source Ext.dd.DragSource The drag source that was dragged over this drop zone * @param e Event The event * @param data Object An object containing arbitrary data supplied by the drag source + * @returns Boolean False if the drop was invalid. */ notifyDrop?( source?:Ext.dd.IDragSource, e?:Event, data?:any ): boolean; /** [Method] The function a Ext dd DragSource calls once to notify this drop zone that the source is now over the zone * @param source Ext.dd.DragSource The drag source that was dragged over this drop zone * @param e Event The event * @param data Object An object containing arbitrary data supplied by the drag source + * @returns String status The CSS class that communicates the drop status back to the source so that the underlying Ext.dd.StatusProxy can be updated */ notifyEnter?( source?:Ext.dd.IDragSource, e?:Event, data?:any ): string; /** [Method] The function a Ext dd DragSource calls once to notify this drop zone that the source has been dragged out of the zone @@ -11182,18 +11840,21 @@ declare module Ext.dd { * @param source Ext.dd.DragSource The drag source that was dragged over this drop zone * @param e Event The event * @param data Object An object containing arbitrary data supplied by the drag source + * @returns String status The CSS class that communicates the drop status back to the source so that the underlying Ext.dd.StatusProxy can be updated */ notifyOver?( source?:Ext.dd.IDragSource, e?:Event, data?:any ): string; /** [Method] Called when the DropZone determines that a Ext dd DragSource has been dropped on it but not on any of its registered * @param source Ext.dd.DragSource The drag source that was dragged over this drop zone * @param e Event The event * @param data Object An object containing arbitrary data supplied by the drag source + * @returns Boolean True if the drop was valid, else false */ onContainerDrop?( source?:Ext.dd.IDragSource, e?:Event, data?:any ): boolean; /** [Method] Called while the DropZone determines that a Ext dd DragSource is being dragged over it but not over any of its regis * @param source Ext.dd.DragSource The drag source that was dragged over this drop zone * @param e Event The event * @param data Object An object containing arbitrary data supplied by the drag source + * @returns String status The CSS class that communicates the drop status back to the source so that the underlying Ext.dd.StatusProxy can be updated */ onContainerOver?( source?:Ext.dd.IDragSource, e?:Event, data?:any ): string; /** [Method] Called when the DropZone determines that a Ext dd DragSource has been dropped onto the drop node @@ -11201,6 +11862,7 @@ declare module Ext.dd { * @param source Ext.dd.DragSource The drag source that was dragged over this drop zone * @param e Event The event * @param data Object An object containing arbitrary data supplied by the drag source + * @returns Boolean True if the drop was valid, else false */ onNodeDrop?( nodeData?:any, source?:Ext.dd.IDragSource, e?:Event, data?:any ): boolean; /** [Method] Called when the DropZone determines that a Ext dd DragSource has entered a drop node that has either been registered @@ -11222,6 +11884,7 @@ declare module Ext.dd { * @param source Ext.dd.DragSource The drag source that was dragged over this drop zone * @param e Event The event * @param data Object An object containing arbitrary data supplied by the drag source + * @returns String status The CSS class that communicates the drop status back to the source so that the underlying Ext.dd.StatusProxy can be updated */ onNodeOver?( nodeData?:any, source?:Ext.dd.IDragSource, e?:Event, data?:any ): string; } @@ -11232,62 +11895,62 @@ declare module Ext.dd { export class Registry { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the handle registered for a DOM Node by id * @param id String/HTMLElement The DOM node or id to look up + * @returns Object handle The custom handle data */ static getHandle( id?:any ): any; - static getHandle( id?:string ): any; - static getHandle( id?:HTMLElement ): any; /** [Method] Returns the handle that is registered for the DOM node that is the target of the event * @param e Event The event + * @returns Object handle The custom handle data */ static getHandleFromEvent( e?:Event ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Returns a custom data object that is registered for a DOM node by id * @param id String/HTMLElement The DOM node or id to look up + * @returns Object data The custom data */ static getTarget( id?:any ): any; - static getTarget( id?:string ): any; - static getTarget( id?:HTMLElement ): any; /** [Method] Returns a custom data object that is registered for the DOM node that is the target of the event * @param e Event The event + * @returns Object data The custom data */ static getTargetFromEvent( e?:Event ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Registers a drag drop element * @param element String/HTMLElement The id or DOM node to register * @param data Object An custom data object that will be passed between the elements that are involved in drag drop operations. You can populate this object with any arbitrary properties that your own code knows how to interpret, plus there are some specific properties known to the Registry that should be populated in the data object (if applicable): */ - static register( element?:any, data?:any ): any; - static register( element?:string, data?:any ): void; - static register( element?:HTMLElement, data?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + static register( element?:any, data?:any ): void; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregister a drag drop element * @param element String/HTMLElement The id or DOM node to unregister */ - static unregister( element?:any ): any; - static unregister( element?:string ): void; - static unregister( element?:HTMLElement ): void; + static unregister( element?:any ): void; } } declare module Ext.dd { @@ -11296,25 +11959,27 @@ declare module Ext.dd { export class ScrollManager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Manually trigger a cache refresh */ @@ -11322,25 +11987,15 @@ declare module Ext.dd { /** [Method] Registers new overflow element s to auto scroll * @param el String/HTMLElement/Ext.Element/String[]/HTMLElement[]/Ext.Element[] The id of or the element to be scrolled or an array of either */ - static register( el?:any ): any; - static register( el?:string ): void; - static register( el?:HTMLElement ): void; - static register( el?:Ext.IElement ): void; - static register( el?:string[] ): void; - static register( el?:HTMLElement[] ): void; - static register( el?:Ext.IElement[] ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + static register( el?:any ): void; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters overflow element s so they are no longer scrolled * @param el String/HTMLElement/Ext.Element/String[]/HTMLElement[]/Ext.Element[] The id of or the element to be removed or an array of either */ - static unregister( el?:any ): any; - static unregister( el?:string ): void; - static unregister( el?:HTMLElement ): void; - static unregister( el?:Ext.IElement ): void; - static unregister( el?:string[] ): void; - static unregister( el?:HTMLElement[] ): void; - static unregister( el?:Ext.IElement[] ): void; + static unregister( el?:any ): void; } } declare module Ext.dd { @@ -11351,7 +12006,9 @@ declare module Ext.dd { dropNotAllowed?: string; /** [Config Option] (Ext.XTemplate/String/String[]) */ renderTpl?: any; - /** [Method] Returns the ghost element */ + /** [Method] Returns the ghost element + * @returns Ext.Element el + */ getGhost?(): Ext.IElement; /** [Method] Causes the proxy to return to its position of origin via an animation * @param xy Number[] The XY position of the element ([x, y]) @@ -11374,16 +12031,18 @@ declare module Ext.dd { /** [Method] Updates the contents of the ghost element * @param html String/HTMLElement The html that will replace the current innerHTML of the ghost element, or a DOM node to append as the child of the ghost element (in which case the innerHTML will be cleared first). */ - update?( html?:any ): any; - update?( html?:string ): void; - update?( html?:HTMLElement ): void; + update?( html?:any ): void; } } declare module Ext.direct { export interface IEvent extends Ext.IBase { - /** [Method] Return the raw data for this event */ + /** [Method] Return the raw data for this event + * @returns Mixed The data from the event + */ getData?(): any; - /** [Method] Return the name for this event */ + /** [Method] Return the name for this event + * @returns String The name of event + */ getName?(): string; } } @@ -11395,10 +12054,12 @@ declare module Ext.direct { export interface IJsonProvider extends Ext.direct.IProvider { /** [Method] Create an event from a response object * @param response Object Response object + * @returns Ext.direct.Event The event */ createEvent?( response?:any ): Ext.direct.IEvent; /** [Method] Creates a set of events based on the XHR response * @param response Object The XHR response + * @returns Ext.direct.Event[] An array of Ext.direct.Event */ createEvents?( response?:any ): Ext.direct.IEvent[]; } @@ -11416,6 +12077,7 @@ declare module Ext.direct { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -11424,29 +12086,28 @@ declare module Ext.direct { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds an Ext Direct Provider and creates the proxy or stub methods to execute server side methods * @param provider Ext.direct.Provider/Object... Accepts any number of Provider descriptions (an instance or config object for a Provider). Each Provider description instructs Ext.Direct how to create client-side stub methods. */ static addProvider( provider?:any ): void; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ @@ -11454,35 +12115,36 @@ declare module Ext.direct { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Retrieves a provider by the id specified when the provider is added * @param id String/Ext.direct.Provider The id of the provider, or the provider instance. */ - static getProvider( id?:any ): any; - static getProvider( id?:string ): void; - static getProvider( id?:Ext.direct.IProvider ): void; + static getProvider( id?:any ): void; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Shorthand for addManagedListener @@ -11491,35 +12153,34 @@ declare module Ext.direct { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Parses a direct function * @param fn String/Function The direct function + * @returns Function The function to use in the direct call. Null if not found */ static parseMethod( fn?:any ): any; - static parseMethod( fn?:string ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -11534,22 +12195,21 @@ declare module Ext.direct { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Removes the provider * @param provider String/Ext.direct.Provider The provider instance or the id of the provider. + * @returns Ext.direct.Provider The provider, null if not found. */ - static removeProvider( provider?:any ): any; - static removeProvider( provider?:string ): Ext.direct.IProvider; - static removeProvider( provider?:Ext.direct.IProvider ): Ext.direct.IProvider; + static removeProvider( provider?:any ): Ext.direct.IProvider; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ static resumeEvent( ...eventName:any[] ): void; /** [Method] Resumes firing events see suspendEvents */ static resumeEvents(): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. @@ -11580,6 +12240,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -11588,29 +12249,28 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds an Ext Direct Provider and creates the proxy or stub methods to execute server side methods * @param provider Ext.direct.Provider/Object... Accepts any number of Provider descriptions (an instance or config object for a Provider). Each Provider description instructs Ext.Direct how to create client-side stub methods. */ static addProvider( provider?:any ): void; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ @@ -11618,35 +12278,36 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Retrieves a provider by the id specified when the provider is added * @param id String/Ext.direct.Provider The id of the provider, or the provider instance. */ - static getProvider( id?:any ): any; - static getProvider( id?:string ): void; - static getProvider( id?:Ext.direct.IProvider ): void; + static getProvider( id?:any ): void; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Shorthand for addManagedListener @@ -11655,35 +12316,34 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Parses a direct function * @param fn String/Function The direct function + * @returns Function The function to use in the direct call. Null if not found */ static parseMethod( fn?:any ): any; - static parseMethod( fn?:string ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -11698,22 +12358,21 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Removes the provider * @param provider String/Ext.direct.Provider The provider instance or the id of the provider. + * @returns Ext.direct.Provider The provider, null if not found. */ - static removeProvider( provider?:any ): any; - static removeProvider( provider?:string ): Ext.direct.IProvider; - static removeProvider( provider?:Ext.direct.IProvider ): Ext.direct.IProvider; + static removeProvider( provider?:any ): Ext.direct.IProvider; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ static resumeEvent( ...eventName:any[] ): void; /** [Method] Resumes firing events see suspendEvents */ static resumeEvents(): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. @@ -11762,6 +12421,7 @@ declare module Ext.direct { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -11770,10 +12430,9 @@ declare module Ext.direct { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -11785,21 +12444,22 @@ declare module Ext.direct { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Returns whether or not the server side is currently connected */ @@ -11810,30 +12470,29 @@ declare module Ext.direct { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -11848,9 +12507,7 @@ declare module Ext.direct { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -11875,7 +12532,9 @@ declare module Ext.direct { } declare module Ext.direct { export interface IRemotingEvent extends Ext.direct.IEvent { - /** [Method] Get the transaction associated with this event */ + /** [Method] Get the transaction associated with this event + * @returns Ext.direct.Transaction The transaction + */ getTransaction?(): Ext.direct.ITransaction; } } @@ -11883,6 +12542,7 @@ declare module Ext.direct { export interface IRemotingMethod extends Ext.IBase { /** [Method] Takes the arguments for the Direct function and splits the arguments from the scope and the callback * @param args Array The arguments passed to the direct call + * @returns Object An object with 3 properties: args, callback & scope. */ getCallData?( args?:any[] ): any; } @@ -11937,46 +12597,41 @@ declare module Ext.dom { VISIBILITY?: number; /** [Method] Adds one or more CSS classes to the element * @param className String/String[] The CSS classes to add separated by space, or an array of classes + * @returns Ext.dom.Element this */ - addCls?( className?:any ): any; - addCls?( className?:string ): Ext.dom.IElement; - addCls?( className?:string[] ): Ext.dom.IElement; + addCls?( className?:any ): Ext.dom.IElement; /** [Method] Appends the passed element s to this element Defined in override Ext dom AbstractElement_insertion * @param el String/HTMLElement/Ext.dom.AbstractElement/Object The id or element to insert or a DomHelper config The id of the node, a DOM Node or an existing Element. * @param returnDom Boolean True to return the raw DOM element instead of Ext.dom.AbstractElement + * @returns Ext.dom.AbstractElement The inserted Element. */ appendChild?( el?:any, returnDom?:boolean ): Ext.dom.IAbstractElement; /** [Method] Appends this element to the passed element Defined in override Ext dom AbstractElement_insertion * @param el String/HTMLElement/Ext.dom.AbstractElement The new parent element. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.AbstractElement This element */ - appendTo?( el?:any ): any; - appendTo?( el?:string ): Ext.dom.IAbstractElement; - appendTo?( el?:HTMLElement ): Ext.dom.IAbstractElement; - appendTo?( el?:Ext.dom.IAbstractElement ): Ext.dom.IAbstractElement; + appendTo?( el?:any ): Ext.dom.IAbstractElement; /** [Method] More flexible version of setStyle for setting style properties * @param styles String/Object/Function A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification. + * @returns Ext.dom.Element this */ applyStyles?( styles?:any ): Ext.dom.IElement; /** [Method] Selects a single direct child based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector * @param returnDom Boolean True to return the DOM node instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom = true) */ - child?( selector?:string, returnDom?:boolean ): HTMLElement; - /** [Method] Selects a single direct child based on the passed CSS selector the selector should not contain an id - * @param selector String The CSS selector - * @param returnDom Boolean True to return the DOM node instead of Ext.dom.Element. - */ - child?( selector?:string, returnDom?:boolean ): Ext.dom.IElement; + child?( selector?:string, returnDom?:boolean ): any; /** [Method] Returns true if this element is an ancestor of the passed element * @param el HTMLElement/String The element to check + * @returns Boolean True if this element is an ancestor of el, else false */ - contains?( el?:any ): any; - contains?( el?:HTMLElement ): boolean; - contains?( el?:string ): boolean; + contains?( el?:any ): boolean; /** [Method] Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e * @param config Object DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be automatically generated with the specified attributes. * @param insertBefore HTMLElement a child element of this element * @param returnDom Boolean true to return the dom node instead of creating an Element + * @returns Ext.dom.AbstractElement The new child element */ createChild?( config?:any, insertBefore?:HTMLElement, returnDom?:boolean ): Ext.dom.IAbstractElement; /** [Method] Alias to remove */ @@ -11984,52 +12639,42 @@ declare module Ext.dom { /** [Method] Selects a single child at any depth below this element based on the passed CSS selector the selector should not cont * @param selector String The CSS selector * @param returnDom Boolean True to return the DOM node instead of Ext.dom.Element + * @returns HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom = true) */ - down?( selector?:string, returnDom?:boolean ): HTMLElement; - /** [Method] Selects a single child at any depth below this element based on the passed CSS selector the selector should not cont - * @param selector String The CSS selector - * @param returnDom Boolean True to return the DOM node instead of Ext.dom.Element - */ - down?( selector?:string, returnDom?:boolean ): Ext.dom.IElement; + down?( selector?:string, returnDom?:boolean ): any; /** [Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g * @param selector String The simple selector to test * @param limit Number/String/HTMLElement/Ext.Element The max depth to search as a number or an element which causes the upward traversal to stop and is not considered for inclusion as the result. (defaults to 50 || document.documentElement) * @param returnEl Boolean True to return a Ext.Element object instead of DOM node + * @returns HTMLElement The matching DOM node (or null if no match was found) */ - findParent?( selector?:any, limit?:any, returnEl?:any ): any; - findParent?( selector?:string, limit?:number, returnEl?:boolean ): HTMLElement; - findParent?( selector?:string, limit?:string, returnEl?:boolean ): HTMLElement; - findParent?( selector?:string, limit?:HTMLElement, returnEl?:boolean ): HTMLElement; - findParent?( selector?:string, limit?:Ext.IElement, returnEl?:boolean ): HTMLElement; + findParent?( selector?:string, limit?:any, returnEl?:boolean ): HTMLElement; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param selector String The simple selector to test * @param limit Number/String/HTMLElement/Ext.Element The max depth to search as a number or an element which causes the upward traversal to stop and is not considered for inclusion as the result. (defaults to 50 || document.documentElement) * @param returnEl Boolean True to return a Ext.Element object instead of DOM node + * @returns HTMLElement The matching DOM node (or null if no match was found) */ - findParentNode?( selector?:any, limit?:any, returnEl?:any ): any; - findParentNode?( selector?:string, limit?:number, returnEl?:boolean ): HTMLElement; - findParentNode?( selector?:string, limit?:string, returnEl?:boolean ): HTMLElement; - findParentNode?( selector?:string, limit?:HTMLElement, returnEl?:boolean ): HTMLElement; - findParentNode?( selector?:string, limit?:Ext.IElement, returnEl?:boolean ): HTMLElement; + findParentNode?( selector?:string, limit?:any, returnEl?:boolean ): HTMLElement; /** [Method] Gets the first child skipping text nodes Defined in override Ext dom AbstractElement_traversal * @param selector String Find the next sibling that matches the passed simple selector * @param returnDom Boolean True to return a raw dom node instead of an Ext.dom.Element + * @returns Ext.dom.Element/HTMLElement The first child or null */ - first?( selector?:string, returnDom?:boolean ): Ext.dom.IElement; - /** [Method] Gets the first child skipping text nodes Defined in override Ext dom AbstractElement_traversal - * @param selector String Find the next sibling that matches the passed simple selector - * @param returnDom Boolean True to return a raw dom node instead of an Ext.dom.Element + first?( selector?:string, returnDom?:boolean ): any; + /** [Method] Returns the active element in the DOM + * @returns HTMLElement The active (focused) element in the document. */ - first?( selector?:string, returnDom?:boolean ): HTMLElement; - /** [Method] Returns the active element in the DOM */ getActiveElement?(): HTMLElement; /** [Method] Returns the value of an attribute from the element s underlying DOM node * @param name String The attribute name * @param namespace String The namespace in which to look for the attribute + * @returns String The attribute value */ getAttribute?( name?:string, namespace?:string ): string; /** [Method] Gets the width of the border s for the specified side s Defined in override Ext dom AbstractElement_style * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the border left width + the border right width. + * @returns Number The width of the sides passed added together */ getBorderWidth?( side?:string ): number; /** [Method] Returns a child element of this element given its id @@ -12041,108 +12686,105 @@ declare module Ext.dom { getHTML?(): void; /** [Method] Returns the offset height of the element Defined in override Ext dom AbstractElement_style * @param contentHeight Boolean true to get the height minus borders and padding + * @returns Number The element's height */ getHeight?( contentHeight?:boolean ): number; /** [Method] Returns an object with properties top left right and bottom representing the margins of this element unless sides i * @param sides String Any combination of l, r, t, b to get the sum of those sides + * @returns Object/Number */ getMargin?( sides?:string ): any; /** [Method] Gets the width of the padding s for the specified side s Defined in override Ext dom AbstractElement_style * @param side String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the padding left + the padding right. + * @returns Number The padding of the sides passed added together */ getPadding?( side?:string ): number; /** [Method] Returns the size of the element * @param contentSize Boolean true to get the width/size minus borders and padding + * @returns Object An object containing the element's size: */ getSize?( contentSize?:boolean ): any; /** [Method] Returns a named style property based on computed currentStyle primary and inline style if primary is not available * @param property String/String[] The style property (or multiple property names in an array) whose value is returned. * @param inline Boolean if true only inline styles will be returned. + * @returns String/Object The current value of the style property for this element (or a hash of named style values if multiple property arguments are requested). */ - getStyle?( property?:any, inline?:any ): any; - getStyle?( property?:string, inline?:boolean ): any; - getStyle?( property?:string[], inline?:boolean ): any; + getStyle?( property?:any, inline?:boolean ): any; /** [Method] Returns the value of the value attribute * @param asNumber Boolean true to parse the value as a number + * @returns String/Number */ - getValue?( asNumber?:boolean ): string; - /** [Method] Returns the value of the value attribute - * @param asNumber Boolean true to parse the value as a number + getValue?( asNumber?:boolean ): any; + /** [Method] Returns the dimensions of the element available to lay content out in + * @returns Object Object describing width and height. */ - getValue?( asNumber?:boolean ): number; - /** [Method] Returns the dimensions of the element available to lay content out in */ getViewSize?(): any; /** [Method] Returns the offset width of the element Defined in override Ext dom AbstractElement_style * @param contentWidth Boolean true to get the width minus borders and padding + * @returns Number The element's width */ getWidth?( contentWidth?:boolean ): number; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param className String The CSS class to check for + * @returns Boolean True if the class exists, else false */ hasCls?( className?:string ): boolean; /** [Method] Hide this element Uses display mode to determine whether to use display or visibility * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.dom.Element this */ hide?( animate?:any ): Ext.dom.IElement; /** [Method] Inserts this element after the passed element in the DOM Defined in override Ext dom AbstractElement_insertion * @param el String/HTMLElement/Ext.dom.AbstractElement The element to insert after. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.AbstractElement This element */ - insertAfter?( el?:any ): any; - insertAfter?( el?:string ): Ext.dom.IAbstractElement; - insertAfter?( el?:HTMLElement ): Ext.dom.IAbstractElement; - insertAfter?( el?:Ext.dom.IAbstractElement ): Ext.dom.IAbstractElement; + insertAfter?( el?:any ): Ext.dom.IAbstractElement; /** [Method] Inserts this element before the passed element in the DOM Defined in override Ext dom AbstractElement_insertion * @param el String/HTMLElement/Ext.dom.AbstractElement The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.AbstractElement This element */ - insertBefore?( el?:any ): any; - insertBefore?( el?:string ): Ext.dom.IAbstractElement; - insertBefore?( el?:HTMLElement ): Ext.dom.IAbstractElement; - insertBefore?( el?:Ext.dom.IAbstractElement ): Ext.dom.IAbstractElement; + insertBefore?( el?:any ): Ext.dom.IAbstractElement; /** [Method] Inserts or creates an element or DomHelper config as the first child of this element Defined in override Ext dom * @param el String/HTMLElement/Ext.dom.AbstractElement/Object The id or element to insert or a DomHelper config to create and insert + * @returns Ext.dom.AbstractElement The new child */ insertFirst?( el?:any ): Ext.dom.IAbstractElement; /** [Method] Inserts an html fragment into this element Defined in override Ext dom AbstractElement_insertion * @param where String Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd. See Ext.dom.Helper.insertHtml for details. * @param html String The HTML fragment * @param returnEl Boolean True to return an Ext.dom.AbstractElement + * @returns HTMLElement/Ext.dom.AbstractElement The inserted node (or nearest related if more than 1 inserted) */ - insertHtml?( where?:string, html?:string, returnEl?:boolean ): HTMLElement; - /** [Method] Inserts an html fragment into this element Defined in override Ext dom AbstractElement_insertion - * @param where String Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd. See Ext.dom.Helper.insertHtml for details. - * @param html String The HTML fragment - * @param returnEl Boolean True to return an Ext.dom.AbstractElement - */ - insertHtml?( where?:string, html?:string, returnEl?:boolean ): Ext.dom.IAbstractElement; + insertHtml?( where?:string, html?:string, returnEl?:boolean ): any; /** [Method] Inserts or creates the passed element or DomHelper config as a sibling of this element Defined in override Ext d * @param el String/HTMLElement/Ext.dom.AbstractElement/Object/Array The id, element to insert or a DomHelper config to create and insert or an array of any of those. * @param where String 'before' or 'after' * @param returnDom Boolean True to return the raw DOM element instead of Ext.dom.AbstractElement + * @returns Ext.dom.AbstractElement The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling?( el?:any, where?:string, returnDom?:boolean ): Ext.dom.IAbstractElement; /** [Method] Returns true if this element matches the passed simple selector e g * @param selector String The simple selector to test + * @returns Boolean True if this element matches the selector, else false */ is?( selector?:string ): boolean; /** [Method] Checks if the current value of a style is equal to a given value * @param style String property whose value is returned. * @param value String to check against. + * @returns Boolean true for when the current value equals the given value. */ isStyle?( style?:string, value?:string ): boolean; /** [Method] Returns true if the value of the given property is visually transparent * @param prop String The style property whose value is to be tested. + * @returns Boolean True if the style property is visually transparent. */ isTransparent?( prop?:string ): boolean; /** [Method] Gets the last child skipping text nodes Defined in override Ext dom AbstractElement_traversal * @param selector String Find the previous sibling that matches the passed simple selector * @param returnDom Boolean True to return a raw dom node instead of an Ext.dom.Element + * @returns Ext.dom.Element/HTMLElement The last child or null */ - last?( selector?:string, returnDom?:boolean ): Ext.dom.IElement; - /** [Method] Gets the last child skipping text nodes Defined in override Ext dom AbstractElement_traversal - * @param selector String Find the previous sibling that matches the passed simple selector - * @param returnDom Boolean True to return a raw dom node instead of an Ext.dom.Element - */ - last?( selector?:string, returnDom?:boolean ): HTMLElement; + last?( selector?:string, returnDom?:boolean ): any; /** [Method] Puts a mask over this element to disable user interaction * @param msg String A message to display in the mask * @param msgCls String A css class to apply to the msg element @@ -12151,128 +12793,121 @@ declare module Ext.dom { /** [Method] Gets the next sibling skipping text nodes Defined in override Ext dom AbstractElement_traversal * @param selector String Find the next sibling that matches the passed simple selector * @param returnDom Boolean True to return a raw dom node instead of an Ext.dom.Element + * @returns Ext.dom.Element/HTMLElement The next sibling or null */ - next?( selector?:string, returnDom?:boolean ): Ext.dom.IElement; - /** [Method] Gets the next sibling skipping text nodes Defined in override Ext dom AbstractElement_traversal - * @param selector String Find the next sibling that matches the passed simple selector - * @param returnDom Boolean True to return a raw dom node instead of an Ext.dom.Element - */ - next?( selector?:string, returnDom?:boolean ): HTMLElement; + next?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector Defined in override Ext dom * @param selector String Find a parent node that matches the passed simple selector * @param returnDom Boolean True to return a raw dom node instead of an Ext.dom.Element + * @returns Ext.dom.Element/HTMLElement The parent node or null */ - parent?( selector?:string, returnDom?:boolean ): Ext.dom.IElement; - /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector Defined in override Ext dom - * @param selector String Find a parent node that matches the passed simple selector - * @param returnDom Boolean True to return a raw dom node instead of an Ext.dom.Element - */ - parent?( selector?:string, returnDom?:boolean ): HTMLElement; + parent?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the previous sibling skipping text nodes Defined in override Ext dom AbstractElement_traversal * @param selector String Find the previous sibling that matches the passed simple selector * @param returnDom Boolean True to return a raw dom node instead of an Ext.dom.Element + * @returns Ext.dom.Element/HTMLElement The previous sibling or null */ - prev?( selector?:string, returnDom?:boolean ): Ext.dom.IElement; - /** [Method] Gets the previous sibling skipping text nodes Defined in override Ext dom AbstractElement_traversal - * @param selector String Find the previous sibling that matches the passed simple selector - * @param returnDom Boolean True to return a raw dom node instead of an Ext.dom.Element - */ - prev?( selector?:string, returnDom?:boolean ): HTMLElement; + prev?( selector?:string, returnDom?:boolean ): any; /** [Method] Selects child nodes based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector + * @returns HTMLElement[] An array of the matched nodes */ query?( selector?:string ): HTMLElement[]; /** [Method] Adds one or more CSS classes to this element and removes the same class es from all siblings * @param className String/String[] The CSS class to add, or an array of classes + * @returns Ext.dom.Element this */ - radioCls?( className?:any ): any; - radioCls?( className?:string ): Ext.dom.IElement; - radioCls?( className?:string[] ): Ext.dom.IElement; + radioCls?( className?:any ): Ext.dom.IElement; /** [Method] Removes this element s dom reference */ remove?(): void; /** [Method] Removes one or more CSS classes from the element * @param className String/String[] The CSS classes to remove separated by space, or an array of classes + * @returns Ext.dom.Element this + */ + removeCls?( className?:any ): Ext.dom.IElement; + /** [Method] Forces the browser to repaint this element Defined in override Ext dom AbstractElement_style + * @returns Ext.dom.Element this */ - removeCls?( className?:any ): any; - removeCls?( className?:string ): Ext.dom.IElement; - removeCls?( className?:string[] ): Ext.dom.IElement; - /** [Method] Forces the browser to repaint this element Defined in override Ext dom AbstractElement_style */ repaint?(): Ext.dom.IElement; /** [Method] Replaces the passed element with this element Defined in override Ext dom AbstractElement_insertion * @param el String/HTMLElement/Ext.dom.AbstractElement The element to replace. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.AbstractElement This element */ - replace?( el?:any ): any; - replace?( el?:string ): Ext.dom.IAbstractElement; - replace?( el?:HTMLElement ): Ext.dom.IAbstractElement; - replace?( el?:Ext.dom.IAbstractElement ): Ext.dom.IAbstractElement; + replace?( el?:any ): Ext.dom.IAbstractElement; /** [Method] Replaces a CSS class on the element with another * @param oldClassName String The CSS class to replace * @param newClassName String The replacement CSS class + * @returns Ext.dom.Element this */ replaceCls?( oldClassName?:string, newClassName?:string ): Ext.dom.IElement; /** [Method] Replaces this element with the passed element Defined in override Ext dom AbstractElement_insertion * @param el String/HTMLElement/Ext.dom.AbstractElement/Object The new element (id of the node, a DOM Node or an existing Element) or a DomHelper config of an element to create + * @returns Ext.dom.AbstractElement This element */ replaceWith?( el?:any ): Ext.dom.IAbstractElement; /** [Method] Creates a Ext CompositeElement for child nodes based on the passed CSS selector the selector should not contain an id * @param selector String The CSS selector * @param unique Boolean True to create a unique Ext.Element for each element. Defaults to a shared flyweight object. + * @returns Ext.CompositeElement The composite element */ select?( selector?:string, unique?:boolean ): Ext.ICompositeElement; /** [Method] Serializes a DOM form into a url encoded string Defined in override Ext dom AbstractElement_static * @param form Object The form + * @returns String The url encoded form */ serializeForm?( form?:any ): string; /** [Method] Sets the passed attributes as attributes of this element a style attribute can be a string object or function * @param o Object The object with the attributes * @param useSet Boolean false to override the default setAttribute to use expandos. + * @returns Ext.dom.Element this */ set?( o?:any, useSet?:boolean ): Ext.dom.IElement; /** [Method] Set the innerHTML of this element * @param html String The new HTML + * @returns Ext.Element this */ setHTML?( html?:string ): Ext.IElement; /** [Method] Set the height of this Element * @param height Number/String The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels.) A String used to set the CSS height style. Animation may not be used. + * @returns Ext.dom.Element this */ - setHeight?( height?:any ): any; - setHeight?( height?:number ): Ext.dom.IElement; - setHeight?( height?:string ): Ext.dom.IElement; + setHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the size of this Element * @param width Number/String The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels). A String used to set the CSS width style. Animation may not be used. A size object in the format {width: widthValue, height: heightValue}. * @param height Number/String The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels). A String used to set the CSS height style. Animation may not be used. + * @returns Ext.dom.Element this */ - setSize?( width?:any, height?:any ): any; - setSize?( width?:number, height?:number ): Ext.dom.IElement; - setSize?( width?:string, height?:number ): Ext.dom.IElement; - setSize?( width?:number, height?:string ): Ext.dom.IElement; - setSize?( width?:string, height?:string ): Ext.dom.IElement; + setSize?( width?:any, height?:any ): Ext.dom.IElement; /** [Method] Wrapper for setting style properties also takes single object parameter of multiple styles * @param property String/Object The style property to be set, or an object of multiple styles. * @param value String The value to apply to the given property, or null if an object was passed. + * @returns Ext.dom.Element this */ setStyle?( property?:any, value?:string ): Ext.dom.IElement; /** [Method] Use this to change the visibility mode between VISIBILITY DISPLAY OFFSETS or ASCLASS * @param mode Object + * @returns Ext.dom.AbstractElement this */ setVisibilityMode?( mode?:any ): Ext.dom.IAbstractElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ setVisible?( visible?:boolean, animate?:any ): Ext.dom.IElement; /** [Method] Set the width of this Element * @param width Number/String The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels). A String used to set the CSS width style. Animation may not be used. + * @returns Ext.dom.Element this */ - setWidth?( width?:any ): any; - setWidth?( width?:number ): Ext.dom.IElement; - setWidth?( width?:string ): Ext.dom.IElement; + setWidth?( width?:any ): Ext.dom.IElement; /** [Method] Show this element Uses display mode to determine whether to use display or visibility * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.dom.Element this */ show?( animate?:any ): Ext.dom.IElement; /** [Method] Toggles the specified CSS class on this element removes it if it already exists otherwise adds it * @param className String The CSS class to toggle + * @returns Ext.dom.Element this */ toggleCls?( className?:string ): Ext.dom.IElement; /** [Method] Removes a previously applied mask */ @@ -12281,28 +12916,21 @@ declare module Ext.dom { * @param selector String The simple selector to test * @param limit Number/String/HTMLElement/Ext.Element The max depth to search as a number or an element which causes the upward traversal to stop and is not considered for inclusion as the result. (defaults to 50 || document.documentElement) * @param returnDom Boolean True to return the DOM node instead of Ext.dom.Element + * @returns Ext.Element The matching DOM node (or null if no match was found) */ - up?( selector?:any, limit?:any, returnDom?:any ): any; - up?( selector?:string, limit?:number, returnDom?:boolean ): Ext.IElement; - up?( selector?:string, limit?:string, returnDom?:boolean ): Ext.IElement; - up?( selector?:string, limit?:HTMLElement, returnDom?:boolean ): Ext.IElement; - up?( selector?:string, limit?:Ext.IElement, returnDom?:boolean ): Ext.IElement; + up?( selector?:string, limit?:any, returnDom?:boolean ): Ext.IElement; /** [Method] Update the innerHTML of this element * @param html String The new HTML + * @returns Ext.dom.Element this */ update?( html?:string ): Ext.dom.IElement; /** [Method] Creates and wraps this element with another element Defined in override Ext dom AbstractElement_insertion * @param config Object DomHelper element config object for the wrapper element or null for an empty div * @param returnDom Boolean True to return the raw DOM element instead of Ext.dom.AbstractElement * @param selector String A DomQuery selector to select a descendant node within the created element to use as the wrapping element. + * @returns HTMLElement/Ext.dom.AbstractElement The newly created wrapper element */ - wrap?( config?:any, returnDom?:boolean, selector?:string ): HTMLElement; - /** [Method] Creates and wraps this element with another element Defined in override Ext dom AbstractElement_insertion - * @param config Object DomHelper element config object for the wrapper element or null for an empty div - * @param returnDom Boolean True to return the raw DOM element instead of Ext.dom.AbstractElement - * @param selector String A DomQuery selector to select a descendant node within the created element to use as the wrapping element. - */ - wrap?( config?:any, returnDom?:boolean, selector?:string ): Ext.dom.IAbstractElement; + wrap?( config?:any, returnDom?:boolean, selector?:string ): any; } export class AbstractElement { /** [Method] Add methods properties to the prototype of this class @@ -12311,9 +12939,12 @@ declare module Ext.dom { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -12323,69 +12954,86 @@ declare module Ext.dom { /** [Method] Gets the singleton flyweight element with the passed node as the active element * @param dom String/HTMLElement The dom node or id * @param named String Allows for creation of named reusable flyweights to prevent conflicts (e.g. internally Ext uses "_global") + * @returns Ext.dom.Element.Fly The singleton flyweight object (or null if no matching element was found) */ - static fly( dom?:any, named?:any ): any; - static fly( dom?:string, named?:string ): Ext.dom.element.IFly; - static fly( dom?:HTMLElement, named?:string ): Ext.dom.element.IFly; + static fly( dom?:any, named?:string ): Ext.dom.element.IFly; /** [Method] Returns the top Element that is located at the passed coordinates Defined in override Ext dom AbstractElement_static * @param x Number The x coordinate * @param y Number The y coordinate + * @returns String The found Element */ static fromPoint( x?:number, y?:number ): string; /** [Method] Retrieves Ext dom Element objects * @param el String/HTMLElement/Ext.Element The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element The Element object (or null if no matching element was found) + */ + static get( el?:any ): Ext.dom.IElement; + /** [Method] Retrieves the document height Defined in override Ext dom AbstractElement_static + * @returns Number documentHeight */ - static get( el?:any ): any; - static get( el?:string ): Ext.dom.IElement; - static get( el?:HTMLElement ): Ext.dom.IElement; - static get( el?:Ext.IElement ): Ext.dom.IElement; - /** [Method] Retrieves the document height Defined in override Ext dom AbstractElement_static */ static getDocumentHeight(): number; - /** [Method] Retrieves the document width Defined in override Ext dom AbstractElement_static */ + /** [Method] Retrieves the document width Defined in override Ext dom AbstractElement_static + * @returns Number documentWidth + */ static getDocumentWidth(): number; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; - /** [Method] Retrieves the current orientation of the window */ + /** [Method] Retrieves the current orientation of the window + * @returns String Orientation of window: 'portrait' or 'landscape' + */ static getOrientation(): string; - /** [Method] Retrieves the viewport size of the window */ + /** [Method] Retrieves the viewport size of the window + * @returns Object object containing width and height properties + */ static getViewSize(): any; - /** [Method] Retrieves the viewport height of the window */ + /** [Method] Retrieves the viewport height of the window + * @returns Number viewportHeight + */ static getViewportHeight(): number; - /** [Method] Retrieves the viewport width of the window */ + /** [Method] Retrieves the viewport width of the window + * @returns Number viewportWidth + */ static getViewportWidth(): number; /** [Method] Adds members to class */ static implement(): void; /** [Method] Returns an array of unique class names based upon the input strings or string arrays * @param clsList1 Mixed A string of class names, or an array of class names. * @param clsList2 Mixed A string of class names, or an array of class names. + * @returns Array An array of strings representing remaining unique, merged class names. If class names were added to the first list, the changed property will be true. */ static mergeClsList( clsList1?:any, clsList2?:any ): any[]; /** [Method] Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax * @param prop String The property to normalize + * @returns String The normalized string */ static normalize( prop?:string ): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String The encoded margins + * @returns Object An object with margin sizes for top, right, bottom and left */ static parseBox( box?:any ): any; - static parseBox( box?:number ): any; - static parseBox( box?:string ): any; /** [Method] Converts a CSS string into an object with a property for each style * @param styles String A CSS string + * @returns Object styles */ static parseStyles( styles?:string ): any; /** [Method] Returns an array of unique class names deom the first parameter with all class names from the second parameter removed * @param existingClsList Mixed A string of class names, or an array of class names. * @param removeClsList Mixed A string of class names, or an array of class names to remove from existingClsList. + * @returns Array An array of strings representing remaining class names. If class names were removed, the changed property will be true. */ static removeCls( existingClsList?:any, removeClsList?:any ): any[]; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String/Object The encoded margins, or an object with top, right, bottom, and left properties * @param units String The type of units to add + * @returns String An string with unitized (px if units is not specified) metrics for top, right, bottom and left */ static unitizeBox( box?:any, units?:string ): string; } @@ -12396,116 +13044,60 @@ declare module Ext.dom { * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - append?( el?:any, o?:any, returnElement?:any ): any; - append?( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - append?( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - append?( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and appends them to el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return a Ext.Element - */ - append?( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - append?( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - append?( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + append?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Applies a style specification to an element * @param el String/HTMLElement The element to apply styles to * @param styles String/Object/Function A style specification string e.g. 'width:100px', or object in the form {width:'100px'}, or a function which returns such a specification. */ - applyStyles?( el?:any, styles?:any ): any; - applyStyles?( el?:string, styles?:any ): void; - applyStyles?( el?:HTMLElement, styles?:any ): void; + applyStyles?( el?:any, styles?:any ): void; /** [Method] Converts the styles from the given object to text * @param styles Object The object describing the styles. * @param buffer String[] The output buffer. + * @returns String/String[] If buffer is passed, it is returned. Otherwise the style string is returned. */ - generateStyles?( styles?:any, buffer?:string[] ): string; - /** [Method] Converts the styles from the given object to text - * @param styles Object The object describing the styles. - * @param buffer String[] The output buffer. - */ - generateStyles?( styles?:any, buffer?:string[] ): string[]; + generateStyles?( styles?:any, buffer?:string[] ): any; /** [Method] Creates new DOM element s and inserts them after el * @param el String/HTMLElement/Ext.Element The context element * @param o Object The DOM object spec (and children) * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - insertAfter?( el?:any, o?:any, returnElement?:any ): any; - insertAfter?( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - insertAfter?( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - insertAfter?( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and inserts them after el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object The DOM object spec (and children) - * @param returnElement Boolean true to return a Ext.Element - */ - insertAfter?( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - insertAfter?( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - insertAfter?( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + insertAfter?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Creates new DOM element s and inserts them before el * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - insertBefore?( el?:any, o?:any, returnElement?:any ): any; - insertBefore?( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - insertBefore?( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - insertBefore?( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and inserts them before el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return a Ext.Element - */ - insertBefore?( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - insertBefore?( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - insertBefore?( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + insertBefore?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Creates new DOM element s and inserts them as the first child of el * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - insertFirst?( el?:any, o?:any, returnElement?:any ): any; - insertFirst?( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - insertFirst?( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - insertFirst?( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and inserts them as the first child of el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return a Ext.Element - */ - insertFirst?( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - insertFirst?( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - insertFirst?( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + insertFirst?( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Inserts an HTML fragment into the DOM * @param where String Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd. For example take the following HTML: <div>Contents</div> Using different where values inserts element to the following places: beforeBegin: <HERE><div>Contents</div> afterBegin: <div><HERE>Contents</div> beforeEnd: <div>Contents<HERE></div> afterEnd: <div>Contents</div><HERE> * @param el HTMLElement/TextNode The context element * @param html String The HTML fragment + * @returns HTMLElement The new node */ - insertHtml?( where?:any, el?:any, html?:any ): any; - insertHtml?( where?:string, el?:HTMLElement, html?:string ): HTMLElement; insertHtml?( where?:string, el?:any, html?:string ): HTMLElement; /** [Method] Returns the markup for the passed Element s config * @param spec Object The DOM object spec (and children) + * @returns String */ markup?( spec?:any ): string; /** [Method] Creates new DOM element s and overwrites the contents of el with them * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - overwrite?( el?:any, o?:any, returnElement?:any ): any; - overwrite?( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - overwrite?( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - overwrite?( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and overwrites the contents of el with them - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return a Ext.Element - */ - overwrite?( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - overwrite?( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - overwrite?( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + overwrite?( el?:any, o?:any, returnElement?:boolean ): any; } } declare module Ext.dom { @@ -12513,25 +13105,21 @@ declare module Ext.dom { /** [Method] Returns true if the passed element s match the passed simple selector e g * @param el String/HTMLElement/Array An element id, element or array of elements * @param selector String The simple selector to test + * @returns Boolean */ - is?( el?:any, selector?:any ): any; - is?( el?:string, selector?:string ): boolean; - is?( el?:HTMLElement, selector?:string ): boolean; - is?( el?:any[], selector?:string ): boolean; + is?( el?:any, selector?:string ): boolean; /** [Method] Selects a group of elements * @param selector String The selector/xpath query (can be a comma separated list of selectors) * @param root HTMLElement/String The start of the query (defaults to document). + * @returns HTMLElement[] An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned. */ - select?( selector?:any, root?:any ): any; - select?( selector?:string, root?:HTMLElement ): HTMLElement[]; - select?( selector?:string, root?:string ): HTMLElement[]; + select?( selector?:string, root?:any ): HTMLElement[]; /** [Method] Selects a single element * @param selector String The selector/xpath query * @param root HTMLElement/String The start of the query (defaults to document). + * @returns HTMLElement The DOM element which matched the selector. */ - selectNode?( selector?:any, root?:any ): any; - selectNode?( selector?:string, root?:HTMLElement ): HTMLElement; - selectNode?( selector?:string, root?:string ): HTMLElement; + selectNode?( selector?:string, root?:any ): HTMLElement; } } declare module Ext.dom { @@ -12550,82 +13138,73 @@ declare module Ext.dom { isComposite?: boolean; /** [Method] Adds elements to this Composite object * @param els HTMLElement[]/Ext.dom.CompositeElement Either an Array of DOM elements to add, or another Composite object who's elements should be added. + * @returns Ext.dom.CompositeElement This Composite object. */ - add?( els?:any ): any; - add?( els?:HTMLElement[] ): Ext.dom.ICompositeElement; - add?( els?:Ext.dom.ICompositeElement ): Ext.dom.ICompositeElement; + add?( els?:any ): Ext.dom.ICompositeElement; /** [Method] Removes all elements from this Composite * @param removeDom Boolean True to also remove the elements from the document. */ clear?( removeDom?:boolean ): void; /** [Method] Returns true if this composite contains the passed element * @param el String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection. + * @returns Boolean */ - contains?( el?:any ): any; - contains?( el?:string ): boolean; - contains?( el?:HTMLElement ): boolean; - contains?( el?:Ext.IElement ): boolean; - contains?( el?:number ): boolean; + contains?( el?:any ): boolean; /** [Method] Calls the passed function for each element in this composite * @param fn Function The function to call. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Element. + * @returns Ext.dom.CompositeElement this */ each?( fn?:any, scope?:any ): Ext.dom.ICompositeElement; /** [Method] Clears this Composite and adds the elements passed * @param els HTMLElement[]/Ext.dom.CompositeElement Either an array of DOM elements, or another Composite from which to fill this Composite. + * @returns Ext.dom.CompositeElement this */ - fill?( els?:any ): any; - fill?( els?:HTMLElement[] ): Ext.dom.ICompositeElement; - fill?( els?:Ext.dom.ICompositeElement ): Ext.dom.ICompositeElement; + fill?( els?:any ): Ext.dom.ICompositeElement; /** [Method] Filters this composite to only elements that match the passed selector * @param selector String/Function A string CSS selector or a comparison function. The comparison function will be called with the following arguments: + * @returns Ext.dom.CompositeElement this + */ + filter?( selector?:any ): Ext.dom.ICompositeElement; + /** [Method] Returns the first Element + * @returns Ext.dom.Element */ - filter?( selector?:any ): any; - filter?( selector?:string ): Ext.dom.ICompositeElement; - /** [Method] Returns the first Element */ first?(): Ext.dom.IElement; - /** [Method] Returns the number of elements in this Composite */ + /** [Method] Returns the number of elements in this Composite + * @returns Number + */ getCount?(): number; /** [Method] Find the index of the passed element within the composite collection * @param el String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.dom.Element, or an HtmlElement to find within the composite collection. + * @returns Number The index of the passed Ext.dom.Element in the composite collection, or -1 if not found. */ - indexOf?( el?:any ): any; - indexOf?( el?:string ): number; - indexOf?( el?:HTMLElement ): number; - indexOf?( el?:Ext.IElement ): number; - indexOf?( el?:number ): number; + indexOf?( el?:any ): number; /** [Method] Returns a flyweight Element of the dom element object at the specified index * @param index Number + * @returns Ext.dom.Element */ item?( index?:number ): Ext.dom.IElement; - /** [Method] Returns the last Element */ + /** [Method] Returns the last Element + * @returns Ext.dom.Element + */ last?(): Ext.dom.IElement; /** [Method] Removes the specified element s * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite or an array of any of those. * @param removeDom Boolean True to also remove the element from the document. + * @returns Ext.dom.CompositeElement this */ - removeElement?( el?:any, removeDom?:any ): any; - removeElement?( el?:string, removeDom?:boolean ): Ext.dom.ICompositeElement; - removeElement?( el?:HTMLElement, removeDom?:boolean ): Ext.dom.ICompositeElement; - removeElement?( el?:Ext.IElement, removeDom?:boolean ): Ext.dom.ICompositeElement; - removeElement?( el?:number, removeDom?:boolean ): Ext.dom.ICompositeElement; + removeElement?( el?:any, removeDom?:boolean ): Ext.dom.ICompositeElement; /** [Method] Replaces the specified element with the passed element * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite to replace. * @param replacement String/Ext.Element The id of an element or the Element itself. * @param domReplace Boolean True to remove and replace the element in the document too. + * @returns Ext.dom.CompositeElement this */ - replaceElement?( el?:any, replacement?:any, domReplace?:any ): any; - replaceElement?( el?:string, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:HTMLElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:Ext.IElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:number, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:string, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:HTMLElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:Ext.IElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:number, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElement; + replaceElement?( el?:any, replacement?:any, domReplace?:boolean ): Ext.dom.ICompositeElement; /** [Method] Gets a range nodes * @param start Number The index of the first node in the range * @param end Number The index of the last node in the range + * @returns HTMLElement[] An array of nodes */ slice?( start?:number, end?:number ): HTMLElement[]; } @@ -12638,82 +13217,73 @@ declare module Ext { isComposite?: boolean; /** [Method] Adds elements to this Composite object * @param els HTMLElement[]/Ext.dom.CompositeElement Either an Array of DOM elements to add, or another Composite object who's elements should be added. + * @returns Ext.dom.CompositeElement This Composite object. */ - add?( els?:any ): any; - add?( els?:HTMLElement[] ): Ext.dom.ICompositeElement; - add?( els?:Ext.dom.ICompositeElement ): Ext.dom.ICompositeElement; + add?( els?:any ): Ext.dom.ICompositeElement; /** [Method] Removes all elements from this Composite * @param removeDom Boolean True to also remove the elements from the document. */ clear?( removeDom?:boolean ): void; /** [Method] Returns true if this composite contains the passed element * @param el String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection. + * @returns Boolean */ - contains?( el?:any ): any; - contains?( el?:string ): boolean; - contains?( el?:HTMLElement ): boolean; - contains?( el?:Ext.IElement ): boolean; - contains?( el?:number ): boolean; + contains?( el?:any ): boolean; /** [Method] Calls the passed function for each element in this composite * @param fn Function The function to call. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Element. + * @returns Ext.dom.CompositeElement this */ each?( fn?:any, scope?:any ): Ext.dom.ICompositeElement; /** [Method] Clears this Composite and adds the elements passed * @param els HTMLElement[]/Ext.dom.CompositeElement Either an array of DOM elements, or another Composite from which to fill this Composite. + * @returns Ext.dom.CompositeElement this */ - fill?( els?:any ): any; - fill?( els?:HTMLElement[] ): Ext.dom.ICompositeElement; - fill?( els?:Ext.dom.ICompositeElement ): Ext.dom.ICompositeElement; + fill?( els?:any ): Ext.dom.ICompositeElement; /** [Method] Filters this composite to only elements that match the passed selector * @param selector String/Function A string CSS selector or a comparison function. The comparison function will be called with the following arguments: + * @returns Ext.dom.CompositeElement this + */ + filter?( selector?:any ): Ext.dom.ICompositeElement; + /** [Method] Returns the first Element + * @returns Ext.dom.Element */ - filter?( selector?:any ): any; - filter?( selector?:string ): Ext.dom.ICompositeElement; - /** [Method] Returns the first Element */ first?(): Ext.dom.IElement; - /** [Method] Returns the number of elements in this Composite */ + /** [Method] Returns the number of elements in this Composite + * @returns Number + */ getCount?(): number; /** [Method] Find the index of the passed element within the composite collection * @param el String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.dom.Element, or an HtmlElement to find within the composite collection. + * @returns Number The index of the passed Ext.dom.Element in the composite collection, or -1 if not found. */ - indexOf?( el?:any ): any; - indexOf?( el?:string ): number; - indexOf?( el?:HTMLElement ): number; - indexOf?( el?:Ext.IElement ): number; - indexOf?( el?:number ): number; + indexOf?( el?:any ): number; /** [Method] Returns a flyweight Element of the dom element object at the specified index * @param index Number + * @returns Ext.dom.Element */ item?( index?:number ): Ext.dom.IElement; - /** [Method] Returns the last Element */ + /** [Method] Returns the last Element + * @returns Ext.dom.Element + */ last?(): Ext.dom.IElement; /** [Method] Removes the specified element s * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite or an array of any of those. * @param removeDom Boolean True to also remove the element from the document. + * @returns Ext.dom.CompositeElement this */ - removeElement?( el?:any, removeDom?:any ): any; - removeElement?( el?:string, removeDom?:boolean ): Ext.dom.ICompositeElement; - removeElement?( el?:HTMLElement, removeDom?:boolean ): Ext.dom.ICompositeElement; - removeElement?( el?:Ext.IElement, removeDom?:boolean ): Ext.dom.ICompositeElement; - removeElement?( el?:number, removeDom?:boolean ): Ext.dom.ICompositeElement; + removeElement?( el?:any, removeDom?:boolean ): Ext.dom.ICompositeElement; /** [Method] Replaces the specified element with the passed element * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite to replace. * @param replacement String/Ext.Element The id of an element or the Element itself. * @param domReplace Boolean True to remove and replace the element in the document too. + * @returns Ext.dom.CompositeElement this */ - replaceElement?( el?:any, replacement?:any, domReplace?:any ): any; - replaceElement?( el?:string, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:HTMLElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:Ext.IElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:number, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:string, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:HTMLElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:Ext.IElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElement; - replaceElement?( el?:number, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElement; + replaceElement?( el?:any, replacement?:any, domReplace?:boolean ): Ext.dom.ICompositeElement; /** [Method] Gets a range nodes * @param start Number The index of the first node in the range * @param end Number The index of the last node in the range + * @returns HTMLElement[] An array of nodes */ slice?( start?:number, end?:number ): HTMLElement[]; } @@ -12740,28 +13310,33 @@ declare module Ext.dom { * @param className String The class to add * @param testFn Function A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added. * @param scope Object The scope to execute the testFn in. + * @returns Ext.dom.Element this */ addClsOnClick?( className?:string, testFn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Sets up event handlers to add and remove a css class when this element has the focus Defined in override Ext dom Ele * @param className String The class to add * @param testFn Function A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added. * @param scope Object The scope to execute the testFn in. + * @returns Ext.dom.Element this */ addClsOnFocus?( className?:string, testFn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Sets up event handlers to add and remove a css class when the mouse is over this element Defined in override Ext dom * @param className String The class to add * @param testFn Function A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added. * @param scope Object The scope to execute the testFn in. + * @returns Ext.dom.Element this */ addClsOnOver?( className?:string, testFn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Convenience method for constructing a KeyMap * @param key String/Number/Number[]/Object Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options: * @param fn Function The function to call * @param scope Object The scope (this reference) in which the specified function is executed. Defaults to this Element. + * @returns Ext.util.KeyMap The KeyMap created */ addKeyListener?( key?:any, fn?:any, scope?:any ): Ext.util.IKeyMap; /** [Method] Creates a KeyMap for this element * @param config Object The KeyMap config. See Ext.util.KeyMap for more details + * @returns Ext.util.KeyMap The KeyMap created */ addKeyMap?( config?:any ): Ext.util.IKeyMap; /** [Method] Shorthand for on @@ -12769,85 +13344,108 @@ declare module Ext.dom { * @param fn Function The handler function the event invokes. This function is passed the following parameters: evt : EventObject The EventObject describing the event. el : HtmlElement The DOM element which was the target of the event. Note that this may be filtered by using the delegate option. o : Object The options object from the call that setup the listener. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. * @param options Object An object containing handler configuration properties. This may contain any of the following properties: scope Object : The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. delegate String: A simple selector to filter the target or look for a descendant of the target. See below for additional details. stopEvent Boolean: True to stop the event. That is stop propagation, and prevent the default action. preventDefault Boolean: True to prevent the default action stopPropagation Boolean: True to prevent event propagation normalized Boolean: False to pass a browser event to the handler function instead of an Ext.EventObject target Ext.dom.Element: Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a child node. delay Number: The number of milliseconds to delay the invocation of the handler after the 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. Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the options object. The options object is available as the third parameter in the handler function. Code: el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, 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. Code: el.on({ 'click' : { fn: this.onClick, scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver, scope: this }, 'mouseout' : { fn: this.onMouseOut, scope: this } }); Or a shorthand syntax: Code: el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut, scope: this }); delegate This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. Event delegation is a technique that is used to reduce memory consumption and prevent exposure to memory-leaks. By registering an event for a container element as opposed to each element within a container. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example: // using this markup: <div id='elId'> <p id='p1'>paragraph one</p> <p id='p2' class='clickable'>paragraph two</p> <p id='p3'>paragraph three</p> </div> // utilize event delegation to registering just one handler on the container element: el = Ext.get('elId'); el.on( 'click', function(e,t) { // handle click console.info(t.id); // 'p2' }, this, { // filter the target element to be a descendant with the class 'clickable' delegate: '.clickable' } ); + * @returns Ext.dom.Element this */ addListener?( eventName?:string, fn?:any, scope?:any, options?:any ): Ext.dom.IElement; /** [Method] Performs custom animation on this Element * @param config Object Configuration for Ext.fx.Anim. Note that the to config is required. + * @returns Ext.dom.Element this */ animate?( config?:any ): Ext.dom.IElement; - /** [Method] Tries to blur the element */ + /** [Method] Tries to blur the element + * @returns Ext.dom.Element this + */ blur?(): Ext.dom.IElement; /** [Method] Wraps the specified element with a special 9 element markup CSS block that renders by default as a gray container wit * @param class String A base CSS class to apply to the containing wrapper element. Note that there are a number of CSS rules that are dependent on this name to make the overall effect work, so if you supply an alternate base class, make sure you also supply all of the necessary rules. + * @returns Ext.dom.Element The outermost wrapping element of the created box structure. */ boxWrap?( clazz?:string ): Ext.dom.IElement; - /** [Method] When an element is moved around in the DOM or is hidden using display none it loses layout and therefore all scrol */ + /** [Method] When an element is moved around in the DOM or is hidden using display none it loses layout and therefore all scrol + * @returns Function A function which will restore all descentant elements of this Element to their scroll positions recorded when this function was executed. Be aware that the returned function is a closure which has captured the scope of cacheScrollValues, so take care to derefence it as soon as not needed - if is it is a var it will drop out of scope, and the reference will be freed. + */ cacheScrollValues?(): any; /** [Method] Centers the Element in either the viewport or another Element * @param centerIn String/HTMLElement/Ext.dom.Element element in which to center the element. */ - center?( centerIn?:any ): any; - center?( centerIn?:string ): void; - center?( centerIn?:HTMLElement ): void; - center?( centerIn?:Ext.dom.IElement ): void; + center?( centerIn?:any ): void; /** [Method] Removes Empty or whitespace filled text nodes * @param forceReclean Boolean By default the element keeps track if it has been cleaned already so you can call this over and over. However, if you update the element and need to force a reclean, you can pass true. */ clean?( forceReclean?:boolean ): void; - /** [Method] Alias for removeAllListeners */ + /** [Method] Alias for removeAllListeners + * @returns Ext.dom.Element this + */ clearListeners?(): Ext.dom.IElement; - /** [Method] Clears any opacity settings from this element */ + /** [Method] Clears any opacity settings from this element + * @returns Ext.dom.Element this + */ clearOpacity?(): Ext.dom.IElement; /** [Method] Clears positioning back to the default when the document was loaded * @param value String The value to use for the left, right, top, bottom. You could use 'auto'. + * @returns Ext.dom.Element this */ clearPositioning?( value?:string ): Ext.dom.IElement; - /** [Method] Store the current overflow setting and clip overflow on the element use unclip to remove Defined in override Ext d */ + /** [Method] Store the current overflow setting and clip overflow on the element use unclip to remove Defined in override Ext d + * @returns Ext.dom.Element this + */ clip?(): Ext.dom.IElement; /** [Method] Creates a proxy element of this element * @param config String/Object The class name of the proxy element or a DomHelper config object * @param renderTo String/HTMLElement The element or element id to render the proxy to. Defaults to: document.body. * @param matchBox Boolean True to align and size the proxy to this element now. + * @returns Ext.dom.Element The new proxy element + */ + createProxy?( config?:any, renderTo?:any, matchBox?:boolean ): Ext.dom.IElement; + /** [Method] Creates an iframe shim for this element to keep selects and other windowed objects from showing through + * @returns Ext.dom.Element The new shim element */ - createProxy?( config?:any, renderTo?:any, matchBox?:any ): any; - createProxy?( config?:any, renderTo?:string, matchBox?:boolean ): Ext.dom.IElement; - createProxy?( config?:any, renderTo?:HTMLElement, matchBox?:boolean ): Ext.dom.IElement; - /** [Method] Creates an iframe shim for this element to keep selects and other windowed objects from showing through */ createShim?(): Ext.dom.IElement; /** [Method] Convenience method for setVisibilityMode Element DISPLAY * @param display String What to set display to when visible + * @returns Ext.dom.Element this */ enableDisplayMode?( display?:string ): Ext.dom.IElement; /** [Method] Fade an element in from transparent to opaque * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ fadeIn?( options?:any ): Ext.IElement; /** [Method] Fade an element out from opaque to transparent * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ fadeOut?( options?:any ): Ext.IElement; /** [Method] Tries to focus the element * @param defer Number Milliseconds to defer the focus + * @returns Ext.dom.Element this */ focus?( defer?:number ): Ext.dom.IElement; - /** [Method] Alias for isFocusable */ + /** [Method] Alias for isFocusable + * @returns Boolean True if the element is focusable + */ focusable?(): boolean; /** [Method] Shows a ripple of exploding attenuating borders to draw attention to an Element * @param color String The hex color value for the border. * @param count Number The number of ripples to display. * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ frame?( color?:string, count?:number, options?:any ): Ext.dom.IElement; /** [Method] Returns the value of a namespaced attribute from the element s underlying DOM node * @param namespace String The namespace in which to look for the attribute * @param name String The attribute name + * @returns String The attribute value */ getAttributeNS?( namespace?:string, name?:string ): string; /** [Method] Gets the bottom Y coordinate of the element element Y position element height Defined in override Ext dom Elemen * @param local Boolean True to get the local css position instead of page coordinate + * @returns Number */ getBottom?( local?:boolean ): number; - /** [Method] Calculates the x y to center this element on the screen Defined in override Ext dom Element_position */ + /** [Method] Calculates the x y to center this element on the screen Defined in override Ext dom Element_position + * @returns Number[] The x, y values [x, y] + */ getCenterXY?(): number[]; /** [Method] Return the CSS color for the specified CSS attribute * @param attr String The css attribute @@ -12855,74 +13453,110 @@ declare module Ext.dom { * @param prefix String defaults to #. Use an empty string when working with color anims. */ getColor?( attr?:string, defaultValue?:string, prefix?:string ): void; - /** [Method] Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders when */ + /** [Method] Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders when + * @returns Number + */ getComputedHeight?(): number; - /** [Method] Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders when ne */ + /** [Method] Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders when ne + * @returns Number + */ getComputedWidth?(): number; /** [Method] Returns the sum width of the padding and borders for the passed sides * @param sides String + * @returns Number */ getFrameWidth?( sides?:string ): number; /** [Method] Gets the left X coordinate Defined in override Ext dom Element_position * @param local Boolean True to get the local css position instead of page coordinate + * @returns Number */ getLeft?( local?:boolean ): number; - /** [Method] Gets this element s ElementLoader */ + /** [Method] Gets this element s ElementLoader + * @returns Ext.ElementLoader The loader + */ getLoader?(): Ext.IElementLoader; - /** [Method] Gets the local CSS X position for the element Defined in override Ext dom Element_position */ + /** [Method] Gets the local CSS X position for the element Defined in override Ext dom Element_position + * @returns Number + */ getLocalX?(): number; - /** [Method] Gets the local CSS X and Y position for the element Defined in override Ext dom Element_position */ + /** [Method] Gets the local CSS X and Y position for the element Defined in override Ext dom Element_position + * @returns Array [x, y] + */ getLocalXY?(): any[]; - /** [Method] Gets the local CSS Y position for the element Defined in override Ext dom Element_position */ + /** [Method] Gets the local CSS Y position for the element Defined in override Ext dom Element_position + * @returns Number + */ getLocalY?(): number; /** [Method] Returns an object defining the area of this Element which can be passed to Ext util Positionable setBox to set anothe * @param asRegion Boolean If true an Ext.util.Region will be returned + * @returns Object/Ext.util.Region box An object in the following format: { left: <Element's X position>, top: <Element's Y position>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. So the result may also be used for setXY */ getPageBox?( asRegion?:boolean ): any; /** [Method] Gets an object with all CSS positioning properties * @param autoPx Boolean true to return pixel values for "auto" styles. + * @returns Object */ getPositioning?( autoPx?:boolean ): any; /** [Method] Gets the right X coordinate of the element element X position element width Defined in override Ext dom Element_ * @param local Boolean True to get the local css position instead of page coordinates + * @returns Number */ getRight?( local?:boolean ): number; - /** [Method] Returns the current scroll position of the element */ + /** [Method] Returns the current scroll position of the element + * @returns Object An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)} + */ getScroll?(): any; - /** [Method] Gets the left scroll position Defined in override Ext dom Element_scroll */ + /** [Method] Gets the left scroll position Defined in override Ext dom Element_scroll + * @returns Number The left scroll position + */ getScrollLeft?(): number; - /** [Method] Gets the top scroll position Defined in override Ext dom Element_scroll */ + /** [Method] Gets the top scroll position Defined in override Ext dom Element_scroll + * @returns Number The top scroll position + */ getScrollTop?(): number; - /** [Method] Returns the dimensions of the element available to lay content out in */ + /** [Method] Returns the dimensions of the element available to lay content out in + * @returns Object Object describing width and height. + */ getStyleSize?(): any; /** [Method] Returns the width in pixels of the passed text or the width of the text in this Element * @param text String The text to measure. Defaults to the innerHTML of the element. * @param min Number The minumum value to return. * @param max Number The maximum value to return. + * @returns Number The text width in pixels. */ getTextWidth?( text?:string, min?:number, max?:number ): number; /** [Method] Gets the top Y coordinate Defined in override Ext dom Element_position * @param local Boolean True to get the local css position instead of page coordinates + * @returns Number */ getTop?( local?:boolean ): number; - /** [Method] Gets element X position in page coordinates Defined in override Ext dom Element_position */ + /** [Method] Gets element X position in page coordinates Defined in override Ext dom Element_position + * @returns Number + */ getX?(): number; - /** [Method] Gets element X and Y positions in page coordinates Defined in override Ext dom Element_position */ + /** [Method] Gets element X and Y positions in page coordinates Defined in override Ext dom Element_position + * @returns Array [x, y] + */ getXY?(): any[]; - /** [Method] Gets element Y position in page coordinates Defined in override Ext dom Element_position */ + /** [Method] Gets element Y position in page coordinates Defined in override Ext dom Element_position + * @returns Number + */ getY?(): number; /** [Method] Slides the element while fading it out of view * @param anchor String One of the valid Ext.fx.Anim anchor positions (defaults to bottom: 'b') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ ghost?( anchor?:string, options?:any ): Ext.dom.IElement; /** [Method] Hide this element Uses display mode to determine whether to use display or visibility * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.dom.Element this */ hide?( animate?:any ): Ext.dom.IElement; /** [Method] Highlights the Element by setting a color applies to the background color by default but can be changed using the * @param color String The highlight color. Should be a 6 char hex color without the leading # (defaults to yellow: 'ffff9c') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ highlight?( color?:string, options?:any ): Ext.dom.IElement; /** [Method] Sets up event handlers to call the passed functions when the mouse is moved into and out of the Element @@ -12930,61 +13564,79 @@ declare module Ext.dom { * @param outFn Function The function to call when the mouse leaves the Element. * @param scope Object The scope (this reference) in which the functions are executed. Defaults to the Element's DOM element. * @param options Object Options for the listener. See the options parameter. + * @returns Ext.dom.Element this */ hover?( overFn?:any, outFn?:any, scope?:any, options?:any ): Ext.dom.IElement; /** [Method] Initializes a Ext dd DD drag drop object for this element * @param group String The group the DD object is member of * @param config Object The DD config object * @param overrides Object An object containing methods to override/implement on the DD object + * @returns Ext.dd.DD The DD object */ initDD?( group?:string, config?:any, overrides?:any ): Ext.dd.IDD; /** [Method] Initializes a Ext dd DDProxy object for this element * @param group String The group the DDProxy object is member of * @param config Object The DDProxy config object * @param overrides Object An object containing methods to override/implement on the DDProxy object + * @returns Ext.dd.DDProxy The DDProxy object */ initDDProxy?( group?:string, config?:any, overrides?:any ): Ext.dd.IDDProxy; /** [Method] Initializes a Ext dd DDTarget object for this element * @param group String The group the DDTarget object is member of * @param config Object The DDTarget config object * @param overrides Object An object containing methods to override/implement on the DDTarget object + * @returns Ext.dd.DDTarget The DDTarget object */ initDDTarget?( group?:string, config?:any, overrides?:any ): Ext.dd.IDDTarget; - /** [Method] Tests various css rules browsers to determine if this element uses a border box */ + /** [Method] Tests various css rules browsers to determine if this element uses a border box + * @returns Boolean + */ isBorderBox?(): boolean; - /** [Method] Returns true if display is not none */ + /** [Method] Returns true if display is not none + * @returns Boolean + */ isDisplayed?(): boolean; /** [Method] Checks whether this element can be focused * @param asFocusEl Object + * @returns Boolean True if the element is focusable */ isFocusable?( asFocusEl?:any ): boolean; - /** [Method] Returns true if this element is masked */ + /** [Method] Returns true if this element is masked + * @returns Boolean + */ isMasked?(): boolean; - /** [Method] Returns true if this element is scrollable */ + /** [Method] Returns true if this element is scrollable + * @returns Boolean + */ isScrollable?(): boolean; /** [Method] Checks whether the element is currently visible using both visibility and display properties * @param deep Boolean True to walk the dom and see if parent elements are hidden. If false, the function only checks the visibility of the element itself and it may return true even though a parent is not visible. + * @returns Boolean true if the element is currently visible, else false */ isVisible?( deep?:boolean ): boolean; /** [Method] Direct access to the Ext ElementLoader Ext ElementLoader load method * @param options Object + * @returns Ext.dom.Element this */ load?( options?:any ): Ext.dom.IElement; /** [Method] Puts a mask over this element to disable user interaction * @param msg String A message to display in the mask * @param msgCls String A css class to apply to the msg element + * @returns Ext.dom.Element The mask element */ mask?( msg?:string, msgCls?:string ): Ext.dom.IElement; /** [Method] Monitors this Element for the mouse leaving * @param delay Number The delay in milliseconds to wait for possible mouse re-entry before calling the handler function. * @param handler Function The function to call if the mouse remains outside of this Element for the specified time. * @param scope Object The scope (this reference) in which the handler function executes. Defaults to this Element. + * @returns Object The listeners object which was added to this element so that monitoring can be stopped. Example usage: // Hide the menu if the mouse moves out for 250ms or more this.mouseLeaveMonitor = this.menuEl.monitorMouseLeave(250, this.hideMenu, this); ... // Remove mouseleave monitor on menu destroy this.menuEl.un(this.mouseLeaveMonitor); */ monitorMouseLeave?( delay?:number, handler?:any, scope?:any ): any; /** [Method] Sets the position of the element in page coordinates * @param x Number X value for new position (coordinates are page-based) * @param y Number Y value for new position (coordinates are page-based) * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ moveTo?( x?:number, y?:number, animate?:any ): Ext.dom.IElement; /** [Method] Returns true if this element needs an explicit tabIndex to make it focusable */ @@ -12994,10 +13646,12 @@ declare module Ext.dom { * @param fn Function The handler function the event invokes. This function is passed the following parameters: evt : EventObject The EventObject describing the event. el : HtmlElement The DOM element which was the target of the event. Note that this may be filtered by using the delegate option. o : Object The options object from the call that setup the listener. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. * @param options Object An object containing handler configuration properties. This may contain any of the following properties: scope Object : The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. delegate String: A simple selector to filter the target or look for a descendant of the target. See below for additional details. stopEvent Boolean: True to stop the event. That is stop propagation, and prevent the default action. preventDefault Boolean: True to prevent the default action stopPropagation Boolean: True to prevent event propagation normalized Boolean: False to pass a browser event to the handler function instead of an Ext.EventObject target Ext.dom.Element: Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a child node. delay Number: The number of milliseconds to delay the invocation of the handler after the 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. Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the options object. The options object is available as the third parameter in the handler function. Code: el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, 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. Code: el.on({ 'click' : { fn: this.onClick, scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver, scope: this }, 'mouseout' : { fn: this.onMouseOut, scope: this } }); Or a shorthand syntax: Code: el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut, scope: this }); delegate This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. Event delegation is a technique that is used to reduce memory consumption and prevent exposure to memory-leaks. By registering an event for a container element as opposed to each element within a container. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example: // using this markup: <div id='elId'> <p id='p1'>paragraph one</p> <p id='p2' class='clickable'>paragraph two</p> <p id='p3'>paragraph three</p> </div> // utilize event delegation to registering just one handler on the container element: el = Ext.get('elId'); el.on( 'click', function(e,t) { // handle click console.info(t.id); // 'p2' }, this, { // filter the target element to be a descendant with the class 'clickable' delegate: '.clickable' } ); + * @returns Ext.dom.Element this */ on?( eventName?:string, fn?:any, scope?:any, options?:any ): Ext.dom.IElement; /** [Method] Creates a pause before any subsequent queued effects begin * @param seconds Number The length of time to pause (in seconds) + * @returns Ext.Element The Element */ pause?( seconds?:number ): Ext.IElement; /** [Method] Initializes positioning on this element @@ -13009,39 +13663,48 @@ declare module Ext.dom { position?( pos?:string, zIndex?:number, x?:number, y?:number ): void; /** [Method] Fades the element out while slowly expanding it in all directions * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ puff?( options?:any ): Ext.dom.IElement; - /** [Method] Recursively removes all previous added listeners from this element and its children */ + /** [Method] Recursively removes all previous added listeners from this element and its children + * @returns Ext.dom.Element this + */ purgeAllListeners?(): Ext.dom.IElement; /** [Method] Create an event handler on this element such that when the event fires and is handled by this element it will be rel * @param eventName String The type of event to relay * @param observable Object Any object that extends Ext.util.Observable that will provide the context for firing the relayed event */ relayEvent?( eventName?:string, observable?:any ): void; - /** [Method] Removes all previous added listeners from this element */ + /** [Method] Removes all previous added listeners from this element + * @returns Ext.dom.Element this + */ removeAllListeners?(): Ext.dom.IElement; /** [Method] Shorthand for un * @param eventName String The name of the event from which to remove the handler. * @param fn Function The handler function to remove. This must be a reference to the function passed into the on call. * @param scope Object If a scope (this reference) was specified when the listener was added, then this must refer to the same object. + * @returns Ext.dom.Element this */ removeListener?( eventName?:string, fn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Animates the transition of an element s dimensions from a starting height width to an ending height width * @param width Number The new width (pass undefined to keep the original width) * @param height Number The new height (pass undefined to keep the original height) * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ scale?( width?:number, height?:number, options?:any ): Ext.IElement; /** [Method] Scrolls this element the specified direction * @param direction String Possible values are: "l" (or "left") "r" (or "right") "t" (or "top", or "up") "b" (or "bottom", or "down") * @param distance Number How far to scroll the element in pixels * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Boolean Returns true if a scroll was triggered or false if the element was scrolled as far as it could go. */ scroll?( direction?:string, distance?:number, animate?:any ): boolean; /** [Method] Scrolls this element by the passed delta values optionally animating * @param deltaX Number/Number[]/Object Either the x delta, an Array specifying x and y deltas or an object with "x" and "y" properties. * @param deltaY Number/Boolean/Object Either the y delta, or an animate flag or config object. * @param animate Boolean/Object Animate flag/config object if the delta values were passed separately. + * @returns Ext.Element this */ scrollBy?( deltaX?:any, deltaY?:any, animate?:any ): Ext.IElement; /** [Method] Scrolls this element into view within the passed container @@ -13049,147 +13712,154 @@ declare module Ext.dom { * @param hscroll Boolean False to disable horizontal scroll. * @param animate Boolean/Object true for the default animation or a standard Element * @param highlight Boolean true to highlight the element when it is in view. animation config object + * @returns Ext.dom.Element this */ - scrollIntoView?( container?:any, hscroll?:any, animate?:any, highlight?:any ): any; - scrollIntoView?( container?:string, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; - scrollIntoView?( container?:HTMLElement, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; - scrollIntoView?( container?:Ext.IElement, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; + scrollIntoView?( container?:any, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; /** [Method] Scrolls this element the specified scroll point * @param side String Either "left" for scrollLeft values or "top" for scrollTop values. * @param value Number The new scroll value * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.Element this */ scrollTo?( side?:string, value?:number, animate?:any ): Ext.IElement; - /** [Method] Enable text selection for this element normalized across browsers Defined in override Ext dom Element_style */ + /** [Method] Enable text selection for this element normalized across browsers Defined in override Ext dom Element_style + * @returns Ext.Element this + */ selectable?(): Ext.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom Number/String Number of pixels or CSS string value to set as the bottom CSS property value + * @returns Ext.dom.Element this */ - setBottom?( bottom?:any ): any; - setBottom?( bottom?:number ): Ext.dom.IElement; - setBottom?( bottom?:string ): Ext.dom.IElement; + setBottom?( bottom?:any ): Ext.dom.IElement; /** [Method] Sets the element s position and size in one shot * @param x Number X value for new position (coordinates are page-based) * @param y Number Y value for new position (coordinates are page-based) * @param width Number/String The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels) A String used to set the CSS width style. Animation may not be used. * @param height Number/String The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels) A String used to set the CSS height style. Animation may not be used. * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.dom.Element this */ - setBounds?( x?:any, y?:any, width?:any, height?:any, animate?:any ): any; - setBounds?( x?:number, y?:number, width?:number, height?:number, animate?:any ): Ext.dom.IElement; - setBounds?( x?:number, y?:number, width?:string, height?:number, animate?:any ): Ext.dom.IElement; - setBounds?( x?:number, y?:number, width?:number, height?:string, animate?:any ): Ext.dom.IElement; - setBounds?( x?:number, y?:number, width?:string, height?:string, animate?:any ): Ext.dom.IElement; + setBounds?( x?:number, y?:number, width?:any, height?:any, animate?:any ): Ext.dom.IElement; /** [Method] Sets the CSS display property * @param value Boolean/String Boolean value to display the element using its default display, or a string to set the display directly. + * @returns Ext.dom.Element this */ - setDisplayed?( value?:any ): any; - setDisplayed?( value?:boolean ): Ext.dom.IElement; - setDisplayed?( value?:string ): Ext.dom.IElement; + setDisplayed?( value?:any ): Ext.dom.IElement; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left Number/String Number of pixels or CSS string value to set as the left CSS property value + * @returns Ext.dom.Element this */ - setLeft?( left?:any ): any; - setLeft?( left?:number ): Ext.dom.IElement; - setLeft?( left?:string ): Ext.dom.IElement; + setLeft?( left?:any ): Ext.dom.IElement; /** [Method] Sets the element s left and top positions directly using CSS style Defined in override Ext dom Element_position * @param left Number/String Number of pixels or CSS string value to set as the left CSS property value * @param top Number/String Number of pixels or CSS string value to set as the top CSS property value + * @returns Ext.dom.Element this */ - setLeftTop?( left?:any, top?:any ): any; - setLeftTop?( left?:number, top?:number ): Ext.dom.IElement; - setLeftTop?( left?:string, top?:number ): Ext.dom.IElement; - setLeftTop?( left?:number, top?:string ): Ext.dom.IElement; - setLeftTop?( left?:string, top?:string ): Ext.dom.IElement; + setLeftTop?( left?:any, top?:any ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates * @param x Number X value for new position * @param y Number Y value for new position * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ setLocation?( x?:number, y?:number, animate?:any ): Ext.dom.IElement; /** [Method] Set the opacity of the element Defined in override Ext dom Element_style * @param opacity Number The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc * @param animate Boolean/Object a standard Element animation config object or true for the default animation ({duration: 350, easing: 'easeIn'}) + * @returns Ext.dom.Element this */ setOpacity?( opacity?:number, animate?:any ): Ext.dom.IElement; /** [Method] Set positioning with an object returned by getPositioning * @param posCfg Object + * @returns Ext.dom.Element this */ setPositioning?( posCfg?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right Number/String Number of pixels or CSS string value to set as the right CSS property value + * @returns Ext.dom.Element this */ - setRight?( right?:any ): any; - setRight?( right?:number ): Ext.dom.IElement; - setRight?( right?:string ): Ext.dom.IElement; + setRight?( right?:any ): Ext.dom.IElement; /** [Method] Sets the left scroll position Defined in override Ext dom Element_scroll * @param left Number The left scroll position + * @returns Ext.dom.Element this */ setScrollLeft?( left?:number ): Ext.dom.IElement; /** [Method] Sets the top scroll position Defined in override Ext dom Element_scroll * @param top Number The top scroll position + * @returns Ext.dom.Element this */ setScrollTop?( top?:number ): Ext.dom.IElement; /** [Method] Sets the element s top position directly using CSS style instead of setY * @param top Number/String Number of pixels or CSS string value to set as the top CSS property value + * @returns Ext.dom.Element this */ - setTop?( top?:any ): any; - setTop?( top?:number ): Ext.dom.IElement; - setTop?( top?:string ): Ext.dom.IElement; + setTop?( top?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ setVisible?( visible?:boolean, animate?:any ): Ext.dom.IElement; /** [Method] Animates the transition of any combination of an element s dimensions xy position and or opacity * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ shift?( options?:any ): Ext.IElement; /** [Method] Show this element Uses display mode to determine whether to use display or visibility * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.dom.Element this */ show?( animate?:any ): Ext.dom.IElement; /** [Method] Slides the element into view * @param anchor String One of the valid Ext.fx.Anim anchor positions (defaults to top: 't') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ slideIn?( anchor?:string, options?:any ): Ext.dom.IElement; /** [Method] Slides the element out of view * @param anchor String One of the valid Ext.fx.Anim anchor positions (defaults to top: 't') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ slideOut?( anchor?:string, options?:any ): Ext.dom.IElement; /** [Method] Stops the specified event s from bubbling and optionally prevents the default action * @param eventName String/String[] an event / array of events to stop from bubbling * @param preventDefault Boolean true to prevent the default action too + * @returns Ext.dom.Element this */ - swallowEvent?( eventName?:any, preventDefault?:any ): any; - swallowEvent?( eventName?:string, preventDefault?:boolean ): Ext.dom.IElement; - swallowEvent?( eventName?:string[], preventDefault?:boolean ): Ext.dom.IElement; + swallowEvent?( eventName?:any, preventDefault?:boolean ): Ext.dom.IElement; /** [Method] Blinks the element as if it was clicked and then collapses on its center similar to switching off a television * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ switchOff?( options?:any ): Ext.dom.IElement; /** [Method] Toggles the element s visibility or display depending on visibility mode * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ toggle?( animate?:any ): Ext.dom.IElement; /** [Method] Removes an event handler from this element * @param eventName String The name of the event from which to remove the handler. * @param fn Function The handler function to remove. This must be a reference to the function passed into the on call. * @param scope Object If a scope (this reference) was specified when the listener was added, then this must refer to the same object. + * @returns Ext.dom.Element this */ un?( eventName?:string, fn?:any, scope?:any ): Ext.dom.IElement; - /** [Method] Return clipping overflow to original clipping before clip was called Defined in override Ext dom Element_style */ + /** [Method] Return clipping overflow to original clipping before clip was called Defined in override Ext dom Element_style + * @returns Ext.dom.Element this + */ unclip?(): Ext.dom.IElement; /** [Method] Hides a previously applied mask */ unmask?(): void; - /** [Method] Disables text selection for this element normalized across browsers Defined in override Ext dom Element_style */ + /** [Method] Disables text selection for this element normalized across browsers Defined in override Ext dom Element_style + * @returns Ext.dom.Element this + */ unselectable?(): Ext.dom.IElement; /** [Method] Updates the innerHTML of this element optionally searching for and processing scripts * @param html String The new HTML * @param loadScripts Boolean True to look for and process scripts (defaults to false) * @param callback Function For async script loading you can be notified when the update completes + * @returns Ext.dom.Element this */ update?( html?:string, loadScripts?:boolean, callback?:any ): Ext.dom.IElement; } @@ -13200,9 +13870,12 @@ declare module Ext.dom { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -13212,81 +13885,87 @@ declare module Ext.dom { /** [Method] Returns the top Element that is located at the passed coordinates Defined in override Ext dom AbstractElement_static * @param x Number The x coordinate * @param y Number The y coordinate + * @returns String The found Element */ static fromPoint( x?:number, y?:number ): string; /** [Method] Retrieves Ext dom Element objects * @param el String/HTMLElement/Ext.Element The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element The Element object (or null if no matching element was found) + */ + static get( el?:any ): Ext.dom.IElement; + /** [Method] Retrieves the document height Defined in override Ext dom AbstractElement_static + * @returns Number documentHeight */ - static get( el?:any ): any; - static get( el?:string ): Ext.dom.IElement; - static get( el?:HTMLElement ): Ext.dom.IElement; - static get( el?:Ext.IElement ): Ext.dom.IElement; - /** [Method] Retrieves the document height Defined in override Ext dom AbstractElement_static */ static getDocumentHeight(): number; - /** [Method] Retrieves the document width Defined in override Ext dom AbstractElement_static */ + /** [Method] Retrieves the document width Defined in override Ext dom AbstractElement_static + * @returns Number documentWidth + */ static getDocumentWidth(): number; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; - /** [Method] Retrieves the current orientation of the window */ + /** [Method] Retrieves the current orientation of the window + * @returns String Orientation of window: 'portrait' or 'landscape' + */ static getOrientation(): string; - /** [Method] Retrieves the viewport size of the window */ + /** [Method] Retrieves the viewport size of the window + * @returns Object object containing width and height properties + */ static getViewSize(): any; - /** [Method] Retrieves the viewport height of the window */ + /** [Method] Retrieves the viewport height of the window + * @returns Number viewportHeight + */ static getViewportHeight(): number; - /** [Method] Retrieves the viewport width of the window */ + /** [Method] Retrieves the viewport width of the window + * @returns Number viewportWidth + */ static getViewportWidth(): number; /** [Method] Adds members to class */ static implement(): void; /** [Method] Returns an array of unique class names based upon the input strings or string arrays * @param clsList1 Mixed A string of class names, or an array of class names. * @param clsList2 Mixed A string of class names, or an array of class names. + * @returns Array An array of strings representing remaining unique, merged class names. If class names were added to the first list, the changed property will be true. */ static mergeClsList( clsList1?:any, clsList2?:any ): any[]; /** [Method] Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax * @param prop String The property to normalize + * @returns String The normalized string */ static normalize( prop?:string ): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String The encoded margins + * @returns Object An object with margin sizes for top, right, bottom and left */ static parseBox( box?:any ): any; - static parseBox( box?:number ): any; - static parseBox( box?:string ): any; /** [Method] Converts a CSS string into an object with a property for each style * @param styles String A CSS string + * @returns Object styles */ static parseStyles( styles?:string ): any; /** [Method] Returns an array of unique class names deom the first parameter with all class names from the second parameter removed * @param existingClsList Mixed A string of class names, or an array of class names. * @param removeClsList Mixed A string of class names, or an array of class names to remove from existingClsList. + * @returns Array An array of strings representing remaining class names. If class names were removed, the changed property will be true. */ static removeCls( existingClsList?:any, removeClsList?:any ): any[]; /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in * @param selector String/HTMLElement[] The CSS selector or an array of elements * @param unique Boolean true to create a unique Ext.Element for each element (defaults to a shared flyweight object) * @param root HTMLElement/String The root element of the query or id of the root + * @returns Ext.CompositeElementLite/Ext.CompositeElement */ - static select( selector?:any, unique?:any, root?:any ): any; - static select( selector?:string, unique?:boolean, root?:HTMLElement ): Ext.ICompositeElementLite; - static select( selector?:HTMLElement[], unique?:boolean, root?:HTMLElement ): Ext.ICompositeElementLite; - static select( selector?:string, unique?:boolean, root?:string ): Ext.ICompositeElementLite; - static select( selector?:HTMLElement[], unique?:boolean, root?:string ): Ext.ICompositeElementLite; - /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in - * @param selector String/HTMLElement[] The CSS selector or an array of elements - * @param unique Boolean true to create a unique Ext.Element for each element (defaults to a shared flyweight object) - * @param root HTMLElement/String The root element of the query or id of the root - */ - static select( selector?:string, unique?:boolean, root?:HTMLElement ): Ext.ICompositeElement; - static select( selector?:HTMLElement[], unique?:boolean, root?:HTMLElement ): Ext.ICompositeElement; - static select( selector?:string, unique?:boolean, root?:string ): Ext.ICompositeElement; - static select( selector?:HTMLElement[], unique?:boolean, root?:string ): Ext.ICompositeElement; + static select( selector?:any, unique?:boolean, root?:any ): any; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String/Object The encoded margins, or an object with top, right, bottom, and left properties * @param units String The type of units to add + * @returns String An string with unitized (px if units is not specified) metrics for top, right, bottom and left */ static unitizeBox( box?:any, units?:string ): string; } @@ -13301,28 +13980,33 @@ declare module Ext { * @param className String The class to add * @param testFn Function A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added. * @param scope Object The scope to execute the testFn in. + * @returns Ext.dom.Element this */ addClsOnClick?( className?:string, testFn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Sets up event handlers to add and remove a css class when this element has the focus Defined in override Ext dom Ele * @param className String The class to add * @param testFn Function A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added. * @param scope Object The scope to execute the testFn in. + * @returns Ext.dom.Element this */ addClsOnFocus?( className?:string, testFn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Sets up event handlers to add and remove a css class when the mouse is over this element Defined in override Ext dom * @param className String The class to add * @param testFn Function A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added. * @param scope Object The scope to execute the testFn in. + * @returns Ext.dom.Element this */ addClsOnOver?( className?:string, testFn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Convenience method for constructing a KeyMap * @param key String/Number/Number[]/Object Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options: * @param fn Function The function to call * @param scope Object The scope (this reference) in which the specified function is executed. Defaults to this Element. + * @returns Ext.util.KeyMap The KeyMap created */ addKeyListener?( key?:any, fn?:any, scope?:any ): Ext.util.IKeyMap; /** [Method] Creates a KeyMap for this element * @param config Object The KeyMap config. See Ext.util.KeyMap for more details + * @returns Ext.util.KeyMap The KeyMap created */ addKeyMap?( config?:any ): Ext.util.IKeyMap; /** [Method] Shorthand for on @@ -13330,85 +14014,108 @@ declare module Ext { * @param fn Function The handler function the event invokes. This function is passed the following parameters: evt : EventObject The EventObject describing the event. el : HtmlElement The DOM element which was the target of the event. Note that this may be filtered by using the delegate option. o : Object The options object from the call that setup the listener. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. * @param options Object An object containing handler configuration properties. This may contain any of the following properties: scope Object : The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. delegate String: A simple selector to filter the target or look for a descendant of the target. See below for additional details. stopEvent Boolean: True to stop the event. That is stop propagation, and prevent the default action. preventDefault Boolean: True to prevent the default action stopPropagation Boolean: True to prevent event propagation normalized Boolean: False to pass a browser event to the handler function instead of an Ext.EventObject target Ext.dom.Element: Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a child node. delay Number: The number of milliseconds to delay the invocation of the handler after the 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. Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the options object. The options object is available as the third parameter in the handler function. Code: el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, 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. Code: el.on({ 'click' : { fn: this.onClick, scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver, scope: this }, 'mouseout' : { fn: this.onMouseOut, scope: this } }); Or a shorthand syntax: Code: el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut, scope: this }); delegate This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. Event delegation is a technique that is used to reduce memory consumption and prevent exposure to memory-leaks. By registering an event for a container element as opposed to each element within a container. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example: // using this markup: <div id='elId'> <p id='p1'>paragraph one</p> <p id='p2' class='clickable'>paragraph two</p> <p id='p3'>paragraph three</p> </div> // utilize event delegation to registering just one handler on the container element: el = Ext.get('elId'); el.on( 'click', function(e,t) { // handle click console.info(t.id); // 'p2' }, this, { // filter the target element to be a descendant with the class 'clickable' delegate: '.clickable' } ); + * @returns Ext.dom.Element this */ addListener?( eventName?:string, fn?:any, scope?:any, options?:any ): Ext.dom.IElement; /** [Method] Performs custom animation on this Element * @param config Object Configuration for Ext.fx.Anim. Note that the to config is required. + * @returns Ext.dom.Element this */ animate?( config?:any ): Ext.dom.IElement; - /** [Method] Tries to blur the element */ + /** [Method] Tries to blur the element + * @returns Ext.dom.Element this + */ blur?(): Ext.dom.IElement; /** [Method] Wraps the specified element with a special 9 element markup CSS block that renders by default as a gray container wit * @param class String A base CSS class to apply to the containing wrapper element. Note that there are a number of CSS rules that are dependent on this name to make the overall effect work, so if you supply an alternate base class, make sure you also supply all of the necessary rules. + * @returns Ext.dom.Element The outermost wrapping element of the created box structure. */ boxWrap?( clazz?:string ): Ext.dom.IElement; - /** [Method] When an element is moved around in the DOM or is hidden using display none it loses layout and therefore all scrol */ + /** [Method] When an element is moved around in the DOM or is hidden using display none it loses layout and therefore all scrol + * @returns Function A function which will restore all descentant elements of this Element to their scroll positions recorded when this function was executed. Be aware that the returned function is a closure which has captured the scope of cacheScrollValues, so take care to derefence it as soon as not needed - if is it is a var it will drop out of scope, and the reference will be freed. + */ cacheScrollValues?(): any; /** [Method] Centers the Element in either the viewport or another Element * @param centerIn String/HTMLElement/Ext.dom.Element element in which to center the element. */ - center?( centerIn?:any ): any; - center?( centerIn?:string ): void; - center?( centerIn?:HTMLElement ): void; - center?( centerIn?:Ext.dom.IElement ): void; + center?( centerIn?:any ): void; /** [Method] Removes Empty or whitespace filled text nodes * @param forceReclean Boolean By default the element keeps track if it has been cleaned already so you can call this over and over. However, if you update the element and need to force a reclean, you can pass true. */ clean?( forceReclean?:boolean ): void; - /** [Method] Alias for removeAllListeners */ + /** [Method] Alias for removeAllListeners + * @returns Ext.dom.Element this + */ clearListeners?(): Ext.dom.IElement; - /** [Method] Clears any opacity settings from this element */ + /** [Method] Clears any opacity settings from this element + * @returns Ext.dom.Element this + */ clearOpacity?(): Ext.dom.IElement; /** [Method] Clears positioning back to the default when the document was loaded * @param value String The value to use for the left, right, top, bottom. You could use 'auto'. + * @returns Ext.dom.Element this */ clearPositioning?( value?:string ): Ext.dom.IElement; - /** [Method] Store the current overflow setting and clip overflow on the element use unclip to remove Defined in override Ext d */ + /** [Method] Store the current overflow setting and clip overflow on the element use unclip to remove Defined in override Ext d + * @returns Ext.dom.Element this + */ clip?(): Ext.dom.IElement; /** [Method] Creates a proxy element of this element * @param config String/Object The class name of the proxy element or a DomHelper config object * @param renderTo String/HTMLElement The element or element id to render the proxy to. Defaults to: document.body. * @param matchBox Boolean True to align and size the proxy to this element now. + * @returns Ext.dom.Element The new proxy element + */ + createProxy?( config?:any, renderTo?:any, matchBox?:boolean ): Ext.dom.IElement; + /** [Method] Creates an iframe shim for this element to keep selects and other windowed objects from showing through + * @returns Ext.dom.Element The new shim element */ - createProxy?( config?:any, renderTo?:any, matchBox?:any ): any; - createProxy?( config?:any, renderTo?:string, matchBox?:boolean ): Ext.dom.IElement; - createProxy?( config?:any, renderTo?:HTMLElement, matchBox?:boolean ): Ext.dom.IElement; - /** [Method] Creates an iframe shim for this element to keep selects and other windowed objects from showing through */ createShim?(): Ext.dom.IElement; /** [Method] Convenience method for setVisibilityMode Element DISPLAY * @param display String What to set display to when visible + * @returns Ext.dom.Element this */ enableDisplayMode?( display?:string ): Ext.dom.IElement; /** [Method] Fade an element in from transparent to opaque * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ fadeIn?( options?:any ): Ext.IElement; /** [Method] Fade an element out from opaque to transparent * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ fadeOut?( options?:any ): Ext.IElement; /** [Method] Tries to focus the element * @param defer Number Milliseconds to defer the focus + * @returns Ext.dom.Element this */ focus?( defer?:number ): Ext.dom.IElement; - /** [Method] Alias for isFocusable */ + /** [Method] Alias for isFocusable + * @returns Boolean True if the element is focusable + */ focusable?(): boolean; /** [Method] Shows a ripple of exploding attenuating borders to draw attention to an Element * @param color String The hex color value for the border. * @param count Number The number of ripples to display. * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ frame?( color?:string, count?:number, options?:any ): Ext.dom.IElement; /** [Method] Returns the value of a namespaced attribute from the element s underlying DOM node * @param namespace String The namespace in which to look for the attribute * @param name String The attribute name + * @returns String The attribute value */ getAttributeNS?( namespace?:string, name?:string ): string; /** [Method] Gets the bottom Y coordinate of the element element Y position element height Defined in override Ext dom Elemen * @param local Boolean True to get the local css position instead of page coordinate + * @returns Number */ getBottom?( local?:boolean ): number; - /** [Method] Calculates the x y to center this element on the screen Defined in override Ext dom Element_position */ + /** [Method] Calculates the x y to center this element on the screen Defined in override Ext dom Element_position + * @returns Number[] The x, y values [x, y] + */ getCenterXY?(): number[]; /** [Method] Return the CSS color for the specified CSS attribute * @param attr String The css attribute @@ -13416,74 +14123,110 @@ declare module Ext { * @param prefix String defaults to #. Use an empty string when working with color anims. */ getColor?( attr?:string, defaultValue?:string, prefix?:string ): void; - /** [Method] Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders when */ + /** [Method] Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders when + * @returns Number + */ getComputedHeight?(): number; - /** [Method] Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders when ne */ + /** [Method] Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders when ne + * @returns Number + */ getComputedWidth?(): number; /** [Method] Returns the sum width of the padding and borders for the passed sides * @param sides String + * @returns Number */ getFrameWidth?( sides?:string ): number; /** [Method] Gets the left X coordinate Defined in override Ext dom Element_position * @param local Boolean True to get the local css position instead of page coordinate + * @returns Number */ getLeft?( local?:boolean ): number; - /** [Method] Gets this element s ElementLoader */ + /** [Method] Gets this element s ElementLoader + * @returns Ext.ElementLoader The loader + */ getLoader?(): Ext.IElementLoader; - /** [Method] Gets the local CSS X position for the element Defined in override Ext dom Element_position */ + /** [Method] Gets the local CSS X position for the element Defined in override Ext dom Element_position + * @returns Number + */ getLocalX?(): number; - /** [Method] Gets the local CSS X and Y position for the element Defined in override Ext dom Element_position */ + /** [Method] Gets the local CSS X and Y position for the element Defined in override Ext dom Element_position + * @returns Array [x, y] + */ getLocalXY?(): any[]; - /** [Method] Gets the local CSS Y position for the element Defined in override Ext dom Element_position */ + /** [Method] Gets the local CSS Y position for the element Defined in override Ext dom Element_position + * @returns Number + */ getLocalY?(): number; /** [Method] Returns an object defining the area of this Element which can be passed to Ext util Positionable setBox to set anothe * @param asRegion Boolean If true an Ext.util.Region will be returned + * @returns Object/Ext.util.Region box An object in the following format: { left: <Element's X position>, top: <Element's Y position>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. So the result may also be used for setXY */ getPageBox?( asRegion?:boolean ): any; /** [Method] Gets an object with all CSS positioning properties * @param autoPx Boolean true to return pixel values for "auto" styles. + * @returns Object */ getPositioning?( autoPx?:boolean ): any; /** [Method] Gets the right X coordinate of the element element X position element width Defined in override Ext dom Element_ * @param local Boolean True to get the local css position instead of page coordinates + * @returns Number */ getRight?( local?:boolean ): number; - /** [Method] Returns the current scroll position of the element */ + /** [Method] Returns the current scroll position of the element + * @returns Object An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)} + */ getScroll?(): any; - /** [Method] Gets the left scroll position Defined in override Ext dom Element_scroll */ + /** [Method] Gets the left scroll position Defined in override Ext dom Element_scroll + * @returns Number The left scroll position + */ getScrollLeft?(): number; - /** [Method] Gets the top scroll position Defined in override Ext dom Element_scroll */ + /** [Method] Gets the top scroll position Defined in override Ext dom Element_scroll + * @returns Number The top scroll position + */ getScrollTop?(): number; - /** [Method] Returns the dimensions of the element available to lay content out in */ + /** [Method] Returns the dimensions of the element available to lay content out in + * @returns Object Object describing width and height. + */ getStyleSize?(): any; /** [Method] Returns the width in pixels of the passed text or the width of the text in this Element * @param text String The text to measure. Defaults to the innerHTML of the element. * @param min Number The minumum value to return. * @param max Number The maximum value to return. + * @returns Number The text width in pixels. */ getTextWidth?( text?:string, min?:number, max?:number ): number; /** [Method] Gets the top Y coordinate Defined in override Ext dom Element_position * @param local Boolean True to get the local css position instead of page coordinates + * @returns Number */ getTop?( local?:boolean ): number; - /** [Method] Gets element X position in page coordinates Defined in override Ext dom Element_position */ + /** [Method] Gets element X position in page coordinates Defined in override Ext dom Element_position + * @returns Number + */ getX?(): number; - /** [Method] Gets element X and Y positions in page coordinates Defined in override Ext dom Element_position */ + /** [Method] Gets element X and Y positions in page coordinates Defined in override Ext dom Element_position + * @returns Array [x, y] + */ getXY?(): any[]; - /** [Method] Gets element Y position in page coordinates Defined in override Ext dom Element_position */ + /** [Method] Gets element Y position in page coordinates Defined in override Ext dom Element_position + * @returns Number + */ getY?(): number; /** [Method] Slides the element while fading it out of view * @param anchor String One of the valid Ext.fx.Anim anchor positions (defaults to bottom: 'b') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ ghost?( anchor?:string, options?:any ): Ext.dom.IElement; /** [Method] Hide this element Uses display mode to determine whether to use display or visibility * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.dom.Element this */ hide?( animate?:any ): Ext.dom.IElement; /** [Method] Highlights the Element by setting a color applies to the background color by default but can be changed using the * @param color String The highlight color. Should be a 6 char hex color without the leading # (defaults to yellow: 'ffff9c') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ highlight?( color?:string, options?:any ): Ext.dom.IElement; /** [Method] Sets up event handlers to call the passed functions when the mouse is moved into and out of the Element @@ -13491,61 +14234,79 @@ declare module Ext { * @param outFn Function The function to call when the mouse leaves the Element. * @param scope Object The scope (this reference) in which the functions are executed. Defaults to the Element's DOM element. * @param options Object Options for the listener. See the options parameter. + * @returns Ext.dom.Element this */ hover?( overFn?:any, outFn?:any, scope?:any, options?:any ): Ext.dom.IElement; /** [Method] Initializes a Ext dd DD drag drop object for this element * @param group String The group the DD object is member of * @param config Object The DD config object * @param overrides Object An object containing methods to override/implement on the DD object + * @returns Ext.dd.DD The DD object */ initDD?( group?:string, config?:any, overrides?:any ): Ext.dd.IDD; /** [Method] Initializes a Ext dd DDProxy object for this element * @param group String The group the DDProxy object is member of * @param config Object The DDProxy config object * @param overrides Object An object containing methods to override/implement on the DDProxy object + * @returns Ext.dd.DDProxy The DDProxy object */ initDDProxy?( group?:string, config?:any, overrides?:any ): Ext.dd.IDDProxy; /** [Method] Initializes a Ext dd DDTarget object for this element * @param group String The group the DDTarget object is member of * @param config Object The DDTarget config object * @param overrides Object An object containing methods to override/implement on the DDTarget object + * @returns Ext.dd.DDTarget The DDTarget object */ initDDTarget?( group?:string, config?:any, overrides?:any ): Ext.dd.IDDTarget; - /** [Method] Tests various css rules browsers to determine if this element uses a border box */ + /** [Method] Tests various css rules browsers to determine if this element uses a border box + * @returns Boolean + */ isBorderBox?(): boolean; - /** [Method] Returns true if display is not none */ + /** [Method] Returns true if display is not none + * @returns Boolean + */ isDisplayed?(): boolean; /** [Method] Checks whether this element can be focused * @param asFocusEl Object + * @returns Boolean True if the element is focusable */ isFocusable?( asFocusEl?:any ): boolean; - /** [Method] Returns true if this element is masked */ + /** [Method] Returns true if this element is masked + * @returns Boolean + */ isMasked?(): boolean; - /** [Method] Returns true if this element is scrollable */ + /** [Method] Returns true if this element is scrollable + * @returns Boolean + */ isScrollable?(): boolean; /** [Method] Checks whether the element is currently visible using both visibility and display properties * @param deep Boolean True to walk the dom and see if parent elements are hidden. If false, the function only checks the visibility of the element itself and it may return true even though a parent is not visible. + * @returns Boolean true if the element is currently visible, else false */ isVisible?( deep?:boolean ): boolean; /** [Method] Direct access to the Ext ElementLoader Ext ElementLoader load method * @param options Object + * @returns Ext.dom.Element this */ load?( options?:any ): Ext.dom.IElement; /** [Method] Puts a mask over this element to disable user interaction * @param msg String A message to display in the mask * @param msgCls String A css class to apply to the msg element + * @returns Ext.dom.Element The mask element */ mask?( msg?:string, msgCls?:string ): Ext.dom.IElement; /** [Method] Monitors this Element for the mouse leaving * @param delay Number The delay in milliseconds to wait for possible mouse re-entry before calling the handler function. * @param handler Function The function to call if the mouse remains outside of this Element for the specified time. * @param scope Object The scope (this reference) in which the handler function executes. Defaults to this Element. + * @returns Object The listeners object which was added to this element so that monitoring can be stopped. Example usage: // Hide the menu if the mouse moves out for 250ms or more this.mouseLeaveMonitor = this.menuEl.monitorMouseLeave(250, this.hideMenu, this); ... // Remove mouseleave monitor on menu destroy this.menuEl.un(this.mouseLeaveMonitor); */ monitorMouseLeave?( delay?:number, handler?:any, scope?:any ): any; /** [Method] Sets the position of the element in page coordinates * @param x Number X value for new position (coordinates are page-based) * @param y Number Y value for new position (coordinates are page-based) * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ moveTo?( x?:number, y?:number, animate?:any ): Ext.dom.IElement; /** [Method] Returns true if this element needs an explicit tabIndex to make it focusable */ @@ -13555,10 +14316,12 @@ declare module Ext { * @param fn Function The handler function the event invokes. This function is passed the following parameters: evt : EventObject The EventObject describing the event. el : HtmlElement The DOM element which was the target of the event. Note that this may be filtered by using the delegate option. o : Object The options object from the call that setup the listener. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. * @param options Object An object containing handler configuration properties. This may contain any of the following properties: scope Object : The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. delegate String: A simple selector to filter the target or look for a descendant of the target. See below for additional details. stopEvent Boolean: True to stop the event. That is stop propagation, and prevent the default action. preventDefault Boolean: True to prevent the default action stopPropagation Boolean: True to prevent event propagation normalized Boolean: False to pass a browser event to the handler function instead of an Ext.EventObject target Ext.dom.Element: Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a child node. delay Number: The number of milliseconds to delay the invocation of the handler after the 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. Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the options object. The options object is available as the third parameter in the handler function. Code: el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, 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. Code: el.on({ 'click' : { fn: this.onClick, scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver, scope: this }, 'mouseout' : { fn: this.onMouseOut, scope: this } }); Or a shorthand syntax: Code: el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut, scope: this }); delegate This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. Event delegation is a technique that is used to reduce memory consumption and prevent exposure to memory-leaks. By registering an event for a container element as opposed to each element within a container. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example: // using this markup: <div id='elId'> <p id='p1'>paragraph one</p> <p id='p2' class='clickable'>paragraph two</p> <p id='p3'>paragraph three</p> </div> // utilize event delegation to registering just one handler on the container element: el = Ext.get('elId'); el.on( 'click', function(e,t) { // handle click console.info(t.id); // 'p2' }, this, { // filter the target element to be a descendant with the class 'clickable' delegate: '.clickable' } ); + * @returns Ext.dom.Element this */ on?( eventName?:string, fn?:any, scope?:any, options?:any ): Ext.dom.IElement; /** [Method] Creates a pause before any subsequent queued effects begin * @param seconds Number The length of time to pause (in seconds) + * @returns Ext.Element The Element */ pause?( seconds?:number ): Ext.IElement; /** [Method] Initializes positioning on this element @@ -13570,39 +14333,48 @@ declare module Ext { position?( pos?:string, zIndex?:number, x?:number, y?:number ): void; /** [Method] Fades the element out while slowly expanding it in all directions * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ puff?( options?:any ): Ext.dom.IElement; - /** [Method] Recursively removes all previous added listeners from this element and its children */ + /** [Method] Recursively removes all previous added listeners from this element and its children + * @returns Ext.dom.Element this + */ purgeAllListeners?(): Ext.dom.IElement; /** [Method] Create an event handler on this element such that when the event fires and is handled by this element it will be rel * @param eventName String The type of event to relay * @param observable Object Any object that extends Ext.util.Observable that will provide the context for firing the relayed event */ relayEvent?( eventName?:string, observable?:any ): void; - /** [Method] Removes all previous added listeners from this element */ + /** [Method] Removes all previous added listeners from this element + * @returns Ext.dom.Element this + */ removeAllListeners?(): Ext.dom.IElement; /** [Method] Shorthand for un * @param eventName String The name of the event from which to remove the handler. * @param fn Function The handler function to remove. This must be a reference to the function passed into the on call. * @param scope Object If a scope (this reference) was specified when the listener was added, then this must refer to the same object. + * @returns Ext.dom.Element this */ removeListener?( eventName?:string, fn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Animates the transition of an element s dimensions from a starting height width to an ending height width * @param width Number The new width (pass undefined to keep the original width) * @param height Number The new height (pass undefined to keep the original height) * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ scale?( width?:number, height?:number, options?:any ): Ext.IElement; /** [Method] Scrolls this element the specified direction * @param direction String Possible values are: "l" (or "left") "r" (or "right") "t" (or "top", or "up") "b" (or "bottom", or "down") * @param distance Number How far to scroll the element in pixels * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Boolean Returns true if a scroll was triggered or false if the element was scrolled as far as it could go. */ scroll?( direction?:string, distance?:number, animate?:any ): boolean; /** [Method] Scrolls this element by the passed delta values optionally animating * @param deltaX Number/Number[]/Object Either the x delta, an Array specifying x and y deltas or an object with "x" and "y" properties. * @param deltaY Number/Boolean/Object Either the y delta, or an animate flag or config object. * @param animate Boolean/Object Animate flag/config object if the delta values were passed separately. + * @returns Ext.Element this */ scrollBy?( deltaX?:any, deltaY?:any, animate?:any ): Ext.IElement; /** [Method] Scrolls this element into view within the passed container @@ -13610,147 +14382,154 @@ declare module Ext { * @param hscroll Boolean False to disable horizontal scroll. * @param animate Boolean/Object true for the default animation or a standard Element * @param highlight Boolean true to highlight the element when it is in view. animation config object + * @returns Ext.dom.Element this */ - scrollIntoView?( container?:any, hscroll?:any, animate?:any, highlight?:any ): any; - scrollIntoView?( container?:string, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; - scrollIntoView?( container?:HTMLElement, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; - scrollIntoView?( container?:Ext.IElement, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; + scrollIntoView?( container?:any, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; /** [Method] Scrolls this element the specified scroll point * @param side String Either "left" for scrollLeft values or "top" for scrollTop values. * @param value Number The new scroll value * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.Element this */ scrollTo?( side?:string, value?:number, animate?:any ): Ext.IElement; - /** [Method] Enable text selection for this element normalized across browsers Defined in override Ext dom Element_style */ + /** [Method] Enable text selection for this element normalized across browsers Defined in override Ext dom Element_style + * @returns Ext.Element this + */ selectable?(): Ext.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom Number/String Number of pixels or CSS string value to set as the bottom CSS property value + * @returns Ext.dom.Element this */ - setBottom?( bottom?:any ): any; - setBottom?( bottom?:number ): Ext.dom.IElement; - setBottom?( bottom?:string ): Ext.dom.IElement; + setBottom?( bottom?:any ): Ext.dom.IElement; /** [Method] Sets the element s position and size in one shot * @param x Number X value for new position (coordinates are page-based) * @param y Number Y value for new position (coordinates are page-based) * @param width Number/String The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels) A String used to set the CSS width style. Animation may not be used. * @param height Number/String The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels) A String used to set the CSS height style. Animation may not be used. * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.dom.Element this */ - setBounds?( x?:any, y?:any, width?:any, height?:any, animate?:any ): any; - setBounds?( x?:number, y?:number, width?:number, height?:number, animate?:any ): Ext.dom.IElement; - setBounds?( x?:number, y?:number, width?:string, height?:number, animate?:any ): Ext.dom.IElement; - setBounds?( x?:number, y?:number, width?:number, height?:string, animate?:any ): Ext.dom.IElement; - setBounds?( x?:number, y?:number, width?:string, height?:string, animate?:any ): Ext.dom.IElement; + setBounds?( x?:number, y?:number, width?:any, height?:any, animate?:any ): Ext.dom.IElement; /** [Method] Sets the CSS display property * @param value Boolean/String Boolean value to display the element using its default display, or a string to set the display directly. + * @returns Ext.dom.Element this */ - setDisplayed?( value?:any ): any; - setDisplayed?( value?:boolean ): Ext.dom.IElement; - setDisplayed?( value?:string ): Ext.dom.IElement; + setDisplayed?( value?:any ): Ext.dom.IElement; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left Number/String Number of pixels or CSS string value to set as the left CSS property value + * @returns Ext.dom.Element this */ - setLeft?( left?:any ): any; - setLeft?( left?:number ): Ext.dom.IElement; - setLeft?( left?:string ): Ext.dom.IElement; + setLeft?( left?:any ): Ext.dom.IElement; /** [Method] Sets the element s left and top positions directly using CSS style Defined in override Ext dom Element_position * @param left Number/String Number of pixels or CSS string value to set as the left CSS property value * @param top Number/String Number of pixels or CSS string value to set as the top CSS property value + * @returns Ext.dom.Element this */ - setLeftTop?( left?:any, top?:any ): any; - setLeftTop?( left?:number, top?:number ): Ext.dom.IElement; - setLeftTop?( left?:string, top?:number ): Ext.dom.IElement; - setLeftTop?( left?:number, top?:string ): Ext.dom.IElement; - setLeftTop?( left?:string, top?:string ): Ext.dom.IElement; + setLeftTop?( left?:any, top?:any ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates * @param x Number X value for new position * @param y Number Y value for new position * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ setLocation?( x?:number, y?:number, animate?:any ): Ext.dom.IElement; /** [Method] Set the opacity of the element Defined in override Ext dom Element_style * @param opacity Number The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc * @param animate Boolean/Object a standard Element animation config object or true for the default animation ({duration: 350, easing: 'easeIn'}) + * @returns Ext.dom.Element this */ setOpacity?( opacity?:number, animate?:any ): Ext.dom.IElement; /** [Method] Set positioning with an object returned by getPositioning * @param posCfg Object + * @returns Ext.dom.Element this */ setPositioning?( posCfg?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right Number/String Number of pixels or CSS string value to set as the right CSS property value + * @returns Ext.dom.Element this */ - setRight?( right?:any ): any; - setRight?( right?:number ): Ext.dom.IElement; - setRight?( right?:string ): Ext.dom.IElement; + setRight?( right?:any ): Ext.dom.IElement; /** [Method] Sets the left scroll position Defined in override Ext dom Element_scroll * @param left Number The left scroll position + * @returns Ext.dom.Element this */ setScrollLeft?( left?:number ): Ext.dom.IElement; /** [Method] Sets the top scroll position Defined in override Ext dom Element_scroll * @param top Number The top scroll position + * @returns Ext.dom.Element this */ setScrollTop?( top?:number ): Ext.dom.IElement; /** [Method] Sets the element s top position directly using CSS style instead of setY * @param top Number/String Number of pixels or CSS string value to set as the top CSS property value + * @returns Ext.dom.Element this */ - setTop?( top?:any ): any; - setTop?( top?:number ): Ext.dom.IElement; - setTop?( top?:string ): Ext.dom.IElement; + setTop?( top?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ setVisible?( visible?:boolean, animate?:any ): Ext.dom.IElement; /** [Method] Animates the transition of any combination of an element s dimensions xy position and or opacity * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ shift?( options?:any ): Ext.IElement; /** [Method] Show this element Uses display mode to determine whether to use display or visibility * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.dom.Element this */ show?( animate?:any ): Ext.dom.IElement; /** [Method] Slides the element into view * @param anchor String One of the valid Ext.fx.Anim anchor positions (defaults to top: 't') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ slideIn?( anchor?:string, options?:any ): Ext.dom.IElement; /** [Method] Slides the element out of view * @param anchor String One of the valid Ext.fx.Anim anchor positions (defaults to top: 't') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ slideOut?( anchor?:string, options?:any ): Ext.dom.IElement; /** [Method] Stops the specified event s from bubbling and optionally prevents the default action * @param eventName String/String[] an event / array of events to stop from bubbling * @param preventDefault Boolean true to prevent the default action too + * @returns Ext.dom.Element this */ - swallowEvent?( eventName?:any, preventDefault?:any ): any; - swallowEvent?( eventName?:string, preventDefault?:boolean ): Ext.dom.IElement; - swallowEvent?( eventName?:string[], preventDefault?:boolean ): Ext.dom.IElement; + swallowEvent?( eventName?:any, preventDefault?:boolean ): Ext.dom.IElement; /** [Method] Blinks the element as if it was clicked and then collapses on its center similar to switching off a television * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ switchOff?( options?:any ): Ext.dom.IElement; /** [Method] Toggles the element s visibility or display depending on visibility mode * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ toggle?( animate?:any ): Ext.dom.IElement; /** [Method] Removes an event handler from this element * @param eventName String The name of the event from which to remove the handler. * @param fn Function The handler function to remove. This must be a reference to the function passed into the on call. * @param scope Object If a scope (this reference) was specified when the listener was added, then this must refer to the same object. + * @returns Ext.dom.Element this */ un?( eventName?:string, fn?:any, scope?:any ): Ext.dom.IElement; - /** [Method] Return clipping overflow to original clipping before clip was called Defined in override Ext dom Element_style */ + /** [Method] Return clipping overflow to original clipping before clip was called Defined in override Ext dom Element_style + * @returns Ext.dom.Element this + */ unclip?(): Ext.dom.IElement; /** [Method] Hides a previously applied mask */ unmask?(): void; - /** [Method] Disables text selection for this element normalized across browsers Defined in override Ext dom Element_style */ + /** [Method] Disables text selection for this element normalized across browsers Defined in override Ext dom Element_style + * @returns Ext.dom.Element this + */ unselectable?(): Ext.dom.IElement; /** [Method] Updates the innerHTML of this element optionally searching for and processing scripts * @param html String The new HTML * @param loadScripts Boolean True to look for and process scripts (defaults to false) * @param callback Function For async script loading you can be notified when the update completes + * @returns Ext.dom.Element this */ update?( html?:string, loadScripts?:boolean, callback?:any ): Ext.dom.IElement; } @@ -13761,9 +14540,12 @@ declare module Ext { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -13773,81 +14555,87 @@ declare module Ext { /** [Method] Returns the top Element that is located at the passed coordinates Defined in override Ext dom AbstractElement_static * @param x Number The x coordinate * @param y Number The y coordinate + * @returns String The found Element */ static fromPoint( x?:number, y?:number ): string; /** [Method] Retrieves Ext dom Element objects * @param el String/HTMLElement/Ext.Element The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element The Element object (or null if no matching element was found) + */ + static get( el?:any ): Ext.dom.IElement; + /** [Method] Retrieves the document height Defined in override Ext dom AbstractElement_static + * @returns Number documentHeight */ - static get( el?:any ): any; - static get( el?:string ): Ext.dom.IElement; - static get( el?:HTMLElement ): Ext.dom.IElement; - static get( el?:Ext.IElement ): Ext.dom.IElement; - /** [Method] Retrieves the document height Defined in override Ext dom AbstractElement_static */ static getDocumentHeight(): number; - /** [Method] Retrieves the document width Defined in override Ext dom AbstractElement_static */ + /** [Method] Retrieves the document width Defined in override Ext dom AbstractElement_static + * @returns Number documentWidth + */ static getDocumentWidth(): number; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; - /** [Method] Retrieves the current orientation of the window */ + /** [Method] Retrieves the current orientation of the window + * @returns String Orientation of window: 'portrait' or 'landscape' + */ static getOrientation(): string; - /** [Method] Retrieves the viewport size of the window */ + /** [Method] Retrieves the viewport size of the window + * @returns Object object containing width and height properties + */ static getViewSize(): any; - /** [Method] Retrieves the viewport height of the window */ + /** [Method] Retrieves the viewport height of the window + * @returns Number viewportHeight + */ static getViewportHeight(): number; - /** [Method] Retrieves the viewport width of the window */ + /** [Method] Retrieves the viewport width of the window + * @returns Number viewportWidth + */ static getViewportWidth(): number; /** [Method] Adds members to class */ static implement(): void; /** [Method] Returns an array of unique class names based upon the input strings or string arrays * @param clsList1 Mixed A string of class names, or an array of class names. * @param clsList2 Mixed A string of class names, or an array of class names. + * @returns Array An array of strings representing remaining unique, merged class names. If class names were added to the first list, the changed property will be true. */ static mergeClsList( clsList1?:any, clsList2?:any ): any[]; /** [Method] Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax * @param prop String The property to normalize + * @returns String The normalized string */ static normalize( prop?:string ): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String The encoded margins + * @returns Object An object with margin sizes for top, right, bottom and left */ static parseBox( box?:any ): any; - static parseBox( box?:number ): any; - static parseBox( box?:string ): any; /** [Method] Converts a CSS string into an object with a property for each style * @param styles String A CSS string + * @returns Object styles */ static parseStyles( styles?:string ): any; /** [Method] Returns an array of unique class names deom the first parameter with all class names from the second parameter removed * @param existingClsList Mixed A string of class names, or an array of class names. * @param removeClsList Mixed A string of class names, or an array of class names to remove from existingClsList. + * @returns Array An array of strings representing remaining class names. If class names were removed, the changed property will be true. */ static removeCls( existingClsList?:any, removeClsList?:any ): any[]; /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in * @param selector String/HTMLElement[] The CSS selector or an array of elements * @param unique Boolean true to create a unique Ext.Element for each element (defaults to a shared flyweight object) * @param root HTMLElement/String The root element of the query or id of the root + * @returns Ext.CompositeElementLite/Ext.CompositeElement */ - static select( selector?:any, unique?:any, root?:any ): any; - static select( selector?:string, unique?:boolean, root?:HTMLElement ): Ext.ICompositeElementLite; - static select( selector?:HTMLElement[], unique?:boolean, root?:HTMLElement ): Ext.ICompositeElementLite; - static select( selector?:string, unique?:boolean, root?:string ): Ext.ICompositeElementLite; - static select( selector?:HTMLElement[], unique?:boolean, root?:string ): Ext.ICompositeElementLite; - /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in - * @param selector String/HTMLElement[] The CSS selector or an array of elements - * @param unique Boolean true to create a unique Ext.Element for each element (defaults to a shared flyweight object) - * @param root HTMLElement/String The root element of the query or id of the root - */ - static select( selector?:string, unique?:boolean, root?:HTMLElement ): Ext.ICompositeElement; - static select( selector?:HTMLElement[], unique?:boolean, root?:HTMLElement ): Ext.ICompositeElement; - static select( selector?:string, unique?:boolean, root?:string ): Ext.ICompositeElement; - static select( selector?:HTMLElement[], unique?:boolean, root?:string ): Ext.ICompositeElement; + static select( selector?:any, unique?:boolean, root?:any ): any; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String/Object The encoded margins, or an object with top, right, bottom, and left properties * @param units String The type of units to add + * @returns String An string with unitized (px if units is not specified) metrics for top, right, bottom and left */ static unitizeBox( box?:any, units?:string ): string; } @@ -13862,28 +14650,33 @@ declare module Ext.core { * @param className String The class to add * @param testFn Function A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added. * @param scope Object The scope to execute the testFn in. + * @returns Ext.dom.Element this */ addClsOnClick?( className?:string, testFn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Sets up event handlers to add and remove a css class when this element has the focus Defined in override Ext dom Ele * @param className String The class to add * @param testFn Function A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added. * @param scope Object The scope to execute the testFn in. + * @returns Ext.dom.Element this */ addClsOnFocus?( className?:string, testFn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Sets up event handlers to add and remove a css class when the mouse is over this element Defined in override Ext dom * @param className String The class to add * @param testFn Function A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added. * @param scope Object The scope to execute the testFn in. + * @returns Ext.dom.Element this */ addClsOnOver?( className?:string, testFn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Convenience method for constructing a KeyMap * @param key String/Number/Number[]/Object Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options: * @param fn Function The function to call * @param scope Object The scope (this reference) in which the specified function is executed. Defaults to this Element. + * @returns Ext.util.KeyMap The KeyMap created */ addKeyListener?( key?:any, fn?:any, scope?:any ): Ext.util.IKeyMap; /** [Method] Creates a KeyMap for this element * @param config Object The KeyMap config. See Ext.util.KeyMap for more details + * @returns Ext.util.KeyMap The KeyMap created */ addKeyMap?( config?:any ): Ext.util.IKeyMap; /** [Method] Shorthand for on @@ -13891,85 +14684,108 @@ declare module Ext.core { * @param fn Function The handler function the event invokes. This function is passed the following parameters: evt : EventObject The EventObject describing the event. el : HtmlElement The DOM element which was the target of the event. Note that this may be filtered by using the delegate option. o : Object The options object from the call that setup the listener. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. * @param options Object An object containing handler configuration properties. This may contain any of the following properties: scope Object : The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. delegate String: A simple selector to filter the target or look for a descendant of the target. See below for additional details. stopEvent Boolean: True to stop the event. That is stop propagation, and prevent the default action. preventDefault Boolean: True to prevent the default action stopPropagation Boolean: True to prevent event propagation normalized Boolean: False to pass a browser event to the handler function instead of an Ext.EventObject target Ext.dom.Element: Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a child node. delay Number: The number of milliseconds to delay the invocation of the handler after the 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. Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the options object. The options object is available as the third parameter in the handler function. Code: el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, 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. Code: el.on({ 'click' : { fn: this.onClick, scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver, scope: this }, 'mouseout' : { fn: this.onMouseOut, scope: this } }); Or a shorthand syntax: Code: el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut, scope: this }); delegate This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. Event delegation is a technique that is used to reduce memory consumption and prevent exposure to memory-leaks. By registering an event for a container element as opposed to each element within a container. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example: // using this markup: <div id='elId'> <p id='p1'>paragraph one</p> <p id='p2' class='clickable'>paragraph two</p> <p id='p3'>paragraph three</p> </div> // utilize event delegation to registering just one handler on the container element: el = Ext.get('elId'); el.on( 'click', function(e,t) { // handle click console.info(t.id); // 'p2' }, this, { // filter the target element to be a descendant with the class 'clickable' delegate: '.clickable' } ); + * @returns Ext.dom.Element this */ addListener?( eventName?:string, fn?:any, scope?:any, options?:any ): Ext.dom.IElement; /** [Method] Performs custom animation on this Element * @param config Object Configuration for Ext.fx.Anim. Note that the to config is required. + * @returns Ext.dom.Element this */ animate?( config?:any ): Ext.dom.IElement; - /** [Method] Tries to blur the element */ + /** [Method] Tries to blur the element + * @returns Ext.dom.Element this + */ blur?(): Ext.dom.IElement; /** [Method] Wraps the specified element with a special 9 element markup CSS block that renders by default as a gray container wit * @param class String A base CSS class to apply to the containing wrapper element. Note that there are a number of CSS rules that are dependent on this name to make the overall effect work, so if you supply an alternate base class, make sure you also supply all of the necessary rules. + * @returns Ext.dom.Element The outermost wrapping element of the created box structure. */ boxWrap?( clazz?:string ): Ext.dom.IElement; - /** [Method] When an element is moved around in the DOM or is hidden using display none it loses layout and therefore all scrol */ + /** [Method] When an element is moved around in the DOM or is hidden using display none it loses layout and therefore all scrol + * @returns Function A function which will restore all descentant elements of this Element to their scroll positions recorded when this function was executed. Be aware that the returned function is a closure which has captured the scope of cacheScrollValues, so take care to derefence it as soon as not needed - if is it is a var it will drop out of scope, and the reference will be freed. + */ cacheScrollValues?(): any; /** [Method] Centers the Element in either the viewport or another Element * @param centerIn String/HTMLElement/Ext.dom.Element element in which to center the element. */ - center?( centerIn?:any ): any; - center?( centerIn?:string ): void; - center?( centerIn?:HTMLElement ): void; - center?( centerIn?:Ext.dom.IElement ): void; + center?( centerIn?:any ): void; /** [Method] Removes Empty or whitespace filled text nodes * @param forceReclean Boolean By default the element keeps track if it has been cleaned already so you can call this over and over. However, if you update the element and need to force a reclean, you can pass true. */ clean?( forceReclean?:boolean ): void; - /** [Method] Alias for removeAllListeners */ + /** [Method] Alias for removeAllListeners + * @returns Ext.dom.Element this + */ clearListeners?(): Ext.dom.IElement; - /** [Method] Clears any opacity settings from this element */ + /** [Method] Clears any opacity settings from this element + * @returns Ext.dom.Element this + */ clearOpacity?(): Ext.dom.IElement; /** [Method] Clears positioning back to the default when the document was loaded * @param value String The value to use for the left, right, top, bottom. You could use 'auto'. + * @returns Ext.dom.Element this */ clearPositioning?( value?:string ): Ext.dom.IElement; - /** [Method] Store the current overflow setting and clip overflow on the element use unclip to remove Defined in override Ext d */ + /** [Method] Store the current overflow setting and clip overflow on the element use unclip to remove Defined in override Ext d + * @returns Ext.dom.Element this + */ clip?(): Ext.dom.IElement; /** [Method] Creates a proxy element of this element * @param config String/Object The class name of the proxy element or a DomHelper config object * @param renderTo String/HTMLElement The element or element id to render the proxy to. Defaults to: document.body. * @param matchBox Boolean True to align and size the proxy to this element now. + * @returns Ext.dom.Element The new proxy element + */ + createProxy?( config?:any, renderTo?:any, matchBox?:boolean ): Ext.dom.IElement; + /** [Method] Creates an iframe shim for this element to keep selects and other windowed objects from showing through + * @returns Ext.dom.Element The new shim element */ - createProxy?( config?:any, renderTo?:any, matchBox?:any ): any; - createProxy?( config?:any, renderTo?:string, matchBox?:boolean ): Ext.dom.IElement; - createProxy?( config?:any, renderTo?:HTMLElement, matchBox?:boolean ): Ext.dom.IElement; - /** [Method] Creates an iframe shim for this element to keep selects and other windowed objects from showing through */ createShim?(): Ext.dom.IElement; /** [Method] Convenience method for setVisibilityMode Element DISPLAY * @param display String What to set display to when visible + * @returns Ext.dom.Element this */ enableDisplayMode?( display?:string ): Ext.dom.IElement; /** [Method] Fade an element in from transparent to opaque * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ fadeIn?( options?:any ): Ext.IElement; /** [Method] Fade an element out from opaque to transparent * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ fadeOut?( options?:any ): Ext.IElement; /** [Method] Tries to focus the element * @param defer Number Milliseconds to defer the focus + * @returns Ext.dom.Element this */ focus?( defer?:number ): Ext.dom.IElement; - /** [Method] Alias for isFocusable */ + /** [Method] Alias for isFocusable + * @returns Boolean True if the element is focusable + */ focusable?(): boolean; /** [Method] Shows a ripple of exploding attenuating borders to draw attention to an Element * @param color String The hex color value for the border. * @param count Number The number of ripples to display. * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ frame?( color?:string, count?:number, options?:any ): Ext.dom.IElement; /** [Method] Returns the value of a namespaced attribute from the element s underlying DOM node * @param namespace String The namespace in which to look for the attribute * @param name String The attribute name + * @returns String The attribute value */ getAttributeNS?( namespace?:string, name?:string ): string; /** [Method] Gets the bottom Y coordinate of the element element Y position element height Defined in override Ext dom Elemen * @param local Boolean True to get the local css position instead of page coordinate + * @returns Number */ getBottom?( local?:boolean ): number; - /** [Method] Calculates the x y to center this element on the screen Defined in override Ext dom Element_position */ + /** [Method] Calculates the x y to center this element on the screen Defined in override Ext dom Element_position + * @returns Number[] The x, y values [x, y] + */ getCenterXY?(): number[]; /** [Method] Return the CSS color for the specified CSS attribute * @param attr String The css attribute @@ -13977,74 +14793,110 @@ declare module Ext.core { * @param prefix String defaults to #. Use an empty string when working with color anims. */ getColor?( attr?:string, defaultValue?:string, prefix?:string ): void; - /** [Method] Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders when */ + /** [Method] Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders when + * @returns Number + */ getComputedHeight?(): number; - /** [Method] Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders when ne */ + /** [Method] Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders when ne + * @returns Number + */ getComputedWidth?(): number; /** [Method] Returns the sum width of the padding and borders for the passed sides * @param sides String + * @returns Number */ getFrameWidth?( sides?:string ): number; /** [Method] Gets the left X coordinate Defined in override Ext dom Element_position * @param local Boolean True to get the local css position instead of page coordinate + * @returns Number */ getLeft?( local?:boolean ): number; - /** [Method] Gets this element s ElementLoader */ + /** [Method] Gets this element s ElementLoader + * @returns Ext.ElementLoader The loader + */ getLoader?(): Ext.IElementLoader; - /** [Method] Gets the local CSS X position for the element Defined in override Ext dom Element_position */ + /** [Method] Gets the local CSS X position for the element Defined in override Ext dom Element_position + * @returns Number + */ getLocalX?(): number; - /** [Method] Gets the local CSS X and Y position for the element Defined in override Ext dom Element_position */ + /** [Method] Gets the local CSS X and Y position for the element Defined in override Ext dom Element_position + * @returns Array [x, y] + */ getLocalXY?(): any[]; - /** [Method] Gets the local CSS Y position for the element Defined in override Ext dom Element_position */ + /** [Method] Gets the local CSS Y position for the element Defined in override Ext dom Element_position + * @returns Number + */ getLocalY?(): number; /** [Method] Returns an object defining the area of this Element which can be passed to Ext util Positionable setBox to set anothe * @param asRegion Boolean If true an Ext.util.Region will be returned + * @returns Object/Ext.util.Region box An object in the following format: { left: <Element's X position>, top: <Element's Y position>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. So the result may also be used for setXY */ getPageBox?( asRegion?:boolean ): any; /** [Method] Gets an object with all CSS positioning properties * @param autoPx Boolean true to return pixel values for "auto" styles. + * @returns Object */ getPositioning?( autoPx?:boolean ): any; /** [Method] Gets the right X coordinate of the element element X position element width Defined in override Ext dom Element_ * @param local Boolean True to get the local css position instead of page coordinates + * @returns Number */ getRight?( local?:boolean ): number; - /** [Method] Returns the current scroll position of the element */ + /** [Method] Returns the current scroll position of the element + * @returns Object An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)} + */ getScroll?(): any; - /** [Method] Gets the left scroll position Defined in override Ext dom Element_scroll */ + /** [Method] Gets the left scroll position Defined in override Ext dom Element_scroll + * @returns Number The left scroll position + */ getScrollLeft?(): number; - /** [Method] Gets the top scroll position Defined in override Ext dom Element_scroll */ + /** [Method] Gets the top scroll position Defined in override Ext dom Element_scroll + * @returns Number The top scroll position + */ getScrollTop?(): number; - /** [Method] Returns the dimensions of the element available to lay content out in */ + /** [Method] Returns the dimensions of the element available to lay content out in + * @returns Object Object describing width and height. + */ getStyleSize?(): any; /** [Method] Returns the width in pixels of the passed text or the width of the text in this Element * @param text String The text to measure. Defaults to the innerHTML of the element. * @param min Number The minumum value to return. * @param max Number The maximum value to return. + * @returns Number The text width in pixels. */ getTextWidth?( text?:string, min?:number, max?:number ): number; /** [Method] Gets the top Y coordinate Defined in override Ext dom Element_position * @param local Boolean True to get the local css position instead of page coordinates + * @returns Number */ getTop?( local?:boolean ): number; - /** [Method] Gets element X position in page coordinates Defined in override Ext dom Element_position */ + /** [Method] Gets element X position in page coordinates Defined in override Ext dom Element_position + * @returns Number + */ getX?(): number; - /** [Method] Gets element X and Y positions in page coordinates Defined in override Ext dom Element_position */ + /** [Method] Gets element X and Y positions in page coordinates Defined in override Ext dom Element_position + * @returns Array [x, y] + */ getXY?(): any[]; - /** [Method] Gets element Y position in page coordinates Defined in override Ext dom Element_position */ + /** [Method] Gets element Y position in page coordinates Defined in override Ext dom Element_position + * @returns Number + */ getY?(): number; /** [Method] Slides the element while fading it out of view * @param anchor String One of the valid Ext.fx.Anim anchor positions (defaults to bottom: 'b') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ ghost?( anchor?:string, options?:any ): Ext.dom.IElement; /** [Method] Hide this element Uses display mode to determine whether to use display or visibility * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.dom.Element this */ hide?( animate?:any ): Ext.dom.IElement; /** [Method] Highlights the Element by setting a color applies to the background color by default but can be changed using the * @param color String The highlight color. Should be a 6 char hex color without the leading # (defaults to yellow: 'ffff9c') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ highlight?( color?:string, options?:any ): Ext.dom.IElement; /** [Method] Sets up event handlers to call the passed functions when the mouse is moved into and out of the Element @@ -14052,61 +14904,79 @@ declare module Ext.core { * @param outFn Function The function to call when the mouse leaves the Element. * @param scope Object The scope (this reference) in which the functions are executed. Defaults to the Element's DOM element. * @param options Object Options for the listener. See the options parameter. + * @returns Ext.dom.Element this */ hover?( overFn?:any, outFn?:any, scope?:any, options?:any ): Ext.dom.IElement; /** [Method] Initializes a Ext dd DD drag drop object for this element * @param group String The group the DD object is member of * @param config Object The DD config object * @param overrides Object An object containing methods to override/implement on the DD object + * @returns Ext.dd.DD The DD object */ initDD?( group?:string, config?:any, overrides?:any ): Ext.dd.IDD; /** [Method] Initializes a Ext dd DDProxy object for this element * @param group String The group the DDProxy object is member of * @param config Object The DDProxy config object * @param overrides Object An object containing methods to override/implement on the DDProxy object + * @returns Ext.dd.DDProxy The DDProxy object */ initDDProxy?( group?:string, config?:any, overrides?:any ): Ext.dd.IDDProxy; /** [Method] Initializes a Ext dd DDTarget object for this element * @param group String The group the DDTarget object is member of * @param config Object The DDTarget config object * @param overrides Object An object containing methods to override/implement on the DDTarget object + * @returns Ext.dd.DDTarget The DDTarget object */ initDDTarget?( group?:string, config?:any, overrides?:any ): Ext.dd.IDDTarget; - /** [Method] Tests various css rules browsers to determine if this element uses a border box */ + /** [Method] Tests various css rules browsers to determine if this element uses a border box + * @returns Boolean + */ isBorderBox?(): boolean; - /** [Method] Returns true if display is not none */ + /** [Method] Returns true if display is not none + * @returns Boolean + */ isDisplayed?(): boolean; /** [Method] Checks whether this element can be focused * @param asFocusEl Object + * @returns Boolean True if the element is focusable */ isFocusable?( asFocusEl?:any ): boolean; - /** [Method] Returns true if this element is masked */ + /** [Method] Returns true if this element is masked + * @returns Boolean + */ isMasked?(): boolean; - /** [Method] Returns true if this element is scrollable */ + /** [Method] Returns true if this element is scrollable + * @returns Boolean + */ isScrollable?(): boolean; /** [Method] Checks whether the element is currently visible using both visibility and display properties * @param deep Boolean True to walk the dom and see if parent elements are hidden. If false, the function only checks the visibility of the element itself and it may return true even though a parent is not visible. + * @returns Boolean true if the element is currently visible, else false */ isVisible?( deep?:boolean ): boolean; /** [Method] Direct access to the Ext ElementLoader Ext ElementLoader load method * @param options Object + * @returns Ext.dom.Element this */ load?( options?:any ): Ext.dom.IElement; /** [Method] Puts a mask over this element to disable user interaction * @param msg String A message to display in the mask * @param msgCls String A css class to apply to the msg element + * @returns Ext.dom.Element The mask element */ mask?( msg?:string, msgCls?:string ): Ext.dom.IElement; /** [Method] Monitors this Element for the mouse leaving * @param delay Number The delay in milliseconds to wait for possible mouse re-entry before calling the handler function. * @param handler Function The function to call if the mouse remains outside of this Element for the specified time. * @param scope Object The scope (this reference) in which the handler function executes. Defaults to this Element. + * @returns Object The listeners object which was added to this element so that monitoring can be stopped. Example usage: // Hide the menu if the mouse moves out for 250ms or more this.mouseLeaveMonitor = this.menuEl.monitorMouseLeave(250, this.hideMenu, this); ... // Remove mouseleave monitor on menu destroy this.menuEl.un(this.mouseLeaveMonitor); */ monitorMouseLeave?( delay?:number, handler?:any, scope?:any ): any; /** [Method] Sets the position of the element in page coordinates * @param x Number X value for new position (coordinates are page-based) * @param y Number Y value for new position (coordinates are page-based) * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ moveTo?( x?:number, y?:number, animate?:any ): Ext.dom.IElement; /** [Method] Returns true if this element needs an explicit tabIndex to make it focusable */ @@ -14116,10 +14986,12 @@ declare module Ext.core { * @param fn Function The handler function the event invokes. This function is passed the following parameters: evt : EventObject The EventObject describing the event. el : HtmlElement The DOM element which was the target of the event. Note that this may be filtered by using the delegate option. o : Object The options object from the call that setup the listener. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. * @param options Object An object containing handler configuration properties. This may contain any of the following properties: scope Object : The scope (this reference) in which the handler function is executed. If omitted, defaults to this Element. delegate String: A simple selector to filter the target or look for a descendant of the target. See below for additional details. stopEvent Boolean: True to stop the event. That is stop propagation, and prevent the default action. preventDefault Boolean: True to prevent the default action stopPropagation Boolean: True to prevent event propagation normalized Boolean: False to pass a browser event to the handler function instead of an Ext.EventObject target Ext.dom.Element: Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a child node. delay Number: The number of milliseconds to delay the invocation of the handler after the 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. Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the options object. The options object is available as the third parameter in the handler function. Code: el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, 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. Code: el.on({ 'click' : { fn: this.onClick, scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver, scope: this }, 'mouseout' : { fn: this.onMouseOut, scope: this } }); Or a shorthand syntax: Code: el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut, scope: this }); delegate This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. Event delegation is a technique that is used to reduce memory consumption and prevent exposure to memory-leaks. By registering an event for a container element as opposed to each element within a container. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example: // using this markup: <div id='elId'> <p id='p1'>paragraph one</p> <p id='p2' class='clickable'>paragraph two</p> <p id='p3'>paragraph three</p> </div> // utilize event delegation to registering just one handler on the container element: el = Ext.get('elId'); el.on( 'click', function(e,t) { // handle click console.info(t.id); // 'p2' }, this, { // filter the target element to be a descendant with the class 'clickable' delegate: '.clickable' } ); + * @returns Ext.dom.Element this */ on?( eventName?:string, fn?:any, scope?:any, options?:any ): Ext.dom.IElement; /** [Method] Creates a pause before any subsequent queued effects begin * @param seconds Number The length of time to pause (in seconds) + * @returns Ext.Element The Element */ pause?( seconds?:number ): Ext.IElement; /** [Method] Initializes positioning on this element @@ -14131,39 +15003,48 @@ declare module Ext.core { position?( pos?:string, zIndex?:number, x?:number, y?:number ): void; /** [Method] Fades the element out while slowly expanding it in all directions * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ puff?( options?:any ): Ext.dom.IElement; - /** [Method] Recursively removes all previous added listeners from this element and its children */ + /** [Method] Recursively removes all previous added listeners from this element and its children + * @returns Ext.dom.Element this + */ purgeAllListeners?(): Ext.dom.IElement; /** [Method] Create an event handler on this element such that when the event fires and is handled by this element it will be rel * @param eventName String The type of event to relay * @param observable Object Any object that extends Ext.util.Observable that will provide the context for firing the relayed event */ relayEvent?( eventName?:string, observable?:any ): void; - /** [Method] Removes all previous added listeners from this element */ + /** [Method] Removes all previous added listeners from this element + * @returns Ext.dom.Element this + */ removeAllListeners?(): Ext.dom.IElement; /** [Method] Shorthand for un * @param eventName String The name of the event from which to remove the handler. * @param fn Function The handler function to remove. This must be a reference to the function passed into the on call. * @param scope Object If a scope (this reference) was specified when the listener was added, then this must refer to the same object. + * @returns Ext.dom.Element this */ removeListener?( eventName?:string, fn?:any, scope?:any ): Ext.dom.IElement; /** [Method] Animates the transition of an element s dimensions from a starting height width to an ending height width * @param width Number The new width (pass undefined to keep the original width) * @param height Number The new height (pass undefined to keep the original height) * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ scale?( width?:number, height?:number, options?:any ): Ext.IElement; /** [Method] Scrolls this element the specified direction * @param direction String Possible values are: "l" (or "left") "r" (or "right") "t" (or "top", or "up") "b" (or "bottom", or "down") * @param distance Number How far to scroll the element in pixels * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Boolean Returns true if a scroll was triggered or false if the element was scrolled as far as it could go. */ scroll?( direction?:string, distance?:number, animate?:any ): boolean; /** [Method] Scrolls this element by the passed delta values optionally animating * @param deltaX Number/Number[]/Object Either the x delta, an Array specifying x and y deltas or an object with "x" and "y" properties. * @param deltaY Number/Boolean/Object Either the y delta, or an animate flag or config object. * @param animate Boolean/Object Animate flag/config object if the delta values were passed separately. + * @returns Ext.Element this */ scrollBy?( deltaX?:any, deltaY?:any, animate?:any ): Ext.IElement; /** [Method] Scrolls this element into view within the passed container @@ -14171,147 +15052,154 @@ declare module Ext.core { * @param hscroll Boolean False to disable horizontal scroll. * @param animate Boolean/Object true for the default animation or a standard Element * @param highlight Boolean true to highlight the element when it is in view. animation config object + * @returns Ext.dom.Element this */ - scrollIntoView?( container?:any, hscroll?:any, animate?:any, highlight?:any ): any; - scrollIntoView?( container?:string, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; - scrollIntoView?( container?:HTMLElement, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; - scrollIntoView?( container?:Ext.IElement, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; + scrollIntoView?( container?:any, hscroll?:boolean, animate?:any, highlight?:boolean ): Ext.dom.IElement; /** [Method] Scrolls this element the specified scroll point * @param side String Either "left" for scrollLeft values or "top" for scrollTop values. * @param value Number The new scroll value * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.Element this */ scrollTo?( side?:string, value?:number, animate?:any ): Ext.IElement; - /** [Method] Enable text selection for this element normalized across browsers Defined in override Ext dom Element_style */ + /** [Method] Enable text selection for this element normalized across browsers Defined in override Ext dom Element_style + * @returns Ext.Element this + */ selectable?(): Ext.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom Number/String Number of pixels or CSS string value to set as the bottom CSS property value + * @returns Ext.dom.Element this */ - setBottom?( bottom?:any ): any; - setBottom?( bottom?:number ): Ext.dom.IElement; - setBottom?( bottom?:string ): Ext.dom.IElement; + setBottom?( bottom?:any ): Ext.dom.IElement; /** [Method] Sets the element s position and size in one shot * @param x Number X value for new position (coordinates are page-based) * @param y Number Y value for new position (coordinates are page-based) * @param width Number/String The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels) A String used to set the CSS width style. Animation may not be used. * @param height Number/String The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels) A String used to set the CSS height style. Animation may not be used. * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.dom.Element this */ - setBounds?( x?:any, y?:any, width?:any, height?:any, animate?:any ): any; - setBounds?( x?:number, y?:number, width?:number, height?:number, animate?:any ): Ext.dom.IElement; - setBounds?( x?:number, y?:number, width?:string, height?:number, animate?:any ): Ext.dom.IElement; - setBounds?( x?:number, y?:number, width?:number, height?:string, animate?:any ): Ext.dom.IElement; - setBounds?( x?:number, y?:number, width?:string, height?:string, animate?:any ): Ext.dom.IElement; + setBounds?( x?:number, y?:number, width?:any, height?:any, animate?:any ): Ext.dom.IElement; /** [Method] Sets the CSS display property * @param value Boolean/String Boolean value to display the element using its default display, or a string to set the display directly. + * @returns Ext.dom.Element this */ - setDisplayed?( value?:any ): any; - setDisplayed?( value?:boolean ): Ext.dom.IElement; - setDisplayed?( value?:string ): Ext.dom.IElement; + setDisplayed?( value?:any ): Ext.dom.IElement; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left Number/String Number of pixels or CSS string value to set as the left CSS property value + * @returns Ext.dom.Element this */ - setLeft?( left?:any ): any; - setLeft?( left?:number ): Ext.dom.IElement; - setLeft?( left?:string ): Ext.dom.IElement; + setLeft?( left?:any ): Ext.dom.IElement; /** [Method] Sets the element s left and top positions directly using CSS style Defined in override Ext dom Element_position * @param left Number/String Number of pixels or CSS string value to set as the left CSS property value * @param top Number/String Number of pixels or CSS string value to set as the top CSS property value + * @returns Ext.dom.Element this */ - setLeftTop?( left?:any, top?:any ): any; - setLeftTop?( left?:number, top?:number ): Ext.dom.IElement; - setLeftTop?( left?:string, top?:number ): Ext.dom.IElement; - setLeftTop?( left?:number, top?:string ): Ext.dom.IElement; - setLeftTop?( left?:string, top?:string ): Ext.dom.IElement; + setLeftTop?( left?:any, top?:any ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates * @param x Number X value for new position * @param y Number Y value for new position * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ setLocation?( x?:number, y?:number, animate?:any ): Ext.dom.IElement; /** [Method] Set the opacity of the element Defined in override Ext dom Element_style * @param opacity Number The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc * @param animate Boolean/Object a standard Element animation config object or true for the default animation ({duration: 350, easing: 'easeIn'}) + * @returns Ext.dom.Element this */ setOpacity?( opacity?:number, animate?:any ): Ext.dom.IElement; /** [Method] Set positioning with an object returned by getPositioning * @param posCfg Object + * @returns Ext.dom.Element this */ setPositioning?( posCfg?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right Number/String Number of pixels or CSS string value to set as the right CSS property value + * @returns Ext.dom.Element this */ - setRight?( right?:any ): any; - setRight?( right?:number ): Ext.dom.IElement; - setRight?( right?:string ): Ext.dom.IElement; + setRight?( right?:any ): Ext.dom.IElement; /** [Method] Sets the left scroll position Defined in override Ext dom Element_scroll * @param left Number The left scroll position + * @returns Ext.dom.Element this */ setScrollLeft?( left?:number ): Ext.dom.IElement; /** [Method] Sets the top scroll position Defined in override Ext dom Element_scroll * @param top Number The top scroll position + * @returns Ext.dom.Element this */ setScrollTop?( top?:number ): Ext.dom.IElement; /** [Method] Sets the element s top position directly using CSS style instead of setY * @param top Number/String Number of pixels or CSS string value to set as the top CSS property value + * @returns Ext.dom.Element this */ - setTop?( top?:any ): any; - setTop?( top?:number ): Ext.dom.IElement; - setTop?( top?:string ): Ext.dom.IElement; + setTop?( top?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ setVisible?( visible?:boolean, animate?:any ): Ext.dom.IElement; /** [Method] Animates the transition of any combination of an element s dimensions xy position and or opacity * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.Element The Element */ shift?( options?:any ): Ext.IElement; /** [Method] Show this element Uses display mode to determine whether to use display or visibility * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.dom.Element this */ show?( animate?:any ): Ext.dom.IElement; /** [Method] Slides the element into view * @param anchor String One of the valid Ext.fx.Anim anchor positions (defaults to top: 't') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ slideIn?( anchor?:string, options?:any ): Ext.dom.IElement; /** [Method] Slides the element out of view * @param anchor String One of the valid Ext.fx.Anim anchor positions (defaults to top: 't') * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ slideOut?( anchor?:string, options?:any ): Ext.dom.IElement; /** [Method] Stops the specified event s from bubbling and optionally prevents the default action * @param eventName String/String[] an event / array of events to stop from bubbling * @param preventDefault Boolean true to prevent the default action too + * @returns Ext.dom.Element this */ - swallowEvent?( eventName?:any, preventDefault?:any ): any; - swallowEvent?( eventName?:string, preventDefault?:boolean ): Ext.dom.IElement; - swallowEvent?( eventName?:string[], preventDefault?:boolean ): Ext.dom.IElement; + swallowEvent?( eventName?:any, preventDefault?:boolean ): Ext.dom.IElement; /** [Method] Blinks the element as if it was clicked and then collapses on its center similar to switching off a television * @param options Object Object literal with any of the Ext.fx.Anim config options + * @returns Ext.dom.Element The Element */ switchOff?( options?:any ): Ext.dom.IElement; /** [Method] Toggles the element s visibility or display depending on visibility mode * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.dom.Element this */ toggle?( animate?:any ): Ext.dom.IElement; /** [Method] Removes an event handler from this element * @param eventName String The name of the event from which to remove the handler. * @param fn Function The handler function to remove. This must be a reference to the function passed into the on call. * @param scope Object If a scope (this reference) was specified when the listener was added, then this must refer to the same object. + * @returns Ext.dom.Element this */ un?( eventName?:string, fn?:any, scope?:any ): Ext.dom.IElement; - /** [Method] Return clipping overflow to original clipping before clip was called Defined in override Ext dom Element_style */ + /** [Method] Return clipping overflow to original clipping before clip was called Defined in override Ext dom Element_style + * @returns Ext.dom.Element this + */ unclip?(): Ext.dom.IElement; /** [Method] Hides a previously applied mask */ unmask?(): void; - /** [Method] Disables text selection for this element normalized across browsers Defined in override Ext dom Element_style */ + /** [Method] Disables text selection for this element normalized across browsers Defined in override Ext dom Element_style + * @returns Ext.dom.Element this + */ unselectable?(): Ext.dom.IElement; /** [Method] Updates the innerHTML of this element optionally searching for and processing scripts * @param html String The new HTML * @param loadScripts Boolean True to look for and process scripts (defaults to false) * @param callback Function For async script loading you can be notified when the update completes + * @returns Ext.dom.Element this */ update?( html?:string, loadScripts?:boolean, callback?:any ): Ext.dom.IElement; } @@ -14322,9 +15210,12 @@ declare module Ext.core { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -14334,81 +15225,87 @@ declare module Ext.core { /** [Method] Returns the top Element that is located at the passed coordinates Defined in override Ext dom AbstractElement_static * @param x Number The x coordinate * @param y Number The y coordinate + * @returns String The found Element */ static fromPoint( x?:number, y?:number ): string; /** [Method] Retrieves Ext dom Element objects * @param el String/HTMLElement/Ext.Element The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element The Element object (or null if no matching element was found) + */ + static get( el?:any ): Ext.dom.IElement; + /** [Method] Retrieves the document height Defined in override Ext dom AbstractElement_static + * @returns Number documentHeight */ - static get( el?:any ): any; - static get( el?:string ): Ext.dom.IElement; - static get( el?:HTMLElement ): Ext.dom.IElement; - static get( el?:Ext.IElement ): Ext.dom.IElement; - /** [Method] Retrieves the document height Defined in override Ext dom AbstractElement_static */ static getDocumentHeight(): number; - /** [Method] Retrieves the document width Defined in override Ext dom AbstractElement_static */ + /** [Method] Retrieves the document width Defined in override Ext dom AbstractElement_static + * @returns Number documentWidth + */ static getDocumentWidth(): number; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; - /** [Method] Retrieves the current orientation of the window */ + /** [Method] Retrieves the current orientation of the window + * @returns String Orientation of window: 'portrait' or 'landscape' + */ static getOrientation(): string; - /** [Method] Retrieves the viewport size of the window */ + /** [Method] Retrieves the viewport size of the window + * @returns Object object containing width and height properties + */ static getViewSize(): any; - /** [Method] Retrieves the viewport height of the window */ + /** [Method] Retrieves the viewport height of the window + * @returns Number viewportHeight + */ static getViewportHeight(): number; - /** [Method] Retrieves the viewport width of the window */ + /** [Method] Retrieves the viewport width of the window + * @returns Number viewportWidth + */ static getViewportWidth(): number; /** [Method] Adds members to class */ static implement(): void; /** [Method] Returns an array of unique class names based upon the input strings or string arrays * @param clsList1 Mixed A string of class names, or an array of class names. * @param clsList2 Mixed A string of class names, or an array of class names. + * @returns Array An array of strings representing remaining unique, merged class names. If class names were added to the first list, the changed property will be true. */ static mergeClsList( clsList1?:any, clsList2?:any ): any[]; /** [Method] Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax * @param prop String The property to normalize + * @returns String The normalized string */ static normalize( prop?:string ): string; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String The encoded margins + * @returns Object An object with margin sizes for top, right, bottom and left */ static parseBox( box?:any ): any; - static parseBox( box?:number ): any; - static parseBox( box?:string ): any; /** [Method] Converts a CSS string into an object with a property for each style * @param styles String A CSS string + * @returns Object styles */ static parseStyles( styles?:string ): any; /** [Method] Returns an array of unique class names deom the first parameter with all class names from the second parameter removed * @param existingClsList Mixed A string of class names, or an array of class names. * @param removeClsList Mixed A string of class names, or an array of class names to remove from existingClsList. + * @returns Array An array of strings representing remaining class names. If class names were removed, the changed property will be true. */ static removeCls( existingClsList?:any, removeClsList?:any ): any[]; /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in * @param selector String/HTMLElement[] The CSS selector or an array of elements * @param unique Boolean true to create a unique Ext.Element for each element (defaults to a shared flyweight object) * @param root HTMLElement/String The root element of the query or id of the root + * @returns Ext.CompositeElementLite/Ext.CompositeElement */ - static select( selector?:any, unique?:any, root?:any ): any; - static select( selector?:string, unique?:boolean, root?:HTMLElement ): Ext.ICompositeElementLite; - static select( selector?:HTMLElement[], unique?:boolean, root?:HTMLElement ): Ext.ICompositeElementLite; - static select( selector?:string, unique?:boolean, root?:string ): Ext.ICompositeElementLite; - static select( selector?:HTMLElement[], unique?:boolean, root?:string ): Ext.ICompositeElementLite; - /** [Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in - * @param selector String/HTMLElement[] The CSS selector or an array of elements - * @param unique Boolean true to create a unique Ext.Element for each element (defaults to a shared flyweight object) - * @param root HTMLElement/String The root element of the query or id of the root - */ - static select( selector?:string, unique?:boolean, root?:HTMLElement ): Ext.ICompositeElement; - static select( selector?:HTMLElement[], unique?:boolean, root?:HTMLElement ): Ext.ICompositeElement; - static select( selector?:string, unique?:boolean, root?:string ): Ext.ICompositeElement; - static select( selector?:HTMLElement[], unique?:boolean, root?:string ): Ext.ICompositeElement; + static select( selector?:any, unique?:boolean, root?:any ): any; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String/Object The encoded margins, or an object with top, right, bottom, and left properties * @param units String The type of units to add + * @returns String An string with unitized (px if units is not specified) metrics for top, right, bottom and left */ static unitizeBox( box?:any, units?:string ): string; } @@ -14419,33 +15316,26 @@ declare module Ext.dom { useDom?: boolean; /** [Method] Creates new DOM element s without inserting them to the document * @param o Object/String The DOM object spec (and children) or raw HTML blob + * @returns HTMLElement The new uninserted node */ createDom?( o?:any ): HTMLElement; /** [Method] Alias for markup * @param spec Object The DOM object spec (and children) + * @returns String */ createHtml?( spec?:any ): string; /** [Method] Creates a new Ext Template from the DOM object spec * @param o Object The DOM object spec (and children) + * @returns Ext.Template The new template */ createTemplate?( o?:any ): Ext.ITemplate; /** [Method] Creates new DOM element s and overwrites the contents of el with them * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return an Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - overwrite?( el?:any, o?:any, returnElement?:any ): any; - overwrite?( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - overwrite?( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - overwrite?( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and overwrites the contents of el with them - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return an Ext.Element - */ - overwrite?( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - overwrite?( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - overwrite?( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + overwrite?( el?:any, o?:any, returnElement?:boolean ): any; } } declare module Ext.dom { @@ -14481,6 +15371,7 @@ declare module Ext.dom { * @param duration Object * @param callback Object * @param easing Object + * @returns Ext.dom.Element this */ setBounds?( x?:any, y?:any, width?:any, height?:any, animate?:any, duration?:any, callback?:any, easing?:any ): Ext.dom.IElement; /** [Method] overridden Element method @@ -14489,15 +15380,18 @@ declare module Ext.dom { * @param duration Object * @param callback Object * @param easing Object + * @returns Ext.dom.Element this */ setHeight?( h?:any, animate?:any, duration?:any, callback?:any, easing?:any ): Ext.dom.IElement; /** [Method] overridden Element method * @param left Object + * @returns Ext.dom.Element this */ setLeft?( left?:any ): Ext.dom.IElement; /** [Method] Sets the element s left and top positions directly using CSS style Defined in override Ext dom Element_position * @param left Object * @param top Object + * @returns Ext.dom.Element this */ setLeftTop?( left?:any, top?:any ): Ext.dom.IElement; /** [Method] overridden Element method @@ -14507,10 +15401,12 @@ declare module Ext.dom { * @param duration Object * @param callback Object * @param easing Object + * @returns Ext.dom.Element this */ setSize?( w?:any, h?:any, animate?:any, duration?:any, callback?:any, easing?:any ): Ext.dom.IElement; /** [Method] Sets the element s top position directly using CSS style instead of setY * @param top Object + * @returns Ext.dom.Element this */ setTop?( top?:any ): Ext.dom.IElement; /** [Method] overridden Element method @@ -14519,6 +15415,7 @@ declare module Ext.dom { * @param duration Object * @param callback Object * @param easing Object + * @returns Ext.dom.Element this */ setVisible?( visible?:any, animate?:any, duration?:any, callback?:any, easing?:any ): Ext.dom.IElement; /** [Method] overridden Element method @@ -14527,10 +15424,12 @@ declare module Ext.dom { * @param duration Object * @param callback Object * @param easing Object + * @returns Ext.dom.Element this */ setWidth?( w?:any, animate?:any, duration?:any, callback?:any, easing?:any ): Ext.dom.IElement; /** [Method] Sets the z index of this layer and adjusts any shadow and shim z indexes * @param zindex Number The new z-index to set + * @returns Ext.Layer The Layer */ setZIndex?( zindex?:number ): Ext.ILayer; } @@ -14568,6 +15467,7 @@ declare module Ext { * @param duration Object * @param callback Object * @param easing Object + * @returns Ext.dom.Element this */ setBounds?( x?:any, y?:any, width?:any, height?:any, animate?:any, duration?:any, callback?:any, easing?:any ): Ext.dom.IElement; /** [Method] overridden Element method @@ -14576,15 +15476,18 @@ declare module Ext { * @param duration Object * @param callback Object * @param easing Object + * @returns Ext.dom.Element this */ setHeight?( h?:any, animate?:any, duration?:any, callback?:any, easing?:any ): Ext.dom.IElement; /** [Method] overridden Element method * @param left Object + * @returns Ext.dom.Element this */ setLeft?( left?:any ): Ext.dom.IElement; /** [Method] Sets the element s left and top positions directly using CSS style Defined in override Ext dom Element_position * @param left Object * @param top Object + * @returns Ext.dom.Element this */ setLeftTop?( left?:any, top?:any ): Ext.dom.IElement; /** [Method] overridden Element method @@ -14594,10 +15497,12 @@ declare module Ext { * @param duration Object * @param callback Object * @param easing Object + * @returns Ext.dom.Element this */ setSize?( w?:any, h?:any, animate?:any, duration?:any, callback?:any, easing?:any ): Ext.dom.IElement; /** [Method] Sets the element s top position directly using CSS style instead of setY * @param top Object + * @returns Ext.dom.Element this */ setTop?( top?:any ): Ext.dom.IElement; /** [Method] overridden Element method @@ -14606,6 +15511,7 @@ declare module Ext { * @param duration Object * @param callback Object * @param easing Object + * @returns Ext.dom.Element this */ setVisible?( visible?:any, animate?:any, duration?:any, callback?:any, easing?:any ): Ext.dom.IElement; /** [Method] overridden Element method @@ -14614,10 +15520,12 @@ declare module Ext { * @param duration Object * @param callback Object * @param easing Object + * @returns Ext.dom.Element this */ setWidth?( w?:any, animate?:any, duration?:any, callback?:any, easing?:any ): Ext.dom.IElement; /** [Method] Sets the z index of this layer and adjusts any shadow and shim z indexes * @param zindex Number The new z-index to set + * @returns Ext.Layer The Layer */ setZIndex?( zindex?:number ): Ext.ILayer; } @@ -14629,51 +15537,54 @@ declare module Ext.dom { /** [Method] Compiles a selector xpath query into a reusable function * @param selector String The selector/xpath query * @param type String Either "select" or "simple" for a simple selector match + * @returns Function */ static compile( selector?:string, type?:string ): any; /** [Method] Filters an array of elements to only include matches of a simple selector e g * @param el HTMLElement[] An array of elements to filter * @param selector String The simple selector to test * @param nonMatches Boolean If true, it returns the elements that DON'T match the selector instead of the ones that match + * @returns HTMLElement[] An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned. */ static filter( el?:HTMLElement[], selector?:string, nonMatches?:boolean ): HTMLElement[]; /** [Method] Returns true if the passed element s match the passed simple selector e g * @param el String/HTMLElement/HTMLElement[] An element id, element or array of elements * @param selector String The simple selector to test + * @returns Boolean */ - static is( el?:any, selector?:any ): any; - static is( el?:string, selector?:string ): boolean; - static is( el?:HTMLElement, selector?:string ): boolean; - static is( el?:HTMLElement[], selector?:string ): boolean; + static is( el?:any, selector?:string ): boolean; /** [Method] Selects an array of DOM nodes using JavaScript only implementation * @param selector String The selector/xpath query (can be a comma separated list of selectors) * @param root HTMLElement/String The start of the query. + * @returns HTMLElement[] An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned. */ - static jsSelect( selector?:any, root?:any ): any; - static jsSelect( selector?:string, root?:HTMLElement ): HTMLElement[]; - static jsSelect( selector?:string, root?:string ): HTMLElement[]; + static jsSelect( selector?:string, root?:any ): HTMLElement[]; /** [Method] Selects an array of DOM nodes by CSS XPath selector * @param path String The selector/xpath query * @param root HTMLElement The start of the query. * @param type String Either "select" or "simple" for a simple selector match (only valid when used when the call is deferred to the jsSelect method) * @param single Boolean Pass true to select only the first matching node using document.querySelector (where available) + * @returns HTMLElement[] An array of DOM elements (not a NodeList as returned by querySelectorAll). */ static select( path?:string, root?:HTMLElement, type?:string, single?:boolean ): HTMLElement[]; /** [Method] Selects a single element * @param selector String The selector/xpath query * @param root HTMLElement The start of the query. + * @returns HTMLElement The DOM element which matched the selector. */ static selectNode( selector?:string, root?:HTMLElement ): HTMLElement; /** [Method] Selects the value of a node parsing integers and floats * @param selector String The selector/xpath query * @param root HTMLElement The start of the query. * @param defaultValue Number When specified, this is return as empty value. + * @returns Number */ static selectNumber( selector?:string, root?:HTMLElement, defaultValue?:number ): number; /** [Method] Selects the value of a node optionally replacing null with the defaultValue * @param selector String The selector/xpath query * @param root HTMLElement The start of the query. * @param defaultValue String When specified, this is return as empty value. + * @returns String */ static selectValue( selector?:string, root?:HTMLElement, defaultValue?:string ): string; } @@ -14685,51 +15596,54 @@ declare module Ext { /** [Method] Compiles a selector xpath query into a reusable function * @param selector String The selector/xpath query * @param type String Either "select" or "simple" for a simple selector match + * @returns Function */ static compile( selector?:string, type?:string ): any; /** [Method] Filters an array of elements to only include matches of a simple selector e g * @param el HTMLElement[] An array of elements to filter * @param selector String The simple selector to test * @param nonMatches Boolean If true, it returns the elements that DON'T match the selector instead of the ones that match + * @returns HTMLElement[] An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned. */ static filter( el?:HTMLElement[], selector?:string, nonMatches?:boolean ): HTMLElement[]; /** [Method] Returns true if the passed element s match the passed simple selector e g * @param el String/HTMLElement/HTMLElement[] An element id, element or array of elements * @param selector String The simple selector to test + * @returns Boolean */ - static is( el?:any, selector?:any ): any; - static is( el?:string, selector?:string ): boolean; - static is( el?:HTMLElement, selector?:string ): boolean; - static is( el?:HTMLElement[], selector?:string ): boolean; + static is( el?:any, selector?:string ): boolean; /** [Method] Selects an array of DOM nodes using JavaScript only implementation * @param selector String The selector/xpath query (can be a comma separated list of selectors) * @param root HTMLElement/String The start of the query. + * @returns HTMLElement[] An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned. */ - static jsSelect( selector?:any, root?:any ): any; - static jsSelect( selector?:string, root?:HTMLElement ): HTMLElement[]; - static jsSelect( selector?:string, root?:string ): HTMLElement[]; + static jsSelect( selector?:string, root?:any ): HTMLElement[]; /** [Method] Selects an array of DOM nodes by CSS XPath selector * @param path String The selector/xpath query * @param root HTMLElement The start of the query. * @param type String Either "select" or "simple" for a simple selector match (only valid when used when the call is deferred to the jsSelect method) * @param single Boolean Pass true to select only the first matching node using document.querySelector (where available) + * @returns HTMLElement[] An array of DOM elements (not a NodeList as returned by querySelectorAll). */ static select( path?:string, root?:HTMLElement, type?:string, single?:boolean ): HTMLElement[]; /** [Method] Selects a single element * @param selector String The selector/xpath query * @param root HTMLElement The start of the query. + * @returns HTMLElement The DOM element which matched the selector. */ static selectNode( selector?:string, root?:HTMLElement ): HTMLElement; /** [Method] Selects the value of a node parsing integers and floats * @param selector String The selector/xpath query * @param root HTMLElement The start of the query. * @param defaultValue Number When specified, this is return as empty value. + * @returns Number */ static selectNumber( selector?:string, root?:HTMLElement, defaultValue?:number ): number; /** [Method] Selects the value of a node optionally replacing null with the defaultValue * @param selector String The selector/xpath query * @param root HTMLElement The start of the query. * @param defaultValue String When specified, this is return as empty value. + * @returns String */ static selectValue( selector?:string, root?:HTMLElement, defaultValue?:string ): string; } @@ -14741,51 +15655,54 @@ declare module Ext.core { /** [Method] Compiles a selector xpath query into a reusable function * @param selector String The selector/xpath query * @param type String Either "select" or "simple" for a simple selector match + * @returns Function */ static compile( selector?:string, type?:string ): any; /** [Method] Filters an array of elements to only include matches of a simple selector e g * @param el HTMLElement[] An array of elements to filter * @param selector String The simple selector to test * @param nonMatches Boolean If true, it returns the elements that DON'T match the selector instead of the ones that match + * @returns HTMLElement[] An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned. */ static filter( el?:HTMLElement[], selector?:string, nonMatches?:boolean ): HTMLElement[]; /** [Method] Returns true if the passed element s match the passed simple selector e g * @param el String/HTMLElement/HTMLElement[] An element id, element or array of elements * @param selector String The simple selector to test + * @returns Boolean */ - static is( el?:any, selector?:any ): any; - static is( el?:string, selector?:string ): boolean; - static is( el?:HTMLElement, selector?:string ): boolean; - static is( el?:HTMLElement[], selector?:string ): boolean; + static is( el?:any, selector?:string ): boolean; /** [Method] Selects an array of DOM nodes using JavaScript only implementation * @param selector String The selector/xpath query (can be a comma separated list of selectors) * @param root HTMLElement/String The start of the query. + * @returns HTMLElement[] An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned. */ - static jsSelect( selector?:any, root?:any ): any; - static jsSelect( selector?:string, root?:HTMLElement ): HTMLElement[]; - static jsSelect( selector?:string, root?:string ): HTMLElement[]; + static jsSelect( selector?:string, root?:any ): HTMLElement[]; /** [Method] Selects an array of DOM nodes by CSS XPath selector * @param path String The selector/xpath query * @param root HTMLElement The start of the query. * @param type String Either "select" or "simple" for a simple selector match (only valid when used when the call is deferred to the jsSelect method) * @param single Boolean Pass true to select only the first matching node using document.querySelector (where available) + * @returns HTMLElement[] An array of DOM elements (not a NodeList as returned by querySelectorAll). */ static select( path?:string, root?:HTMLElement, type?:string, single?:boolean ): HTMLElement[]; /** [Method] Selects a single element * @param selector String The selector/xpath query * @param root HTMLElement The start of the query. + * @returns HTMLElement The DOM element which matched the selector. */ static selectNode( selector?:string, root?:HTMLElement ): HTMLElement; /** [Method] Selects the value of a node parsing integers and floats * @param selector String The selector/xpath query * @param root HTMLElement The start of the query. * @param defaultValue Number When specified, this is return as empty value. + * @returns Number */ static selectNumber( selector?:string, root?:HTMLElement, defaultValue?:number ): number; /** [Method] Selects the value of a node optionally replacing null with the defaultValue * @param selector String The selector/xpath query * @param root HTMLElement The start of the query. * @param defaultValue String When specified, this is return as empty value. + * @returns String */ static selectValue( selector?:string, root?:HTMLElement, defaultValue?:string ): string; } @@ -14798,152 +15715,103 @@ declare module Ext { * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - static append( el?:any, o?:any, returnElement?:any ): any; - static append( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - static append( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - static append( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and appends them to el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return a Ext.Element - */ - static append( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - static append( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - static append( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + static append( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Applies a style specification to an element * @param el String/HTMLElement The element to apply styles to * @param styles String/Object/Function A style specification string e.g. 'width:100px', or object in the form {width:'100px'}, or a function which returns such a specification. */ - static applyStyles( el?:any, styles?:any ): any; - static applyStyles( el?:string, styles?:any ): void; - static applyStyles( el?:HTMLElement, styles?:any ): void; + static applyStyles( el?:any, styles?:any ): void; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates new DOM element s without inserting them to the document * @param o Object/String The DOM object spec (and children) or raw HTML blob + * @returns HTMLElement The new uninserted node */ static createDom( o?:any ): HTMLElement; /** [Method] Alias for markup * @param spec Object The DOM object spec (and children) + * @returns String */ static createHtml( spec?:any ): string; /** [Method] Creates a new Ext Template from the DOM object spec * @param o Object The DOM object spec (and children) + * @returns Ext.Template The new template */ static createTemplate( o?:any ): Ext.ITemplate; /** [Method] Converts the styles from the given object to text * @param styles Object The object describing the styles. * @param buffer String[] The output buffer. + * @returns String/String[] If buffer is passed, it is returned. Otherwise the style string is returned. */ - static generateStyles( styles?:any, buffer?:string[] ): string; - /** [Method] Converts the styles from the given object to text - * @param styles Object The object describing the styles. - * @param buffer String[] The output buffer. - */ - static generateStyles( styles?:any, buffer?:string[] ): string[]; + static generateStyles( styles?:any, buffer?:string[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Creates new DOM element s and inserts them after el * @param el String/HTMLElement/Ext.Element The context element * @param o Object The DOM object spec (and children) * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - static insertAfter( el?:any, o?:any, returnElement?:any ): any; - static insertAfter( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - static insertAfter( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - static insertAfter( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and inserts them after el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object The DOM object spec (and children) - * @param returnElement Boolean true to return a Ext.Element - */ - static insertAfter( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - static insertAfter( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - static insertAfter( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + static insertAfter( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Creates new DOM element s and inserts them before el * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - static insertBefore( el?:any, o?:any, returnElement?:any ): any; - static insertBefore( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - static insertBefore( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - static insertBefore( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and inserts them before el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return a Ext.Element - */ - static insertBefore( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - static insertBefore( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - static insertBefore( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + static insertBefore( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Creates new DOM element s and inserts them as the first child of el * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - static insertFirst( el?:any, o?:any, returnElement?:any ): any; - static insertFirst( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - static insertFirst( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - static insertFirst( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and inserts them as the first child of el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return a Ext.Element - */ - static insertFirst( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - static insertFirst( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - static insertFirst( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + static insertFirst( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Inserts an HTML fragment into the DOM * @param where String Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd. For example take the following HTML: <div>Contents</div> Using different where values inserts element to the following places: beforeBegin: <HERE><div>Contents</div> afterBegin: <div><HERE>Contents</div> beforeEnd: <div>Contents<HERE></div> afterEnd: <div>Contents</div><HERE> * @param el HTMLElement/TextNode The context element * @param html String The HTML fragment + * @returns HTMLElement The new node */ - static insertHtml( where?:any, el?:any, html?:any ): any; - static insertHtml( where?:string, el?:HTMLElement, html?:string ): HTMLElement; static insertHtml( where?:string, el?:any, html?:string ): HTMLElement; /** [Method] Returns the markup for the passed Element s config * @param spec Object The DOM object spec (and children) + * @returns String */ static markup( spec?:any ): string; /** [Method] Creates new DOM element s and overwrites the contents of el with them * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return an Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - static overwrite( el?:any, o?:any, returnElement?:any ): any; - static overwrite( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - static overwrite( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - static overwrite( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and overwrites the contents of el with them - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return an Ext.Element + static overwrite( el?:any, o?:any, returnElement?:boolean ): any; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class */ - static overwrite( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - static overwrite( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - static overwrite( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; - /** [Method] Get the reference to the class from which this object was instantiated */ static statics(): Ext.IClass; } } @@ -14955,152 +15823,103 @@ declare module Ext.core { * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - static append( el?:any, o?:any, returnElement?:any ): any; - static append( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - static append( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - static append( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and appends them to el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return a Ext.Element - */ - static append( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - static append( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - static append( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + static append( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Applies a style specification to an element * @param el String/HTMLElement The element to apply styles to * @param styles String/Object/Function A style specification string e.g. 'width:100px', or object in the form {width:'100px'}, or a function which returns such a specification. */ - static applyStyles( el?:any, styles?:any ): any; - static applyStyles( el?:string, styles?:any ): void; - static applyStyles( el?:HTMLElement, styles?:any ): void; + static applyStyles( el?:any, styles?:any ): void; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates new DOM element s without inserting them to the document * @param o Object/String The DOM object spec (and children) or raw HTML blob + * @returns HTMLElement The new uninserted node */ static createDom( o?:any ): HTMLElement; /** [Method] Alias for markup * @param spec Object The DOM object spec (and children) + * @returns String */ static createHtml( spec?:any ): string; /** [Method] Creates a new Ext Template from the DOM object spec * @param o Object The DOM object spec (and children) + * @returns Ext.Template The new template */ static createTemplate( o?:any ): Ext.ITemplate; /** [Method] Converts the styles from the given object to text * @param styles Object The object describing the styles. * @param buffer String[] The output buffer. + * @returns String/String[] If buffer is passed, it is returned. Otherwise the style string is returned. */ - static generateStyles( styles?:any, buffer?:string[] ): string; - /** [Method] Converts the styles from the given object to text - * @param styles Object The object describing the styles. - * @param buffer String[] The output buffer. - */ - static generateStyles( styles?:any, buffer?:string[] ): string[]; + static generateStyles( styles?:any, buffer?:string[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Creates new DOM element s and inserts them after el * @param el String/HTMLElement/Ext.Element The context element * @param o Object The DOM object spec (and children) * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - static insertAfter( el?:any, o?:any, returnElement?:any ): any; - static insertAfter( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - static insertAfter( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - static insertAfter( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and inserts them after el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object The DOM object spec (and children) - * @param returnElement Boolean true to return a Ext.Element - */ - static insertAfter( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - static insertAfter( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - static insertAfter( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + static insertAfter( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Creates new DOM element s and inserts them before el * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - static insertBefore( el?:any, o?:any, returnElement?:any ): any; - static insertBefore( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - static insertBefore( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - static insertBefore( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and inserts them before el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return a Ext.Element - */ - static insertBefore( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - static insertBefore( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - static insertBefore( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + static insertBefore( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Creates new DOM element s and inserts them as the first child of el * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return a Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - static insertFirst( el?:any, o?:any, returnElement?:any ): any; - static insertFirst( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - static insertFirst( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - static insertFirst( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and inserts them as the first child of el - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return a Ext.Element - */ - static insertFirst( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - static insertFirst( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - static insertFirst( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; + static insertFirst( el?:any, o?:any, returnElement?:boolean ): any; /** [Method] Inserts an HTML fragment into the DOM * @param where String Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd. For example take the following HTML: <div>Contents</div> Using different where values inserts element to the following places: beforeBegin: <HERE><div>Contents</div> afterBegin: <div><HERE>Contents</div> beforeEnd: <div>Contents<HERE></div> afterEnd: <div>Contents</div><HERE> * @param el HTMLElement/TextNode The context element * @param html String The HTML fragment + * @returns HTMLElement The new node */ - static insertHtml( where?:any, el?:any, html?:any ): any; - static insertHtml( where?:string, el?:HTMLElement, html?:string ): HTMLElement; static insertHtml( where?:string, el?:any, html?:string ): HTMLElement; /** [Method] Returns the markup for the passed Element s config * @param spec Object The DOM object spec (and children) + * @returns String */ static markup( spec?:any ): string; /** [Method] Creates new DOM element s and overwrites the contents of el with them * @param el String/HTMLElement/Ext.Element The context element * @param o Object/String The DOM object spec (and children) or raw HTML blob * @param returnElement Boolean true to return an Ext.Element + * @returns HTMLElement/Ext.Element The new node */ - static overwrite( el?:any, o?:any, returnElement?:any ): any; - static overwrite( el?:string, o?:any, returnElement?:boolean ): HTMLElement; - static overwrite( el?:HTMLElement, o?:any, returnElement?:boolean ): HTMLElement; - static overwrite( el?:Ext.IElement, o?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Creates new DOM element s and overwrites the contents of el with them - * @param el String/HTMLElement/Ext.Element The context element - * @param o Object/String The DOM object spec (and children) or raw HTML blob - * @param returnElement Boolean true to return an Ext.Element + static overwrite( el?:any, o?:any, returnElement?:boolean ): any; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class */ - static overwrite( el?:string, o?:any, returnElement?:boolean ): Ext.IElement; - static overwrite( el?:HTMLElement, o?:any, returnElement?:boolean ): Ext.IElement; - static overwrite( el?:Ext.IElement, o?:any, returnElement?:boolean ): Ext.IElement; - /** [Method] Get the reference to the class from which this object was instantiated */ static statics(): Ext.IClass; } } @@ -15108,27 +15927,43 @@ declare module Ext.draw { export interface IColor extends Ext.IBase { /** [Config Option] (Number) */ lightnessFactor?: number; - /** [Method] Get the blue component of the color in the range 0 255 */ + /** [Method] Get the blue component of the color in the range 0 255 + * @returns Number + */ getBlue?(): number; /** [Method] Return a new color that is darker than this color * @param factor Number Darker factor (0..1), default to 0.2 + * @returns Object Ext.draw.Color */ getDarker?( factor?:number ): any; - /** [Method] Returns the gray value 0 to 255 of the color */ + /** [Method] Returns the gray value 0 to 255 of the color + * @returns Number + */ getGrayscale?(): number; - /** [Method] Get the green component of the color in the range 0 255 */ + /** [Method] Get the green component of the color in the range 0 255 + * @returns Number + */ getGreen?(): number; - /** [Method] Get the equivalent HSL components of the color */ + /** [Method] Get the equivalent HSL components of the color + * @returns Number[] + */ getHSL?(): number[]; /** [Method] Return a new color that is lighter than this color * @param factor Number Lighter factor (0..1), default to 0.2 + * @returns Object Ext.draw.Color */ getLighter?( factor?:number ): any; - /** [Method] Get the RGB values */ + /** [Method] Get the RGB values + * @returns Number[] + */ getRGB?(): number[]; - /** [Method] Get the red component of the color in the range 0 255 */ + /** [Method] Get the red component of the color in the range 0 255 + * @returns Number + */ getRed?(): number; - /** [Method] Return the color in the hex format i e */ + /** [Method] Return the color in the hex format i e + * @returns String + */ toString?(): string; } export class Color { @@ -15138,9 +15973,12 @@ declare module Ext.draw { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -15151,26 +15989,30 @@ declare module Ext.draw { * @param h Number Hue component (0..359) * @param s Number Saturation component (0..1) * @param l Number Lightness component (0..1) + * @returns Object Ext.draw.Color */ static fromHSL( h?:number, s?:number, l?:number ): any; /** [Method] Parse the string and create a new color * @param str String Color in string. + * @returns Object Ext.draw.Color */ static fromString( str?:string ): any; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Convert a color to hexadecimal format * @param color String/String[] The color value (i.e 'rgb(255, 255, 255)', 'color: #ffffff'). Can also be an Array, in this case the function handles the first member. + * @returns String The color in hexadecimal format. */ - static toHex( color?:any ): any; - static toHex( color?:string ): string; - static toHex( color?:string[] ): string; + static toHex( color?:any ): string; } } declare module Ext.draw { @@ -15200,6 +16042,7 @@ declare module Ext.draw { /** [Method] Inherit docs from MixedCollection * @param key Object * @param o Object + * @returns Object The item added. */ add?( key?:any, o?:any ): any; /** [Method] Adds class to all sprites @@ -15208,45 +16051,54 @@ declare module Ext.draw { addCls?( cls?:string ): void; /** [Method] Performs custom animation on this object * @param config Object Configuration for Ext.fx.Anim. Note that the to config is required. + * @returns Object this */ animate?( config?:any ): any; /** [Method] Destroys this CompositeSprite */ destroy?(): void; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - getActiveAnimation?(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - getActiveAnimation?(): boolean; - /** [Method] Returns the group bounding box */ + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + getActiveAnimation?(): any; + /** [Method] Returns the group bounding box + * @returns Object an object with x, y, width, and height properties. + */ getBBox?(): any; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - hasActiveFx?(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - hasActiveFx?(): boolean; + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + hasActiveFx?(): any; /** [Method] Hides all sprites * @param redraw Boolean Flag to immediately draw the change. + * @returns Ext.draw.CompositeSprite this */ hide?( redraw?:boolean ): Ext.draw.ICompositeSprite; /** [Method] Inserts an item at the specified index in the collection * @param index Object * @param key Object * @param o Object + * @returns Object The item inserted or an array of items inserted. */ insert?( index?:any, key?:any, o?:any ): any; /** [Method] Force redraw of all sprites */ redraw?(): void; /** [Method] Inherit docs from MixedCollection * @param o Object + * @returns Object The item removed or false if no item was removed. */ remove?( o?:any ): any; /** [Method] Removes class from all sprites * @param cls String CSS class name */ removeCls?( cls?:string ): void; - /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence */ + /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence + * @returns Object this + */ sequenceFx?(): any; /** [Method] Iterates through all sprites calling setAttributes on each one * @param attrs Object Attributes to be changed on the sprite. * @param redraw Boolean Flag to immediately draw the change. + * @returns Ext.draw.CompositeSprite this */ setAttributes?( attrs?:any, redraw?:boolean ): Ext.draw.ICompositeSprite; /** [Method] Sets style for all sprites @@ -15255,13 +16107,20 @@ declare module Ext.draw { setStyle?( style?:string ): void; /** [Method] Shows all sprites * @param redraw Boolean Flag to immediately draw the change. + * @returns Ext.draw.CompositeSprite this */ show?( redraw?:boolean ): Ext.draw.ICompositeSprite; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ stopAnimation?(): Ext.IElement; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ stopFx?(): Ext.IElement; - /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently */ + /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently + * @returns Object this + */ syncFx?(): any; } } @@ -15271,25 +16130,27 @@ declare module Ext.draw { export class Draw { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] snapEndsByDate is a utility method to deduce an appropriate tick configuration for the data set of given feature @@ -15297,6 +16158,7 @@ declare module Ext.draw { * @param to Date The maximum value in the data * @param stepsMax Number The maximum number of ticks * @param lockEnds Boolean If true, the 'from' and 'to' parameters will be used as fixed end values and will not be adjusted + * @returns Object The calculated step and ends info; properties are: - from: The result start value, which may be lower than the original start value - to: The result end value, which may be higher than the original end value - step: The fixed value size of each step, or undefined if the steps are not fixed. - steps: The number of steps if the steps are fixed, or an array of step values. NOTE: Even when the steps have a fixed value, they may not divide the from/to range perfectly evenly; there may be a smaller distance between the last step and the end value than between prior steps, particularly when the endsLocked param is true. Therefore it is best to not use the steps result when finding the axis tick points, instead use the step, to, and from to find the correct point for each tick. */ static snapEndsByDate( from?:any, to?:any, stepsMax?:number, lockEnds?:boolean ): any; /** [Method] snapEndsByDateAndStep is a utility method to deduce an appropriate tick configuration for the data set of given featu @@ -15304,9 +16166,12 @@ declare module Ext.draw { * @param to Date The maximum value in the data * @param step Array An array with two components: The first is the unit of the step (day, month, year, etc). The second is the number of units for the step (1, 2, etc.). If the number is an integer, it represents the number of units for the step ([Ext.Date.DAY, 2] means "Every other day"). If the number is a fraction, it represents the number of steps per unit ([Ext.Date.DAY, 1/2] means "Twice a day"). If the unit is the month, the steps may be adjusted depending on the month. For instance [Ext.Date.MONTH, 1/3], which means "Three times a month", generates steps on the 1st, the 10th and the 20th of every month regardless of whether a month has 28 days or 31 days. The steps are generated as follows: - [Ext.Date.MONTH, n]: on the current date every 'n' months, maxed to the number of days in the month. - [Ext.Date.MONTH, 1/2]: on the 1st and 15th of every month. - [Ext.Date.MONTH, 1/3]: on the 1st, 10th and 20th of every month. - [Ext.Date.MONTH, 1/4]: on the 1st, 8th, 15th and 22nd of every month. * @param lockEnds Boolean If true, the 'from' and 'to' parameters will be used as fixed end values and will not be adjusted + * @returns Object The calculated step and ends info; properties are: - from: The result start value, which may be lower than the original start value - to: The result end value, which may be higher than the original end value - step: The fixed value size of each step, or undefined if the steps are not fixed. - steps: The number of steps if the steps are fixed, or an array of step values. NOTE: Even when the steps have a fixed value, they may not divide the from/to range perfectly evenly; there may be a smaller distance between the last step and the end value than between prior steps, particularly when the endsLocked param is true. Therefore it is best to not use the steps result when finding the axis tick points, instead use the step, to, and from to find the correct point for each tick. */ static snapEndsByDateAndStep( from?:any, to?:any, step?:any[], lockEnds?:boolean ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -15316,33 +16181,38 @@ declare module Ext.draw.engine { export class ImageExporter { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Exports the surface to an image * @param surface Ext.draw.Surface The surface to export * @param config Object The following config options are supported: + * @returns Boolean True if the surface was successfully sent to the server. */ static generate( surface?:Ext.draw.ISurface, config?:any ): boolean; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -15363,11 +16233,14 @@ declare module Ext.draw.engine { applyZIndex?( sprite?:Ext.draw.ISprite ): void; /** [Method] Destroys the surface */ destroy?(): void; - /** [Method] Get the region for the surface s canvas area */ + /** [Method] Get the region for the surface s canvas area + * @returns Ext.util.Region + */ getRegion?(): Ext.util.IRegion; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param sprite Ext.draw.Sprite The sprite to look into. * @param className String The CSS class to check for + * @returns Boolean True if the class exists, else false */ hasCls?( sprite?:Ext.draw.ISprite, className?:string ): boolean; /** [Method] Removes one or more CSS classes from the element @@ -15393,33 +16266,38 @@ declare module Ext.draw.engine { export class SvgExporter { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Exports the passed surface to a SVG string representation * @param surface Ext.draw.Surface The surface to export * @param config Object Any configuration for the export. Currently this is unused but may provide more options in the future + * @returns String The SVG as a string */ static generate( surface?:Ext.draw.ISurface, config?:any ): string; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -15501,10 +16379,9 @@ declare module Ext.draw { isSprite?: boolean; /** [Method] Adds one or more CSS classes to the element * @param className String/String[] The CSS class to add, or an array of classes + * @returns Ext.draw.Sprite this */ - addCls?( className?:any ): any; - addCls?( className?:string ): Ext.draw.ISprite; - addCls?( className?:string[] ): Ext.draw.ISprite; + addCls?( className?:any ): Ext.draw.ISprite; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true. For example: this.addEvents({ storeloaded: true, storecleared: true }); Or any number of event names as separate parameters. For example: this.addEvents('storeloaded', 'storecleared'); */ @@ -15514,6 +16391,7 @@ declare module Ext.draw { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -15522,12 +16400,12 @@ declare module Ext.draw { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Performs custom animation on this object * @param config Object Configuration for Ext.fx.Anim. Note that the to config is required. + * @returns Object this */ animate?( config?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ @@ -15539,35 +16417,39 @@ declare module Ext.draw { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - getActiveAnimation?(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - getActiveAnimation?(): boolean; - /** [Method] Retrieves the bounding box of the sprite */ + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + getActiveAnimation?(): any; + /** [Method] Retrieves the bounding box of the sprite + * @returns Object bbox + */ getBBox?(): any; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - hasActiveFx?(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - hasActiveFx?(): boolean; + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + hasActiveFx?(): any; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Hides the sprite * @param redraw Boolean Flag to immediately draw the change. + * @returns Ext.draw.Sprite this */ hide?( redraw?:boolean ): Ext.draw.ISprite; /** [Method] Shorthand for addManagedListener @@ -15576,42 +16458,44 @@ declare module Ext.draw { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - /** [Method] Redraws the sprite */ + /** [Method] Redraws the sprite + * @returns Ext.draw.Sprite this + */ redraw?(): Ext.draw.ISprite; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; - /** [Method] Removes the sprite */ + /** [Method] Removes the sprite + * @returns Boolean True if sprite was successfully removed. False when there was no surface to remove it from. + */ remove?(): boolean; /** [Method] Removes one or more CSS classes from the element * @param className String/String[] The CSS class to remove, or an array of classes. Note this method is severly limited in VML. + * @returns Ext.draw.Sprite this */ - removeCls?( className?:any ): any; - removeCls?( className?:string ): Ext.draw.ISprite; - removeCls?( className?:string[] ): Ext.draw.ISprite; + removeCls?( className?:any ): Ext.draw.ISprite; /** [Method] Removes an event handler * @param eventName String The type of event the handler was associated with. * @param fn Function The handler to remove. This must be a reference to the function passed into the Ext.util.Observable.addListener call. @@ -15624,34 +16508,41 @@ declare module Ext.draw { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ resumeEvent?( ...eventName:any[] ): void; /** [Method] Resumes firing events see suspendEvents */ resumeEvents?(): void; - /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence */ + /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence + * @returns Object this + */ sequenceFx?(): any; /** [Method] Change the attributes of the sprite * @param attrs Object attributes to be changed on the sprite. * @param redraw Boolean Flag to immediately draw the change. + * @returns Ext.draw.Sprite this */ setAttributes?( attrs?:any, redraw?:boolean ): Ext.draw.ISprite; /** [Method] Wrapper for setting style properties also takes single object parameter of multiple styles * @param property String/Object The style property to be set, or an object of multiple styles. * @param value String The value to apply to the given property, or null if an object was passed. + * @returns Ext.draw.Sprite this */ setStyle?( property?:any, value?:string ): Ext.draw.ISprite; /** [Method] Shows the sprite * @param redraw Boolean Flag to immediately draw the change. + * @returns Ext.draw.Sprite this */ show?( redraw?:boolean ): Ext.draw.ISprite; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ stopAnimation?(): Ext.IElement; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ stopFx?(): Ext.IElement; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. @@ -15661,7 +16552,9 @@ declare module Ext.draw { * @param queueSuspended Boolean Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events. */ suspendEvents?( queueSuspended?:boolean ): void; - /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently */ + /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently + * @returns Object this + */ syncFx?(): any; /** [Method] Shorthand for removeListener * @param eventName String The type of event the handler was associated with. @@ -15677,6 +16570,7 @@ declare module Ext.draw { createFrame?(): void; /** [Method] Returns a reference to the actual element to drag * @param e Object + * @returns HTMLElement the html element */ getDragEl?( e?:any ): HTMLElement; /** [Method] Abstract method called during the onMouseMove event while dragging an object @@ -15697,22 +16591,14 @@ declare module Ext.draw { width?: number; /** [Method] Adds a Sprite to the surface * @param args Ext.draw.Sprite[]/Ext.draw.Sprite... One or more Sprite objects or configs. + * @returns Ext.draw.Sprite[]/Ext.draw.Sprite The sprites added. */ add?( args?:any ): any; - add?( args?:Ext.draw.ISprite[] ): Ext.draw.ISprite[]; - add?( args:Ext.draw.ISprite ): Ext.draw.ISprite[]; - /** [Method] Adds a Sprite to the surface - * @param args Ext.draw.Sprite[]/Ext.draw.Sprite... One or more Sprite objects or configs. - */ - add?( args?:Ext.draw.ISprite[] ): Ext.draw.ISprite; - add?( args:Ext.draw.ISprite ): Ext.draw.ISprite; /** [Method] Adds one or more CSS classes to the element * @param sprite Object The sprite to add the class to. * @param className String/String[] The CSS class to add, or an array of classes */ - addCls?( sprite?:any, className?:any ): any; - addCls?( sprite?:any, className?:string ): void; - addCls?( sprite?:any, className?:string[] ): void; + addCls?( sprite?:any, className?:any ): void; /** [Method] Adds the specified events to the list of events which this Observable may fire * @param eventNames Object/String... Either an object with event names as properties with a value of true. For example: this.addEvents({ storeloaded: true, storecleared: true }); Or any number of event names as separate parameters. For example: this.addEvents('storeloaded', 'storecleared'); */ @@ -15726,6 +16612,7 @@ declare module Ext.draw { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -15734,10 +16621,9 @@ declare module Ext.draw { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -15747,27 +16633,29 @@ declare module Ext.draw { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Returns a new group or an existent group associated with the current surface * @param id String The unique identifier of the group. + * @returns Object The Ext.draw.CompositeSprite. */ getGroup?( id?:string ): any; /** [Method] Retrieves the id of this component */ getId?(): void; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -15776,30 +16664,29 @@ declare module Ext.draw { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes a given sprite from the surface optionally destroying the sprite in the process @@ -15815,9 +16702,7 @@ declare module Ext.draw { * @param sprite Object The sprite to remove the class from. * @param className String/String[] The CSS class to remove, or an array of classes */ - removeCls?( sprite?:any, className?:any ): any; - removeCls?( sprite?:any, className?:string ): void; - removeCls?( sprite?:any, className?:string[] ): void; + removeCls?( sprite?:any, className?:any ): void; /** [Method] Removes an event handler * @param eventName String The type of event the handler was associated with. * @param fn Function The handler to remove. This must be a reference to the function passed into the Ext.util.Observable.addListener call. @@ -15830,9 +16715,7 @@ declare module Ext.draw { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -15876,11 +16759,13 @@ declare module Ext.draw { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] Creates and returns a new concrete Surface instance appropriate for the current environment * @param config Object Initial configuration for the Surface instance * @param enginePriority String[] order of implementations to use; the first one that is available in the current environment will be used. Defaults to ['Svg', 'Vml']. + * @returns Object The created Surface or false. */ static create( config?:any, enginePriority?:string[] ): any; /** [Method] Create aliases for existing prototype methods @@ -15888,17 +16773,21 @@ declare module Ext.draw { * @param origin String/Object The original method name */ static createAlias( alias?:any, origin?:any ): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Exports a surface in a different format * @param surface Ext.draw.Surface The surface to export. * @param config Object The configuration to be passed to the exporter. See the export method for the appropriate exporter for the relevant configuration options + * @returns Object See the return types for the appropriate exporter */ static save( surface?:Ext.draw.ISurface, config?:any ): any; } @@ -15984,7 +16873,9 @@ declare module Ext { * @param remainVisible Boolean Override the default behavior and keep the editor visible after edit */ completeEdit?( remainVisible?:boolean ): void; - /** [Method] Gets the data value of the editor */ + /** [Method] Gets the data value of the editor + * @returns Object The data value + */ getValue?(): any; /** [Method] private */ onHide?(): void; @@ -16002,10 +16893,7 @@ declare module Ext { * @param el String/HTMLElement/Ext.Element The element to edit * @param value String A value to initialize the editor with. If a value is not provided, it defaults to the innerHTML of el. */ - startEdit?( el?:any, value?:any ): any; - startEdit?( el?:string, value?:string ): void; - startEdit?( el?:HTMLElement, value?:string ): void; - startEdit?( el?:Ext.IElement, value?:string ): void; + startEdit?( el?:any, value?:string ): void; } } declare module Ext { @@ -16049,6 +16937,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -16057,10 +16946,9 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -16070,26 +16958,31 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the target of this loader */ + /** [Method] Returns the target of this loader + * @returns Ext.Component The target or null if none exists. + */ getTarget?(): Ext.IComponent; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; - /** [Method] Checks whether the loader is automatically refreshing */ + /** [Method] Checks whether the loader is automatically refreshing + * @returns Boolean True if the loader is automatically refreshing + */ isAutoRefreshing?(): boolean; /** [Method] Loads new data from the server * @param options Object The options for the request. They can be any configuration option that can be specified for the class, with the exception of the target option. Note that any options passed to the method will override any class defaults. @@ -16101,30 +16994,29 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -16139,9 +17031,7 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -16151,10 +17041,7 @@ declare module Ext { /** [Method] Sets an Ext Element as the target of this loader * @param target String/HTMLElement/Ext.Element The element or its ID. */ - setTarget?( target?:any ): any; - setTarget?( target?:string ): void; - setTarget?( target?:HTMLElement ): void; - setTarget?( target?:Ext.IElement ): void; + setTarget?( target?:any ): void; /** [Method] Automatically refreshes the content over a specified period * @param interval Number The interval to refresh in ms. * @param options Object The options to pass to the load method. See load @@ -16458,7 +17345,9 @@ declare module Ext { ignore?: boolean; /** [Property] (Boolean) */ notify?: boolean; - /** [Method] Provides a custom string representation of the error object */ + /** [Method] Provides a custom string representation of the error object + * @returns String The error message. If raised from within the Ext 4 class system, the error message will also include the raising class and method names, if available. + */ toString?(): string; } export class Error { @@ -16483,41 +17372,39 @@ declare module Ext { * @param scope Object The scope (this reference) in which the handler function is executed. Defaults to the Element. * @param options Object An object containing handler configuration properties. This may contain any of the following properties (See Ext.Element.addListener for examples of how to use these options.): */ - static addListener( el?:any, eventName?:any, handler?:any, scope?:any, options?:any ): any; - static addListener( el?:string, eventName?:string, handler?:any, scope?:any, options?:any ): void; - static addListener( el?:Ext.IElement, eventName?:string, handler?:any, scope?:any, options?:any ): void; - static addListener( el?:HTMLElement, eventName?:string, handler?:any, scope?:any, options?:any ): void; - static addListener( el?:Window, eventName?:string, handler?:any, scope?:any, options?:any ): void; - static addListener( el?:string, eventName?:string, handler?:string, scope?:any, options?:any ): void; - static addListener( el?:Ext.IElement, eventName?:string, handler?:string, scope?:any, options?:any ): void; - static addListener( el?:HTMLElement, eventName?:string, handler?:string, scope?:any, options?:any ): void; - static addListener( el?:Window, eventName?:string, handler?:string, scope?:any, options?:any ): void; + static addListener( el?:any, eventName?:string, handler?:any, scope?:any, options?:any ): void; /** [Method] Get the id of the element * @param element HTMLElement/Ext.Element The element to get the id for. + * @returns String id + */ + static getId( element?:any ): string; + /** [Method] Indicates which event to use for getting key presses + * @returns String The appropriate event name. */ - static getId( element?:any ): any; - static getId( element?:HTMLElement ): string; - static getId( element?:Ext.IElement ): string; - /** [Method] Indicates which event to use for getting key presses */ static getKeyEvent(): string; /** [Method] Gets the x coordinate from the event * @param event Object The event + * @returns Number The x coordinate */ static getPageX( event?:any ): number; /** [Method] Gets the x amp y coordinate from the event * @param event Object The event + * @returns Number[] The x/y coordinate */ static getPageXY( event?:any ): number[]; /** [Method] Gets the y coordinate from the event * @param event Object The event + * @returns Number The y coordinate */ static getPageY( event?:any ): number; /** [Method] Gets the related target from the event * @param event Object The event + * @returns HTMLElement The related target. */ static getRelatedTarget( event?:any ): HTMLElement; /** [Method] Gets the target of the event * @param event Object The event + * @returns HTMLElement target */ static getTarget( event?:any ): HTMLElement; /** [Method] Appends an event handler to an element @@ -16527,15 +17414,7 @@ declare module Ext { * @param scope Object The scope (this reference) in which the handler function is executed. Defaults to the Element. * @param options Object An object containing handler configuration properties. This may contain any of the following properties (See Ext.Element.addListener for examples of how to use these options.): */ - static on( el?:any, eventName?:any, handler?:any, scope?:any, options?:any ): any; - static on( el?:string, eventName?:string, handler?:any, scope?:any, options?:any ): void; - static on( el?:Ext.IElement, eventName?:string, handler?:any, scope?:any, options?:any ): void; - static on( el?:HTMLElement, eventName?:string, handler?:any, scope?:any, options?:any ): void; - static on( el?:Window, eventName?:string, handler?:any, scope?:any, options?:any ): void; - static on( el?:string, eventName?:string, handler?:string, scope?:any, options?:any ): void; - static on( el?:Ext.IElement, eventName?:string, handler?:string, scope?:any, options?:any ): void; - static on( el?:HTMLElement, eventName?:string, handler?:string, scope?:any, options?:any ): void; - static on( el?:Window, eventName?:string, handler?:string, scope?:any, options?:any ): void; + static on( el?:any, eventName?:string, handler?:any, scope?:any, options?:any ): void; /** [Method] Adds a listener to be notified when the document is ready before onload and before images are loaded * @param fn Function The method the event invokes. * @param scope Object The scope (this reference) in which the handler function executes. Defaults to the browser window. @@ -16564,30 +17443,18 @@ declare module Ext { * @param el String/Ext.Element/HTMLElement/Window The id or html element from which to remove all event handlers. * @param eventName String The name of the event. */ - static purgeElement( el?:any, eventName?:any ): any; - static purgeElement( el?:string, eventName?:string ): void; - static purgeElement( el?:Ext.IElement, eventName?:string ): void; - static purgeElement( el?:HTMLElement, eventName?:string ): void; - static purgeElement( el?:Window, eventName?:string ): void; + static purgeElement( el?:any, eventName?:string ): void; /** [Method] Removes all event handers from an element * @param el String/Ext.Element/HTMLElement/Window The id or html element from which to remove all event handlers. */ - static removeAll( el?:any ): any; - static removeAll( el?:string ): void; - static removeAll( el?:Ext.IElement ): void; - static removeAll( el?:HTMLElement ): void; - static removeAll( el?:Window ): void; + static removeAll( el?:any ): void; /** [Method] Removes an event handler from an element * @param el String/Ext.Element/HTMLElement/Window The id or html element from which to remove the listener. * @param eventName String The name of the event. * @param fn Function The handler function to remove. This must be a reference to the function passed into the addListener call. * @param scope Object If a scope (this reference) was specified when the listener was added, then this must refer to the same object. */ - static removeListener( el?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeListener( el?:string, eventName?:string, fn?:any, scope?:any ): void; - static removeListener( el?:Ext.IElement, eventName?:string, fn?:any, scope?:any ): void; - static removeListener( el?:HTMLElement, eventName?:string, fn?:any, scope?:any ): void; - static removeListener( el?:Window, eventName?:string, fn?:any, scope?:any ): void; + static removeListener( el?:any, eventName?:string, fn?:any, scope?:any ): void; /** [Method] Removes the passed window resize listener * @param fn Function The method the event invokes * @param scope Object The scope of handler @@ -16612,11 +17479,7 @@ declare module Ext { * @param fn Function The handler function to remove. This must be a reference to the function passed into the addListener call. * @param scope Object If a scope (this reference) was specified when the listener was added, then this must refer to the same object. */ - static un( el?:any, eventName?:any, fn?:any, scope?:any ): any; - static un( el?:string, eventName?:string, fn?:any, scope?:any ): void; - static un( el?:Ext.IElement, eventName?:string, fn?:any, scope?:any ): void; - static un( el?:HTMLElement, eventName?:string, fn?:any, scope?:any ): void; - static un( el?:Window, eventName?:string, fn?:any, scope?:any ): void; + static un( el?:any, eventName?:string, fn?:any, scope?:any ): void; } } declare module Ext { @@ -16627,53 +17490,75 @@ declare module Ext { * @param delta Number The delta value. */ static correctWheelDelta( delta?:number ): void; - /** [Method] Gets the character code for the event */ + /** [Method] Gets the character code for the event + * @returns Number + */ static getCharCode(): number; - /** [Method] Returns a normalized keyCode for the event */ + /** [Method] Returns a normalized keyCode for the event + * @returns Number The key code + */ static getKey(): number; - /** [Method] Gets the x coordinate of the event */ + /** [Method] Gets the x coordinate of the event + * @returns Number + */ static getPageX(): number; - /** [Method] Gets the y coordinate of the event */ + /** [Method] Gets the y coordinate of the event + * @returns Number + */ static getPageY(): number; - /** [Method] Returns a point object that consists of the object coordinates */ + /** [Method] Returns a point object that consists of the object coordinates + * @returns Ext.util.Point point + */ static getPoint(): Ext.util.IPoint; /** [Method] Gets the related target * @param selector String A simple selector to filter the target or look for an ancestor of the target * @param maxDepth Number/HTMLElement The max depth to search as a number or element (defaults to 10 || document.body) * @param returnEl Boolean True to return a Ext.Element object instead of DOM node + * @returns HTMLElement */ - static getRelatedTarget( selector?:any, maxDepth?:any, returnEl?:any ): any; - static getRelatedTarget( selector?:string, maxDepth?:number, returnEl?:boolean ): HTMLElement; - static getRelatedTarget( selector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): HTMLElement; + static getRelatedTarget( selector?:string, maxDepth?:any, returnEl?:boolean ): HTMLElement; /** [Method] Gets the target for the event * @param selector String A simple selector to filter the target or look for an ancestor of the target * @param maxDepth Number/HTMLElement The max depth to search as a number or element (defaults to 10 || document.body) * @param returnEl Boolean True to return a Ext.Element object instead of DOM node + * @returns HTMLElement + */ + static getTarget( selector?:string, maxDepth?:any, returnEl?:boolean ): HTMLElement; + /** [Method] Normalizes mouse wheel y delta across browsers + * @returns Number The mouse wheel y-delta */ - static getTarget( selector?:any, maxDepth?:any, returnEl?:any ): any; - static getTarget( selector?:string, maxDepth?:number, returnEl?:boolean ): HTMLElement; - static getTarget( selector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): HTMLElement; - /** [Method] Normalizes mouse wheel y delta across browsers */ static getWheelDelta(): number; - /** [Method] Returns the mouse wheel deltas for this event */ + /** [Method] Returns the mouse wheel deltas for this event + * @returns Object An object with "x" and "y" properties holding the mouse wheel deltas. + */ static getWheelDeltas(): any; - /** [Method] Gets the x coordinate of the event */ + /** [Method] Gets the x coordinate of the event + * @returns Number + */ static getX(): number; - /** [Method] Gets the page coordinates of the event */ + /** [Method] Gets the page coordinates of the event + * @returns Number[] The xy values like [x, y] + */ static getXY(): number[]; - /** [Method] Gets the y coordinate of the event */ + /** [Method] Gets the y coordinate of the event + * @returns Number + */ static getY(): number; - /** [Method] Returns true if the control meta shift or alt key was pressed during this event */ + /** [Method] Returns true if the control meta shift or alt key was pressed during this event + * @returns Boolean + */ static hasModifier(): boolean; /** [Method] Injects a DOM event using the data in this object and optionally a new target * @param target Ext.Element/HTMLElement If specified, the target for the event. This is likely to be used when relaying a DOM event. If not specified, getTarget is used to determine the target. */ - static injectEvent( target?:any ): any; - static injectEvent( target?:Ext.IElement ): void; - static injectEvent( target?:HTMLElement ): void; - /** [Method] Checks if the key pressed was a navigation key */ + static injectEvent( target?:any ): void; + /** [Method] Checks if the key pressed was a navigation key + * @returns Boolean True if the press is a navigation keypress + */ static isNavKeyPress(): boolean; - /** [Method] Checks if the key pressed was a special key */ + /** [Method] Checks if the key pressed was a special key + * @returns Boolean True if the press is a special keypress + */ static isSpecialKey(): boolean; /** [Method] Prevents the browsers default handling of the event */ static preventDefault(): void; @@ -16685,11 +17570,9 @@ declare module Ext { * @param el String/HTMLElement/Ext.Element The id, DOM element or Ext.Element to check * @param related Boolean true to test if the related target is within el instead of the target * @param allowEl Boolean true to also check if the passed element is the target or related target + * @returns Boolean */ - static within( el?:any, related?:any, allowEl?:any ): any; - static within( el?:string, related?:boolean, allowEl?:boolean ): boolean; - static within( el?:HTMLElement, related?:boolean, allowEl?:boolean ): boolean; - static within( el?:Ext.IElement, related?:boolean, allowEl?:boolean ): boolean; + static within( el?:any, related?:boolean, allowEl?:boolean ): boolean; } } declare module Ext.flash { @@ -16781,6 +17664,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -16789,31 +17673,28 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds the specified xtype to the whitelist * @param xtype String/String[] Adds the xtype(s) to the whitelist. */ - static addXTypeToWhitelist( xtype?:any ): any; - static addXTypeToWhitelist( xtype?:string ): void; - static addXTypeToWhitelist( xtype?:string[] ): void; + static addXTypeToWhitelist( xtype?:any ): void; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ @@ -16827,29 +17708,32 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Shorthand for addManagedListener @@ -16858,30 +17742,29 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -16896,22 +17779,20 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Removes the specified xtype from the whitelist * @param xtype String/String[] Removes the xtype(s) from the whitelist. */ - static removeXTypeFromWhitelist( xtype?:any ): any; - static removeXTypeFromWhitelist( xtype?:string ): void; - static removeXTypeFromWhitelist( xtype?:string[] ): void; + static removeXTypeFromWhitelist( xtype?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ static resumeEvent( ...eventName:any[] ): void; /** [Method] Resumes firing events see suspendEvents */ static resumeEvents(): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. @@ -16942,6 +17823,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -16950,31 +17832,28 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds the specified xtype to the whitelist * @param xtype String/String[] Adds the xtype(s) to the whitelist. */ - static addXTypeToWhitelist( xtype?:any ): any; - static addXTypeToWhitelist( xtype?:string ): void; - static addXTypeToWhitelist( xtype?:string[] ): void; + static addXTypeToWhitelist( xtype?:any ): void; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ @@ -16988,29 +17867,32 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Shorthand for addManagedListener @@ -17019,30 +17901,29 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -17057,22 +17938,20 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Removes the specified xtype from the whitelist * @param xtype String/String[] Removes the xtype(s) from the whitelist. */ - static removeXTypeFromWhitelist( xtype?:any ): any; - static removeXTypeFromWhitelist( xtype?:string ): void; - static removeXTypeFromWhitelist( xtype?:string[] ): void; + static removeXTypeFromWhitelist( xtype?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ static resumeEvent( ...eventName:any[] ): void; /** [Method] Resumes firing events see suspendEvents */ static resumeEvents(): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. @@ -17254,80 +18133,103 @@ declare module Ext.form { owner?: Ext.container.IContainer; /** [Method] Calls Ext applyIf for all field in this form with the passed object * @param obj Object The object to be applied + * @returns Ext.form.Basic this */ applyIfToFields?( obj?:any ): Ext.form.IBasic; /** [Method] Calls Ext apply for all fields in this form with the passed object * @param obj Object The object to be applied + * @returns Ext.form.Basic this */ applyToFields?( obj?:any ): Ext.form.IBasic; /** [Method] Check whether the dirty state of the entire form has changed since it was last checked and if so fire the dirtychang */ checkDirty?(): void; /** [Method] Check whether the validity of the entire form has changed since it was last checked and if so fire the validitychang */ checkValidity?(): void; - /** [Method] Clears all invalid field messages in this form */ + /** [Method] Clears all invalid field messages in this form + * @returns Ext.form.Basic this + */ clearInvalid?(): Ext.form.IBasic; /** [Method] Destroys this object */ destroy?(): void; /** [Method] Performs a predefined action an implementation of Ext form action Action to perform application specific processing * @param action String/Ext.form.action.Action The name of the predefined action type, or instance of Ext.form.action.Action to perform. * @param options Object The options to pass to the Ext.form.action.Action that will get created, if the action argument is a String. All of the config options listed below are supported by both the submit and load actions unless otherwise noted (custom actions could also accept other config options): + * @returns Ext.form.Basic this */ - doAction?( action?:any, options?:any ): any; - doAction?( action?:string, options?:any ): Ext.form.IBasic; - doAction?( action?:Ext.form.action.IAction, options?:any ): Ext.form.IBasic; + doAction?( action?:any, options?:any ): Ext.form.IBasic; /** [Method] Find a specific Ext form field Field in this form by id or name * @param id String The value to search for (specify either a id or name or hiddenName). + * @returns any The first matching field, or null if none was found. */ findField?( id?:string ): any; /** [Method] Retrieves the fields in the form as a set of key value pairs using their getModelData method to collect the values * @param dirtyOnly Boolean If true, only fields that are dirty will be included in the result. + * @returns Object */ getFieldValues?( dirtyOnly?:boolean ): any; - /** [Method] Return all the Ext form field Field components in the owner container */ + /** [Method] Return all the Ext form field Field components in the owner container + * @returns Ext.util.MixedCollection Collection of the Field objects + */ getFields?(): Ext.util.IMixedCollection; - /** [Method] Returns the last Ext data Model instance that was loaded via loadRecord */ + /** [Method] Returns the last Ext data Model instance that was loaded via loadRecord + * @returns Ext.data.Model The record + */ getRecord?(): Ext.data.IModel; /** [Method] Retrieves the fields in the form as a set of key value pairs using their getSubmitData method to collect the values * @param asString Boolean If true, will return the key/value collection as a single URL-encoded param string. * @param dirtyOnly Boolean If true, only fields that are dirty will be included in the result. * @param includeEmptyText Boolean If true, the configured emptyText of empty fields will be used. * @param useDataValues Boolean If true, the getModelData method is used to retrieve values from fields, otherwise the getSubmitData method is used. + * @returns String/Object */ getValues?( asString?:boolean, dirtyOnly?:boolean, includeEmptyText?:boolean, useDataValues?:boolean ): any; /** [Method] Returns true if the form contains any invalid fields */ hasInvalidField?(): void; - /** [Method] Returns true if the form contains a file upload field */ + /** [Method] Returns true if the form contains a file upload field + * @returns Boolean + */ hasUpload?(): boolean; - /** [Method] Returns true if any fields in this form have changed from their original values */ + /** [Method] Returns true if any fields in this form have changed from their original values + * @returns Boolean + */ isDirty?(): boolean; - /** [Method] Returns true if client side validation on the form is successful */ + /** [Method] Returns true if client side validation on the form is successful + * @returns Boolean + */ isValid?(): boolean; /** [Method] Shortcut to do a load action * @param options Object The options to pass to the action (see doAction for details) + * @returns Ext.form.Basic this */ load?( options?:any ): Ext.form.IBasic; /** [Method] Loads an Ext data Model into this form by calling setValues with the record data * @param record Ext.data.Model The record to load + * @returns Ext.form.Basic this */ loadRecord?( record?:Ext.data.IModel ): Ext.form.IBasic; /** [Method] Mark fields in this form invalid in bulk * @param errors Object/Object[]/Ext.data.Errors Either an array in the form [{id:'fieldId', msg:'The message'}, ...], an object hash of {id: msg, id2: msg2}, or a Ext.data.Errors object. + * @returns Ext.form.Basic this */ markInvalid?( errors?:any ): Ext.form.IBasic; /** [Method] Resets all fields in this form * @param resetRecord Boolean True to unbind any record set by loadRecord + * @returns Ext.form.Basic this */ reset?( resetRecord?:boolean ): Ext.form.IBasic; /** [Method] Set values for fields in this form in bulk * @param values Object/Object[] Either an array in the form: [{id:'clientName', value:'Fred. Olsen Lines'}, {id:'portOfLoading', value:'FXT'}, {id:'portOfDischarge', value:'OSL'} ] or an object hash of the form: { clientName: 'Fred. Olsen Lines', portOfLoading: 'FXT', portOfDischarge: 'OSL' } + * @returns Ext.form.Basic this */ setValues?( values?:any ): Ext.form.IBasic; /** [Method] Shortcut to do a submit action * @param options Object The options to pass to the action (see doAction for details). + * @returns Ext.form.Basic this */ submit?( options?:any ): Ext.form.IBasic; /** [Method] Persists the values in this form into the passed Ext data Model object in a beginEdit endEdit block * @param record Ext.data.Model The record to edit + * @returns Ext.form.Basic this */ updateRecord?( record?:Ext.data.IModel ): Ext.form.IBasic; } @@ -17366,80 +18268,103 @@ declare module Ext.form { owner?: Ext.container.IContainer; /** [Method] Calls Ext applyIf for all field in this form with the passed object * @param obj Object The object to be applied + * @returns Ext.form.Basic this */ applyIfToFields?( obj?:any ): Ext.form.IBasic; /** [Method] Calls Ext apply for all fields in this form with the passed object * @param obj Object The object to be applied + * @returns Ext.form.Basic this */ applyToFields?( obj?:any ): Ext.form.IBasic; /** [Method] Check whether the dirty state of the entire form has changed since it was last checked and if so fire the dirtychang */ checkDirty?(): void; /** [Method] Check whether the validity of the entire form has changed since it was last checked and if so fire the validitychang */ checkValidity?(): void; - /** [Method] Clears all invalid field messages in this form */ + /** [Method] Clears all invalid field messages in this form + * @returns Ext.form.Basic this + */ clearInvalid?(): Ext.form.IBasic; /** [Method] Destroys this object */ destroy?(): void; /** [Method] Performs a predefined action an implementation of Ext form action Action to perform application specific processing * @param action String/Ext.form.action.Action The name of the predefined action type, or instance of Ext.form.action.Action to perform. * @param options Object The options to pass to the Ext.form.action.Action that will get created, if the action argument is a String. All of the config options listed below are supported by both the submit and load actions unless otherwise noted (custom actions could also accept other config options): + * @returns Ext.form.Basic this */ - doAction?( action?:any, options?:any ): any; - doAction?( action?:string, options?:any ): Ext.form.IBasic; - doAction?( action?:Ext.form.action.IAction, options?:any ): Ext.form.IBasic; + doAction?( action?:any, options?:any ): Ext.form.IBasic; /** [Method] Find a specific Ext form field Field in this form by id or name * @param id String The value to search for (specify either a id or name or hiddenName). + * @returns any The first matching field, or null if none was found. */ findField?( id?:string ): any; /** [Method] Retrieves the fields in the form as a set of key value pairs using their getModelData method to collect the values * @param dirtyOnly Boolean If true, only fields that are dirty will be included in the result. + * @returns Object */ getFieldValues?( dirtyOnly?:boolean ): any; - /** [Method] Return all the Ext form field Field components in the owner container */ + /** [Method] Return all the Ext form field Field components in the owner container + * @returns Ext.util.MixedCollection Collection of the Field objects + */ getFields?(): Ext.util.IMixedCollection; - /** [Method] Returns the last Ext data Model instance that was loaded via loadRecord */ + /** [Method] Returns the last Ext data Model instance that was loaded via loadRecord + * @returns Ext.data.Model The record + */ getRecord?(): Ext.data.IModel; /** [Method] Retrieves the fields in the form as a set of key value pairs using their getSubmitData method to collect the values * @param asString Boolean If true, will return the key/value collection as a single URL-encoded param string. * @param dirtyOnly Boolean If true, only fields that are dirty will be included in the result. * @param includeEmptyText Boolean If true, the configured emptyText of empty fields will be used. * @param useDataValues Boolean If true, the getModelData method is used to retrieve values from fields, otherwise the getSubmitData method is used. + * @returns String/Object */ getValues?( asString?:boolean, dirtyOnly?:boolean, includeEmptyText?:boolean, useDataValues?:boolean ): any; /** [Method] Returns true if the form contains any invalid fields */ hasInvalidField?(): void; - /** [Method] Returns true if the form contains a file upload field */ + /** [Method] Returns true if the form contains a file upload field + * @returns Boolean + */ hasUpload?(): boolean; - /** [Method] Returns true if any fields in this form have changed from their original values */ + /** [Method] Returns true if any fields in this form have changed from their original values + * @returns Boolean + */ isDirty?(): boolean; - /** [Method] Returns true if client side validation on the form is successful */ + /** [Method] Returns true if client side validation on the form is successful + * @returns Boolean + */ isValid?(): boolean; /** [Method] Shortcut to do a load action * @param options Object The options to pass to the action (see doAction for details) + * @returns Ext.form.Basic this */ load?( options?:any ): Ext.form.IBasic; /** [Method] Loads an Ext data Model into this form by calling setValues with the record data * @param record Ext.data.Model The record to load + * @returns Ext.form.Basic this */ loadRecord?( record?:Ext.data.IModel ): Ext.form.IBasic; /** [Method] Mark fields in this form invalid in bulk * @param errors Object/Object[]/Ext.data.Errors Either an array in the form [{id:'fieldId', msg:'The message'}, ...], an object hash of {id: msg, id2: msg2}, or a Ext.data.Errors object. + * @returns Ext.form.Basic this */ markInvalid?( errors?:any ): Ext.form.IBasic; /** [Method] Resets all fields in this form * @param resetRecord Boolean True to unbind any record set by loadRecord + * @returns Ext.form.Basic this */ reset?( resetRecord?:boolean ): Ext.form.IBasic; /** [Method] Set values for fields in this form in bulk * @param values Object/Object[] Either an array in the form: [{id:'clientName', value:'Fred. Olsen Lines'}, {id:'portOfLoading', value:'FXT'}, {id:'portOfDischarge', value:'OSL'} ] or an object hash of the form: { clientName: 'Fred. Olsen Lines', portOfLoading: 'FXT', portOfDischarge: 'OSL' } + * @returns Ext.form.Basic this */ setValues?( values?:any ): Ext.form.IBasic; /** [Method] Shortcut to do a submit action * @param options Object The options to pass to the action (see doAction for details). + * @returns Ext.form.Basic this */ submit?( options?:any ): Ext.form.IBasic; /** [Method] Persists the values in this form into the passed Ext data Model object in a beginEdit endEdit block * @param record Ext.data.Model The record to edit + * @returns Ext.form.Basic this */ updateRecord?( record?:Ext.data.IModel ): Ext.form.IBasic; } @@ -17474,17 +18399,29 @@ declare module Ext.form { checkDirty?(): void; /** [Method] Clear any invalid styles messages for this field */ clearInvalid?(): void; - /** [Method] Only relevant if the instance s isFileUpload method returns true */ + /** [Method] Only relevant if the instance s isFileUpload method returns true + * @returns HTMLElement + */ extractFileInput?(): HTMLElement; - /** [Method] Returns an Array of all checkboxes in the container which are currently checked */ + /** [Method] Returns an Array of all checkboxes in the container which are currently checked + * @returns Ext.form.field.Checkbox[] Array of Ext.form.field.Checkbox components + */ getChecked?(): Ext.form.field.ICheckbox[]; - /** [Method] Runs CheckboxGroup s validations and returns an array of any errors */ + /** [Method] Runs CheckboxGroup s validations and returns an array of any errors + * @returns String[] Array of all validation errors + */ getErrors?(): string[]; - /** [Method] Don t return any data for the model the form will get the info from the individual checkboxes themselves */ + /** [Method] Don t return any data for the model the form will get the info from the individual checkboxes themselves + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getModelData?(): any; - /** [Method] Returns the name attribute of the field */ + /** [Method] Returns the name attribute of the field + * @returns String name The field name + */ getName?(): string; - /** [Method] Don t return any data for submit the form will get the info from the individual checkboxes themselves */ + /** [Method] Don t return any data for submit the form will get the info from the individual checkboxes themselves + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getSubmitData?(): any; /** [Method] Returns an object containing the values of all checked checkboxes within the group */ getValue?(): void; @@ -17492,23 +18429,28 @@ declare module Ext.form { initField?(): void; /** [Method] Initializes the field s value based on the initial config */ initValue?(): void; - /** [Method] private override */ + /** [Method] private override + * @returns Boolean True if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; /** [Method] private override the group value is a complex object compare using object serialization * @param value1 Object * @param value2 Object + * @returns Boolean True if the values are equal, false if inequal. */ isEqual?( value1?:any, value2?:any ): boolean; - /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti */ + /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti + * @returns Boolean + */ isFileUpload?(): boolean; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value + * @returns Boolean True if the value is valid, else false + */ isValid?(): boolean; /** [Method] Associate one or more error messages with this field * @param errors String/String[] The error message(s) for the field. */ - markInvalid?( errors?:any ): any; - markInvalid?( errors?:string ): void; - markInvalid?( errors?:string[] ): void; + markInvalid?( errors?:any ): void; /** [Method] When a checkbox is added to the group monitor it for changes * @param field Object */ @@ -17523,13 +18465,17 @@ declare module Ext.form { resetOriginalValue?(): void; /** [Method] Sets the value s of all checkboxes in the group * @param value Object The mapping of checkbox names to values. + * @returns Ext.form.CheckboxGroup this */ setValue?( value?:any ): Ext.form.ICheckboxGroup; /** [Method] Allows for any necessary modifications before the original value is set * @param value Object The initial value + * @returns Object The modified initial value */ transformOriginalValue?( value?:any ): any; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali + * @returns Boolean True if the value is valid, else false + */ validate?(): boolean; } } @@ -17540,6 +18486,7 @@ declare module Ext.form { /** [Method] Adds an item to the collection * @param key String/Object The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param obj Object The item to add. + * @returns Object The item added. */ static add( key?:any, obj?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -17555,6 +18502,7 @@ declare module Ext.form { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -17563,45 +18511,49 @@ declare module Ext.form { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all items from the collection */ static clear(): void; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ static clearManagedListeners(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ static clone(): Ext.util.IMixedCollection; /** [Method] Collects unique values of a particular property in this MixedCollection * @param property String The property to collect on * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param allowBlank Boolean Pass true to allow null, undefined or empty string values + * @returns Array The unique values */ static collect( property?:string, root?:string, allowBlank?:boolean ): any[]; /** [Method] Returns true if the collection contains the passed Object as an item * @param o Object The Object to look for in the collection. + * @returns Boolean True if the collection contains the Object as an item. */ static contains( o?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean True if the collection contains the Object as a key. */ static containsKey( key?:string ): boolean; /** [Method] Executes the specified function once for every item in the collection @@ -17617,23 +18569,19 @@ declare module Ext.form { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Filters the objects in this collection by a set of Filters or by a single property value pair with optional paramete * @param property Ext.util.Filter[]/String A property on your objects, or an array of Filter objects * @param value String/RegExp Either string that the property values should start with or a RegExp to test against the property * @param anyMatch Boolean True to match any part of the string, not just the beginning * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Ext.util.MixedCollection The new filtered collection */ - static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any; - static filter( property?:Ext.util.IFilter[], value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:Ext.util.IFilter[], value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; + static filter( property?:any, value?:any, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ static filterBy( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function */ @@ -17641,6 +18589,7 @@ declare module Ext.form { /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function, or null if none was found. */ static findBy( fn?:any, scope?:any ): any; /** [Method] Finds the index of the first matching object in this collection by a specific property value @@ -17649,82 +18598,97 @@ declare module Ext.form { * @param start Number The index to start searching at. * @param anyMatch Boolean True to match any part of the string, not just the beginning. * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Number The matched index or -1 */ - static findIndex( property?:any, value?:any, start?:any, anyMatch?:any, caseSensitive?:any ): any; - static findIndex( property?:string, value?:string, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; - static findIndex( property?:string, value?:RegExp, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; + static findIndex( property?:string, value?:any, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index or -1 */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] Calculates the insertion index of the new item based upon the comparison function passed or the current sort order * @param newItem Object The new object to find the insertion position of. * @param sorterFn Function The function to sort by. This is the same as the sorting function passed to sortBy. It accepts 2 items from this MixedCollection, and returns -1 0, or 1 depending on the relative sort positions of the 2 compared items. If omitted, a function generated from the currently defined set of sorters will be used. + * @returns Number The insertion point to add the new item into this MixedCollection at using insert */ static findInsertionIndex( newItem?:any, sorterFn?:any ): number; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection.. + */ static first(): any; /** [Method] Returns a comparator function which compares two items and returns 1 0 or 1 depending on the currently defined set */ static generateComparator(): void; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ static get( key?:any ): any; - static get( key?:string ): any; - static get( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ static getAt( index?:number ): any; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ static getByKey( key?:any ): any; - static getByKey( key?:string ): any; - static getByKey( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ static getCount(): number; - /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place */ + /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place + * @returns Ext.util.Sorter The sorter, null if none exist + */ static getFirstSorter(): Ext.util.ISorter; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] A function which will be called passing a newly added object when the object is added without a separate id * @param item Object The item for which to find the key. + * @returns Object The key for the passed item. */ static getKey( item?:any ): any; /** [Method] Returns a range of items in this collection * @param startIndex Number The starting index. Defaults to 0. * @param endIndex Number The ending index. Defaults to the last item. + * @returns Array An array of items */ static getRange( startIndex?:number, endIndex?:number ): any[]; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Returns index within the collection of the passed Object * @param o Object The item to find the index of. + * @returns Number index of the item. Returns -1 if not found. */ static indexOf( o?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number index of the key. */ static indexOfKey( key?:string ): number; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Performs initialization of this mixin */ @@ -17733,9 +18697,12 @@ declare module Ext.form { * @param index Number The index to insert the item at. * @param key String/Object/String[]/Object[] The key to associate with the new item, or the item itself. May also be an array of either to insert multiple items at once. * @param o Object/Object[] If the second parameter was a key, the new item. May also be an array to insert multiple items at once. + * @returns Object The item inserted or an array of items inserted. */ static insert( index?:number, key?:any, o?:any ): any; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection.. + */ static last(): any; /** [Method] Shorthand for addManagedListener * @param item Ext.util.Observable/Ext.Element The item to which to add a listener/listeners. @@ -17743,46 +18710,49 @@ declare module Ext.form { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Remove an item from the collection * @param o Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( o?:any ): any; /** [Method] Remove all items in the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ static removeAll( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ static removeAt( index?:number ): any; /** [Method] Removes an item associated with the passed key fom the collection * @param key String The key of the item to remove. If null is passed, all objects which yielded no key from the configured getKey function are removed. + * @returns Object Only returned if removing at a specified key. The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] Removes an event handler @@ -17797,12 +18767,11 @@ declare module Ext.form { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Remove a range of items starting at a specified index in the collection * @param index Number The index within the collection of the item to remove. * @param removeCount Number The nuber of items to remove beginning at the specified index. + * @returns Object The last item removed or false if no item was removed. */ static removeRange( index?:number, removeCount?:number ): any; /** [Method] Reorders each of the items based on a mapping from old index to new index @@ -17812,6 +18781,7 @@ declare module Ext.form { /** [Method] Replaces an item in the collection * @param key String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param o Object {Object} o (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( key?:string, o?:any ): any; /** [Method] Resumes firing of the named event s @@ -17823,10 +18793,9 @@ declare module Ext.form { /** [Method] Sorts the data in the Store by one or more of its properties * @param sorters String/Ext.util.Sorter[] Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations. * @param direction String The overall direction to sort the data by. + * @returns Ext.util.Sorter[] */ - static sort( sorters?:any, direction?:any ): any; - static sort( sorters?:string, direction?:string ): Ext.util.ISorter[]; - static sort( sorters?:Ext.util.ISorter[], direction?:string ): Ext.util.ISorter[]; + static sort( sorters?:any, direction?:string ): Ext.util.ISorter[]; /** [Method] Sorts the collection by a single sorter function * @param sorterFn Function The function to sort by */ @@ -17836,13 +18805,16 @@ declare module Ext.form { * @param fn Function Comparison function that defines the sort order. Defaults to sorting by case insensitive string. */ static sortByKey( direction?:string, fn?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Collects all of the values of the given property and returns their sum * @param property String The property to sum by * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param start Number The record index to start at * @param end Number The record index to end at + * @returns Number The total */ static sum( property?:string, root?:string, start?:number, end?:number ): number; /** [Method] Suspends firing of the named event s @@ -17918,45 +18890,74 @@ declare module Ext.form.field { checkDirty?(): void; /** [Method] Clear any invalid styles messages for this field */ clearInvalid?(): void; - /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t */ + /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t + * @returns Ext.container.Container this + */ doComponentLayout?(): Ext.container.IContainer; - /** [Method] Only relevant if the instance s isFileUpload method returns true */ + /** [Method] Only relevant if the instance s isFileUpload method returns true + * @returns HTMLElement + */ extractFileInput?(): HTMLElement; - /** [Method] Gets the active error message for this component if any */ + /** [Method] Gets the active error message for this component if any + * @returns String The active error message on the component; if there is no error, an empty string is returned. + */ getActiveError?(): string; - /** [Method] Gets an Array of any active error messages currently applied to the field */ + /** [Method] Gets an Array of any active error messages currently applied to the field + * @returns String[] The active error messages on the component; if there are no errors, an empty Array is returned. + */ getActiveErrors?(): string[]; /** [Method] Runs this field s validators and returns an array of error messages for any validation failures * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All error messages for this field; an empty Array if none. */ getErrors?( value?:any ): string[]; - /** [Method] Returns the label for the field */ + /** [Method] Returns the label for the field + * @returns String The configured field label, or empty string if not defined + */ getFieldLabel?(): string; - /** [Method] Returns the input id for this field */ - getInputId?(): void; - /** [Method] Gets the width of the label if visible */ + /** [Method] Gets the width of the label if visible + * @returns Number The label width + */ getLabelWidth?(): number; - /** [Method] Generates the arguments for the field decorations rendering template */ + /** [Method] Generates the arguments for the field decorations rendering template + * @returns Object The template arguments + */ getLabelableRenderData?(): any; - /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ + /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getModelData?(): any; - /** [Method] Returns the name attribute of the field */ + /** [Method] Returns the name attribute of the field + * @returns String name The field name + */ getName?(): string; - /** [Method] Returns the raw value of the field without performing any normalization conversion or validation */ + /** [Method] Returns the raw value of the field without performing any normalization conversion or validation + * @returns any value The raw String value of the field + */ getRawValue?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Gets the markup to be inserted into the outer template s bodyEl */ - getSubTplMarkup?(): void; - /** [Method] private override to use getSubmitValue as a convenience */ + /** [Method] private override to use getSubmitValue as a convenience + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getSubmitData?(): any; - /** [Method] Returns the value that would be included in a standard form submit for this field */ + /** [Method] Returns the value that would be included in a standard form submit for this field + * @returns any The value to be submitted, or null. + */ getSubmitValue?(): any; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; - /** [Method] Tells whether the field currently has an active error message */ + /** [Method] Tells whether the field currently has an active error message + * @returns Boolean + */ hasActiveError?(): boolean; - /** [Method] Checks if the field has a visible label */ + /** [Method] Checks if the field has a visible label + * @returns Boolean True if the field has a visible label + */ hasVisibleLabel?(): boolean; /** [Method] private */ initComponent?(): void; @@ -17966,27 +18967,34 @@ declare module Ext.form.field { initField?(): void; /** [Method] Performs initialization of this mixin */ initLabelable?(): void; - /** [Method] Initialized the renderData to be used when rendering the renderTpl */ + /** [Method] Initialized the renderData to be used when rendering the renderTpl + * @returns Object Object with keys and values that are going to be applied to the renderTpl + */ initRenderData?(): any; /** [Method] Initializes the field s value based on the initial config */ initValue?(): void; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean True if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; /** [Method] Returns whether two field values are logically equal * @param value1 Object The first value to compare * @param value2 Object The second value to compare + * @returns Boolean True if the values are equal, false if inequal. */ isEqual?( value1?:any, value2?:any ): boolean; - /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti */ + /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti + * @returns Boolean + */ isFileUpload?(): boolean; - /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field */ + /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field + * @returns Boolean True if the value is valid, else false + */ isValid?(): boolean; /** [Method] Display one or more error messages associated with this field using msgTarget to determine how to display the messag * @param errors String/String[] The validation message(s) to display. */ - markInvalid?( errors?:any ): any; - markInvalid?( errors?:string ): void; - markInvalid?( errors?:string[] ): void; + markInvalid?( errors?:any ): void; /** [Method] private */ onDisable?(): void; /** [Method] private */ @@ -17995,10 +19003,12 @@ declare module Ext.form.field { onRender?(): void; /** [Method] Performs any necessary manipulation of a raw field value to prepare it for conversion and or validation for instance * @param value Object The unprocessed string value + * @returns Object The processed string value */ processRawValue?( value?:any ): any; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Resets the current field value to the originally loaded value and clears any validation messages */ @@ -18027,6 +19037,7 @@ declare module Ext.form.field { setFieldStyle?( style?:any ): void; /** [Method] Sets the field s raw value directly bypassing value conversion change detection and validation * @param value Object The value to set + * @returns Object value The field value that is set */ setRawValue?( value?:any ): any; /** [Method] Sets the read only state of this field @@ -18035,28 +19046,37 @@ declare module Ext.form.field { setReadOnly?( readOnly?:boolean ): void; /** [Method] Sets a data value into the field and runs the change detection and validation * @param value Object The value to set + * @returns any this */ setValue?( value?:any ): any; /** [Method] Allows for any necessary modifications before the original value is set * @param value Object The initial value + * @returns Object The modified initial value */ transformOriginalValue?( value?:any ): any; /** [Method] Transform the raw value before it is set * @param value Object The value + * @returns Object The value to set */ transformRawValue?( value?:any ): any; - /** [Method] Returns the trimmed label by slicing off the label separator character */ + /** [Method] Returns the trimmed label by slicing off the label separator character + * @returns String The trimmed field label, or empty string if not defined + */ trimLabelSeparator?(): string; /** [Method] Clears the active error message s */ unsetActiveError?(): void; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali + * @returns Boolean True if the value is valid, else false + */ validate?(): boolean; /** [Method] Uses getErrors to build an array of validation errors * @param value Object The value to validate + * @returns Boolean True if all validations passed, false if one or more failed */ validateValue?( value?:any ): boolean; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object The mixed-type value to convert to the raw representation. + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -18113,45 +19133,74 @@ declare module Ext.form { checkDirty?(): void; /** [Method] Clear any invalid styles messages for this field */ clearInvalid?(): void; - /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t */ + /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t + * @returns Ext.container.Container this + */ doComponentLayout?(): Ext.container.IContainer; - /** [Method] Only relevant if the instance s isFileUpload method returns true */ + /** [Method] Only relevant if the instance s isFileUpload method returns true + * @returns HTMLElement + */ extractFileInput?(): HTMLElement; - /** [Method] Gets the active error message for this component if any */ + /** [Method] Gets the active error message for this component if any + * @returns String The active error message on the component; if there is no error, an empty string is returned. + */ getActiveError?(): string; - /** [Method] Gets an Array of any active error messages currently applied to the field */ + /** [Method] Gets an Array of any active error messages currently applied to the field + * @returns String[] The active error messages on the component; if there are no errors, an empty Array is returned. + */ getActiveErrors?(): string[]; /** [Method] Runs this field s validators and returns an array of error messages for any validation failures * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All error messages for this field; an empty Array if none. */ getErrors?( value?:any ): string[]; - /** [Method] Returns the label for the field */ + /** [Method] Returns the label for the field + * @returns String The configured field label, or empty string if not defined + */ getFieldLabel?(): string; - /** [Method] Returns the input id for this field */ - getInputId?(): void; - /** [Method] Gets the width of the label if visible */ + /** [Method] Gets the width of the label if visible + * @returns Number The label width + */ getLabelWidth?(): number; - /** [Method] Generates the arguments for the field decorations rendering template */ + /** [Method] Generates the arguments for the field decorations rendering template + * @returns Object The template arguments + */ getLabelableRenderData?(): any; - /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ + /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getModelData?(): any; - /** [Method] Returns the name attribute of the field */ + /** [Method] Returns the name attribute of the field + * @returns String name The field name + */ getName?(): string; - /** [Method] Returns the raw value of the field without performing any normalization conversion or validation */ + /** [Method] Returns the raw value of the field without performing any normalization conversion or validation + * @returns any value The raw String value of the field + */ getRawValue?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Gets the markup to be inserted into the outer template s bodyEl */ - getSubTplMarkup?(): void; - /** [Method] private override to use getSubmitValue as a convenience */ + /** [Method] private override to use getSubmitValue as a convenience + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getSubmitData?(): any; - /** [Method] Returns the value that would be included in a standard form submit for this field */ + /** [Method] Returns the value that would be included in a standard form submit for this field + * @returns any The value to be submitted, or null. + */ getSubmitValue?(): any; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; - /** [Method] Tells whether the field currently has an active error message */ + /** [Method] Tells whether the field currently has an active error message + * @returns Boolean + */ hasActiveError?(): boolean; - /** [Method] Checks if the field has a visible label */ + /** [Method] Checks if the field has a visible label + * @returns Boolean True if the field has a visible label + */ hasVisibleLabel?(): boolean; /** [Method] private */ initComponent?(): void; @@ -18161,27 +19210,34 @@ declare module Ext.form { initField?(): void; /** [Method] Performs initialization of this mixin */ initLabelable?(): void; - /** [Method] Initialized the renderData to be used when rendering the renderTpl */ + /** [Method] Initialized the renderData to be used when rendering the renderTpl + * @returns Object Object with keys and values that are going to be applied to the renderTpl + */ initRenderData?(): any; /** [Method] Initializes the field s value based on the initial config */ initValue?(): void; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean True if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; /** [Method] Returns whether two field values are logically equal * @param value1 Object The first value to compare * @param value2 Object The second value to compare + * @returns Boolean True if the values are equal, false if inequal. */ isEqual?( value1?:any, value2?:any ): boolean; - /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti */ + /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti + * @returns Boolean + */ isFileUpload?(): boolean; - /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field */ + /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field + * @returns Boolean True if the value is valid, else false + */ isValid?(): boolean; /** [Method] Display one or more error messages associated with this field using msgTarget to determine how to display the messag * @param errors String/String[] The validation message(s) to display. */ - markInvalid?( errors?:any ): any; - markInvalid?( errors?:string ): void; - markInvalid?( errors?:string[] ): void; + markInvalid?( errors?:any ): void; /** [Method] private */ onDisable?(): void; /** [Method] private */ @@ -18190,10 +19246,12 @@ declare module Ext.form { onRender?(): void; /** [Method] Performs any necessary manipulation of a raw field value to prepare it for conversion and or validation for instance * @param value Object The unprocessed string value + * @returns Object The processed string value */ processRawValue?( value?:any ): any; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Resets the current field value to the originally loaded value and clears any validation messages */ @@ -18222,6 +19280,7 @@ declare module Ext.form { setFieldStyle?( style?:any ): void; /** [Method] Sets the field s raw value directly bypassing value conversion change detection and validation * @param value Object The value to set + * @returns Object value The field value that is set */ setRawValue?( value?:any ): any; /** [Method] Sets the read only state of this field @@ -18230,28 +19289,37 @@ declare module Ext.form { setReadOnly?( readOnly?:boolean ): void; /** [Method] Sets a data value into the field and runs the change detection and validation * @param value Object The value to set + * @returns any this */ setValue?( value?:any ): any; /** [Method] Allows for any necessary modifications before the original value is set * @param value Object The initial value + * @returns Object The modified initial value */ transformOriginalValue?( value?:any ): any; /** [Method] Transform the raw value before it is set * @param value Object The value + * @returns Object The value to set */ transformRawValue?( value?:any ): any; - /** [Method] Returns the trimmed label by slicing off the label separator character */ + /** [Method] Returns the trimmed label by slicing off the label separator character + * @returns String The trimmed field label, or empty string if not defined + */ trimLabelSeparator?(): string; /** [Method] Clears the active error message s */ unsetActiveError?(): void; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali + * @returns Boolean True if the value is valid, else false + */ validate?(): boolean; /** [Method] Uses getErrors to build an array of validation errors * @param value Object The value to validate + * @returns Boolean True if all validations passed, false if one or more failed */ validateValue?( value?:any ): boolean; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object The mixed-type value to convert to the raw representation. + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -18308,45 +19376,74 @@ declare module Ext.form { checkDirty?(): void; /** [Method] Clear any invalid styles messages for this field */ clearInvalid?(): void; - /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t */ + /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t + * @returns Ext.container.Container this + */ doComponentLayout?(): Ext.container.IContainer; - /** [Method] Only relevant if the instance s isFileUpload method returns true */ + /** [Method] Only relevant if the instance s isFileUpload method returns true + * @returns HTMLElement + */ extractFileInput?(): HTMLElement; - /** [Method] Gets the active error message for this component if any */ + /** [Method] Gets the active error message for this component if any + * @returns String The active error message on the component; if there is no error, an empty string is returned. + */ getActiveError?(): string; - /** [Method] Gets an Array of any active error messages currently applied to the field */ + /** [Method] Gets an Array of any active error messages currently applied to the field + * @returns String[] The active error messages on the component; if there are no errors, an empty Array is returned. + */ getActiveErrors?(): string[]; /** [Method] Runs this field s validators and returns an array of error messages for any validation failures * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All error messages for this field; an empty Array if none. */ getErrors?( value?:any ): string[]; - /** [Method] Returns the label for the field */ + /** [Method] Returns the label for the field + * @returns String The configured field label, or empty string if not defined + */ getFieldLabel?(): string; - /** [Method] Returns the input id for this field */ - getInputId?(): void; - /** [Method] Gets the width of the label if visible */ + /** [Method] Gets the width of the label if visible + * @returns Number The label width + */ getLabelWidth?(): number; - /** [Method] Generates the arguments for the field decorations rendering template */ + /** [Method] Generates the arguments for the field decorations rendering template + * @returns Object The template arguments + */ getLabelableRenderData?(): any; - /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ + /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getModelData?(): any; - /** [Method] Returns the name attribute of the field */ + /** [Method] Returns the name attribute of the field + * @returns String name The field name + */ getName?(): string; - /** [Method] Returns the raw value of the field without performing any normalization conversion or validation */ + /** [Method] Returns the raw value of the field without performing any normalization conversion or validation + * @returns any value The raw String value of the field + */ getRawValue?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Gets the markup to be inserted into the outer template s bodyEl */ - getSubTplMarkup?(): void; - /** [Method] private override to use getSubmitValue as a convenience */ + /** [Method] private override to use getSubmitValue as a convenience + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getSubmitData?(): any; - /** [Method] Returns the value that would be included in a standard form submit for this field */ + /** [Method] Returns the value that would be included in a standard form submit for this field + * @returns any The value to be submitted, or null. + */ getSubmitValue?(): any; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; - /** [Method] Tells whether the field currently has an active error message */ + /** [Method] Tells whether the field currently has an active error message + * @returns Boolean + */ hasActiveError?(): boolean; - /** [Method] Checks if the field has a visible label */ + /** [Method] Checks if the field has a visible label + * @returns Boolean True if the field has a visible label + */ hasVisibleLabel?(): boolean; /** [Method] private */ initComponent?(): void; @@ -18356,27 +19453,34 @@ declare module Ext.form { initField?(): void; /** [Method] Performs initialization of this mixin */ initLabelable?(): void; - /** [Method] Initialized the renderData to be used when rendering the renderTpl */ + /** [Method] Initialized the renderData to be used when rendering the renderTpl + * @returns Object Object with keys and values that are going to be applied to the renderTpl + */ initRenderData?(): any; /** [Method] Initializes the field s value based on the initial config */ initValue?(): void; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean True if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; /** [Method] Returns whether two field values are logically equal * @param value1 Object The first value to compare * @param value2 Object The second value to compare + * @returns Boolean True if the values are equal, false if inequal. */ isEqual?( value1?:any, value2?:any ): boolean; - /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti */ + /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti + * @returns Boolean + */ isFileUpload?(): boolean; - /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field */ + /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field + * @returns Boolean True if the value is valid, else false + */ isValid?(): boolean; /** [Method] Display one or more error messages associated with this field using msgTarget to determine how to display the messag * @param errors String/String[] The validation message(s) to display. */ - markInvalid?( errors?:any ): any; - markInvalid?( errors?:string ): void; - markInvalid?( errors?:string[] ): void; + markInvalid?( errors?:any ): void; /** [Method] private */ onDisable?(): void; /** [Method] private */ @@ -18385,10 +19489,12 @@ declare module Ext.form { onRender?(): void; /** [Method] Performs any necessary manipulation of a raw field value to prepare it for conversion and or validation for instance * @param value Object The unprocessed string value + * @returns Object The processed string value */ processRawValue?( value?:any ): any; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Resets the current field value to the originally loaded value and clears any validation messages */ @@ -18417,6 +19523,7 @@ declare module Ext.form { setFieldStyle?( style?:any ): void; /** [Method] Sets the field s raw value directly bypassing value conversion change detection and validation * @param value Object The value to set + * @returns Object value The field value that is set */ setRawValue?( value?:any ): any; /** [Method] Sets the read only state of this field @@ -18425,28 +19532,37 @@ declare module Ext.form { setReadOnly?( readOnly?:boolean ): void; /** [Method] Sets a data value into the field and runs the change detection and validation * @param value Object The value to set + * @returns any this */ setValue?( value?:any ): any; /** [Method] Allows for any necessary modifications before the original value is set * @param value Object The initial value + * @returns Object The modified initial value */ transformOriginalValue?( value?:any ): any; /** [Method] Transform the raw value before it is set * @param value Object The value + * @returns Object The value to set */ transformRawValue?( value?:any ): any; - /** [Method] Returns the trimmed label by slicing off the label separator character */ + /** [Method] Returns the trimmed label by slicing off the label separator character + * @returns String The trimmed field label, or empty string if not defined + */ trimLabelSeparator?(): string; /** [Method] Clears the active error message s */ unsetActiveError?(): void; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali + * @returns Boolean True if the value is valid, else false + */ validate?(): boolean; /** [Method] Uses getErrors to build an array of validation errors * @param value Object The value to validate + * @returns Boolean True if all validations passed, false if one or more failed */ validateValue?( value?:any ): boolean; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object The mixed-type value to convert to the raw representation. + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -18497,13 +19613,21 @@ declare module Ext.form.field { originalValue?: any; /** [Method] inherit docs */ beforeDestroy?(): void; - /** [Method] Returns the checked state of the checkbox */ + /** [Method] Returns the checked state of the checkbox + * @returns Boolean True if checked, else false + */ getRawValue?(): boolean; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ + /** [Method] Returns the submit value for the checkbox which can be used when submitting forms + * @returns any If checked the inputValue is returned; otherwise the uncheckedValue (or null if the latter is not configured). + */ getSubmitValue?(): any; - /** [Method] Returns the checked state of the checkbox */ + /** [Method] Returns the checked state of the checkbox + * @returns Boolean True if checked, else false + */ getValue?(): boolean; /** [Method] private */ initComponent?(): void; @@ -18523,23 +19647,21 @@ declare module Ext.form.field { setBoxLabel?( boxLabel?:string ): void; /** [Method] Sets the checked state of the checkbox * @param value Boolean/String/Number The following values will check the checkbox: true, 'true', '1', 1, or 'on', as well as a String that matches the inputValue. Any other value will uncheck the checkbox. + * @returns Boolean the new checked state of the checkbox */ - setRawValue?( value?:any ): any; - setRawValue?( value?:boolean ): boolean; - setRawValue?( value?:string ): boolean; - setRawValue?( value?:number ): boolean; + setRawValue?( value?:any ): boolean; /** [Method] Sets the read only state of this field * @param readOnly Object */ setReadOnly?( readOnly?:any ): void; /** [Method] Sets the checked state of the checkbox and invokes change detection * @param checked Boolean/String The following values will check the checkbox: true, 'true', '1', or 'on', as well as a String that matches the inputValue. Any other value will uncheck the checkbox. + * @returns Ext.form.field.Checkbox this */ - setValue?( checked?:any ): any; - setValue?( checked?:boolean ): Ext.form.field.ICheckbox; - setValue?( checked?:string ): Ext.form.field.ICheckbox; + setValue?( checked?:any ): Ext.form.field.ICheckbox; /** [Method] private * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -18590,13 +19712,21 @@ declare module Ext.form { originalValue?: any; /** [Method] inherit docs */ beforeDestroy?(): void; - /** [Method] Returns the checked state of the checkbox */ + /** [Method] Returns the checked state of the checkbox + * @returns Boolean True if checked, else false + */ getRawValue?(): boolean; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ + /** [Method] Returns the submit value for the checkbox which can be used when submitting forms + * @returns any If checked the inputValue is returned; otherwise the uncheckedValue (or null if the latter is not configured). + */ getSubmitValue?(): any; - /** [Method] Returns the checked state of the checkbox */ + /** [Method] Returns the checked state of the checkbox + * @returns Boolean True if checked, else false + */ getValue?(): boolean; /** [Method] private */ initComponent?(): void; @@ -18616,23 +19746,21 @@ declare module Ext.form { setBoxLabel?( boxLabel?:string ): void; /** [Method] Sets the checked state of the checkbox * @param value Boolean/String/Number The following values will check the checkbox: true, 'true', '1', 1, or 'on', as well as a String that matches the inputValue. Any other value will uncheck the checkbox. + * @returns Boolean the new checked state of the checkbox */ - setRawValue?( value?:any ): any; - setRawValue?( value?:boolean ): boolean; - setRawValue?( value?:string ): boolean; - setRawValue?( value?:number ): boolean; + setRawValue?( value?:any ): boolean; /** [Method] Sets the read only state of this field * @param readOnly Object */ setReadOnly?( readOnly?:any ): void; /** [Method] Sets the checked state of the checkbox and invokes change detection * @param checked Boolean/String The following values will check the checkbox: true, 'true', '1', or 'on', as well as a String that matches the inputValue. Any other value will uncheck the checkbox. + * @returns Ext.form.field.Checkbox this */ - setValue?( checked?:any ): any; - setValue?( checked?:boolean ): Ext.form.field.ICheckbox; - setValue?( checked?:string ): Ext.form.field.ICheckbox; + setValue?( checked?:any ): Ext.form.field.ICheckbox; /** [Method] private * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -18720,9 +19848,7 @@ declare module Ext.form.field { /** [Method] Binds a store to this instance * @param store Ext.data.AbstractStore/String The store to bind or ID of the store. When no store given (or when null or undefined passed), unbinds the existing store. */ - bindStore?( store?:any ): any; - bindStore?( store?:Ext.data.IAbstractStore ): void; - bindStore?( store?:string ): void; + bindStore?( store?:any ): void; /** [Method] Binds listeners for this component to the store * @param store Ext.data.AbstractStore The store to bind to */ @@ -18735,30 +19861,44 @@ declare module Ext.form.field { * @param queryString String The string to use to filter available items by matching against the configured valueField. * @param forceAll Boolean true to force the query to execute even if there are currently fewer characters in the field than the minimum specified by the minChars config option. It also clears any filter previously saved in the current store. * @param rawQuery Boolean Pass as true if the raw typed value is being used as the query string. This causes the resulting store load to leave the raw value undisturbed. + * @returns Boolean true if the query was permitted to run, false if it was cancelled by a beforequery handler. */ doQuery?( queryString?:string, forceAll?:boolean, rawQuery?:boolean ): boolean; /** [Method] Finds the record by searching for a specific field value combination * @param field String The name of the field to test. * @param value Object The value to match the field against. + * @returns Ext.data.Model The matched record or false. */ findRecord?( field?:string, value?:any ): Ext.data.IModel; /** [Method] Finds the record by searching values in the displayField * @param value Object The value to match the field against. + * @returns Ext.data.Model The matched record or false. */ findRecordByDisplay?( value?:any ): Ext.data.IModel; /** [Method] Finds the record by searching values in the valueField * @param value Object The value to match the field against. + * @returns Ext.data.Model The matched record or false. */ findRecordByValue?( value?:any ): Ext.data.IModel; - /** [Method] Returns the store associated with this ComboBox */ + /** [Method] Returns the store associated with this ComboBox + * @returns Ext.data.Store The store + */ getStore?(): Ext.data.IStore; - /** [Method] Gets the listeners to bind to a new store */ + /** [Method] Gets the listeners to bind to a new store + * @returns Object The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance. + */ getStoreListeners?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Returns the value that would be included in a standard form submit for this field */ + /** [Method] Returns the value that would be included in a standard form submit for this field + * @returns String The value to be submitted, or null. + */ getSubmitValue?(): string; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; /** [Method] private */ initComponent?(): void; @@ -18783,10 +19923,9 @@ declare module Ext.form.field { select?( r?:any ): void; /** [Method] Sets the specified value s into the field * @param value String/String[] The value(s) to be set. Can be either a single String or Ext.data.Model, or an Array of Strings or Models. + * @returns any this */ setValue?( value?:any ): any; - setValue?( value?:string ): any; - setValue?( value?:string[] ): any; /** [Method] Unbinds listeners from this component to the store * @param store Ext.data.AbstractStore The store to unbind from */ @@ -18876,9 +20015,7 @@ declare module Ext.form { /** [Method] Binds a store to this instance * @param store Ext.data.AbstractStore/String The store to bind or ID of the store. When no store given (or when null or undefined passed), unbinds the existing store. */ - bindStore?( store?:any ): any; - bindStore?( store?:Ext.data.IAbstractStore ): void; - bindStore?( store?:string ): void; + bindStore?( store?:any ): void; /** [Method] Binds listeners for this component to the store * @param store Ext.data.AbstractStore The store to bind to */ @@ -18891,30 +20028,44 @@ declare module Ext.form { * @param queryString String The string to use to filter available items by matching against the configured valueField. * @param forceAll Boolean true to force the query to execute even if there are currently fewer characters in the field than the minimum specified by the minChars config option. It also clears any filter previously saved in the current store. * @param rawQuery Boolean Pass as true if the raw typed value is being used as the query string. This causes the resulting store load to leave the raw value undisturbed. + * @returns Boolean true if the query was permitted to run, false if it was cancelled by a beforequery handler. */ doQuery?( queryString?:string, forceAll?:boolean, rawQuery?:boolean ): boolean; /** [Method] Finds the record by searching for a specific field value combination * @param field String The name of the field to test. * @param value Object The value to match the field against. + * @returns Ext.data.Model The matched record or false. */ findRecord?( field?:string, value?:any ): Ext.data.IModel; /** [Method] Finds the record by searching values in the displayField * @param value Object The value to match the field against. + * @returns Ext.data.Model The matched record or false. */ findRecordByDisplay?( value?:any ): Ext.data.IModel; /** [Method] Finds the record by searching values in the valueField * @param value Object The value to match the field against. + * @returns Ext.data.Model The matched record or false. */ findRecordByValue?( value?:any ): Ext.data.IModel; - /** [Method] Returns the store associated with this ComboBox */ + /** [Method] Returns the store associated with this ComboBox + * @returns Ext.data.Store The store + */ getStore?(): Ext.data.IStore; - /** [Method] Gets the listeners to bind to a new store */ + /** [Method] Gets the listeners to bind to a new store + * @returns Object The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance. + */ getStoreListeners?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Returns the value that would be included in a standard form submit for this field */ + /** [Method] Returns the value that would be included in a standard form submit for this field + * @returns String The value to be submitted, or null. + */ getSubmitValue?(): string; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; /** [Method] private */ initComponent?(): void; @@ -18939,10 +20090,9 @@ declare module Ext.form { select?( r?:any ): void; /** [Method] Sets the specified value s into the field * @param value String/String[] The value(s) to be set. Can be either a single String or Ext.data.Model, or an Array of Strings or Models. + * @returns any this */ setValue?( value?:any ): any; - setValue?( value?:string ): any; - setValue?( value?:string[] ): any; /** [Method] Unbinds listeners from this component to the store * @param store Ext.data.AbstractStore The store to unbind from */ @@ -18991,6 +20141,7 @@ declare module Ext.form.field { createPicker?(): void; /** [Method] Runs all of Date s validations and returns an array of any errors * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All validation errors for this field */ getErrors?( value?:any ): string[]; /** [Method] */ @@ -18999,6 +20150,7 @@ declare module Ext.form.field { initValue?(): void; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Attempts to parse a given string value using a given date format. ... */ @@ -19021,11 +20173,12 @@ declare module Ext.form.field { setMinValue?( value?:any ): void; /** [Method] Sets the value of the date field * @param date String/Date The date or valid date string + * @returns Ext.form.field.Date this */ - setValue?( date?:any ): any; - setValue?( date?:string ): Ext.form.field.IDate; + setValue?( date?:any ): Ext.form.field.IDate; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -19072,6 +20225,7 @@ declare module Ext.form { createPicker?(): void; /** [Method] Runs all of Date s validations and returns an array of any errors * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All validation errors for this field */ getErrors?( value?:any ): string[]; /** [Method] */ @@ -19080,6 +20234,7 @@ declare module Ext.form { initValue?(): void; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Attempts to parse a given string value using a given date format. ... */ @@ -19102,11 +20257,12 @@ declare module Ext.form { setMinValue?( value?:any ): void; /** [Method] Sets the value of the date field * @param date String/Date The date or valid date string + * @returns Ext.form.field.Date this */ - setValue?( date?:any ): any; - setValue?( date?:string ): Ext.form.field.IDate; + setValue?( date?:any ): Ext.form.field.IDate; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -19153,6 +20309,7 @@ declare module Ext.form { createPicker?(): void; /** [Method] Runs all of Date s validations and returns an array of any errors * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All validation errors for this field */ getErrors?( value?:any ): string[]; /** [Method] */ @@ -19161,6 +20318,7 @@ declare module Ext.form { initValue?(): void; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Attempts to parse a given string value using a given date format. ... */ @@ -19183,11 +20341,12 @@ declare module Ext.form { setMinValue?( value?:any ): void; /** [Method] Sets the value of the date field * @param date String/Date The date or valid date string + * @returns Ext.form.field.Date this */ - setValue?( date?:any ): any; - setValue?( date?:string ): Ext.form.field.IDate; + setValue?( date?:any ): Ext.form.field.IDate; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -19206,21 +20365,32 @@ declare module Ext.form.field { scope?: any; /** [Config Option] (Boolean) */ submitValue?: boolean; - /** [Method] Returns the raw value of the field without performing any normalization conversion or validation */ + /** [Method] Returns the raw value of the field without performing any normalization conversion or validation + * @returns String value The raw String value of the field + */ getRawValue?(): string; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; /** [Method] private */ initEvents?(): void; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean True if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; - /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field */ + /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field + * @returns Boolean True if the value is valid, else false + */ isValid?(): boolean; /** [Method] Sets the field s raw value directly bypassing value conversion change detection and validation * @param value Object + * @returns Object value The field value that is set */ setRawValue?( value?:any ): any; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali + * @returns Boolean True if the value is valid, else false + */ validate?(): boolean; } } @@ -19238,21 +20408,32 @@ declare module Ext.form { scope?: any; /** [Config Option] (Boolean) */ submitValue?: boolean; - /** [Method] Returns the raw value of the field without performing any normalization conversion or validation */ + /** [Method] Returns the raw value of the field without performing any normalization conversion or validation + * @returns String value The raw String value of the field + */ getRawValue?(): string; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; /** [Method] private */ initEvents?(): void; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean True if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; - /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field */ + /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field + * @returns Boolean True if the value is valid, else false + */ isValid?(): boolean; /** [Method] Sets the field s raw value directly bypassing value conversion change detection and validation * @param value Object + * @returns Object value The field value that is set */ setRawValue?( value?:any ): any; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali + * @returns Boolean True if the value is valid, else false + */ validate?(): boolean; } } @@ -19270,21 +20451,32 @@ declare module Ext.form { scope?: any; /** [Config Option] (Boolean) */ submitValue?: boolean; - /** [Method] Returns the raw value of the field without performing any normalization conversion or validation */ + /** [Method] Returns the raw value of the field without performing any normalization conversion or validation + * @returns String value The raw String value of the field + */ getRawValue?(): string; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; /** [Method] private */ initEvents?(): void; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean True if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; - /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field */ + /** [Method] Returns whether or not the field value is currently valid by validating the processed raw value of the field + * @returns Boolean True if the value is valid, else false + */ isValid?(): boolean; /** [Method] Sets the field s raw value directly bypassing value conversion change detection and validation * @param value Object + * @returns Object value The field value that is set */ setRawValue?( value?:any ): any; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali + * @returns Boolean True if the value is valid, else false + */ validate?(): boolean; } } @@ -19316,54 +20508,74 @@ declare module Ext.form.field { checkDirty?(): void; /** [Method] Clear any invalid styles messages for this field */ clearInvalid?(): void; - /** [Method] Only relevant if the instance s isFileUpload method returns true */ + /** [Method] Only relevant if the instance s isFileUpload method returns true + * @returns any + */ extractFileInput?(): any; /** [Method] Runs this field s validators and returns an array of error messages for any validation failures * @param value Object The value to get errors for (defaults to the current field value) + * @returns any All error messages for this field; an empty Array if none. */ getErrors?( value?:any ): any; - /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ + /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe + * @returns any A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getModelData?(): any; - /** [Method] Returns the name attribute of the field */ + /** [Method] Returns the name attribute of the field + * @returns string name The field name + */ getName?(): string; - /** [Method] Returns the parameter s that would be included in a standard form submit for this field */ + /** [Method] Returns the parameter s that would be included in a standard form submit for this field + * @returns any A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getSubmitData?(): any; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns any value The field value + */ getValue?(): any; /** [Method] Initializes this Field mixin on the current instance */ initField?(): void; /** [Method] Initializes the field s value based on the initial config */ initValue?(): void; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns any True if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): any; /** [Method] Returns whether two field values are logically equal * @param value1 Object The first value to compare * @param value2 Object The second value to compare + * @returns any True if the values are equal, false if inequal. */ isEqual?( value1?:any, value2?:any ): any; - /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti */ + /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti + * @returns any + */ isFileUpload?(): any; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value + * @returns any True if the value is valid, else false + */ isValid?(): any; /** [Method] Associate one or more error messages with this field * @param errors String/String[] The error message(s) for the field. */ - markInvalid?( errors?:any ): any; - markInvalid?( errors?:string ): void; - markInvalid?( errors?:string[] ): void; + markInvalid?( errors?:any ): void; /** [Method] Resets the current field value to the originally loaded value and clears any validation messages */ reset?(): void; /** [Method] Resets the field s originalValue property so it matches the current value */ resetOriginalValue?(): void; /** [Method] Sets a data value into the field and runs the change detection and validation * @param value Object The value to set + * @returns any this */ setValue?( value?:any ): any; /** [Method] Allows for any necessary modifications before the original value is set * @param value Object The initial value + * @returns any The modified initial value */ transformOriginalValue?( value?:any ): any; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value and fires the vali + * @returns any True if the value is valid, else false + */ validate?(): any; } } @@ -19387,11 +20599,15 @@ declare module Ext.form.field { button?: Ext.button.IButton; /** [Property] (Ext.Element) */ fileInputEl?: Ext.IElement; - /** [Method] Only relevant if the instance s isFileUpload method returns true */ + /** [Method] Only relevant if the instance s isFileUpload method returns true + * @returns HTMLElement + */ extractFileInput?(): HTMLElement; /** [Method] Gets the markup to be inserted into the subTplMarkup */ getTriggerMarkup?(): void; - /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti */ + /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti + * @returns Boolean + */ isFileUpload?(): boolean; /** [Method] private */ onDisable?(): void; @@ -19427,11 +20643,15 @@ declare module Ext.form { button?: Ext.button.IButton; /** [Property] (Ext.Element) */ fileInputEl?: Ext.IElement; - /** [Method] Only relevant if the instance s isFileUpload method returns true */ + /** [Method] Only relevant if the instance s isFileUpload method returns true + * @returns HTMLElement + */ extractFileInput?(): HTMLElement; /** [Method] Gets the markup to be inserted into the subTplMarkup */ getTriggerMarkup?(): void; - /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti */ + /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti + * @returns Boolean + */ isFileUpload?(): boolean; /** [Method] private */ onDisable?(): void; @@ -19467,11 +20687,15 @@ declare module Ext.ux.form { button?: Ext.button.IButton; /** [Property] (Ext.Element) */ fileInputEl?: Ext.IElement; - /** [Method] Only relevant if the instance s isFileUpload method returns true */ + /** [Method] Only relevant if the instance s isFileUpload method returns true + * @returns HTMLElement + */ extractFileInput?(): HTMLElement; /** [Method] Gets the markup to be inserted into the subTplMarkup */ getTriggerMarkup?(): void; - /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti */ + /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti + * @returns Boolean + */ isFileUpload?(): boolean; /** [Method] private */ onDisable?(): void; @@ -19507,11 +20731,15 @@ declare module Ext.form { button?: Ext.button.IButton; /** [Property] (Ext.Element) */ fileInputEl?: Ext.IElement; - /** [Method] Only relevant if the instance s isFileUpload method returns true */ + /** [Method] Only relevant if the instance s isFileUpload method returns true + * @returns HTMLElement + */ extractFileInput?(): HTMLElement; /** [Method] Gets the markup to be inserted into the subTplMarkup */ getTriggerMarkup?(): void; - /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti */ + /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti + * @returns Boolean + */ isFileUpload?(): boolean; /** [Method] private */ onDisable?(): void; @@ -19537,7 +20765,9 @@ declare module Ext.form.field { renderTpl?: any; /** [Method] Allows addition of behavior after rendering is complete */ afterRender?(): void; - /** [Method] This method returns an object which provides substitution parameters for the XTemplate used to create this Button s D */ + /** [Method] This method returns an object which provides substitution parameters for the XTemplate used to create this Button s D + * @returns Object Substitution data for a Template. The default implementation which provides data for the default template returns an Object containing the following properties: + */ getTemplateArgs?(): any; /** [Method] See comments in onFocus */ onDisable?(): void; @@ -19561,15 +20791,25 @@ declare module Ext.form.field { initEvents?(): void; /** [Method] Display one or more error messages associated with this field using msgTarget to determine how to display the messag */ markInvalid?(): void; - /** [Method] Sets the height of the component */ + /** [Method] Sets the height of the component + * @returns Ext.Component this + */ setHeight?(): Ext.IComponent; - /** [Method] Sets the page XY position of the component */ + /** [Method] Sets the page XY position of the component + * @returns Ext.Component this + */ setPagePosition?(): Ext.IComponent; - /** [Method] Sets the left and top of the component */ + /** [Method] Sets the left and top of the component + * @returns Ext.Component this + */ setPosition?(): Ext.IComponent; - /** [Method] Sets the width and height of this Component */ + /** [Method] Sets the width and height of this Component + * @returns Ext.Component this + */ setSize?(): Ext.IComponent; - /** [Method] Sets the width of the component */ + /** [Method] Sets the width of the component + * @returns Ext.Component this + */ setWidth?(): Ext.IComponent; } } @@ -19589,15 +20829,25 @@ declare module Ext.form { initEvents?(): void; /** [Method] Display one or more error messages associated with this field using msgTarget to determine how to display the messag */ markInvalid?(): void; - /** [Method] Sets the height of the component */ + /** [Method] Sets the height of the component + * @returns Ext.Component this + */ setHeight?(): Ext.IComponent; - /** [Method] Sets the page XY position of the component */ + /** [Method] Sets the page XY position of the component + * @returns Ext.Component this + */ setPagePosition?(): Ext.IComponent; - /** [Method] Sets the left and top of the component */ + /** [Method] Sets the left and top of the component + * @returns Ext.Component this + */ setPosition?(): Ext.IComponent; - /** [Method] Sets the width and height of this Component */ + /** [Method] Sets the width and height of this Component + * @returns Ext.Component this + */ setSize?(): Ext.IComponent; - /** [Method] Sets the width of the component */ + /** [Method] Sets the width of the component + * @returns Ext.Component this + */ setWidth?(): Ext.IComponent; } } @@ -19657,6 +20907,7 @@ declare module Ext.form.field { checkDirty?(): void; /** [Method] If you need want custom HTML cleanup this is the method you should override * @param html String The HTML to be cleaned + * @returns String The cleaned HTML */ cleanHtml?( html?:string ): string; /** [Method] Clear any invalid styles messages for this field */ @@ -19665,31 +20916,43 @@ declare module Ext.form.field { * @param cmd String The Midas command * @param value String/Boolean The value to pass to the command */ - execCmd?( cmd?:any, value?:any ): any; - execCmd?( cmd?:string, value?:string ): void; - execCmd?( cmd?:string, value?:boolean ): void; - /** [Method] Only relevant if the instance s isFileUpload method returns true */ + execCmd?( cmd?:string, value?:any ): void; + /** [Method] Only relevant if the instance s isFileUpload method returns true + * @returns HTMLElement + */ extractFileInput?(): HTMLElement; /** [Method] Try to focus this component * @param selectText Object * @param delay Object + * @returns Ext.Component The focused Component. Usually this Component. Some Containers may delegate focus to a descendant Component (Windows can do this through their defaultFocus config option. */ focus?( selectText?:any, delay?:any ): Ext.IComponent; /** [Method] Called when the editor initializes the iframe with HTML contents */ getDocMarkup?(): void; /** [Method] Runs this field s validators and returns an array of error messages for any validation failures * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All error messages for this field; an empty Array if none. */ getErrors?( value?:any ): string[]; - /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ + /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getModelData?(): any; - /** [Method] Returns the name attribute of the field */ + /** [Method] Returns the name attribute of the field + * @returns String name The field name + */ getName?(): string; - /** [Method] Returns the parameter s that would be included in a standard form submit for this field */ + /** [Method] Returns the parameter s that would be included in a standard form submit for this field + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getSubmitData?(): any; - /** [Method] Returns the editor s toolbar */ + /** [Method] Returns the editor s toolbar + * @returns Ext.toolbar.Toolbar + */ getToolbar?(): Ext.toolbar.IToolbar; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; /** [Method] Initializes this Field mixin on the current instance */ initField?(): void; @@ -19699,32 +20962,35 @@ declare module Ext.form.field { * @param text String */ insertAtCursor?( text?:string ): void; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean True if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; /** [Method] Returns whether two field values are logically equal * @param value1 Object * @param value2 Object + * @returns Boolean True if the values are equal, false if inequal. */ isEqual?( value1?:any, value2?:any ): boolean; - /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti */ + /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti + * @returns Boolean + */ isFileUpload?(): boolean; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value + * @returns Boolean True if the value is valid, else false + */ isValid?(): boolean; /** [Method] Associate one or more error messages with this field * @param errors String/String[] The error message(s) for the field. */ - markInvalid?( errors?:any ): any; - markInvalid?( errors?:string ): void; - markInvalid?( errors?:string[] ): void; + markInvalid?( errors?:any ): void; /** [Method] Pushes the value of the textarea into the iframe editor */ pushValue?(): void; /** [Method] Executes a Midas editor command on the editor document and performs necessary focus and toolbar updates * @param cmd String The Midas command * @param value String/Boolean The value to pass to the command */ - relayCmd?( cmd?:any, value?:any ): any; - relayCmd?( cmd?:string, value?:string ): void; - relayCmd?( cmd?:string, value?:boolean ): void; + relayCmd?( cmd?:string, value?:any ): void; /** [Method] Resets the current field value to the originally loaded value and clears any validation messages */ reset?(): void; /** [Method] Resets the field s originalValue property so it matches the current value */ @@ -19735,6 +21001,7 @@ declare module Ext.form.field { setReadOnly?( readOnly?:boolean ): void; /** [Method] Sets a data value into the field and runs the change detection and validation * @param value Object + * @returns any this */ setValue?( value?:any ): any; /** [Method] Syncs the contents of the editor iframe with the textarea */ @@ -19745,6 +21012,7 @@ declare module Ext.form.field { toggleSourceEdit?( sourceEditMode?:boolean ): void; /** [Method] Allows for any necessary modifications before the original value is set * @param value Object The initial value + * @returns Object The modified initial value */ transformOriginalValue?( value?:any ): any; /** [Method] Triggers a toolbar update by reading the markup state of the current selection in the editor */ @@ -19807,6 +21075,7 @@ declare module Ext.form { checkDirty?(): void; /** [Method] If you need want custom HTML cleanup this is the method you should override * @param html String The HTML to be cleaned + * @returns String The cleaned HTML */ cleanHtml?( html?:string ): string; /** [Method] Clear any invalid styles messages for this field */ @@ -19815,31 +21084,43 @@ declare module Ext.form { * @param cmd String The Midas command * @param value String/Boolean The value to pass to the command */ - execCmd?( cmd?:any, value?:any ): any; - execCmd?( cmd?:string, value?:string ): void; - execCmd?( cmd?:string, value?:boolean ): void; - /** [Method] Only relevant if the instance s isFileUpload method returns true */ + execCmd?( cmd?:string, value?:any ): void; + /** [Method] Only relevant if the instance s isFileUpload method returns true + * @returns HTMLElement + */ extractFileInput?(): HTMLElement; /** [Method] Try to focus this component * @param selectText Object * @param delay Object + * @returns Ext.Component The focused Component. Usually this Component. Some Containers may delegate focus to a descendant Component (Windows can do this through their defaultFocus config option. */ focus?( selectText?:any, delay?:any ): Ext.IComponent; /** [Method] Called when the editor initializes the iframe with HTML contents */ getDocMarkup?(): void; /** [Method] Runs this field s validators and returns an array of error messages for any validation failures * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All error messages for this field; an empty Array if none. */ getErrors?( value?:any ): string[]; - /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ + /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getModelData?(): any; - /** [Method] Returns the name attribute of the field */ + /** [Method] Returns the name attribute of the field + * @returns String name The field name + */ getName?(): string; - /** [Method] Returns the parameter s that would be included in a standard form submit for this field */ + /** [Method] Returns the parameter s that would be included in a standard form submit for this field + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getSubmitData?(): any; - /** [Method] Returns the editor s toolbar */ + /** [Method] Returns the editor s toolbar + * @returns Ext.toolbar.Toolbar + */ getToolbar?(): Ext.toolbar.IToolbar; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; /** [Method] Initializes this Field mixin on the current instance */ initField?(): void; @@ -19849,32 +21130,35 @@ declare module Ext.form { * @param text String */ insertAtCursor?( text?:string ): void; - /** [Method] Returns true if the value of this Field has been changed from its originalValue */ + /** [Method] Returns true if the value of this Field has been changed from its originalValue + * @returns Boolean True if this field has been changed from its original value (and is not disabled), false otherwise. + */ isDirty?(): boolean; /** [Method] Returns whether two field values are logically equal * @param value1 Object * @param value2 Object + * @returns Boolean True if the values are equal, false if inequal. */ isEqual?( value1?:any, value2?:any ): boolean; - /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti */ + /** [Method] Returns whether this Field is a file upload field if it returns true forms will use special techniques for submitti + * @returns Boolean + */ isFileUpload?(): boolean; - /** [Method] Returns whether or not the field value is currently valid by validating the field s current value */ + /** [Method] Returns whether or not the field value is currently valid by validating the field s current value + * @returns Boolean True if the value is valid, else false + */ isValid?(): boolean; /** [Method] Associate one or more error messages with this field * @param errors String/String[] The error message(s) for the field. */ - markInvalid?( errors?:any ): any; - markInvalid?( errors?:string ): void; - markInvalid?( errors?:string[] ): void; + markInvalid?( errors?:any ): void; /** [Method] Pushes the value of the textarea into the iframe editor */ pushValue?(): void; /** [Method] Executes a Midas editor command on the editor document and performs necessary focus and toolbar updates * @param cmd String The Midas command * @param value String/Boolean The value to pass to the command */ - relayCmd?( cmd?:any, value?:any ): any; - relayCmd?( cmd?:string, value?:string ): void; - relayCmd?( cmd?:string, value?:boolean ): void; + relayCmd?( cmd?:string, value?:any ): void; /** [Method] Resets the current field value to the originally loaded value and clears any validation messages */ reset?(): void; /** [Method] Resets the field s originalValue property so it matches the current value */ @@ -19885,6 +21169,7 @@ declare module Ext.form { setReadOnly?( readOnly?:boolean ): void; /** [Method] Sets a data value into the field and runs the change detection and validation * @param value Object + * @returns any this */ setValue?( value?:any ): any; /** [Method] Syncs the contents of the editor iframe with the textarea */ @@ -19895,6 +21180,7 @@ declare module Ext.form { toggleSourceEdit?( sourceEditMode?:boolean ): void; /** [Method] Allows for any necessary modifications before the original value is set * @param value Object The initial value + * @returns Object The modified initial value */ transformOriginalValue?( value?:any ): any; /** [Method] Triggers a toolbar update by reading the markup state of the current selection in the editor */ @@ -19935,9 +21221,12 @@ declare module Ext.form.field { beforeBlur?(): void; /** [Method] Runs all of Number s validations and returns an array of any errors * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All validation errors for this field */ getErrors?( value?:any ): string[]; - /** [Method] Returns the value that would be included in a standard form submit for this field */ + /** [Method] Returns the value that would be included in a standard form submit for this field + * @returns String The value to be submitted, or null. + */ getSubmitValue?(): string; /** [Method] private */ initComponent?(): void; @@ -19947,6 +21236,7 @@ declare module Ext.form.field { onSpinUp?(): void; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Replaces any existing maxValue with the new value @@ -19969,6 +21259,7 @@ declare module Ext.form.field { setSpinUpEnabled?( enabled?:any, internal?:any ): void; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -20007,9 +21298,12 @@ declare module Ext.form { beforeBlur?(): void; /** [Method] Runs all of Number s validations and returns an array of any errors * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All validation errors for this field */ getErrors?( value?:any ): string[]; - /** [Method] Returns the value that would be included in a standard form submit for this field */ + /** [Method] Returns the value that would be included in a standard form submit for this field + * @returns String The value to be submitted, or null. + */ getSubmitValue?(): string; /** [Method] private */ initComponent?(): void; @@ -20019,6 +21313,7 @@ declare module Ext.form { onSpinUp?(): void; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Replaces any existing maxValue with the new value @@ -20041,6 +21336,7 @@ declare module Ext.form { setSpinUpEnabled?( enabled?:any, internal?:any ): void; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -20079,9 +21375,12 @@ declare module Ext.form { beforeBlur?(): void; /** [Method] Runs all of Number s validations and returns an array of any errors * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All validation errors for this field */ getErrors?( value?:any ): string[]; - /** [Method] Returns the value that would be included in a standard form submit for this field */ + /** [Method] Returns the value that would be included in a standard form submit for this field + * @returns String The value to be submitted, or null. + */ getSubmitValue?(): string; /** [Method] private */ initComponent?(): void; @@ -20091,6 +21390,7 @@ declare module Ext.form { onSpinUp?(): void; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Replaces any existing maxValue with the new value @@ -20113,6 +21413,7 @@ declare module Ext.form { setSpinUpEnabled?( enabled?:any, internal?:any ): void; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -20139,7 +21440,9 @@ declare module Ext.form.field { createPicker?(): void; /** [Method] Expands this field s picker dropdown */ expand?(): void; - /** [Method] Returns a reference to the picker component for this field creating it if necessary by calling createPicker */ + /** [Method] Returns a reference to the picker component for this field creating it if necessary by calling createPicker + * @returns Ext.Component The picker component + */ getPicker?(): Ext.IComponent; /** [Method] private */ initComponent?(): void; @@ -20171,7 +21474,9 @@ declare module Ext.form { createPicker?(): void; /** [Method] Expands this field s picker dropdown */ expand?(): void; - /** [Method] Returns a reference to the picker component for this field creating it if necessary by calling createPicker */ + /** [Method] Returns a reference to the picker component for this field creating it if necessary by calling createPicker + * @returns Ext.Component The picker component + */ getPicker?(): Ext.IComponent; /** [Method] private */ initComponent?(): void; @@ -20189,20 +21494,25 @@ declare module Ext.form.field { inputType?: string; /** [Property] (Boolean) */ isRadio?: boolean; - /** [Method] If this radio is part of a group it will return the selected value */ + /** [Method] If this radio is part of a group it will return the selected value + * @returns String + */ getGroupValue?(): string; - /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ + /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getModelData?(): any; - /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ + /** [Method] Returns the submit value for the checkbox which can be used when submitting forms + * @returns Boolean/Object True if checked, null if not. + */ getSubmitValue?(): any; /** [Method] Method to manage awareness of when components are removed from their respective Container firing a removed event */ onRemoved?(): void; /** [Method] Sets either the checked unchecked status of this Radio or if a string value is passed checks a sibling Radio of th * @param value String/Boolean Checked value, or the value of the sibling radio button to check. + * @returns Ext.form.field.Radio this */ - setValue?( value?:any ): any; - setValue?( value?:string ): Ext.form.field.IRadio; - setValue?( value?:boolean ): Ext.form.field.IRadio; + setValue?( value?:any ): Ext.form.field.IRadio; } } declare module Ext.form { @@ -20213,20 +21523,25 @@ declare module Ext.form { inputType?: string; /** [Property] (Boolean) */ isRadio?: boolean; - /** [Method] If this radio is part of a group it will return the selected value */ + /** [Method] If this radio is part of a group it will return the selected value + * @returns String + */ getGroupValue?(): string; - /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe */ + /** [Method] Returns the value s that should be saved to the Ext data Model instance for this field when Ext form Basic updateRe + * @returns Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted. + */ getModelData?(): any; - /** [Method] Returns the submit value for the checkbox which can be used when submitting forms */ + /** [Method] Returns the submit value for the checkbox which can be used when submitting forms + * @returns Boolean/Object True if checked, null if not. + */ getSubmitValue?(): any; /** [Method] Method to manage awareness of when components are removed from their respective Container firing a removed event */ onRemoved?(): void; /** [Method] Sets either the checked unchecked status of this Radio or if a string value is passed checks a sibling Radio of th * @param value String/Boolean Checked value, or the value of the sibling radio button to check. + * @returns Ext.form.field.Radio this */ - setValue?( value?:any ): any; - setValue?( value?:string ): Ext.form.field.IRadio; - setValue?( value?:boolean ): Ext.form.field.IRadio; + setValue?( value?:any ): Ext.form.field.IRadio; } } declare module Ext.form.field { @@ -20245,11 +21560,9 @@ declare module Ext.form.field { spinDownEl?: Ext.IElement; /** [Property] (Ext.Element) */ spinUpEl?: Ext.IElement; - /** [Method] Gets the markup to be inserted into the outer template s bodyEl - * @param values Object + /** [Method] Get the total width of the spinner button area + * @returns Number The total spinner button width */ - getSubTplMarkup?( values?:any ): void; - /** [Method] Get the total width of the spinner button area */ getTriggerWidth?(): number; /** [Method] private */ initComponent?(): void; @@ -20287,11 +21600,9 @@ declare module Ext.form { spinDownEl?: Ext.IElement; /** [Property] (Ext.Element) */ spinUpEl?: Ext.IElement; - /** [Method] Gets the markup to be inserted into the outer template s bodyEl - * @param values Object + /** [Method] Get the total width of the spinner button area + * @returns Number The total spinner button width */ - getSubTplMarkup?( values?:any ): void; - /** [Method] Get the total width of the spinner button area */ getTriggerWidth?(): number; /** [Method] private */ initComponent?(): void; @@ -20383,13 +21694,20 @@ declare module Ext.form.field { beforeFocus?(): void; /** [Method] Validates a value according to the field s validation rules and returns an array of errors for any failing validations * @param value Object The value to validate. The processed raw value will be used if nothing is passed. + * @returns String[] Array of any validation errors */ getErrors?( value?:any ): string[]; - /** [Method] Returns the raw String value of the field without performing any normalization conversion or validation */ + /** [Method] Returns the raw String value of the field without performing any normalization conversion or validation + * @returns String The raw String value of the field + */ getRawValue?(): string; - /** [Method] The supplied default state gathering method for the AbstractComponent class */ + /** [Method] The supplied default state gathering method for the AbstractComponent class + * @returns Object + */ getState?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; /** [Method] private */ initComponent?(): void; @@ -20405,6 +21723,7 @@ declare module Ext.form.field { postBlur?(): void; /** [Method] Performs any necessary manipulation of a raw String value to prepare it for conversion and or validation * @param value String The unprocessed string value + * @returns String The processed string value */ processRawValue?( value?:string ): string; /** [Method] Resets the current field value to the originally loaded value and clears any validation messages */ @@ -20416,6 +21735,7 @@ declare module Ext.form.field { selectText?( start?:number, end?:number ): void; /** [Method] Sets a data value into the field and runs the change detection and validation * @param value Object The value to set + * @returns any this */ setValue?( value?:any ): any; } @@ -20490,13 +21810,20 @@ declare module Ext.form { beforeFocus?(): void; /** [Method] Validates a value according to the field s validation rules and returns an array of errors for any failing validations * @param value Object The value to validate. The processed raw value will be used if nothing is passed. + * @returns String[] Array of any validation errors */ getErrors?( value?:any ): string[]; - /** [Method] Returns the raw String value of the field without performing any normalization conversion or validation */ + /** [Method] Returns the raw String value of the field without performing any normalization conversion or validation + * @returns String The raw String value of the field + */ getRawValue?(): string; - /** [Method] The supplied default state gathering method for the AbstractComponent class */ + /** [Method] The supplied default state gathering method for the AbstractComponent class + * @returns Object + */ getState?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; /** [Method] private */ initComponent?(): void; @@ -20512,6 +21839,7 @@ declare module Ext.form { postBlur?(): void; /** [Method] Performs any necessary manipulation of a raw String value to prepare it for conversion and or validation * @param value String The unprocessed string value + * @returns String The processed string value */ processRawValue?( value?:string ): string; /** [Method] Resets the current field value to the originally loaded value and clears any validation messages */ @@ -20523,6 +21851,7 @@ declare module Ext.form { selectText?( start?:number, end?:number ): void; /** [Method] Sets a data value into the field and runs the change detection and validation * @param value Object The value to set + * @returns any this */ setValue?( value?:any ): any; } @@ -20597,13 +21926,20 @@ declare module Ext.form { beforeFocus?(): void; /** [Method] Validates a value according to the field s validation rules and returns an array of errors for any failing validations * @param value Object The value to validate. The processed raw value will be used if nothing is passed. + * @returns String[] Array of any validation errors */ getErrors?( value?:any ): string[]; - /** [Method] Returns the raw String value of the field without performing any normalization conversion or validation */ + /** [Method] Returns the raw String value of the field without performing any normalization conversion or validation + * @returns String The raw String value of the field + */ getRawValue?(): string; - /** [Method] The supplied default state gathering method for the AbstractComponent class */ + /** [Method] The supplied default state gathering method for the AbstractComponent class + * @returns Object + */ getState?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; /** [Method] private */ initComponent?(): void; @@ -20619,6 +21955,7 @@ declare module Ext.form { postBlur?(): void; /** [Method] Performs any necessary manipulation of a raw String value to prepare it for conversion and or validation * @param value String The unprocessed string value + * @returns String The processed string value */ processRawValue?( value?:string ): string; /** [Method] Resets the current field value to the originally loaded value and clears any validation messages */ @@ -20630,6 +21967,7 @@ declare module Ext.form { selectText?( start?:number, end?:number ): void; /** [Method] Sets a data value into the field and runs the change detection and validation * @param value Object The value to set + * @returns any this */ setValue?( value?:any ): any; } @@ -20658,20 +21996,27 @@ declare module Ext.form.field { autoSize?(): void; /** [Method] Invoked before the Component is destroyed */ beforeDestroy?(): void; - /** [Method] private */ + /** [Method] private + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; /** [Method] Allows for any necessary modifications before the original value is set * @param value Object + * @returns Object The modified initial value */ transformOriginalValue?( value?:any ): any; /** [Method] The following overrides deal with an issue whereby some browsers will strip carriage returns from the textarea input * @param value Object + * @returns Object The value to set */ transformRawValue?( value?:any ): any; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -20700,20 +22045,27 @@ declare module Ext.form { autoSize?(): void; /** [Method] Invoked before the Component is destroyed */ beforeDestroy?(): void; - /** [Method] private */ + /** [Method] private + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; /** [Method] Allows for any necessary modifications before the original value is set * @param value Object + * @returns Object The modified initial value */ transformOriginalValue?( value?:any ): any; /** [Method] The following overrides deal with an issue whereby some browsers will strip carriage returns from the textarea input * @param value Object + * @returns Object The value to set */ transformRawValue?( value?:any ): any; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -20754,9 +22106,12 @@ declare module Ext.form.field { valueField?: string; /** [Method] Runs all of Time s validations and returns an array of any errors * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All validation errors for this field */ getErrors?( value?:any ): string[]; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; /** [Method] private */ initComponent?(): void; @@ -20764,22 +22119,24 @@ declare module Ext.form.field { postBlur?(): void; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Replaces any existing maxValue with the new time and refreshes the picker s range * @param value Date/String The maximum time that can be selected */ - setMaxValue?( value?:any ): any; - setMaxValue?( value?:string ): void; + setMaxValue?( value?:any ): void; /** [Method] Replaces any existing minValue with the new time and refreshes the picker s range * @param value Date/String The minimum time that can be selected */ - setMinValue?( value?:any ): any; - setMinValue?( value?:string ): void; - /** [Method] Sets the specified value s into the field */ + setMinValue?( value?:any ): void; + /** [Method] Sets the specified value s into the field + * @returns any this + */ setValue?(): any; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -20820,9 +22177,12 @@ declare module Ext.form { valueField?: string; /** [Method] Runs all of Time s validations and returns an array of any errors * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All validation errors for this field */ getErrors?( value?:any ): string[]; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; /** [Method] private */ initComponent?(): void; @@ -20830,22 +22190,24 @@ declare module Ext.form { postBlur?(): void; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Replaces any existing maxValue with the new time and refreshes the picker s range * @param value Date/String The maximum time that can be selected */ - setMaxValue?( value?:any ): any; - setMaxValue?( value?:string ): void; + setMaxValue?( value?:any ): void; /** [Method] Replaces any existing minValue with the new time and refreshes the picker s range * @param value Date/String The minimum time that can be selected */ - setMinValue?( value?:any ): any; - setMinValue?( value?:string ): void; - /** [Method] Sets the specified value s into the field */ + setMinValue?( value?:any ): void; + /** [Method] Sets the specified value s into the field + * @returns any this + */ setValue?(): any; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -20886,9 +22248,12 @@ declare module Ext.form { valueField?: string; /** [Method] Runs all of Time s validations and returns an array of any errors * @param value Object The value to get errors for (defaults to the current field value) + * @returns String[] All validation errors for this field */ getErrors?( value?:any ): string[]; - /** [Method] Returns the current data value of the field */ + /** [Method] Returns the current data value of the field + * @returns Object value The field value + */ getValue?(): any; /** [Method] private */ initComponent?(): void; @@ -20896,22 +22261,24 @@ declare module Ext.form { postBlur?(): void; /** [Method] Converts a raw input field value into a mixed type value that is suitable for this particular field type * @param rawValue Object + * @returns Object The converted value. */ rawToValue?( rawValue?:any ): any; /** [Method] Replaces any existing maxValue with the new time and refreshes the picker s range * @param value Date/String The maximum time that can be selected */ - setMaxValue?( value?:any ): any; - setMaxValue?( value?:string ): void; + setMaxValue?( value?:any ): void; /** [Method] Replaces any existing minValue with the new time and refreshes the picker s range * @param value Date/String The minimum time that can be selected */ - setMinValue?( value?:any ): any; - setMinValue?( value?:string ): void; - /** [Method] Sets the specified value s into the field */ + setMinValue?( value?:any ): void; + /** [Method] Sets the specified value s into the field + * @returns any this + */ setValue?(): any; /** [Method] Converts a mixed type value to a raw representation suitable for displaying in the field * @param value Object + * @returns Object The converted raw value. */ valueToRaw?( value?:any ): any; } @@ -20944,15 +22311,17 @@ declare module Ext.form.field { triggerEl?: Ext.ICompositeElement; /** [Property] (Ext.Element) */ triggerWrap?: Ext.IElement; - /** [Method] Generates the arguments for the field decorations rendering template */ + /** [Method] Generates the arguments for the field decorations rendering template + * @returns Object The template arguments + */ getLabelableRenderData?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Gets the markup to be inserted into the outer template s bodyEl - * @param values Object + /** [Method] Get the total width of the trigger button area + * @returns Number The total trigger width */ - getSubTplMarkup?( values?:any ): void; - /** [Method] Get the total width of the trigger button area */ getTriggerWidth?(): number; /** [Method] private */ initComponent?(): void; @@ -21000,15 +22369,17 @@ declare module Ext.form { triggerEl?: Ext.ICompositeElement; /** [Property] (Ext.Element) */ triggerWrap?: Ext.IElement; - /** [Method] Generates the arguments for the field decorations rendering template */ + /** [Method] Generates the arguments for the field decorations rendering template + * @returns Object The template arguments + */ getLabelableRenderData?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Gets the markup to be inserted into the outer template s bodyEl - * @param values Object + /** [Method] Get the total width of the trigger button area + * @returns Number The total trigger width */ - getSubTplMarkup?( values?:any ): void; - /** [Method] Get the total width of the trigger button area */ getTriggerWidth?(): number; /** [Method] private */ initComponent?(): void; @@ -21056,15 +22427,17 @@ declare module Ext.form { triggerEl?: Ext.ICompositeElement; /** [Property] (Ext.Element) */ triggerWrap?: Ext.IElement; - /** [Method] Generates the arguments for the field decorations rendering template */ + /** [Method] Generates the arguments for the field decorations rendering template + * @returns Object The template arguments + */ getLabelableRenderData?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Gets the markup to be inserted into the outer template s bodyEl - * @param values Object + /** [Method] Get the total width of the trigger button area + * @returns Number The total trigger width */ - getSubTplMarkup?( values?:any ): void; - /** [Method] Get the total width of the trigger button area */ getTriggerWidth?(): number; /** [Method] private */ initComponent?(): void; @@ -21112,15 +22485,17 @@ declare module Ext.form { triggerEl?: Ext.ICompositeElement; /** [Property] (Ext.Element) */ triggerWrap?: Ext.IElement; - /** [Method] Generates the arguments for the field decorations rendering template */ + /** [Method] Generates the arguments for the field decorations rendering template + * @returns Object The template arguments + */ getLabelableRenderData?(): any; - /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl */ + /** [Method] Creates and returns the data object to be used when rendering the fieldSubTpl + * @returns Object The template data + */ getSubTplData?(): any; - /** [Method] Gets the markup to be inserted into the outer template s bodyEl - * @param values Object + /** [Method] Get the total width of the trigger button area + * @returns Number The total trigger width */ - getSubTplMarkup?( values?:any ): void; - /** [Method] Get the total width of the trigger button area */ getTriggerWidth?(): number; /** [Method] private */ initComponent?(): void; @@ -21146,43 +22521,51 @@ declare module Ext.form.field { export class VTypes { /** [Method] The function used to validate alpha values * @param value String The value + * @returns Boolean true if the RegExp test passed, and false if not. */ static alpha( value?:string ): boolean; /** [Method] The function used to validate alphanumeric values * @param value String The value + * @returns Boolean true if the RegExp test passed, and false if not. */ static alphanum( value?:string ): boolean; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] The function used to validate email addresses * @param value String The email address + * @returns Boolean true if the RegExp test passed, and false if not. */ static email( value?:string ): boolean; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] The function used to validate URLs * @param value String The URL + * @returns Boolean true if the RegExp test passed, and false if not. */ static url( value?:string ): boolean; } @@ -21193,43 +22576,51 @@ declare module Ext.form { export class VTypes { /** [Method] The function used to validate alpha values * @param value String The value + * @returns Boolean true if the RegExp test passed, and false if not. */ static alpha( value?:string ): boolean; /** [Method] The function used to validate alphanumeric values * @param value String The value + * @returns Boolean true if the RegExp test passed, and false if not. */ static alphanum( value?:string ): boolean; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] The function used to validate email addresses * @param value String The email address + * @returns Boolean true if the RegExp test passed, and false if not. */ static email( value?:string ): boolean; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] The function used to validate URLs * @param value String The URL + * @returns Boolean true if the RegExp test passed, and false if not. */ static url( value?:string ): boolean; } @@ -21268,33 +22659,54 @@ declare module Ext.form { labelConnector?: string; /** [Property] (Boolean) */ maskOnDisable?: boolean; - /** [Method] Gets the active error message for this component if any */ + /** [Method] Gets the active error message for this component if any + * @returns String The active error message on the component; if there is no error, an empty string is returned. + */ getActiveError?(): string; - /** [Method] Gets an Array of any active error messages currently applied to the field */ + /** [Method] Gets an Array of any active error messages currently applied to the field + * @returns String[] The active error messages on the component; if there are no errors, an empty Array is returned. + */ getActiveErrors?(): string[]; /** [Method] Takes an Array of invalid Ext form field Field objects and builds a combined list of error messages from them * @param invalidFields Ext.form.field.Field[] An Array of the sub-fields which are currently invalid. + * @returns String[] The combined list of error messages */ getCombinedErrors?( invalidFields?:Ext.form.field.IField[] ): string[]; - /** [Method] Returns the combined field label if combineLabels is set to true and if there is no set fieldLabel */ + /** [Method] Returns the combined field label if combineLabels is set to true and if there is no set fieldLabel + * @returns String The label, or empty string if none. + */ getFieldLabel?(): string; - /** [Method] Get the input id if any for this component */ + /** [Method] Get the input id if any for this component + * @returns String The input id + */ getInputId?(): string; - /** [Method] Gets the width of the label if visible */ + /** [Method] Gets the width of the label if visible + * @returns Number The label width + */ getLabelWidth?(): number; - /** [Method] Generates the arguments for the field decorations rendering template */ + /** [Method] Generates the arguments for the field decorations rendering template + * @returns Object The template arguments + */ getLabelableRenderData?(): any; - /** [Method] Gets the markup to be inserted into the outer template s bodyEl */ + /** [Method] Gets the markup to be inserted into the outer template s bodyEl + * @returns String The markup to be inserted + */ getSubTplMarkup?(): string; - /** [Method] Tells whether the field currently has an active error message */ + /** [Method] Tells whether the field currently has an active error message + * @returns Boolean + */ hasActiveError?(): boolean; - /** [Method] Checks if the field has a visible label */ + /** [Method] Checks if the field has a visible label + * @returns Boolean True if the field has a visible label + */ hasVisibleLabel?(): boolean; /** [Method] Initializes the FieldAncestor s state this must be called from the initComponent method of any components importing */ initFieldAncestor?(): void; /** [Method] Performs initialization of this mixin */ initLabelable?(): void; - /** [Method] Initialized the renderData to be used when rendering the renderTpl */ + /** [Method] Initialized the renderData to be used when rendering the renderTpl + * @returns Object Object with keys and values that are going to be applied to the renderTpl + */ initRenderData?(): any; /** [Method] Called when a Ext form Labelable instance is added to the container s subtree * @param labelable Ext.form.Labelable The instance that was added @@ -21325,7 +22737,9 @@ declare module Ext.form { * @param label String The new label. The labelSeparator will be automatically appended to the label string. */ setFieldLabel?( label?:string ): void; - /** [Method] Returns the trimmed label by slicing off the label separator character */ + /** [Method] Returns the trimmed label by slicing off the label separator character + * @returns String The trimmed field label, or empty string if not defined + */ trimLabelSeparator?(): string; /** [Method] Clears the active error message s */ unsetActiveError?(): void; @@ -21365,21 +22779,33 @@ declare module Ext.form { maskOnDisable?: boolean; /** [Property] (Ext.panel.Tool) */ toggleCmp?: Ext.panel.ITool; - /** [Method] Collapses the fieldset */ + /** [Method] Collapses the fieldset + * @returns Ext.form.FieldSet this + */ collapse?(): Ext.form.IFieldSet; - /** [Method] Creates the checkbox component */ + /** [Method] Creates the checkbox component + * @returns Ext.Component + */ createCheckboxCmp?(): Ext.IComponent; - /** [Method] Creates the legend title component */ + /** [Method] Creates the legend title component + * @returns Ext.Component + */ createTitleCmp?(): Ext.IComponent; - /** [Method] Creates the toggle button component */ + /** [Method] Creates the toggle button component + * @returns Ext.Component + */ createToggleCmp?(): Ext.IComponent; - /** [Method] Expands the fieldset */ + /** [Method] Expands the fieldset + * @returns Ext.form.FieldSet this + */ expand?(): Ext.form.IFieldSet; /** [Method] Used by ComponentQuery child and down to retrieve all of the items which can potentially be considered a child of th * @param deep Object */ getRefItems?( deep?:any ): void; - /** [Method] The supplied default state gathering method for the AbstractComponent class */ + /** [Method] The supplied default state gathering method for the AbstractComponent class + * @returns Object + */ getState?(): any; /** [Method] Initializes the FieldAncestor s state this must be called from the initComponent method of any components importing */ initFieldAncestor?(): void; @@ -21395,6 +22821,7 @@ declare module Ext.form { onFieldValidityChange?( field?:Ext.form.field.IField, valid?:boolean ): void; /** [Method] Sets the title of this fieldset * @param title String The new title. + * @returns Ext.form.FieldSet this */ setTitle?( title?:string ): Ext.form.IFieldSet; /** [Method] Toggle the fieldset s collapsed state to the opposite of what it is currently */ @@ -21414,6 +22841,7 @@ declare module Ext.form { /** [Method] Updates the label s innerHTML with the specified string * @param text String The new label text * @param encode Boolean False to skip HTML-encoding the text when rendering it to the label. This might be useful if you want to include tags in the label's innerHTML rather than rendering them as string literals per the default logic. + * @returns Ext.form.Label this */ setText?( text?:string, encode?:boolean ): Ext.form.ILabel; } @@ -21490,23 +22918,41 @@ declare module Ext.form { labelCell?: Ext.IElement; /** [Property] (Ext.Element) */ labelEl?: Ext.IElement; - /** [Method] Gets the active error message for this component if any */ + /** [Method] Gets the active error message for this component if any + * @returns String The active error message on the component; if there is no error, an empty string is returned. + */ getActiveError?(): string; - /** [Method] Gets an Array of any active error messages currently applied to the field */ + /** [Method] Gets an Array of any active error messages currently applied to the field + * @returns String[] The active error messages on the component; if there are no errors, an empty Array is returned. + */ getActiveErrors?(): string[]; - /** [Method] Returns the label for the field */ + /** [Method] Returns the label for the field + * @returns String The configured field label, or empty string if not defined + */ getFieldLabel?(): string; - /** [Method] Get the input id if any for this component */ + /** [Method] Get the input id if any for this component + * @returns String The input id + */ getInputId?(): string; - /** [Method] Gets the width of the label if visible */ + /** [Method] Gets the width of the label if visible + * @returns Number The label width + */ getLabelWidth?(): number; - /** [Method] Generates the arguments for the field decorations rendering template */ + /** [Method] Generates the arguments for the field decorations rendering template + * @returns Object The template arguments + */ getLabelableRenderData?(): any; - /** [Method] Gets the markup to be inserted into the outer template s bodyEl */ + /** [Method] Gets the markup to be inserted into the outer template s bodyEl + * @returns String The markup to be inserted + */ getSubTplMarkup?(): string; - /** [Method] Tells whether the field currently has an active error message */ + /** [Method] Tells whether the field currently has an active error message + * @returns Boolean + */ hasActiveError?(): boolean; - /** [Method] Checks if the field has a visible label */ + /** [Method] Checks if the field has a visible label + * @returns Boolean True if the field has a visible label + */ hasVisibleLabel?(): boolean; /** [Method] Performs initialization of this mixin */ initLabelable?(): void; @@ -21526,7 +22972,9 @@ declare module Ext.form { * @param label String The new label. The labelSeparator will be automatically appended to the label string. */ setFieldLabel?( label?:string ): void; - /** [Method] Returns the trimmed label by slicing off the label separator character */ + /** [Method] Returns the trimmed label by slicing off the label separator character + * @returns String The trimmed field label, or empty string if not defined + */ trimLabelSeparator?(): string; /** [Method] Clears the active error message s */ unsetActiveError?(): void; @@ -21542,24 +22990,33 @@ declare module Ext.form { pollInterval?: number; /** [Method] Forces each field within the form panel to check if its value has changed */ checkChange?(): void; - /** [Method] Provides access to the Form which this Panel contains */ + /** [Method] Provides access to the Form which this Panel contains + * @returns Ext.form.Basic The Form which this Panel contains. + */ getForm?(): Ext.form.IBasic; - /** [Method] Returns the currently loaded Ext data Model instance if one was loaded via loadRecord */ + /** [Method] Returns the currently loaded Ext data Model instance if one was loaded via loadRecord + * @returns Ext.data.Model The loaded instance + */ getRecord?(): Ext.data.IModel; /** [Method] Convenience function for fetching the current value of each field in the form * @param asString Boolean If true, will return the key/value collection as a single URL-encoded param string. * @param dirtyOnly Boolean If true, only fields that are dirty will be included in the result. * @param includeEmptyText Boolean If true, the configured emptyText of empty fields will be used. * @param useDataValues Boolean If true, the getModelData method is used to retrieve values from fields, otherwise the getSubmitData method is used. + * @returns String/Object */ getValues?( asString?:boolean, dirtyOnly?:boolean, includeEmptyText?:boolean, useDataValues?:boolean ): any; /** [Method] Convenience function to check if the form has any invalid fields */ hasInvalidField?(): void; /** [Method] Initializes the FieldAncestor s state this must be called from the initComponent method of any components importing */ initFieldAncestor?(): void; - /** [Method] Convenience function to check if the form has any dirty fields */ + /** [Method] Convenience function to check if the form has any dirty fields + * @returns Boolean + */ isDirty?(): boolean; - /** [Method] Convenience function to check if the form has all valid fields */ + /** [Method] Convenience function to check if the form has all valid fields + * @returns Boolean + */ isValid?(): boolean; /** [Method] This is a proxy for the underlying BasicForm s Ext form Basic load call * @param options Object The options to pass to the action (see Ext.form.Basic.load and Ext.form.Basic.doAction for details) @@ -21567,6 +23024,7 @@ declare module Ext.form { load?( options?:any ): void; /** [Method] Loads an Ext data Model into this form internally just calls Ext form Basic loadRecord See also trackResetOnLoad * @param record Ext.data.Model The record to load + * @returns Ext.form.Basic The Ext.form.Basic attached to this FormPanel */ loadRecord?( record?:Ext.data.IModel ): Ext.form.IBasic; /** [Method] Fired when the error message of any field within the container changes @@ -21591,6 +23049,7 @@ declare module Ext.form { submit?( options?:any ): void; /** [Method] Persists the values in this form into the passed Ext data Model object in a beginEdit endEdit block * @param record Ext.data.Model The record to edit + * @returns Ext.form.Basic The Ext.form.Basic attached to this FormPanel */ updateRecord?( record?:Ext.data.IModel ): Ext.form.IBasic; } @@ -21605,24 +23064,33 @@ declare module Ext { pollInterval?: number; /** [Method] Forces each field within the form panel to check if its value has changed */ checkChange?(): void; - /** [Method] Provides access to the Form which this Panel contains */ + /** [Method] Provides access to the Form which this Panel contains + * @returns Ext.form.Basic The Form which this Panel contains. + */ getForm?(): Ext.form.IBasic; - /** [Method] Returns the currently loaded Ext data Model instance if one was loaded via loadRecord */ + /** [Method] Returns the currently loaded Ext data Model instance if one was loaded via loadRecord + * @returns Ext.data.Model The loaded instance + */ getRecord?(): Ext.data.IModel; /** [Method] Convenience function for fetching the current value of each field in the form * @param asString Boolean If true, will return the key/value collection as a single URL-encoded param string. * @param dirtyOnly Boolean If true, only fields that are dirty will be included in the result. * @param includeEmptyText Boolean If true, the configured emptyText of empty fields will be used. * @param useDataValues Boolean If true, the getModelData method is used to retrieve values from fields, otherwise the getSubmitData method is used. + * @returns String/Object */ getValues?( asString?:boolean, dirtyOnly?:boolean, includeEmptyText?:boolean, useDataValues?:boolean ): any; /** [Method] Convenience function to check if the form has any invalid fields */ hasInvalidField?(): void; /** [Method] Initializes the FieldAncestor s state this must be called from the initComponent method of any components importing */ initFieldAncestor?(): void; - /** [Method] Convenience function to check if the form has any dirty fields */ + /** [Method] Convenience function to check if the form has any dirty fields + * @returns Boolean + */ isDirty?(): boolean; - /** [Method] Convenience function to check if the form has all valid fields */ + /** [Method] Convenience function to check if the form has all valid fields + * @returns Boolean + */ isValid?(): boolean; /** [Method] This is a proxy for the underlying BasicForm s Ext form Basic load call * @param options Object The options to pass to the action (see Ext.form.Basic.load and Ext.form.Basic.doAction for details) @@ -21630,6 +23098,7 @@ declare module Ext { load?( options?:any ): void; /** [Method] Loads an Ext data Model into this form internally just calls Ext form Basic loadRecord See also trackResetOnLoad * @param record Ext.data.Model The record to load + * @returns Ext.form.Basic The Ext.form.Basic attached to this FormPanel */ loadRecord?( record?:Ext.data.IModel ): Ext.form.IBasic; /** [Method] Fired when the error message of any field within the container changes @@ -21654,6 +23123,7 @@ declare module Ext { submit?( options?:any ): void; /** [Method] Persists the values in this form into the passed Ext data Model object in a beginEdit endEdit block * @param record Ext.data.Model The record to edit + * @returns Ext.form.Basic The Ext.form.Basic attached to this FormPanel */ updateRecord?( record?:Ext.data.IModel ): Ext.form.IBasic; } @@ -21668,24 +23138,33 @@ declare module Ext.form { pollInterval?: number; /** [Method] Forces each field within the form panel to check if its value has changed */ checkChange?(): void; - /** [Method] Provides access to the Form which this Panel contains */ + /** [Method] Provides access to the Form which this Panel contains + * @returns Ext.form.Basic The Form which this Panel contains. + */ getForm?(): Ext.form.IBasic; - /** [Method] Returns the currently loaded Ext data Model instance if one was loaded via loadRecord */ + /** [Method] Returns the currently loaded Ext data Model instance if one was loaded via loadRecord + * @returns Ext.data.Model The loaded instance + */ getRecord?(): Ext.data.IModel; /** [Method] Convenience function for fetching the current value of each field in the form * @param asString Boolean If true, will return the key/value collection as a single URL-encoded param string. * @param dirtyOnly Boolean If true, only fields that are dirty will be included in the result. * @param includeEmptyText Boolean If true, the configured emptyText of empty fields will be used. * @param useDataValues Boolean If true, the getModelData method is used to retrieve values from fields, otherwise the getSubmitData method is used. + * @returns String/Object */ getValues?( asString?:boolean, dirtyOnly?:boolean, includeEmptyText?:boolean, useDataValues?:boolean ): any; /** [Method] Convenience function to check if the form has any invalid fields */ hasInvalidField?(): void; /** [Method] Initializes the FieldAncestor s state this must be called from the initComponent method of any components importing */ initFieldAncestor?(): void; - /** [Method] Convenience function to check if the form has any dirty fields */ + /** [Method] Convenience function to check if the form has any dirty fields + * @returns Boolean + */ isDirty?(): boolean; - /** [Method] Convenience function to check if the form has all valid fields */ + /** [Method] Convenience function to check if the form has all valid fields + * @returns Boolean + */ isValid?(): boolean; /** [Method] This is a proxy for the underlying BasicForm s Ext form Basic load call * @param options Object The options to pass to the action (see Ext.form.Basic.load and Ext.form.Basic.doAction for details) @@ -21693,6 +23172,7 @@ declare module Ext.form { load?( options?:any ): void; /** [Method] Loads an Ext data Model into this form internally just calls Ext form Basic loadRecord See also trackResetOnLoad * @param record Ext.data.Model The record to load + * @returns Ext.form.Basic The Ext.form.Basic attached to this FormPanel */ loadRecord?( record?:Ext.data.IModel ): Ext.form.IBasic; /** [Method] Fired when the error message of any field within the container changes @@ -21717,6 +23197,7 @@ declare module Ext.form { submit?( options?:any ): void; /** [Method] Persists the values in this form into the passed Ext data Model object in a beginEdit endEdit block * @param record Ext.data.Model The record to edit + * @returns Ext.form.Basic The Ext.form.Basic attached to this FormPanel */ updateRecord?( record?:Ext.data.IModel ): Ext.form.IBasic; } @@ -21735,6 +23216,7 @@ declare module Ext.form { checkChange?(): void; /** [Method] Sets the value of the radio group * @param value Object The map from names to values to be set. + * @returns Ext.form.CheckboxGroup this */ setValue?( value?:any ): Ext.form.ICheckboxGroup; } @@ -21746,6 +23228,7 @@ declare module Ext.form { /** [Method] Adds an item to the collection * @param key String/Object The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param obj Object The item to add. + * @returns Object The item added. */ static add( key?:any, obj?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -21761,6 +23244,7 @@ declare module Ext.form { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -21769,45 +23253,49 @@ declare module Ext.form { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all items from the collection */ static clear(): void; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ static clearManagedListeners(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ static clone(): Ext.util.IMixedCollection; /** [Method] Collects unique values of a particular property in this MixedCollection * @param property String The property to collect on * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param allowBlank Boolean Pass true to allow null, undefined or empty string values + * @returns Array The unique values */ static collect( property?:string, root?:string, allowBlank?:boolean ): any[]; /** [Method] Returns true if the collection contains the passed Object as an item * @param o Object The Object to look for in the collection. + * @returns Boolean True if the collection contains the Object as an item. */ static contains( o?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean True if the collection contains the Object as a key. */ static containsKey( key?:string ): boolean; /** [Method] Executes the specified function once for every item in the collection @@ -21823,23 +23311,19 @@ declare module Ext.form { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Filters the objects in this collection by a set of Filters or by a single property value pair with optional paramete * @param property Ext.util.Filter[]/String A property on your objects, or an array of Filter objects * @param value String/RegExp Either string that the property values should start with or a RegExp to test against the property * @param anyMatch Boolean True to match any part of the string, not just the beginning * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Ext.util.MixedCollection The new filtered collection */ - static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any; - static filter( property?:Ext.util.IFilter[], value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:Ext.util.IFilter[], value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - static filter( property?:string, value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; + static filter( property?:any, value?:any, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ static filterBy( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function */ @@ -21847,6 +23331,7 @@ declare module Ext.form { /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function, or null if none was found. */ static findBy( fn?:any, scope?:any ): any; /** [Method] Finds the index of the first matching object in this collection by a specific property value @@ -21855,82 +23340,97 @@ declare module Ext.form { * @param start Number The index to start searching at. * @param anyMatch Boolean True to match any part of the string, not just the beginning. * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Number The matched index or -1 */ - static findIndex( property?:any, value?:any, start?:any, anyMatch?:any, caseSensitive?:any ): any; - static findIndex( property?:string, value?:string, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; - static findIndex( property?:string, value?:RegExp, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; + static findIndex( property?:string, value?:any, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index or -1 */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] Calculates the insertion index of the new item based upon the comparison function passed or the current sort order * @param newItem Object The new object to find the insertion position of. * @param sorterFn Function The function to sort by. This is the same as the sorting function passed to sortBy. It accepts 2 items from this MixedCollection, and returns -1 0, or 1 depending on the relative sort positions of the 2 compared items. If omitted, a function generated from the currently defined set of sorters will be used. + * @returns Number The insertion point to add the new item into this MixedCollection at using insert */ static findInsertionIndex( newItem?:any, sorterFn?:any ): number; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection.. + */ static first(): any; /** [Method] Returns a comparator function which compares two items and returns 1 0 or 1 depending on the currently defined set */ static generateComparator(): void; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ static get( key?:any ): any; - static get( key?:string ): any; - static get( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ static getAt( index?:number ): any; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ static getByKey( key?:any ): any; - static getByKey( key?:string ): any; - static getByKey( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ static getCount(): number; - /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place */ + /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place + * @returns Ext.util.Sorter The sorter, null if none exist + */ static getFirstSorter(): Ext.util.ISorter; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] A function which will be called passing a newly added object when the object is added without a separate id * @param item Object The item for which to find the key. + * @returns Object The key for the passed item. */ static getKey( item?:any ): any; /** [Method] Returns a range of items in this collection * @param startIndex Number The starting index. Defaults to 0. * @param endIndex Number The ending index. Defaults to the last item. + * @returns Array An array of items */ static getRange( startIndex?:number, endIndex?:number ): any[]; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Returns index within the collection of the passed Object * @param o Object The item to find the index of. + * @returns Number index of the item. Returns -1 if not found. */ static indexOf( o?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number index of the key. */ static indexOfKey( key?:string ): number; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Performs initialization of this mixin */ @@ -21939,9 +23439,12 @@ declare module Ext.form { * @param index Number The index to insert the item at. * @param key String/Object/String[]/Object[] The key to associate with the new item, or the item itself. May also be an array of either to insert multiple items at once. * @param o Object/Object[] If the second parameter was a key, the new item. May also be an array to insert multiple items at once. + * @returns Object The item inserted or an array of items inserted. */ static insert( index?:number, key?:any, o?:any ): any; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection.. + */ static last(): any; /** [Method] Shorthand for addManagedListener * @param item Ext.util.Observable/Ext.Element The item to which to add a listener/listeners. @@ -21949,46 +23452,49 @@ declare module Ext.form { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Remove an item from the collection * @param o Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( o?:any ): any; /** [Method] Remove all items in the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ static removeAll( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ static removeAt( index?:number ): any; /** [Method] Removes an item associated with the passed key fom the collection * @param key String The key of the item to remove. If null is passed, all objects which yielded no key from the configured getKey function are removed. + * @returns Object Only returned if removing at a specified key. The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] Removes an event handler @@ -22003,12 +23509,11 @@ declare module Ext.form { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Remove a range of items starting at a specified index in the collection * @param index Number The index within the collection of the item to remove. * @param removeCount Number The nuber of items to remove beginning at the specified index. + * @returns Object The last item removed or false if no item was removed. */ static removeRange( index?:number, removeCount?:number ): any; /** [Method] Reorders each of the items based on a mapping from old index to new index @@ -22018,6 +23523,7 @@ declare module Ext.form { /** [Method] Replaces an item in the collection * @param key String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param o Object {Object} o (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( key?:string, o?:any ): any; /** [Method] Resumes firing of the named event s @@ -22029,10 +23535,9 @@ declare module Ext.form { /** [Method] Sorts the data in the Store by one or more of its properties * @param sorters String/Ext.util.Sorter[] Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations. * @param direction String The overall direction to sort the data by. + * @returns Ext.util.Sorter[] */ - static sort( sorters?:any, direction?:any ): any; - static sort( sorters?:string, direction?:string ): Ext.util.ISorter[]; - static sort( sorters?:Ext.util.ISorter[], direction?:string ): Ext.util.ISorter[]; + static sort( sorters?:any, direction?:string ): Ext.util.ISorter[]; /** [Method] Sorts the collection by a single sorter function * @param sorterFn Function The function to sort by */ @@ -22042,13 +23547,16 @@ declare module Ext.form { * @param fn Function Comparison function that defines the sort order. Defaults to sorting by case insensitive string. */ static sortByKey( direction?:string, fn?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Collects all of the values of the given property and returns their sum * @param property String The property to sum by * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param start Number The record index to start at * @param end Number The record index to end at + * @returns Number The total */ static sum( property?:string, root?:string, start?:number, end?:number ): number; /** [Method] Suspends firing of the named event s @@ -22079,6 +23587,7 @@ declare module Ext { /** [Method] Create an alias to the provided method property with name methodName of object * @param object Object/Function * @param methodName String + * @returns Function aliasFn */ static alias( object?:any, methodName?:string ): any; /** [Method] Create a new function from the provided fn change this to the provided scope optionally overrides arguments for the @@ -22086,12 +23595,12 @@ declare module Ext { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the default global environment object (usually the browser window). * @param args Array Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if True args are appended to call args instead of overriding, if a number the args are inserted at the specified position + * @returns Function The new function */ - static bind( fn?:any, scope?:any, args?:any, appendArgs?:any ): any; - static bind( fn?:any, scope?:any, args?:any[], appendArgs?:boolean ): any; - static bind( fn?:any, scope?:any, args?:any[], appendArgs?:number ): any; + static bind( fn?:any, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Create a clone of the provided method * @param method Function + * @returns Function cloneFn */ static clone( method?:any ): any; /** [Method] Creates a delegate function optionally with a bound scope which when called buffers the execution of the passed fu @@ -22099,6 +23608,7 @@ declare module Ext { * @param buffer Number The number of milliseconds by which to buffer the invocation of the function. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope specified by the caller. * @param args Array Override arguments for the call. Defaults to the arguments passed by the caller. + * @returns Function A function which invokes the passed function after buffering for the specified time. */ static createBuffered( fn?:any, buffer?:number, scope?:any, args?:any[] ): any; /** [Method] Creates a delegate callback which when called executes after a specific delay @@ -22107,27 +23617,29 @@ declare module Ext { * @param scope Object The scope (this reference) used by the function at execution time. * @param args Array Override arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if True args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Function A function which, when called, executes the original function after the specified delay. */ - static createDelayed( fn?:any, delay?:any, scope?:any, args?:any, appendArgs?:any ): any; - static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:boolean ): any; - static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:number ): any; + static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Creates an interceptor function * @param origFn Function The original function. * @param newFn Function The function to call before the original * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope in which the original function is called or the browser window. * @param returnValue Object The value to return if the passed function return false. + * @returns Function The new function */ static createInterceptor( origFn?:any, newFn?:any, scope?:any, returnValue?:any ): any; /** [Method] Create a combined function call sequence of the original function the passed function * @param originalFn Function The original function. * @param newFn Function The function to sequence * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope in which the original function is called or the default global environment object (usually the browser window). + * @returns Function The new function */ static createSequence( originalFn?:any, newFn?:any, scope?:any ): any; /** [Method] Creates a throttled version of the passed function which when called repeatedly and rapidly invokes the passed func * @param fn Function The function to execute at a regular time interval. * @param interval Number The interval in milliseconds on which the passed function is executed. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope specified by the caller. + * @returns Function A function which invokes the passed function at the specified interval. */ static createThrottled( fn?:any, interval?:number, scope?:any ): any; /** [Method] Calls this function after the number of millseconds specified optionally in a specific scope @@ -22136,12 +23648,12 @@ declare module Ext { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the browser window. * @param args Array Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if True args are appended to call args instead of overriding, if a number the args are inserted at the specified position + * @returns Number The timeout id that can be used with clearTimeout */ - static defer( fn?:any, millis?:any, scope?:any, args?:any, appendArgs?:any ): any; - static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:boolean ): number; - static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:number ): number; + static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:any ): number; /** [Method] A very commonly used method throughout the framework * @param setter Function + * @returns Function flexSetter */ static flexSetter( setter?:any ): any; /** [Method] Adds behavior to an existing method that is executed after the original behavior of the function @@ -22149,6 +23661,7 @@ declare module Ext { * @param methodName String Name of the method to override * @param fn Function Function with the new behavior. It will be called with the same arguments as the original method. The return value of this function will be the return value of the new method. * @param scope Object The scope to execute the interceptor function. Defaults to the object. + * @returns Function The new function just created. */ static interceptAfter( object?:any, methodName?:string, fn?:any, scope?:any ): any; /** [Method] Adds behavior to an existing method that is executed before the original behavior of the function @@ -22156,12 +23669,14 @@ declare module Ext { * @param methodName String Name of the method to override * @param fn Function Function with the new behavior. It will be called with the same arguments as the original method. The return value of this function will be the return value of the new method. * @param scope Object The scope to execute the interceptor function. Defaults to the object. + * @returns Function The new function just created. */ static interceptBefore( object?:any, methodName?:string, fn?:any, scope?:any ): any; /** [Method] Create a new function from the provided fn the arguments of which are pre set to args * @param fn Function The original function * @param args Array The arguments to pass to new callback * @param scope Object The scope (this reference) in which the function is executed. + * @returns Function The new callback function */ static pass( fn?:any, args?:any[], scope?:any ): any; } @@ -22173,6 +23688,7 @@ declare module Ext.util { /** [Method] Create an alias to the provided method property with name methodName of object * @param object Object/Function * @param methodName String + * @returns Function aliasFn */ static alias( object?:any, methodName?:string ): any; /** [Method] Create a new function from the provided fn change this to the provided scope optionally overrides arguments for the @@ -22180,12 +23696,12 @@ declare module Ext.util { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the default global environment object (usually the browser window). * @param args Array Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if True args are appended to call args instead of overriding, if a number the args are inserted at the specified position + * @returns Function The new function */ - static bind( fn?:any, scope?:any, args?:any, appendArgs?:any ): any; - static bind( fn?:any, scope?:any, args?:any[], appendArgs?:boolean ): any; - static bind( fn?:any, scope?:any, args?:any[], appendArgs?:number ): any; + static bind( fn?:any, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Create a clone of the provided method * @param method Function + * @returns Function cloneFn */ static clone( method?:any ): any; /** [Method] Creates a delegate function optionally with a bound scope which when called buffers the execution of the passed fu @@ -22193,6 +23709,7 @@ declare module Ext.util { * @param buffer Number The number of milliseconds by which to buffer the invocation of the function. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope specified by the caller. * @param args Array Override arguments for the call. Defaults to the arguments passed by the caller. + * @returns Function A function which invokes the passed function after buffering for the specified time. */ static createBuffered( fn?:any, buffer?:number, scope?:any, args?:any[] ): any; /** [Method] Creates a delegate callback which when called executes after a specific delay @@ -22201,27 +23718,29 @@ declare module Ext.util { * @param scope Object The scope (this reference) used by the function at execution time. * @param args Array Override arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if True args are appended to call args instead of overriding, if a number the args are inserted at the specified position. + * @returns Function A function which, when called, executes the original function after the specified delay. */ - static createDelayed( fn?:any, delay?:any, scope?:any, args?:any, appendArgs?:any ): any; - static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:boolean ): any; - static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:number ): any; + static createDelayed( fn?:any, delay?:number, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Creates an interceptor function * @param origFn Function The original function. * @param newFn Function The function to call before the original * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope in which the original function is called or the browser window. * @param returnValue Object The value to return if the passed function return false. + * @returns Function The new function */ static createInterceptor( origFn?:any, newFn?:any, scope?:any, returnValue?:any ): any; /** [Method] Create a combined function call sequence of the original function the passed function * @param originalFn Function The original function. * @param newFn Function The function to sequence * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope in which the original function is called or the default global environment object (usually the browser window). + * @returns Function The new function */ static createSequence( originalFn?:any, newFn?:any, scope?:any ): any; /** [Method] Creates a throttled version of the passed function which when called repeatedly and rapidly invokes the passed func * @param fn Function The function to execute at a regular time interval. * @param interval Number The interval in milliseconds on which the passed function is executed. * @param scope Object The scope (this reference) in which the passed function is executed. If omitted, defaults to the scope specified by the caller. + * @returns Function A function which invokes the passed function at the specified interval. */ static createThrottled( fn?:any, interval?:number, scope?:any ): any; /** [Method] Calls this function after the number of millseconds specified optionally in a specific scope @@ -22230,12 +23749,12 @@ declare module Ext.util { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the browser window. * @param args Array Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if True args are appended to call args instead of overriding, if a number the args are inserted at the specified position + * @returns Number The timeout id that can be used with clearTimeout */ - static defer( fn?:any, millis?:any, scope?:any, args?:any, appendArgs?:any ): any; - static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:boolean ): number; - static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:number ): number; + static defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:any ): number; /** [Method] A very commonly used method throughout the framework * @param setter Function + * @returns Function flexSetter */ static flexSetter( setter?:any ): any; /** [Method] Adds behavior to an existing method that is executed after the original behavior of the function @@ -22243,6 +23762,7 @@ declare module Ext.util { * @param methodName String Name of the method to override * @param fn Function Function with the new behavior. It will be called with the same arguments as the original method. The return value of this function will be the return value of the new method. * @param scope Object The scope to execute the interceptor function. Defaults to the object. + * @returns Function The new function just created. */ static interceptAfter( object?:any, methodName?:string, fn?:any, scope?:any ): any; /** [Method] Adds behavior to an existing method that is executed before the original behavior of the function @@ -22250,12 +23770,14 @@ declare module Ext.util { * @param methodName String Name of the method to override * @param fn Function Function with the new behavior. It will be called with the same arguments as the original method. The return value of this function will be the return value of the new method. * @param scope Object The scope to execute the interceptor function. Defaults to the object. + * @returns Function The new function just created. */ static interceptBefore( object?:any, methodName?:string, fn?:any, scope?:any ): any; /** [Method] Create a new function from the provided fn the arguments of which are pre set to args * @param fn Function The original function * @param args Array The arguments to pass to new callback * @param scope Object The scope (this reference) in which the function is executed. + * @returns Function The new callback function */ static pass( fn?:any, args?:any[], scope?:any ): any; } @@ -22307,6 +23829,7 @@ declare module Ext.fx { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -22315,10 +23838,9 @@ declare module Ext.fx { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -22326,23 +23848,24 @@ declare module Ext.fx { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fire afteranimate event and end the animation */ end?(): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -22351,30 +23874,29 @@ declare module Ext.fx { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -22389,9 +23911,7 @@ declare module Ext.fx { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -22449,6 +23969,7 @@ declare module Ext.fx { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -22457,10 +23978,9 @@ declare module Ext.fx { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -22468,23 +23988,24 @@ declare module Ext.fx { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fire afteranimate event and end the animation */ end?(): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -22493,30 +24014,29 @@ declare module Ext.fx { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -22531,9 +24051,7 @@ declare module Ext.fx { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -22562,28 +24080,32 @@ declare module Ext.fx { export class CubicBezier { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -22603,32 +24125,36 @@ declare module Ext.fx { static addAnim( anim?:Ext.fx.IAnim ): void; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Remove an Anim from the manager * @param anim Ext.fx.Anim */ static removeAnim( anim?:Ext.fx.IAnim ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -22723,6 +24249,7 @@ declare module Ext.grid.column { /** [Method] Cascades down the component container heirarchy from this component passed in the first call calling the specified * @param fn Object * @param scope Object + * @returns Ext.Container this */ cascade?( fn?:any, scope?:any ): Ext.IContainer; /** [Method] Renderer closure iterates through items creating an element for each and tagging with an identifying class name x ac @@ -22739,16 +24266,12 @@ declare module Ext.grid.column { * @param index Number/Ext.grid.column.Action * @param silent Boolean */ - disableAction?( index?:any, silent?:any ): any; - disableAction?( index?:number, silent?:boolean ): void; - disableAction?( index?:Ext.grid.column.IAction, silent?:boolean ): void; + disableAction?( index?:any, silent?:boolean ): void; /** [Method] Enables this ActionColumn s action at the specified index * @param index Number/Ext.grid.column.Action * @param silent Boolean */ - enableAction?( index?:any, silent?:any ): any; - enableAction?( index?:number, silent?:boolean ): void; - enableAction?( index?:Ext.grid.column.IAction, silent?:boolean ): void; + enableAction?( index?:any, silent?:boolean ): void; /** [Method] Private override because this cannot function as a Container and it has an items property which is an Array NOT a M */ getRefItems?(): void; } @@ -22784,6 +24307,7 @@ declare module Ext.grid { /** [Method] Cascades down the component container heirarchy from this component passed in the first call calling the specified * @param fn Object * @param scope Object + * @returns Ext.Container this */ cascade?( fn?:any, scope?:any ): Ext.IContainer; /** [Method] Renderer closure iterates through items creating an element for each and tagging with an identifying class name x ac @@ -22800,16 +24324,12 @@ declare module Ext.grid { * @param index Number/Ext.grid.column.Action * @param silent Boolean */ - disableAction?( index?:any, silent?:any ): any; - disableAction?( index?:number, silent?:boolean ): void; - disableAction?( index?:Ext.grid.column.IAction, silent?:boolean ): void; + disableAction?( index?:any, silent?:boolean ): void; /** [Method] Enables this ActionColumn s action at the specified index * @param index Number/Ext.grid.column.Action * @param silent Boolean */ - enableAction?( index?:any, silent?:any ): any; - enableAction?( index?:number, silent?:boolean ): void; - enableAction?( index?:Ext.grid.column.IAction, silent?:boolean ): void; + enableAction?( index?:any, silent?:boolean ): void; /** [Method] Private override because this cannot function as a Container and it has an items property which is an Array NOT a M */ getRefItems?(): void; } @@ -22946,27 +24466,35 @@ declare module Ext.grid.column { /** [Method] Sizes this Column to fit the max content width * @param The Ext.grid.column.Column/Number header (or index of header) to auto size. */ - autoSize?( The?:any ): any; - autoSize?( The?:Ext.grid.column.IColumn ): void; - autoSize?( The?:number ): void; + autoSize?( The?:any ): void; /** [Method] When defined this will take precedence over the renderer config */ defaultRenderer?(): void; /** [Method] Retrieves the editing field for editing associated with this header * @param record Object The Model instance being edited. * @param defaultField Object An object representing a default field to be created + * @returns any field */ getEditor?( record?:any, defaultField?:any ): any; - /** [Method] Returns the index of this column only if this column is a base level Column */ + /** [Method] Returns the index of this column only if this column is a base level Column + * @returns Number + */ getIndex?(): number; - /** [Method] Returns the parameter to sort upon when sorting this header */ + /** [Method] Returns the parameter to sort upon when sorting this header + * @returns String + */ getSortParam?(): string; - /** [Method] Returns the index of this column in the list of visible columns only if this column is a base level Column */ + /** [Method] Returns the index of this column in the list of visible columns only if this column is a base level Column + * @returns Number + */ getVisibleIndex?(): number; /** [Method] Hides this Component setting it to invisible using the configured hideMode * @param fromOwner Object + * @returns Ext.Component this */ hide?( fromOwner?:any ): Ext.IComponent; - /** [Method] Initialized the renderData to be used when rendering the renderTpl */ + /** [Method] Initialized the renderData to be used when rendering the renderTpl + * @returns Object Object with keys and values that are going to be applied to the renderTpl + */ initRenderData?(): any; /** [Method] Determines whether the UI should be allowed to offer an option to hide this column */ isHideable?(): void; @@ -22993,6 +24521,7 @@ declare module Ext.grid.column { /** [Method] Shows this Component rendering it first if autoRender or floating are true * @param fromOwner Object * @param fromChild Object + * @returns Ext.Component this */ show?( fromOwner?:any, fromChild?:any ): Ext.IComponent; } @@ -23077,27 +24606,35 @@ declare module Ext.grid { /** [Method] Sizes this Column to fit the max content width * @param The Ext.grid.column.Column/Number header (or index of header) to auto size. */ - autoSize?( The?:any ): any; - autoSize?( The?:Ext.grid.column.IColumn ): void; - autoSize?( The?:number ): void; + autoSize?( The?:any ): void; /** [Method] When defined this will take precedence over the renderer config */ defaultRenderer?(): void; /** [Method] Retrieves the editing field for editing associated with this header * @param record Object The Model instance being edited. * @param defaultField Object An object representing a default field to be created + * @returns any field */ getEditor?( record?:any, defaultField?:any ): any; - /** [Method] Returns the index of this column only if this column is a base level Column */ + /** [Method] Returns the index of this column only if this column is a base level Column + * @returns Number + */ getIndex?(): number; - /** [Method] Returns the parameter to sort upon when sorting this header */ + /** [Method] Returns the parameter to sort upon when sorting this header + * @returns String + */ getSortParam?(): string; - /** [Method] Returns the index of this column in the list of visible columns only if this column is a base level Column */ + /** [Method] Returns the index of this column in the list of visible columns only if this column is a base level Column + * @returns Number + */ getVisibleIndex?(): number; /** [Method] Hides this Component setting it to invisible using the configured hideMode * @param fromOwner Object + * @returns Ext.Component this */ hide?( fromOwner?:any ): Ext.IComponent; - /** [Method] Initialized the renderData to be used when rendering the renderTpl */ + /** [Method] Initialized the renderData to be used when rendering the renderTpl + * @returns Object Object with keys and values that are going to be applied to the renderTpl + */ initRenderData?(): any; /** [Method] Determines whether the UI should be allowed to offer an option to hide this column */ isHideable?(): void; @@ -23124,6 +24661,7 @@ declare module Ext.grid { /** [Method] Shows this Component rendering it first if autoRender or floating are true * @param fromOwner Object * @param fromChild Object + * @returns Ext.Component this */ show?( fromOwner?:any, fromChild?:any ): Ext.IComponent; } @@ -23272,14 +24810,17 @@ declare module Ext.grid { export interface IColumnManager extends Ext.IBase { /** [Method] Get a leaf level header by index regardless of what the nesting structure is * @param index Number The column index for which to retrieve the column. + * @returns Ext.grid.column.Column The header. null if it doesn't exist. */ getHeaderAtIndex?( index?:number ): Ext.grid.column.IColumn; /** [Method] Get a leaf level header by index regardless of what the nesting structure is * @param id String The id + * @returns Ext.grid.column.Column The header. null if it doesn't exist. */ getHeaderById?( id?:string ): Ext.grid.column.IColumn; /** [Method] Returns the index of a leaf level header regardless of what the nesting structure is * @param header Ext.grid.column.Column The header to find the index of + * @returns Number The index of the specified column header */ getHeaderIndex?( header?:Ext.grid.column.IColumn ): number; /** [Method] When passed a column index returns the closet visible column to that @@ -23292,14 +24833,17 @@ declare module Ext.grid { export interface IColumnModel extends Ext.IBase { /** [Method] Get a leaf level header by index regardless of what the nesting structure is * @param index Number The column index for which to retrieve the column. + * @returns Ext.grid.column.Column The header. null if it doesn't exist. */ getHeaderAtIndex?( index?:number ): Ext.grid.column.IColumn; /** [Method] Get a leaf level header by index regardless of what the nesting structure is * @param id String The id + * @returns Ext.grid.column.Column The header. null if it doesn't exist. */ getHeaderById?( id?:string ): Ext.grid.column.IColumn; /** [Method] Returns the index of a leaf level header regardless of what the nesting structure is * @param header Ext.grid.column.Column The header to find the index of + * @returns Number The index of the specified column header */ getHeaderIndex?( header?:Ext.grid.column.IColumn ): number; /** [Method] When passed a column index returns the closet visible column to that @@ -23400,10 +24944,12 @@ declare module Ext.grid.feature { getFireEventArgs?( type?:any, view?:any, targetEl?:any, e?:any ): void; /** [Method] Returns the group data object for the group to which the passed record belongs if the Store is grouped * @param record Ext.data.Model The record for which to return group information. + * @returns Object A single group data block as returned from Store.getGroups. Returns undefined if the Store is not grouped. */ getRecordGroup?( record?:Ext.data.IModel ): any; /** [Method] Returns true if the named group is expanded * @param groupName String The group name as returned from getGroupString. This is usually the value of the groupField. + * @returns Boolean true if the group defined by that value is expanded. */ isExpanded?( groupName?:string ): boolean; /** [Method] Toggle whether or not to show the summary row @@ -23422,6 +24968,7 @@ declare module Ext.grid.feature { export interface IGroupStore extends Ext.util.IObservable { /** [Method] Get the index within the entire dataset * @param record Ext.data.Model The Ext.data.Model object to find. + * @returns Number The index of the passed Record. Returns -1 if not found. */ indexOfTotal?( record?:Ext.data.IModel ): number; } @@ -23486,6 +25033,7 @@ declare module Ext.grid.header { /** [Method] Returns an array of all columns which appear in the grid s View * @param inResult Object * @param hiddenAncestor Object + * @returns Array */ getGridColumns?( inResult?:any, hiddenAncestor?:any ): any[]; /** [Method] Get a leaf level header by index regardless of what the nesting structure is @@ -23494,11 +25042,16 @@ declare module Ext.grid.header { getHeaderAtIndex?( index?:number ): void; /** [Method] Returns the index of a leaf level header regardless of what the nesting structure is * @param header Ext.grid.column.Column The header to find the index of + * @returns Number The index of the specified column header */ getHeaderIndex?( header?:Ext.grid.column.IColumn ): number; - /** [Method] Returns an array of menu items to be placed into the shared menu across all headers in this header container */ + /** [Method] Returns an array of menu items to be placed into the shared menu across all headers in this header container + * @returns Array menuItems + */ getMenuItems?(): any[]; - /** [Method] Returns an array of the visible columns in the grid */ + /** [Method] Returns an array of the visible columns in the grid + * @returns Array + */ getVisibleGridColumns?(): any[]; /** [Method] When passed a column index returns the closet visible column to that * @param index Number Position at which to find the closest visible column. @@ -23524,13 +25077,20 @@ declare module Ext.grid.header { export interface IDragZone extends Ext.dd.IDragZone { /** [Method] Called when a mousedown occurs in this container * @param e Object + * @returns Object The dragData */ getDragData?( e?:any ): any; - /** [Method] Called before a repair of an invalid drop to get the XY to animate to */ + /** [Method] Called before a repair of an invalid drop to get the XY to animate to + * @returns Number[] The xy location (e.g. [100, 200]) + */ getRepairXY?(): number[]; - /** [Method] An empty function by default but provided so that you can perform a custom action before the initial drag event begi */ + /** [Method] An empty function by default but provided so that you can perform a custom action before the initial drag event begi + * @returns Boolean isValid True if the drag event is valid, else false to cancel + */ onBeforeDrag?(): boolean; - /** [Method] Called once drag threshold has been reached to initialize the proxy element */ + /** [Method] Called once drag threshold has been reached to initialize the proxy element + * @returns Boolean true to continue the drag, false to cancel + */ onInitDrag?(): boolean; } } @@ -23538,6 +25098,7 @@ declare module Ext.grid.header { export interface IDropZone extends Ext.dd.IDropZone { /** [Method] Returns a custom data object associated with the DOM node that is the target of the event * @param e Object + * @returns Object data The custom data */ getTargetFromEvent?( e?:any ): any; /** [Method] Called when the DropZone determines that a Ext dd DragSource has been dropped onto the drop node @@ -23545,6 +25106,7 @@ declare module Ext.grid.header { * @param dragZone Object * @param e Object * @param data Object + * @returns Boolean True if the drop was valid, else false */ onNodeDrop?( node?:any, dragZone?:any, e?:any, data?:any ): boolean; /** [Method] Called when the DropZone determines that a Ext dd DragSource has been dragged out of the drop node without dropping */ @@ -23554,13 +25116,16 @@ declare module Ext.grid.header { * @param dragZone Object * @param e Object * @param data Object + * @returns String status The CSS class that communicates the drop status back to the source so that the underlying Ext.dd.StatusProxy can be updated */ onNodeOver?( node?:any, dragZone?:any, e?:any, data?:any ): string; } } declare module Ext.grid.locking { export interface IHeaderContainer extends Ext.grid.header.IContainer { - /** [Method] This is the function which all other column access methods are based upon Return the full column set for the whole Lo */ + /** [Method] This is the function which all other column access methods are based upon Return the full column set for the whole Lo + * @returns Array + */ getGridColumns?(): any[]; /** [Method] Used by ComponentQuery child and down to retrieve all of the items which can potentially be considered a child of th */ getRefItems?(): void; @@ -23619,6 +25184,7 @@ declare module Ext.grid.locking { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -23627,10 +25193,9 @@ declare module Ext.grid.locking { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -23638,21 +25203,22 @@ declare module Ext.grid.locking { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -23661,30 +25227,29 @@ declare module Ext.grid.locking { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -23699,9 +25264,7 @@ declare module Ext.grid.locking { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -23737,6 +25300,7 @@ declare module Ext.grid { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -23745,10 +25309,9 @@ declare module Ext.grid { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -23756,21 +25319,22 @@ declare module Ext.grid { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -23779,30 +25343,29 @@ declare module Ext.grid { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -23817,9 +25380,7 @@ declare module Ext.grid { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -23944,12 +25505,9 @@ declare module Ext.grid.plugin { /** [Method] Starts editing the specified record using the specified Column definition to define which field is being edited * @param record Ext.data.Model/Number The Store data record which backs the row to be edited, or index of the record. * @param columnHeader Ext.grid.column.Column/Number The Column object defining the column to be edited, or index of the column. + * @returns Boolean true if editing was started, false otherwise. */ - startEdit?( record?:any, columnHeader?:any ): any; - startEdit?( record?:Ext.data.IModel, columnHeader?:Ext.grid.column.IColumn ): boolean; - startEdit?( record?:number, columnHeader?:Ext.grid.column.IColumn ): boolean; - startEdit?( record?:Ext.data.IModel, columnHeader?:number ): boolean; - startEdit?( record?:number, columnHeader?:number ): boolean; + startEdit?( record?:any, columnHeader?:any ): boolean; /** [Method] Starts editing by position row column * @param position Object A position with keys of row and column. */ @@ -23999,6 +25557,7 @@ declare module Ext.grid.plugin { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -24007,10 +25566,9 @@ declare module Ext.grid.plugin { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Cancels any active edit that is in progress */ cancelEdit?(): void; /** [Method] Removes all listeners for this object including the managed listeners */ @@ -24022,21 +25580,22 @@ declare module Ext.grid.plugin { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -24045,30 +25604,29 @@ declare module Ext.grid.plugin { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -24083,9 +25641,7 @@ declare module Ext.grid.plugin { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -24096,11 +25652,7 @@ declare module Ext.grid.plugin { * @param record Ext.data.Model/Number The Store data record which backs the row to be edited, or index of the record in Store. * @param columnHeader Ext.grid.column.Column/Number The Column object defining the column to be edited, or index of the column. */ - startEdit?( record?:any, columnHeader?:any ): any; - startEdit?( record?:Ext.data.IModel, columnHeader?:Ext.grid.column.IColumn ): void; - startEdit?( record?:number, columnHeader?:Ext.grid.column.IColumn ): void; - startEdit?( record?:Ext.data.IModel, columnHeader?:number ): void; - startEdit?( record?:number, columnHeader?:number ): void; + startEdit?( record?:any, columnHeader?:any ): void; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. */ @@ -24137,7 +25689,9 @@ declare module Ext.grid.plugin { disable?(): void; /** [Method] The base implementation just sets the plugin s disabled flag to false Plugin subclasses which need more complex proc */ enable?(): void; - /** [Method] Returns the value of dynamic */ + /** [Method] Returns the value of dynamic + * @returns Boolean + */ getDynamic?(): boolean; /** [Method] not using w and e resize bc we are only ever resizing one column wResizeCursor Ext isWebKit w resize col resi * @param headerCt Object @@ -24160,6 +25714,7 @@ declare module Ext.grid.plugin { /** [Method] Starts editing the specified record using the specified Column definition to define which field is being edited * @param record Ext.data.Model The Store data record which backs the row to be edited. * @param columnHeader Ext.data.Model The Column object defining the column to be edited. + * @returns Boolean true if editing was started, false otherwise. */ startEdit?( record?:Ext.data.IModel, columnHeader?:Ext.data.IModel ): boolean; } @@ -24202,7 +25757,9 @@ declare module Ext.grid.property { sourceConfig?: any; /** [Config Option] (String) */ valueField?: string; - /** [Method] Gets the source data object containing the property data */ + /** [Method] Gets the source data object containing the property data + * @returns Object The data object. + */ getSource?(): any; /** [Method] Removes a property from the grid * @param prop String The name of the property to remove. @@ -24245,7 +25802,9 @@ declare module Ext.grid { sourceConfig?: any; /** [Config Option] (String) */ valueField?: string; - /** [Method] Gets the source data object containing the property data */ + /** [Method] Gets the source data object containing the property data + * @returns Object The data object. + */ getSource?(): any; /** [Method] Removes a property from the grid * @param prop String The name of the property to remove. @@ -24292,7 +25851,9 @@ declare module Ext.grid.property { export interface IStore extends Ext.data.IStore { /** [Config Option] (Boolean) */ sortOnLoad?: boolean; - /** [Method] Return a singleton customized Proxy object which configures itself with a custom Reader */ + /** [Method] Return a singleton customized Proxy object which configures itself with a custom Reader + * @returns Ext.data.proxy.Proxy The Proxy instance + */ getProxy?(): Ext.data.proxy.IProxy; } } @@ -24300,7 +25861,9 @@ declare module Ext.grid { export interface IPropertyStore extends Ext.data.IStore { /** [Config Option] (Boolean) */ sortOnLoad?: boolean; - /** [Method] Return a singleton customized Proxy object which configures itself with a custom Reader */ + /** [Method] Return a singleton customized Proxy object which configures itself with a custom Reader + * @returns Ext.data.proxy.Proxy The Proxy instance + */ getProxy?(): Ext.data.proxy.IProxy; } } @@ -24314,10 +25877,13 @@ declare module Ext.grid { afterRender?(): void; /** [Method] Lie to the CQ system about our nesting structure */ getRefItems?(): void; - /** [Method] Convenience function to check if the form has any dirty fields */ + /** [Method] Convenience function to check if the form has any dirty fields + * @returns Boolean + */ isDirty?(): boolean; /** [Method] Loads an Ext data Model into this form internally just calls Ext form Basic loadRecord See also trackResetOnLoad * @param record Object + * @returns Ext.form.Basic The Ext.form.Basic attached to this FormPanel */ loadRecord?( record?:any ): Ext.form.IBasic; /** [Method] Possibly animates down to a target element */ @@ -24509,9 +26075,7 @@ declare module Ext { /** [Method] Adds namespace s to known list * @param namespace String/String[] */ - export function addNamespaces( namespace?:any ): any; - export function addNamespaces( namespace?:string ): void; - export function addNamespaces( namespace?:string[] ): void; + export function addNamespaces( namespace?:any ): void; /** [Method] Loads Ext app Application class and starts it up with given configuration after the page is ready * @param config Object/String Application config object or name of a class derived from Ext.app.Application. */ @@ -24520,11 +26084,13 @@ declare module Ext { * @param object Object The receiver of the properties * @param config Object The source of the properties * @param defaults Object A different object that will also be applied for default values + * @returns Object returns obj */ export function apply( object?:any, config?:any, defaults?:any ): any; /** [Method] Copies all the properties of config to object if they don t already exist * @param object Object The receiver of the properties * @param config Object The source of the properties + * @returns Object returns obj */ export function applyIf( object?:any, config?:any ): any; /** [Method] Utility wrapper that suspends layouts of all components for the duration of a given function @@ -24537,28 +26103,31 @@ declare module Ext { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the default global environment object (usually the browser window). * @param args Array Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if True args are appended to call args instead of overriding, if a number the args are inserted at the specified position + * @returns Function The new function */ - export function bind( fn?:any, scope?:any, args?:any, appendArgs?:any ): any; - export function bind( fn?:any, scope?:any, args?:any[], appendArgs?:boolean ): any; - export function bind( fn?:any, scope?:any, args?:any[], appendArgs?:number ): any; + export function bind( fn?:any, scope?:any, args?:any[], appendArgs?:any ): any; /** [Method] Execute a callback function in a particular scope * @param callback Function The callback to execute * @param scope Object The scope to execute in * @param args Array The arguments to pass to the function * @param delay Number Pass a number to delay the call by a number of milliseconds. + * @returns Object The value returned by the callback or undefined (if there is a delay or if the callback is not a function). */ export function callback( callback?:any, scope?:any, args?:any[], delay?:number ): any; /** [Method] Old alias to Ext Array clean * @param array Array + * @returns Array results */ export function clean( array?:any[] ): any[]; /** [Method] Clone simple variables including array like objects DOM nodes and Date without keeping the old reference * @param item Object The variable to clone + * @returns Object clone */ export function clone( item?:any ): any; /** [Method] Coerces the first value if possible so that it is comparable to the second value * @param from Mixed The value to coerce * @param to Mixed The value it must be compared against + * @returns Object The coerced value. */ export function coerce( from?:any, to?:any ): any; /** [Method] Copies a set of named properties fom the source object to the destination object @@ -24566,18 +26135,19 @@ declare module Ext { * @param source Object The source object. * @param names String/String[] Either an Array of property names, or a comma-delimited list of property names to copy. * @param usePrototypeKeys Boolean Defaults to false. Pass true to copy keys off of the prototype as well as the instance. + * @returns Object The modified object. */ - export function copyTo( dest?:any, source?:any, names?:any, usePrototypeKeys?:any ): any; - export function copyTo( dest?:any, source?:any, names?:string, usePrototypeKeys?:boolean ): any; - export function copyTo( dest?:any, source?:any, names?:string[], usePrototypeKeys?:boolean ): any; + export function copyTo( dest?:any, source?:any, names?:any, usePrototypeKeys?:boolean ): any; /** [Method] Instantiate a class by either full name alias or alternate name * @param name String The class name or alias. Can be specified as xclass property if only one object parameter is specified. * @param args Object... Additional arguments after the name will be passed to the class' constructor. + * @returns Object instance */ export function create( name:string, ...args:any[] ): any; /** [Method] Instantiate a class by its alias * @param alias String * @param args Object... Additional arguments after the alias will be passed to the class constructor. + * @returns Object instance */ export function createByAlias( alias:string, ...args:any[] ): any; /** [Method] Old name for widget */ @@ -24585,6 +26155,7 @@ declare module Ext { /** [Method] Shorthand for Ext JSON decode * @param json String The JSON string * @param safe Boolean True to return null, false to throw an exception if the JSON is invalid. + * @returns Object The resulting object */ export function decode( json?:string, safe?:boolean ): any; /** [Method] Calls this function after the number of millseconds specified optionally in a specific scope @@ -24593,14 +26164,14 @@ declare module Ext { * @param scope Object The scope (this reference) in which the function is executed. If omitted, defaults to the browser window. * @param args Array Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param appendArgs Boolean/Number if True args are appended to call args instead of overriding, if a number the args are inserted at the specified position + * @returns Number The timeout id that can be used with clearTimeout */ - export function defer( fn?:any, millis?:any, scope?:any, args?:any, appendArgs?:any ): any; - export function defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:boolean ): number; - export function defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:number ): number; + export function defer( fn?:any, millis?:number, scope?:any, args?:any[], appendArgs?:any ): number; /** [Method] Defines a class or override * @param className String The class name to create in string dot-namespaced format, for example: 'My.very.awesome.Class', 'FeedViewer.plugin.CoolPager' It is highly recommended to follow this simple convention: - The root and the class name are 'CamelCased' - Everything else is lower-cased Pass null to create an anonymous class. * @param data Object The key - value pairs of properties to apply to this class. Property names can be of any valid strings, except those in the reserved listed below: - mixins - statics - config - alias - self - singleton - alternateClassName - override * @param createdFn Function Optional callback to execute after the class is created, the execution scope of which (this) will be the newly created class itself. + * @returns Ext.Base */ export function define( className?:string, data?:any, createdFn?:any ): Ext.IBase; /** [Method] Create a closure for deprecated code @@ -24613,11 +26184,7 @@ declare module Ext { /** [Method] Attempts to destroy any objects passed to it by removing all event listeners removing them from the DOM if applicab * @param args Ext.dom.Element/Ext.util.Observable/Ext.dom.Element[]/Ext.util.Observable[]... Any number of elements or components, or an Array of either of these to destroy. */ - export function destroy( args?:any ): any; - export function destroy( args?:Ext.dom.IElement ): void; - export function destroy( args?:Ext.util.IObservable ): void; - export function destroy( args?:Ext.dom.IElement[] ): void; - export function destroy( args:Ext.util.IObservable[] ): void; + export function destroy( args?:any ): void; /** [Method] Attempts to destroy and then remove a set of named properties of the passed object * @param o Object The object (most likely a Component) who's properties you wish to destroy. * @param args String... One or more names of the properties to destroy and remove from the object. @@ -24628,105 +26195,123 @@ declare module Ext { * @param fn Function The callback function. If it returns false, the iteration stops and this method returns the current index. * @param scope Object The scope (this reference) in which the specified function is executed. * @param reverse Boolean Reverse the iteration order (loop from the end to the beginning) Defaults false + * @returns Boolean See description for the fn parameter. */ export function each( iterable?:any, fn?:any, scope?:any, reverse?:boolean ): boolean; /** [Method] Shorthand for Ext JSON encode * @param o Object The variable to encode + * @returns String The JSON string */ export function encode( o?:any ): string; /** [Method] Escapes the passed string for use in a regular expression * @param str String + * @returns String */ export function escapeRe( str?:string ): string; /** [Method] Convenient shortcut to Ext Loader exclude * @param excludes Array + * @returns Object object contains require method for chaining */ export function exclude( excludes?:any[] ): any; /** [Method] This method deprecated * @param superclass Function * @param overrides Object + * @returns Function The subclass constructor from the overrides parameter, or a generated one if not provided. */ export function extend( superclass?:any, overrides?:any ): any; /** [Method] Old alias to Ext Array flatten * @param array Array The array to flatten + * @returns Array The 1-d array. */ export function flatten( array?:any[] ): any[]; /** [Method] Gets the singleton flyweight element with the passed node as the active element * @param dom String/HTMLElement The dom node or id * @param named String Allows for creation of named reusable flyweights to prevent conflicts (e.g. internally Ext uses "_global") + * @returns Ext.dom.Element.Fly The singleton flyweight object (or null if no matching element was found) */ - export function fly( dom?:any, named?:any ): any; - export function fly( dom?:string, named?:string ): Ext.dom.element.IFly; - export function fly( dom?:HTMLElement, named?:string ): Ext.dom.element.IFly; + export function fly( dom?:any, named?:string ): Ext.dom.element.IFly; /** [Method] Retrieves Ext dom Element objects * @param el String/HTMLElement/Ext.Element The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element The Element object (or null if no matching element was found) + */ + export function get( el?:any ): Ext.dom.IElement; + /** [Method] Returns the current document body as an Ext Element + * @returns Ext.Element The document body */ - export function get( el?:any ): any; - export function get( el?:string ): Ext.dom.IElement; - export function get( el?:HTMLElement ): Ext.dom.IElement; - export function get( el?:Ext.IElement ): Ext.dom.IElement; - /** [Method] Returns the current document body as an Ext Element */ export function getBody(): Ext.IElement; /** [Method] Get the class of the provided object returns null if it s not an instance of any class created with Ext define * @param object Object + * @returns Ext.Class class */ export function getClass( object?:any ): Ext.IClass; /** [Method] Get the name of the class by its reference or its instance Ext ClassManager getName is usually invoked by the short * @param object Ext.Class/Object + * @returns String className */ export function getClassName( object?:any ): string; /** [Method] This is shorthand reference to Ext ComponentManager get * @param id String The component id + * @returns Object Ext.Component The Component, undefined if not found, or null if a Class was found. */ export function getCmp( id?:string ): any; - /** [Method] Returns the current HTML document object as an Ext Element */ + /** [Method] Returns the current HTML document object as an Ext Element + * @returns Ext.Element The document + */ export function getDoc(): Ext.IElement; /** [Method] Returns the dom node for the passed String id dom node or Ext Element * @param el String/HTMLElement/Ext.Element + * @returns Object HTMLElement */ export function getDom( el?:any ): any; - export function getDom( el?:string ): any; - export function getDom( el?:HTMLElement ): any; - export function getDom( el?:Ext.IElement ): any; - /** [Method] Returns the current document head as an Ext Element */ + /** [Method] Returns the current document head as an Ext Element + * @returns Ext.Element The document head + */ export function getHead(): Ext.IElement; /** [Method] Get namespace prefix for a class name * @param className String + * @returns String Namespace prefix if it's known, otherwise undefined */ export function getNamespace( className?:string ): string; - /** [Method] Returns the current orientation of the mobile device */ + /** [Method] Returns the current orientation of the mobile device + * @returns String Either 'portrait' or 'landscape' + */ export function getOrientation(): string; /** [Method] Utility method for getting the width of the browser s vertical scrollbar * @param force Boolean true to force a recalculation of the value. + * @returns Number The width of a vertical scrollbar. */ export function getScrollBarWidth( force?:boolean ): number; /** [Method] Returns the size of the browser scrollbars * @param force Boolean true to force a recalculation of the value. + * @returns Object An object containing scrollbar sizes. */ export function getScrollbarSize( force?:boolean ): any; /** [Method] Shortcut to Ext data StoreManager lookup * @param store String/Object The id of the Store, or a Store instance, or a store configuration + * @returns Ext.data.Store */ export function getStore( store?:any ): Ext.data.IStore; /** [Method] Get the version number of the supplied package name will return the last registered version last Ext setVersion cal * @param packageName String The package name, for example: 'core', 'touch', 'extjs' + * @returns Ext.Version The version */ export function getVersion( packageName?:string ): Ext.IVersion; /** [Method] Old alias to Ext String htmlDecode * @param value String The string to decode. + * @returns String The decoded text. */ export function htmlDecode( value?:string ): string; /** [Method] Old alias to Ext String htmlEncode * @param value String The string to encode. + * @returns String The encoded text. */ export function htmlEncode( value?:string ): string; /** [Method] Generates unique ids * @param el HTMLElement/Ext.Element The element to generate an id for * @param prefix String Id prefix (defaults "ext-gen") + * @returns String The generated Id. */ - export function id( el?:any, prefix?:any ): any; - export function id( el?:HTMLElement, prefix?:string ): string; - export function id( el?:Ext.IElement, prefix?:string ): string; + export function id( el?:any, prefix?:string ): string; /** [Method] A reusable identity function * @param o Object */ @@ -24735,65 +26320,78 @@ declare module Ext { * @param arr Array/NodeList The Array of items to invoke the method on. * @param methodName String The method name to invoke. * @param args Object... Arguments to send into the method invocation. + * @returns Array The results of invoking the method on each item in the array. */ - export function invoke( arr?:any, methodName?:any, args?:any ): any; - export function invoke( arr:any[], methodName:string, ...args:any[] ): any[]; - export function invoke( arr:NodeList, methodName:string, ...args:any[] ): any[]; + export function invoke( arr:any, methodName:string, ...args:any[] ): any[]; /** [Method] Returns true if the passed value is a JavaScript Array false otherwise * @param target Object The target to test + * @returns Boolean */ export function isArray( target?:any ): boolean; /** [Method] Returns true if the passed value is a boolean * @param value Object The value to test + * @returns Boolean */ export function isBoolean( value?:any ): boolean; /** [Method] Returns true if the passed value is a JavaScript Date object false otherwise * @param object Object The object to test + * @returns Boolean */ export function isDate( object?:any ): boolean; /** [Method] Returns true if the passed value is defined * @param value Object The value to test + * @returns Boolean */ export function isDefined( value?:any ): boolean; /** [Method] Returns true if the passed value is an HTMLElement * @param value Object The value to test + * @returns Boolean */ export function isElement( value?:any ): boolean; /** [Method] Returns true if the passed value is empty false otherwise * @param value Object The value to test * @param allowEmptyString Boolean true to allow empty strings (defaults to false) + * @returns Boolean */ export function isEmpty( value?:any, allowEmptyString?:boolean ): boolean; /** [Method] Returns true if the passed value is a JavaScript Function false otherwise * @param value Object The value to test + * @returns Boolean */ export function isFunction( value?:any ): boolean; /** [Method] Returns true if the passed value is iterable that is if elements of it are addressable using array notation with nu * @param value Object The value to test + * @returns Boolean */ export function isIterable( value?:any ): boolean; /** [Method] Returns true if the passed value is a number * @param value Object The value to test + * @returns Boolean */ export function isNumber( value?:any ): boolean; /** [Method] Validates that a value is numeric * @param value Object Examples: 1, '1', '2.34' + * @returns Boolean True if numeric, false otherwise */ export function isNumeric( value?:any ): boolean; /** [Method] Returns true if the passed value is a JavaScript Object false otherwise * @param value Object The value to test + * @returns Boolean */ export function isObject( value?:any ): boolean; /** [Method] Returns true if the passed value is a JavaScript primitive a string number or boolean * @param value Object The value to test + * @returns Boolean */ export function isPrimitive( value?:any ): boolean; /** [Method] Returns true if the passed value is a string * @param value Object The value to test + * @returns Boolean */ export function isString( value?:any ): boolean; /** [Method] Returns true if the passed value is a TextNode * @param value Object The value to test + * @returns Boolean */ export function isTextNode( value?:any ): boolean; /** [Method] Iterates either an array or an object @@ -24810,37 +26408,40 @@ declare module Ext { /** [Method] Old alias to Ext Array max * @param array Array/NodeList The Array from which to select the maximum value. * @param comparisonFn Function a function to perform the comparision which determines maximization. If omitted the ">" operator will be used. Note: gt = 1; eq = 0; lt = -1 + * @returns Object maxValue The maximum value */ export function max( array?:any, comparisonFn?:any ): any; - export function max( array?:any[], comparisonFn?:any ): any; - export function max( array?:NodeList, comparisonFn?:any ): any; /** [Method] Old alias to Ext Array mean * @param array Array The Array to calculate the mean value of. + * @returns Number The mean. */ export function mean( array?:any[] ): number; /** [Method] A convenient alias method for Ext Object merge * @param destination Object The object into which all subsequent objects are merged. * @param object Object... Any number of objects to merge into the destination. + * @returns Object merged The destination object with all passed objects merged in. */ export function merge( destination:any, ...object:any[] ): any; /** [Method] Old alias to Ext Array min * @param array Array/NodeList The Array from which to select the minimum value. * @param comparisonFn Function a function to perform the comparision which determines minimization. If omitted the "<" operator will be used. Note: gt = 1; eq = 0; lt = -1 + * @returns Object minValue The minimum value */ export function min( array?:any, comparisonFn?:any ): any; - export function min( array?:any[], comparisonFn?:any ): any; - export function min( array?:NodeList, comparisonFn?:any ): any; /** [Method] Creates namespaces to be used for scoping variables and classes so that they are not global * @param namespaces String... + * @returns Object The namespace object. (If multiple arguments are passed, this will be the last namespace created) */ export function namespace( ...namespaces:any[] ): any; /** [Method] Convenient alias for Ext namespace * @param namespaces String... + * @returns Object The namespace object. (If multiple arguments are passed, this will be the last namespace created) */ export function ns( ...namespaces:any[] ): any; /** [Method] Validate that a value is numeric and convert it to a number if necessary * @param value Object * @param defaultValue Number The value to return if the original value is non-numeric + * @returns Number value, if numeric, defaultValue otherwise */ export function num( value?:any, defaultValue?:number ): number; /** [Method] Shorthand for the Ext util Observable addListener method of the globalEvents Observable instance @@ -24848,6 +26449,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ export function on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds a listener to be notified when the document is ready before onload and before images are loaded @@ -24870,23 +26472,22 @@ declare module Ext { /** [Method] Partitions the set into two sets a true set and a false set * @param arr Array/NodeList The array to partition * @param truth Function a function to determine truth. If this is omitted the element itself must be able to be evaluated for its truthfulness. + * @returns Array [array of truish values, array of falsy values] */ - export function partition( arr?:any, truth?:any ): any; - export function partition( arr?:any[], truth?:any ): any[]; - export function partition( arr?:NodeList, truth?:any ): any[]; + export function partition( arr?:any, truth?:any ): any[]; /** [Method] Create a new function from the provided fn the arguments of which are pre set to args * @param fn Function The original function * @param args Array The arguments to pass to new callback * @param scope Object The scope (this reference) in which the function is executed. + * @returns Function The new callback function */ export function pass( fn?:any, args?:any[], scope?:any ): any; /** [Method] Old alias to Ext Array pluck * @param array Array/NodeList The Array of items to pluck the value from. * @param propertyName String The property name to pluck from each element. + * @returns Array The value from each item in the Array. */ - export function pluck( array?:any, propertyName?:any ): any; - export function pluck( array?:any[], propertyName?:string ): any[]; - export function pluck( array?:NodeList, propertyName?:string ): any[]; + export function pluck( array?:any, propertyName?:string ): any[]; /** [Method] Shorthand for Ext PluginManager registerType * @param ptype String The ptype mnemonic string by which the Plugin class may be looked up. * @param cls Function The new Plugin class. @@ -24897,11 +26498,13 @@ declare module Ext { * @param root HTMLElement The start of the query. * @param type String Either "select" or "simple" for a simple selector match (only valid when used when the call is deferred to the jsSelect method) * @param single Boolean Pass true to select only the first matching node using document.querySelector (where available) + * @returns HTMLElement[] An array of DOM elements (not a NodeList as returned by querySelectorAll). */ export function query( path?:string, root?:HTMLElement, type?:string, single?:boolean ): HTMLElement[]; /** [Method] Old way for creating Model classes * @param name String Name of the Model class. * @param config Object A configuration object for the Model you wish to create. + * @returns Ext.data.Model The newly registered Model */ export function regModel( name?:string, config?:any ): Ext.data.IModel; /** [Method] Creates a new store for the given id and config then registers it with the Store Manager @@ -24919,11 +26522,7 @@ declare module Ext { * @param scope Object The execution scope (this) of the callback function * @param excludes String/Array Classes to be excluded, useful when being used with expressions */ - export function require( expressions?:any, fn?:any, scope?:any, excludes?:any ): any; - export function require( expressions?:string, fn?:any, scope?:any, excludes?:string ): void; - export function require( expressions?:any[], fn?:any, scope?:any, excludes?:string ): void; - export function require( expressions?:string, fn?:any, scope?:any, excludes?:any[] ): void; - export function require( expressions?:any[], fn?:any, scope?:any, excludes?:any[] ): void; + export function require( expressions?:any, fn?:any, scope?:any, excludes?:any ): void; /** [Method] * @param flush Object */ @@ -24931,6 +26530,7 @@ declare module Ext { /** [Method] Shorthand of Ext Element select * @param selector String The CSS selector * @param unique Boolean True to create a unique Ext.Element for each element. Defaults to a shared flyweight object. + * @returns Ext.CompositeElement The composite element */ export function select( selector?:string, unique?:boolean ): Ext.ICompositeElement; /** [Method] Sets the default font family to use for components that support a glyph config @@ -24940,12 +26540,12 @@ declare module Ext { /** [Method] Set version number for the given package name * @param packageName String The package name, for example: 'core', 'touch', 'extjs' * @param version String/Ext.Version The version, for example: '1.2.3alpha', '2.4.0-dev' + * @returns any */ - export function setVersion( packageName?:any, version?:any ): any; - export function setVersion( packageName?:string, version?:string ): any; - export function setVersion( packageName?:string, version?:Ext.IVersion ): any; + export function setVersion( packageName?:string, version?:any ): any; /** [Method] Old alias to Ext Array sum * @param array Array The Array to calculate the sum value of. + * @returns Number The sum. */ export function sum( array?:any[] ): number; /** [Method] */ @@ -24956,28 +26556,28 @@ declare module Ext { * @param scope Object The execution scope (this) of the callback function * @param excludes String/Array Classes to be excluded, useful when being used with expressions */ - export function syncRequire( expressions?:any, fn?:any, scope?:any, excludes?:any ): any; - export function syncRequire( expressions?:string, fn?:any, scope?:any, excludes?:string ): void; - export function syncRequire( expressions?:any[], fn?:any, scope?:any, excludes?:string ): void; - export function syncRequire( expressions?:string, fn?:any, scope?:any, excludes?:any[] ): void; - export function syncRequire( expressions?:any[], fn?:any, scope?:any, excludes?:any[] ): void; + export function syncRequire( expressions?:any, fn?:any, scope?:any, excludes?:any ): void; /** [Method] Converts any iterable numeric indices and a length property into a true array * @param iterable Object the iterable object to be turned into a true Array. * @param start Number a zero-based index that specifies the start of extraction. Defaults to 0 * @param end Number a 1-based index that specifies the end of extraction. Defaults to the last index of the iterable value + * @returns Array array */ export function toArray( iterable?:any, start?:number, end?:number ): any[]; /** [Method] Turns an array into a sentence joined by a specified connector e g Ext toSentence Adama Tigh Roslin * @param items String[] The array to create a sentence from * @param connector String The string to use to connect the last two words. Usually 'and' or 'or' - defaults to 'and'. + * @returns String The sentence string */ export function toSentence( items?:string[], connector?:string ): string; /** [Method] Old alias to typeOf * @param value Object + * @returns String */ export function type( value?:any ): string; /** [Method] Returns the type of the given variable in string format * @param value Object + * @returns String */ export function typeOf( value?:any ): string; /** [Method] Shorthand for the Ext util Observable removeListener method of the globalEvents Observable instance @@ -24988,47 +26588,53 @@ declare module Ext { export function un( eventName?:string, fn?:any, scope?:any ): void; /** [Method] Old alias to Ext Array unique * @param array Array + * @returns Array results */ export function unique( array?:any[] ): any[]; /** [Method] Old alias to Ext String urlAppend * @param url String The URL to append to. * @param string String The content to append to the URL. + * @returns String The resulting URL */ export function urlAppend( url?:string, string?:string ): string; /** [Method] Alias for Ext Object fromQueryString * @param queryString String The query string to decode * @param recursive Boolean Whether or not to recursively decode the string. This format is supported by PHP / Ruby on Rails servers and similar. + * @returns Object */ export function urlDecode( queryString?:string, recursive?:boolean ): any; /** [Method] Takes an object and converts it to an encoded query string * @param object Object The object to encode * @param recursive Boolean Whether or not to interpret the object in recursive format. (PHP / Ruby on Rails servers and similar). + * @returns String queryString */ export function urlEncode( object?:any, recursive?:boolean ): string; /** [Method] Utility method for returning a default value if the passed value is empty * @param value Object The value to test * @param defaultValue Object The value to return if the original value is empty * @param allowBlank Boolean true to allow zero length strings to qualify as non-empty. + * @returns Object value, if non-empty, else defaultValue */ export function value( value?:any, defaultValue?:any, allowBlank?:boolean ): any; /** [Method] Returns the given value itself if it s not empty as described in isEmpty returns the default value second argument * @param value Object The value to test * @param defaultValue Object The value to return if the original value is empty * @param allowBlank Boolean true to allow zero length strings to qualify as non-empty (defaults to false) + * @returns Object value, if non-empty, else defaultValue */ export function valueFrom( value?:any, defaultValue?:any, allowBlank?:boolean ): any; /** [Method] Convenient shorthand to create a widget by its xtype or a config object * @param name String The xtype of the widget to create. * @param config Object The configuration object for the widget constructor. + * @returns Object The widget instance */ export function widget( name?:string, config?:any ): any; /** [Method] Zips N sets together * @param arr Array/NodeList... This argument may be repeated. Array(s) to contribute values. * @param zipper Function The last item in the argument list. This will drive how the items are zipped together. + * @returns Array The zipped set. */ - export function zip( arr?:any, zipper?:any ): any; - export function zip( arr?:any[], zipper?:any ): any[]; - export function zip( arr:NodeList, zipper:any ): any[]; + export function zip( arr?:any, zipper?:any ): any[]; } declare module Ext { export interface IJSON { @@ -25037,22 +26643,27 @@ declare module Ext { /** [Method] Decodes parses a JSON string to an object * @param json String The JSON string * @param safe Boolean True to return null, false to throw an exception if the JSON is invalid. + * @returns Object The resulting object */ static decode( json?:string, safe?:boolean ): any; /** [Method] Encodes an Object Array or other value * @param o Object The variable to encode + * @returns String The JSON string */ static encode( o?:any ): string; /** [Method] Encodes a Date * @param d Date The Date to encode + * @returns String The string literal to use in a JSON string. */ static encodeDate( d?:any ): string; /** [Method] Encodes a String * @param s String The String to encode + * @returns String The string literal to use in a JSON string. */ static encodeString( s?:string ): string; /** [Method] The function which encode uses to encode all javascript values to their JSON representations when Ext USE_NATIVE_JSON * @param o Object Any javascript value to be converted to its JSON representation + * @returns String The JSON representation of the passed value. */ static encodeValue( o?:any ): string; } @@ -25154,9 +26765,13 @@ declare module Ext.layout.component { * @param ownerContext Object */ finishedLayout?( ownerContext?:any ): void; - /** [Method] Returns the element into which rendering must take place */ + /** [Method] Returns the element into which rendering must take place + * @returns Ext.Element + */ getRenderTarget?(): Ext.IElement; - /** [Method] Returns the owner component s resize element */ + /** [Method] Returns the owner component s resize element + * @returns Ext.Element + */ getTarget?(): Ext.IElement; /** [Method] This method if implemented is called after all layouts are finished and all have a lastComponentSize cached * @param ownerContext Object @@ -25193,14 +26808,18 @@ declare module Ext.layout.component { /** [Method] Retrieve an ordered and or filtered array of all docked Components * @param order String The desired ordering of the items ('render' or 'visual'). * @param beforeBody Boolean An optional flag to limit the set of items to only those before the body (true) or after the body (false). All components are returned by default. + * @returns Ext.Component[] An array of components. */ getDockedItems?( order?:string, beforeBody?:boolean ): Ext.IComponent[]; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object * @param ownerSizeModel Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any, ownerSizeModel?:any ): Ext.layout.ISizePolicy; - /** [Method] Returns an array containing all the visible docked items inside this layout s owner Panel */ + /** [Method] Returns an array containing all the visible docked items inside this layout s owner Panel + * @returns Array An array containing all the visible docked items of the Panel + */ getLayoutItems?(): any[]; /** [Method] The default weighting of docked items produces this arrangement * @param ownerContext Object @@ -25244,14 +26863,18 @@ declare module Ext.layout.component { /** [Method] Retrieve an ordered and or filtered array of all docked Components * @param order String The desired ordering of the items ('render' or 'visual'). * @param beforeBody Boolean An optional flag to limit the set of items to only those before the body (true) or after the body (false). All components are returned by default. + * @returns Ext.Component[] An array of components. */ getDockedItems?( order?:string, beforeBody?:boolean ): Ext.IComponent[]; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object * @param ownerSizeModel Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any, ownerSizeModel?:any ): Ext.layout.ISizePolicy; - /** [Method] Returns an array containing all the visible docked items inside this layout s owner Panel */ + /** [Method] Returns an array containing all the visible docked items inside this layout s owner Panel + * @returns Array An array containing all the visible docked items of the Panel + */ getLayoutItems?(): any[]; /** [Method] The default weighting of docked items produces this arrangement * @param ownerContext Object @@ -25328,6 +26951,7 @@ declare module Ext.layout.component.field { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] Create aliases for existing prototype methods @@ -25337,7 +26961,9 @@ declare module Ext.layout.component.field { static createAlias( alias?:any, origin?:any ): void; /** [Method] Destroy the error tip instance */ static destroyTip(): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; @@ -25345,6 +26971,7 @@ declare module Ext.layout.component.field { static initTip(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -25443,7 +27070,9 @@ declare module Ext.layout.container { * @param ownerContext Object */ beginLayout?( ownerContext?:any ): void; - /** [Method] This method is called when a child item changes in some way */ + /** [Method] This method is called when a child item changes in some way + * @returns Boolean True if this layout has handled the content change. + */ onContentChange?(): boolean; } } @@ -25457,7 +27086,9 @@ declare module Ext.layout { * @param ownerContext Object */ beginLayout?( ownerContext?:any ): void; - /** [Method] This method is called when a child item changes in some way */ + /** [Method] This method is called when a child item changes in some way + * @returns Boolean True if this layout has handled the content change. + */ onContentChange?(): boolean; } } @@ -25553,6 +27184,7 @@ declare module Ext.layout.container { configureItem?( item?:any ): void; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any ): Ext.layout.ISizePolicy; } @@ -25575,6 +27207,7 @@ declare module Ext.layout { configureItem?( item?:any ): void; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any ): Ext.layout.ISizePolicy; } @@ -25614,19 +27247,26 @@ declare module Ext.layout.container { /** [Method] Returns the container size that of the target * @param ownerContext Ext.layout.ContextItem The owner's context item. * @param inDom Boolean True if the container size must be in the DOM. + * @returns Object The size */ getContainerSize?( ownerContext?:Ext.layout.IContextItem, inDom?:boolean ): any; - /** [Method] Overridden method from Ext layout container Container */ + /** [Method] Overridden method from Ext layout container Container + * @returns Ext.Element + */ getElementTarget?(): Ext.IElement; /** [Method] Returns the overflow x style of the render target * @param ownerContext Ext.layout.ContextItem + * @returns String */ getOverflowXStyle?( ownerContext?:Ext.layout.IContextItem ): string; /** [Method] Returns the overflow y style of the render target * @param ownerContext Ext.layout.ContextItem + * @returns String */ getOverflowYStyle?( ownerContext?:Ext.layout.IContextItem ): string; - /** [Method] Overridden method from Ext layout container Container */ + /** [Method] Overridden method from Ext layout container Container + * @returns Ext.Element + */ getRenderTarget?(): Ext.IElement; /** [Method] A one time initialization method called just before rendering */ initLayout?(): void; @@ -25659,9 +27299,12 @@ declare module Ext.layout.container { calculate?( ownerContext?:any ): void; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any ): Ext.layout.ISizePolicy; - /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s */ + /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s + * @returns Ext.Component[] of child components + */ getLayoutItems?(): Ext.IComponent[]; } } @@ -25687,9 +27330,12 @@ declare module Ext.layout { calculate?( ownerContext?:any ): void; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any ): Ext.layout.ISizePolicy; - /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s */ + /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s + * @returns Ext.Component[] of child components + */ getLayoutItems?(): Ext.IComponent[]; } } @@ -25732,14 +27378,19 @@ declare module Ext.layout.container { * @param ownerContext Object */ finishedLayout?( ownerContext?:any ): void; - /** [Method] Overridden method from Ext layout container Container */ + /** [Method] Overridden method from Ext layout container Container + * @returns Ext.Element + */ getElementTarget?(): Ext.IElement; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object * @param ownerSizeModel Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any, ownerSizeModel?:any ): Ext.layout.ISizePolicy; - /** [Method] Overridden method from Ext layout container Container */ + /** [Method] Overridden method from Ext layout container Container + * @returns Ext.Element + */ getRenderTarget?(): Ext.IElement; } } @@ -25782,14 +27433,19 @@ declare module Ext.layout { * @param ownerContext Object */ finishedLayout?( ownerContext?:any ): void; - /** [Method] Overridden method from Ext layout container Container */ + /** [Method] Overridden method from Ext layout container Container + * @returns Ext.Element + */ getElementTarget?(): Ext.IElement; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object * @param ownerSizeModel Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any, ownerSizeModel?:any ): Ext.layout.ISizePolicy; - /** [Method] Overridden method from Ext layout container Container */ + /** [Method] Overridden method from Ext layout container Container + * @returns Ext.Element + */ getRenderTarget?(): Ext.IElement; } } @@ -25852,6 +27508,7 @@ declare module Ext.layout.container.boxoverflow { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -25860,10 +27517,9 @@ declare module Ext.layout.container.boxoverflow { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -25871,23 +27527,26 @@ declare module Ext.layout.container.boxoverflow { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the current scroll position of the innerCt element */ + /** [Method] Returns the current scroll position of the innerCt element + * @returns Number The current scroll position + */ getScrollPosition?(): number; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -25896,30 +27555,29 @@ declare module Ext.layout.container.boxoverflow { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -25934,9 +27592,7 @@ declare module Ext.layout.container.boxoverflow { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -25947,10 +27603,7 @@ declare module Ext.layout.container.boxoverflow { * @param item String/Number/Ext.Component The item to scroll to. Can be a numerical index, component id or a reference to the component itself. * @param animate Boolean True to animate the scrolling */ - scrollToItem?( item?:any, animate?:any ): any; - scrollToItem?( item?:string, animate?:boolean ): void; - scrollToItem?( item?:number, animate?:boolean ): void; - scrollToItem?( item?:Ext.IComponent, animate?:boolean ): void; + scrollToItem?( item?:any, animate?:boolean ): void; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. */ @@ -25998,6 +27651,7 @@ declare module Ext.layout.boxoverflow { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -26006,10 +27660,9 @@ declare module Ext.layout.boxoverflow { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -26017,23 +27670,26 @@ declare module Ext.layout.boxoverflow { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the current scroll position of the innerCt element */ + /** [Method] Returns the current scroll position of the innerCt element + * @returns Number The current scroll position + */ getScrollPosition?(): number; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -26042,30 +27698,29 @@ declare module Ext.layout.boxoverflow { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -26080,9 +27735,7 @@ declare module Ext.layout.boxoverflow { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -26093,10 +27746,7 @@ declare module Ext.layout.boxoverflow { * @param item String/Number/Ext.Component The item to scroll to. Can be a numerical index, component id or a reference to the component itself. * @param animate Boolean True to animate the scrolling */ - scrollToItem?( item?:any, animate?:any ): any; - scrollToItem?( item?:string, animate?:boolean ): void; - scrollToItem?( item?:number, animate?:boolean ): void; - scrollToItem?( item?:Ext.IComponent, animate?:boolean ): void; + scrollToItem?( item?:any, animate?:boolean ): void; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. */ @@ -26117,11 +27767,17 @@ declare module Ext.layout.container { export interface ICard extends Ext.layout.container.IFit { /** [Config Option] (Boolean) */ deferredRender?: boolean; - /** [Method] Return the active visible component in the layout */ + /** [Method] Return the active visible component in the layout + * @returns Ext.Component + */ getActiveItem?(): Ext.IComponent; - /** [Method] Return the active visible component in the layout to the next card */ + /** [Method] Return the active visible component in the layout to the next card + * @returns Ext.Component The next component or false. + */ getNext?(): Ext.IComponent; - /** [Method] Return the active visible component in the layout to the previous card */ + /** [Method] Return the active visible component in the layout to the previous card + * @returns Ext.Component The previous component or false. + */ getPrev?(): Ext.IComponent; /** [Method] Validates item is in the proper place in the dom * @param item Object @@ -26129,28 +27785,36 @@ declare module Ext.layout.container { * @param position Object */ isValidParent?( item?:any, target?:any, position?:any ): void; - /** [Method] Sets the active visible component in the layout to the next card */ + /** [Method] Sets the active visible component in the layout to the next card + * @returns Ext.Component the activated component or false when nothing activated. + */ next?(): Ext.IComponent; - /** [Method] Sets the active visible component in the layout to the previous card */ + /** [Method] Sets the active visible component in the layout to the previous card + * @returns Ext.Component the activated component or false when nothing activated. + */ prev?(): Ext.IComponent; /** [Method] Makes the given card active * @param newCard Ext.Component/Number/String The component, component id, itemId, or index of component. + * @returns Ext.Component the activated component or false when nothing activated. False is returned also when trying to activate an already active card. */ - setActiveItem?( newCard?:any ): any; - setActiveItem?( newCard?:Ext.IComponent ): Ext.IComponent; - setActiveItem?( newCard?:number ): Ext.IComponent; - setActiveItem?( newCard?:string ): Ext.IComponent; + setActiveItem?( newCard?:any ): Ext.IComponent; } } declare module Ext.layout { export interface ICardLayout extends Ext.layout.container.IFit { /** [Config Option] (Boolean) */ deferredRender?: boolean; - /** [Method] Return the active visible component in the layout */ + /** [Method] Return the active visible component in the layout + * @returns Ext.Component + */ getActiveItem?(): Ext.IComponent; - /** [Method] Return the active visible component in the layout to the next card */ + /** [Method] Return the active visible component in the layout to the next card + * @returns Ext.Component The next component or false. + */ getNext?(): Ext.IComponent; - /** [Method] Return the active visible component in the layout to the previous card */ + /** [Method] Return the active visible component in the layout to the previous card + * @returns Ext.Component The previous component or false. + */ getPrev?(): Ext.IComponent; /** [Method] Validates item is in the proper place in the dom * @param item Object @@ -26158,17 +27822,19 @@ declare module Ext.layout { * @param position Object */ isValidParent?( item?:any, target?:any, position?:any ): void; - /** [Method] Sets the active visible component in the layout to the next card */ + /** [Method] Sets the active visible component in the layout to the next card + * @returns Ext.Component the activated component or false when nothing activated. + */ next?(): Ext.IComponent; - /** [Method] Sets the active visible component in the layout to the previous card */ + /** [Method] Sets the active visible component in the layout to the previous card + * @returns Ext.Component the activated component or false when nothing activated. + */ prev?(): Ext.IComponent; /** [Method] Makes the given card active * @param newCard Ext.Component/Number/String The component, component id, itemId, or index of component. + * @returns Ext.Component the activated component or false when nothing activated. False is returned also when trying to activate an already active card. */ - setActiveItem?( newCard?:any ): any; - setActiveItem?( newCard?:Ext.IComponent ): Ext.IComponent; - setActiveItem?( newCard?:number ): Ext.IComponent; - setActiveItem?( newCard?:string ): Ext.IComponent; + setActiveItem?( newCard?:any ): Ext.IComponent; } } declare module Ext.layout.container { @@ -26185,6 +27851,7 @@ declare module Ext.layout.container { calculate?( ownerContext?:any ): void; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any ): Ext.layout.ISizePolicy; /** [Method] A one time initialization method called just before rendering */ @@ -26206,6 +27873,7 @@ declare module Ext.layout.container { /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object * @param ownerSizeModel Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any, ownerSizeModel?:any ): Ext.layout.ISizePolicy; /** [Method] This method sets the height and or width of the outerCt innerCt to adjust for the following browser specific issues @@ -26224,6 +27892,7 @@ declare module Ext.layout { /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object * @param ownerSizeModel Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any, ownerSizeModel?:any ): Ext.layout.ISizePolicy; /** [Method] This method sets the height and or width of the outerCt innerCt to adjust for the following browser specific issues @@ -26257,19 +27926,32 @@ declare module Ext.layout.container { /** [Method] Returns the container size that of the target * @param ownerContext Ext.layout.ContextItem The owner's context item. * @param inDom Boolean True if the container size must be in the DOM. + * @returns Object The size */ getContainerSize?( ownerContext?:Ext.layout.IContextItem, inDom?:boolean ): any; - /** [Method] Returns the element into which extra functional DOM elements can be inserted */ + /** [Method] Returns the element into which extra functional DOM elements can be inserted + * @returns Ext.Element + */ getElementTarget?(): Ext.IElement; - /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s */ + /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s + * @returns Ext.Component[] of child components + */ getLayoutItems?(): Ext.IComponent[]; - /** [Method] Returns the element into which rendering must take place */ + /** [Method] Returns the element into which rendering must take place + * @returns Ext.Element + */ getRenderTarget?(): Ext.IElement; - /** [Method] Returns all items that are rendered */ + /** [Method] Returns all items that are rendered + * @returns Array All matching items + */ getRenderedItems?(): any[]; - /** [Method] Returns the owner component s resize element */ + /** [Method] Returns the owner component s resize element + * @returns Ext.Element + */ getTarget?(): Ext.IElement; - /** [Method] Returns all items that are both rendered and visible */ + /** [Method] Returns all items that are both rendered and visible + * @returns Array All matching items + */ getVisibleItems?(): any[]; /** [Method] Removes items in the childEls array based on the return value of a supplied test function * @param testFn Function The test function. @@ -26301,19 +27983,32 @@ declare module Ext.layout { /** [Method] Returns the container size that of the target * @param ownerContext Ext.layout.ContextItem The owner's context item. * @param inDom Boolean True if the container size must be in the DOM. + * @returns Object The size */ getContainerSize?( ownerContext?:Ext.layout.IContextItem, inDom?:boolean ): any; - /** [Method] Returns the element into which extra functional DOM elements can be inserted */ + /** [Method] Returns the element into which extra functional DOM elements can be inserted + * @returns Ext.Element + */ getElementTarget?(): Ext.IElement; - /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s */ + /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s + * @returns Ext.Component[] of child components + */ getLayoutItems?(): Ext.IComponent[]; - /** [Method] Returns the element into which rendering must take place */ + /** [Method] Returns the element into which rendering must take place + * @returns Ext.Element + */ getRenderTarget?(): Ext.IElement; - /** [Method] Returns all items that are rendered */ + /** [Method] Returns all items that are rendered + * @returns Array All matching items + */ getRenderedItems?(): any[]; - /** [Method] Returns the owner component s resize element */ + /** [Method] Returns the owner component s resize element + * @returns Ext.Element + */ getTarget?(): Ext.IElement; - /** [Method] Returns all items that are both rendered and visible */ + /** [Method] Returns all items that are both rendered and visible + * @returns Array All matching items + */ getVisibleItems?(): any[]; /** [Method] Removes items in the childEls array based on the return value of a supplied test function * @param testFn Function The test function. @@ -26329,6 +28024,7 @@ declare module Ext.layout.container { calculate?( ownerContext?:any ): void; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any ): Ext.layout.ISizePolicy; } @@ -26351,6 +28047,7 @@ declare module Ext.layout.container { /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object * @param ownerSizeModel Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any, ownerSizeModel?:any ): Ext.layout.ISizePolicy; } @@ -26373,6 +28070,7 @@ declare module Ext.layout { /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object * @param ownerSizeModel Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any, ownerSizeModel?:any ): Ext.layout.ISizePolicy; } @@ -26409,21 +28107,27 @@ declare module Ext.layout.container { * @param ownerContext Ext.layout.ContextItem The owner's context item. * @param inDom Boolean True if the container size must be in the DOM. * @param ignoreOverflow Boolean if true scrollbar size will not be subtracted from container size. + * @returns Object The size */ getContainerSize?( ownerContext?:Ext.layout.IContextItem, inDom?:boolean, ignoreOverflow?:boolean ): any; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any ): Ext.layout.ISizePolicy; /** [Method] returns the overflow x style of the render target * @param ownerContext Ext.layout.ContextItem + * @returns String */ getOverflowXStyle?( ownerContext?:Ext.layout.IContextItem ): string; /** [Method] returns the overflow y style of the render target * @param ownerContext Ext.layout.ContextItem + * @returns String */ getOverflowYStyle?( ownerContext?:Ext.layout.IContextItem ): string; - /** [Method] Returns the element into which rendering must take place */ + /** [Method] Returns the element into which rendering must take place + * @returns Ext.Element + */ getRenderTarget?(): Ext.IElement; /** [Method] A one time initialization method called just before rendering */ initLayout?(): void; @@ -26467,21 +28171,27 @@ declare module Ext.layout { * @param ownerContext Ext.layout.ContextItem The owner's context item. * @param inDom Boolean True if the container size must be in the DOM. * @param ignoreOverflow Boolean if true scrollbar size will not be subtracted from container size. + * @returns Object The size */ getContainerSize?( ownerContext?:Ext.layout.IContextItem, inDom?:boolean, ignoreOverflow?:boolean ): any; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Object + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:any ): Ext.layout.ISizePolicy; /** [Method] returns the overflow x style of the render target * @param ownerContext Ext.layout.ContextItem + * @returns String */ getOverflowXStyle?( ownerContext?:Ext.layout.IContextItem ): string; /** [Method] returns the overflow y style of the render target * @param ownerContext Ext.layout.ContextItem + * @returns String */ getOverflowYStyle?( ownerContext?:Ext.layout.IContextItem ): string; - /** [Method] Returns the element into which rendering must take place */ + /** [Method] Returns the element into which rendering must take place + * @returns Ext.Element + */ getRenderTarget?(): Ext.IElement; /** [Method] A one time initialization method called just before rendering */ initLayout?(): void; @@ -26529,7 +28239,9 @@ declare module Ext.layout.container { calculate?( ownerContext?:any ): void; /** [Method] This method if implemented is called after all layouts have completed */ finalizeLayout?(): void; - /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s */ + /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s + * @returns Ext.Component[] of child components + */ getLayoutItems?(): Ext.IComponent[]; /** [Method] Validates item is in the proper place in the dom * @param item Object @@ -26556,7 +28268,9 @@ declare module Ext.layout { calculate?( ownerContext?:any ): void; /** [Method] This method if implemented is called after all layouts have completed */ finalizeLayout?(): void; - /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s */ + /** [Method] Returns an array of child components either for a render phase Performed in the beforeLayout method of the layout s + * @returns Ext.Component[] of child components + */ getLayoutItems?(): Ext.IComponent[]; /** [Method] Validates item is in the proper place in the dom * @param item Object @@ -26608,9 +28322,7 @@ declare module Ext.layout { * @param components Ext.Component/Array An array of Components or a single Component. * @param full Boolean True if all properties should be invalidated, otherwise only those calculated by the component should be invalidated. */ - invalidate?( components?:any, full?:any ): any; - invalidate?( components?:Ext.IComponent, full?:boolean ): void; - invalidate?( components?:any[], full?:boolean ): void; + invalidate?( components?:any, full?:boolean ): void; /** [Method] Removes the ContextItem for an element from the cache and from the parent s children array * @param parent Ext.layout.ContextItem * @param el Ext.dom.Element @@ -26622,21 +28334,20 @@ declare module Ext.layout { * @param firstTime Object */ resetLayout?( layout?:any, ownerContext?:any, firstTime?:any ): void; - /** [Method] Runs the layout calculations */ + /** [Method] Runs the layout calculations + * @returns Boolean True if all layouts were completed, false if not. + */ run?(): boolean; - /** [Method] Performs one layout cycle by calling each layout in the layout queue */ + /** [Method] Performs one layout cycle by calling each layout in the layout queue + * @returns Boolean True if some progress was made, false if not. + */ runCycle?(): boolean; /** [Method] Set the size of a component element or composite or an array of components or elements * @param items Ext.Component/Ext.Component[]/Ext.dom.Element/Ext.dom.Element[]/Ext.dom.CompositeElement The item(s) to size. * @param width Number The new width to set (ignored if undefined or NaN). * @param height Number The new height to set (ignored if undefined or NaN). */ - setItemSize?( items?:any, width?:any, height?:any ): any; - setItemSize?( items?:Ext.IComponent, width?:number, height?:number ): void; - setItemSize?( items?:Ext.IComponent[], width?:number, height?:number ): void; - setItemSize?( items?:Ext.dom.IElement, width?:number, height?:number ): void; - setItemSize?( items?:Ext.dom.IElement[], width?:number, height?:number ): void; - setItemSize?( items?:Ext.dom.ICompositeElement, width?:number, height?:number ): void; + setItemSize?( items?:any, width?:number, height?:number ): void; } } declare module Ext.layout { @@ -26663,48 +28374,59 @@ declare module Ext.layout { domBlock?( layout?:Ext.layout.ILayout, propName?:string ): void; /** [Method] Flushes any updates in the dirty collection to the DOM */ flush?(): void; - /** [Method] Gets the border information for the element as an object with left top right and bottom properties holding border s */ + /** [Method] Gets the border information for the element as an object with left top right and bottom properties holding border s + * @returns Object + */ getBorderInfo?(): any; /** [Method] Returns a ClassList like object to buffer access to this item s element s classes */ getClassList?(): void; /** [Method] Gets a property of this object if it is correct in the DOM * @param propName String The property name (e.g., 'width'). + * @returns Object The property value or undefined if not yet set or is dirty. */ getDomProp?( propName?:string ): any; /** [Method] Returns the context item for an owned element * @param nameOrEl String/Ext.dom.Element The element or the name of an owned element * @param owner Ext.layout.container.Container/Ext.Component The owner of the named element if the passed "nameOrEl" parameter is a String. Defaults to this ContextItem's "target" property. For more details on owned elements see childEls and renderSelectors + * @returns Ext.layout.ContextItem + */ + getEl?( nameOrEl?:any, owner?:any ): Ext.layout.IContextItem; + /** [Method] Gets the frame information for the element as an object with left top right and bottom properties holding border + * @returns Object */ - getEl?( nameOrEl?:any, owner?:any ): any; - getEl?( nameOrEl?:string, owner?:Ext.layout.container.IContainer ): Ext.layout.IContextItem; - getEl?( nameOrEl?:Ext.dom.IElement, owner?:Ext.layout.container.IContainer ): Ext.layout.IContextItem; - getEl?( nameOrEl?:string, owner?:Ext.IComponent ): Ext.layout.IContextItem; - getEl?( nameOrEl?:Ext.dom.IElement, owner?:Ext.IComponent ): Ext.layout.IContextItem; - /** [Method] Gets the frame information for the element as an object with left top right and bottom properties holding border */ getFrameInfo?(): any; - /** [Method] Gets the margin information for the element as an object with left top right and bottom properties holding margin s */ + /** [Method] Gets the margin information for the element as an object with left top right and bottom properties holding margin s + * @returns Object + */ getMarginInfo?(): any; - /** [Method] Gets the padding information for the element as an object with left top right and bottom properties holding padding */ + /** [Method] Gets the padding information for the element as an object with left top right and bottom properties holding padding + * @returns Object + */ getPaddingInfo?(): any; /** [Method] Gets a property of this object * @param propName String The property name that blocked the layout (e.g., 'width'). + * @returns Object The property value or undefined if not yet set. */ getProp?( propName?:string ): any; /** [Method] Returns a style for this item * @param styleName String The CSS style name. + * @returns Object The value of the DOM style (parsed as necessary). */ getStyle?( styleName?:string ): any; /** [Method] Returns styles for this item * @param styleNames String[] The CSS style names. * @param altNames String[] The alternate names for the returned styles. If given, these names must correspond one-for-one to the styleNames. + * @returns Object The values of the DOM styles (parsed as necessary). */ getStyles?( styleNames?:string[], altNames?:string[] ): any; /** [Method] Returns true if the given property is correct in the DOM * @param propName String The property name (e.g., 'width'). + * @returns Boolean */ hasDomProp?( propName?:string ): boolean; /** [Method] Returns true if the given property has been set * @param propName String The property name (e.g., 'width'). + * @returns Boolean */ hasProp?( propName?:string ): boolean; /** [Method] Invalidates the component associated with this item @@ -26725,11 +28447,7 @@ declare module Ext.layout { * @param nameOrEl String/Ext.dom.Element The element or the name of an owned element * @param owner Ext.layout.container.Container/Ext.Component The owner of the named element if the passed "nameOrEl" parameter is a String. Defaults to this ContextItem's "target" property. */ - removeEl?( nameOrEl?:any, owner?:any ): any; - removeEl?( nameOrEl?:string, owner?:Ext.layout.container.IContainer ): void; - removeEl?( nameOrEl?:Ext.dom.IElement, owner?:Ext.layout.container.IContainer ): void; - removeEl?( nameOrEl?:string, owner?:Ext.IComponent ): void; - removeEl?( nameOrEl?:Ext.dom.IElement, owner?:Ext.IComponent ): void; + removeEl?( nameOrEl?:any, owner?:any ): void; /** [Method] Queue the setting of a DOM attribute on this ContextItem s target when next flushed * @param name Object * @param value Object @@ -26754,17 +28472,20 @@ declare module Ext.layout { /** [Method] Sets the height and constrains the height to min maxHeight range * @param height Number The height. * @param dirty Boolean Specifies if the value is currently in the DOM. A value of false indicates that the value is already in the DOM. + * @returns Number The actual height after constraining. */ setHeight?( height?:number, dirty?:boolean ): number; /** [Method] Sets a property value * @param propName String The property name (e.g., 'width'). * @param value Object The new value of the property. * @param dirty Boolean Optionally specifies if the value is currently in the DOM (default is true which indicates the value is not in the DOM and must be flushed at some point). + * @returns Number 1 if this call specified the property value, 0 if not. */ setProp?( propName?:string, value?:any, dirty?:boolean ): number; /** [Method] Sets the height and constrains the width to min maxWidth range * @param width Number The width. * @param dirty Boolean Specifies if the value is currently in the DOM. A value of false indicates that the value is already in the DOM. + * @returns Number The actual width after constraining. */ setWidth?( width?:number, dirty?:boolean ): number; } @@ -26811,6 +28532,7 @@ declare module Ext.layout { finishedLayout?( ownerContext?:Ext.layout.IContextItem ): void; /** [Method] Returns an object describing how this layout manages the size of the given component * @param item Ext.Component + * @returns Ext.layout.SizePolicy An object describing the sizing done by the layout for this item. */ getItemSizePolicy?( item?:Ext.IComponent ): Ext.layout.ISizePolicy; /** [Method] Returns the set of items to layout empty by default */ @@ -26829,6 +28551,7 @@ declare module Ext.layout { notifyOwner?( ownerContext?:Ext.layout.IContextItem ): void; /** [Method] This method is called when a child item changes in some way * @param child Ext.Component The child item that has changed. + * @returns Boolean True if this layout has handled the content change. */ onContentChange?( child?:Ext.IComponent ): boolean; /** [Method] Iterates over all passed items ensuring they are rendered @@ -26890,18 +28613,22 @@ declare module Ext { export class Loader { /** [Method] Sets a batch of path entries * @param paths Object a set of className: path mappings + * @returns Ext.Loader this */ static addClassPathMappings( paths?:Object ): Ext.ILoader; /** [Method] Explicitly exclude files from being loaded * @param excludes Array + * @returns Object object contains require method for chaining */ static exclude( excludes?:any[] ): any; /** [Method] Get the config value corresponding to the specified name * @param name String The config property name + * @returns Object */ static getConfig( name?:string ): any; /** [Method] Translates a className to a file path by adding the the proper prefix and converting the s to s * @param className String + * @returns String path */ static getPath( className?:string ): string; /** [Method] Loads the specified script URL and calls the supplied callbacks @@ -26920,18 +28647,16 @@ declare module Ext { * @param scope Object The execution scope (this) of the callback function * @param excludes String/Array Classes to be excluded, useful when being used with expressions */ - static require( expressions?:any, fn?:any, scope?:any, excludes?:any ): any; - static require( expressions?:string, fn?:any, scope?:any, excludes?:string ): void; - static require( expressions?:any[], fn?:any, scope?:any, excludes?:string ): void; - static require( expressions?:string, fn?:any, scope?:any, excludes?:any[] ): void; - static require( expressions?:any[], fn?:any, scope?:any, excludes?:any[] ): void; + static require( expressions?:any, fn?:any, scope?:any, excludes?:any ): void; /** [Method] Set the configuration for the loader * @param config Object The config object to override the default values + * @returns Ext.Loader this */ static setConfig( config?:any ): Ext.ILoader; /** [Method] Sets the path of a namespace * @param name String/Object See flexSetter * @param path String See flexSetter + * @returns Ext.Loader this */ static setPath( name?:any, path?:string ): Ext.ILoader; /** [Method] Synchronously loads all classes by the given names and all their direct dependencies optionally executes the given c @@ -26940,11 +28665,7 @@ declare module Ext { * @param scope Object The execution scope (this) of the callback function * @param excludes String/Array Classes to be excluded, useful when being used with expressions */ - static syncRequire( expressions?:any, fn?:any, scope?:any, excludes?:any ): any; - static syncRequire( expressions?:string, fn?:any, scope?:any, excludes?:string ): void; - static syncRequire( expressions?:any[], fn?:any, scope?:any, excludes?:string ): void; - static syncRequire( expressions?:string, fn?:any, scope?:any, excludes?:any[] ): void; - static syncRequire( expressions?:any[], fn?:any, scope?:any, excludes?:any[] ): void; + static syncRequire( expressions?:any, fn?:any, scope?:any, excludes?:any ): void; } } declare module Ext { @@ -26979,23 +28700,26 @@ declare module Ext { * @param store Ext.data.AbstractStore The store to bind to */ bindStoreListeners?( store?:Ext.data.IAbstractStore ): void; - /** [Method] Center this Component in its container */ + /** [Method] Center this Component in its container + * @returns Ext.Component this + */ center?(): Ext.IComponent; /** [Method] Moves this floating Component into a constrain region * @param constrainTo String/HTMLElement/Ext.Element/Ext.util.Region The Element or Region into which this Component is to be constrained. Defaults to the element into which this floating Component was rendered. */ - doConstrain?( constrainTo?:any ): any; - doConstrain?( constrainTo?:string ): void; - doConstrain?( constrainTo?:HTMLElement ): void; - doConstrain?( constrainTo?:Ext.IElement ): void; - doConstrain?( constrainTo?:Ext.util.IRegion ): void; - /** [Method] Gets the current store instance */ + doConstrain?( constrainTo?:any ): void; + /** [Method] Gets the current store instance + * @returns Ext.data.AbstractStore The store, null if one does not exist. + */ getStore?(): Ext.data.IAbstractStore; /** [Method] Gets the listeners to bind to a new store * @param store Object + * @returns Object The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance. */ getStoreListeners?( store?:any ): any; - /** [Method] Hides this Component setting it to invisible using the configured hideMode */ + /** [Method] Hides this Component setting it to invisible using the configured hideMode + * @returns Ext.Component this + */ hide?(): Ext.IComponent; /** [Method] Template method it is called when a new store is bound to the current instance * @param store Ext.data.AbstractStore The store being bound @@ -27020,12 +28744,17 @@ declare module Ext { * @param newActive Ext.Component The newly active Component which is taking over topmost zIndex position. */ setActive?( active?:boolean, newActive?:Ext.IComponent ): void; - /** [Method] Shows this Component rendering it first if autoRender or floating are true */ + /** [Method] Shows this Component rendering it first if autoRender or floating are true + * @returns Ext.Component this + */ show?(): Ext.IComponent; - /** [Method] Sends this Component to the back of lower z index than any other visible windows */ + /** [Method] Sends this Component to the back of lower z index than any other visible windows + * @returns Ext.Component this + */ toBack?(): Ext.IComponent; /** [Method] Brings this floating Component to the front of any other visible floating Components managed by the same ZIndexManag * @param preventFocus Boolean Specify true to prevent the Component from being focused. + * @returns Ext.Component this */ toFront?( preventFocus?:boolean ): Ext.IComponent; /** [Method] Unbinds listeners from this component to the store @@ -27145,16 +28874,14 @@ declare module Ext.menu { parentMenu?: Ext.menu.IMenu; /** [Method] Retrieves the first direct child of this container which matches the passed selector or component * @param selector String/Ext.Component An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching child Ext.Component (or null if no match was found). */ child?( selector?:any ): any; - child?( selector?:string ): any; - child?( selector?:Ext.IComponent ): any; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String/Ext.Component An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching descendant Ext.Component (or null if no match was found). */ down?( selector?:any ): any; - down?( selector?:string ): any; - down?( selector?:Ext.IComponent ): any; /** [Method] The initComponent template method is an important initialization step for a Component */ initComponent?(): void; /** [Method] Allows addition of behavior to the destroy operation */ @@ -27165,15 +28892,18 @@ declare module Ext.menu { onRender?(): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned. + * @returns Ext.Component[] Components which matched the selector */ query?( selector?:string ): Ext.IComponent[]; /** [Method] Retrieves all descendant components which match the passed function * @param fn Function The matcher function. It will be called with a single argument, the component being tested. * @param scope Object The scope in which to run the function. If not specified, it will default to the active component. + * @returns Ext.Component[] Components matched by the passed function */ queryBy?( fn?:any, scope?:any ): Ext.IComponent[]; /** [Method] Finds a component at any level under this container matching the id itemId * @param id String The id to find + * @returns Ext.Component The matching id, null if not found */ queryById?( id?:string ): Ext.IComponent; /** [Method] Sets the click handler of this item @@ -27200,6 +28930,7 @@ declare module Ext.menu { setText?( text?:string ): void; /** [Method] Sets the tooltip for this menu item * @param tooltip String/Object This may be: String : A string to be used as innerHTML (html tags are accepted) to show in a tooltip Object : A configuration object for Ext.tip.QuickTipManager.register. + * @returns Ext.menu.Item this */ setTooltip?( tooltip?:any ): Ext.menu.IItem; } @@ -27256,16 +28987,14 @@ declare module Ext.menu { parentMenu?: Ext.menu.IMenu; /** [Method] Retrieves the first direct child of this container which matches the passed selector or component * @param selector String/Ext.Component An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching child Ext.Component (or null if no match was found). */ child?( selector?:any ): any; - child?( selector?:string ): any; - child?( selector?:Ext.IComponent ): any; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String/Ext.Component An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching descendant Ext.Component (or null if no match was found). */ down?( selector?:any ): any; - down?( selector?:string ): any; - down?( selector?:Ext.IComponent ): any; /** [Method] The initComponent template method is an important initialization step for a Component */ initComponent?(): void; /** [Method] Allows addition of behavior to the destroy operation */ @@ -27276,15 +29005,18 @@ declare module Ext.menu { onRender?(): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned. + * @returns Ext.Component[] Components which matched the selector */ query?( selector?:string ): Ext.IComponent[]; /** [Method] Retrieves all descendant components which match the passed function * @param fn Function The matcher function. It will be called with a single argument, the component being tested. * @param scope Object The scope in which to run the function. If not specified, it will default to the active component. + * @returns Ext.Component[] Components matched by the passed function */ queryBy?( fn?:any, scope?:any ): Ext.IComponent[]; /** [Method] Finds a component at any level under this container matching the id itemId * @param id String The id to find + * @returns Ext.Component The matching id, null if not found */ queryById?( id?:string ): Ext.IComponent; /** [Method] Sets the click handler of this item @@ -27311,6 +29043,7 @@ declare module Ext.menu { setText?( text?:string ): void; /** [Method] Sets the tooltip for this menu item * @param tooltip String/Object This may be: String : A string to be used as innerHTML (html tags are accepted) to show in a tooltip Object : A configuration object for Ext.tip.QuickTipManager.register. + * @returns Ext.menu.Item this */ setTooltip?( tooltip?:any ): Ext.menu.IItem; } @@ -27325,34 +29058,41 @@ declare module Ext.menu { export class Manager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns a Ext menu Menu object * @param 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 this. + * @returns Ext.menu.Menu The specified menu, or null if none are found */ static get( menu?:any ): Ext.menu.IMenu; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; - /** [Method] Hides all menus that are currently visible */ + /** [Method] Hides all menus that are currently visible + * @returns Boolean success True if any active menus were hidden. + */ static hideAll(): boolean; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -27362,34 +29102,41 @@ declare module Ext.menu { export class MenuMgr { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns a Ext menu Menu object * @param 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 this. + * @returns Ext.menu.Menu The specified menu, or null if none are found */ static get( menu?:any ): Ext.menu.IMenu; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; - /** [Method] Hides all menus that are currently visible */ + /** [Method] Hides all menus that are currently visible + * @returns Boolean success True if any active menus were hidden. + */ static hideAll(): boolean; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -27423,15 +29170,20 @@ declare module Ext.menu { beforeShow?(): void; /** [Method] Returns whether a menu item can be activated or not * @param item Object + * @returns Boolean */ canActivateItem?( item?:any ): boolean; /** [Method] Deactivates the current active item on the menu if one exists * @param andBlurFocusedItem Object */ deactivateActiveItem?( andBlurFocusedItem?:any ): void; - /** [Method] Hides this Component setting it to invisible using the configured hideMode */ + /** [Method] Hides this Component setting it to invisible using the configured hideMode + * @returns Ext.Component this + */ hide?(): Ext.IComponent; - /** [Method] Menus are never contained and must not ascertain their visibility from the ancestor hierarchy */ + /** [Method] Menus are never contained and must not ascertain their visibility from the ancestor hierarchy + * @returns Boolean true if this component is visible, false otherwise. + */ isVisible?(): boolean; /** [Method] Allows addition of behavior to the destroy operation */ onDestroy?(): void; @@ -27439,6 +29191,7 @@ declare module Ext.menu { * @param cmp Object * @param pos Object * @param off Object + * @returns Ext.Component this */ showBy?( cmp?:any, pos?:any, off?:any ): Ext.IComponent; } @@ -27455,40 +29208,35 @@ declare module Ext { export class MessageBox { /** [Method] Adds Component s to this Container * @param component Ext.Component[]|Object[]/Ext.Component.../Object... Either one or more Components to add or an Array of Components to add. See items for additional information. + * @returns Ext.Component[]/Ext.Component The Components that were added. */ - static add( component?:any ): Ext.IComponent[]; - /** [Method] Adds Component s to this Container - * @param component Ext.Component[]|Object[]/Ext.Component.../Object... Either one or more Components to add or an Array of Components to add. See items for additional information. - */ - static add( component?:any ): Ext.IComponent; + static add( component?:any ): any; /** [Method] Adds a CSS class to the body element * @param cls String The class to add + * @returns Ext.panel.Panel this */ static addBodyCls( cls?:string ): Ext.panel.IPanel; /** [Method] Adds each argument passed to this method to the childEls array */ static addChildEls(): void; /** [Method] Adds a CSS class to the top level element representing this component * @param cls String/String[] The CSS class name to add. + * @returns Ext.Component Returns the Component to allow method chaining. */ - static addClass( cls?:any ): any; - static addClass( cls?:string ): Ext.IComponent; - static addClass( cls?:string[] ): Ext.IComponent; + static addClass( cls?:any ): Ext.IComponent; /** [Method] Adds a CSS class to the top level element representing this component * @param cls String/String[] The CSS class name to add. + * @returns Ext.Component Returns the Component to allow method chaining. */ - static addCls( cls?:any ): any; - static addCls( cls?:string ): Ext.IComponent; - static addCls( cls?:string[] ): Ext.IComponent; + static addCls( cls?:any ): Ext.IComponent; /** [Method] Adds a cls to the uiCls array which will also call addUIClsToElement and adds to all elements of this component * @param classes String/String[] A string or an array of strings to add to the uiCls. * @param skip Object (Boolean) skip true to skip adding it to the class and do it later (via the return). */ - static addClsWithUI( classes?:any, skip?:any ): any; - static addClsWithUI( classes?:string, skip?:any ): void; - static addClsWithUI( classes?:string[], skip?:any ): void; + static addClsWithUI( classes?:any, skip?:any ): void; /** [Method] Adds docked item s to the container * @param component Object/Object[] The Component or array of components to add. The components must include a 'dock' parameter on each component to indicate where it should be docked ('top', 'right', 'bottom', 'left'). * @param pos Number The index at which the Component will be added + * @returns Ext.Component[] The added components. */ static addDocked( component?:any, pos?:number ): Ext.IComponent[]; /** [Method] Adds the specified events to the list of events which this Observable may fire @@ -27500,6 +29248,7 @@ declare module Ext { * @param listeners Object * @param scope Object * @param options Object + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( element?:any, listeners?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -27508,22 +29257,20 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Save a property to the given state object if it is not its default or configured value * @param state Object The state object. * @param propName String The name of the property on this object to save. * @param value String The value of the state property (defaults to this[propName]). + * @returns Boolean The state object or a new object if state was null and the property was saved. */ static addPropertyToState( state?:any, propName?:string, value?:string ): boolean; /** [Method] Add events that will trigger the state to be saved * @param events String/String[] The event name or an array of event names. */ - static addStateEvents( events?:any ): any; - static addStateEvents( events?:string ): void; - static addStateEvents( events?:string[] ): void; + static addStateEvents( events?:any ): void; /** [Method] Add tools to this panel * @param tools Object[]/Ext.panel.Tool[] The tools to add */ @@ -27552,14 +29299,13 @@ declare module Ext { * @param callback Function * @param scope Object */ - static afterShow( animateTarget?:any, callback?:any, scope?:any ): any; - static afterShow( animateTarget?:string, callback?:any, scope?:any ): void; - static afterShow( animateTarget?:Ext.IElement, callback?:any, scope?:any ): void; + static afterShow( animateTarget?:any, callback?:any, scope?:any ): void; /** [Method] Displays a standard read only message box with an OK button comparable to the basic JavaScript alert prompt * @param title String The title bar text * @param msg String The message box body text * @param fn Function The callback function invoked after the message box is closed. See show method for details. * @param scope Object The scope (this reference) in which the callback is executed. + * @returns Ext.window.MessageBox this */ static alert( title?:string, msg?:string, fn?:any, scope?:any ): Ext.window.IMessageBox; /** [Method] Aligns the element with another element relative to the specified anchor points @@ -27567,11 +29313,9 @@ declare module Ext { * @param position String The position to align to * @param offsets Number[] Offset the positioning by [x, y] * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ - static alignTo( element?:any, position?:any, offsets?:any, animate?:any ): any; - static alignTo( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; - static alignTo( element?:HTMLElement, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; - static alignTo( element?:string, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; + static alignTo( element?:any, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; /** [Method] Anchors an element to another element and realigns it when the window is resized * @param element Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or id of the element to align to. * @param position String The position to align to @@ -27579,16 +29323,12 @@ declare module Ext { * @param animate Boolean/Object true for the default animation or a standard Element animation config object * @param monitorScroll Boolean/Number True to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay in milliseconds. * @param callback Function The function to call after the animation finishes + * @returns Ext.util.Positionable this */ - static anchorTo( element?:any, position?:any, offsets?:any, animate?:any, monitorScroll?:any, callback?:any ): any; - static anchorTo( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - static anchorTo( element?:HTMLElement, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - static anchorTo( element?:string, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - static anchorTo( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; - static anchorTo( element?:HTMLElement, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; - static anchorTo( element?:string, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; + static anchorTo( element?:any, position?:string, offsets?:number[], animate?:any, monitorScroll?:any, callback?:any ): Ext.util.IPositionable; /** [Method] Performs custom animation on this object * @param animObj Object + * @returns Object this */ static animate( animObj?:any ): any; /** [Method] Applies the state to the object @@ -27616,6 +29356,7 @@ declare module Ext { * @param fn Function The function to call * @param scope Object The scope of the function. Defaults to current node. * @param args Array The args to call the function with. Defaults to passing the current component. + * @returns Ext.Component this */ static bubble( fn?:any, scope?:any, args?:any[] ): Ext.IComponent; /** [Method] Calculates the new x y position to move this Positionable into a constrain region @@ -27623,49 +29364,49 @@ declare module Ext { * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to coerce into constraints instead of using this Positionable's current position. * @param local Boolean The proposedPosition is local (relative to floatParent if a floating Component) * @param proposedSize Number[] A proposed [width, height] size to use when calculating constraints instead of using this Positionable's current size. + * @returns Number[] If the element needs to be translated, the new [X, Y] position within constraints if possible, giving priority to keeping the top and left edge in the constrain region. Otherwise, false. */ - static calculateConstrainedPosition( constrainTo?:any, proposedPosition?:any, local?:any, proposedSize?:any ): any; - static calculateConstrainedPosition( constrainTo?:string, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - static calculateConstrainedPosition( constrainTo?:HTMLElement, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - static calculateConstrainedPosition( constrainTo?:Ext.IElement, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - static calculateConstrainedPosition( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; + static calculateConstrainedPosition( constrainTo?:any, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Cancel any deferred focus on this component */ static cancelFocus(): void; /** [Method] Cascades down the component container heirarchy from this component passed in the first call calling the specified * @param fn Function The function to call * @param scope Object The scope of the function (defaults to current component) * @param args Array The args to call the function with. The current component always passed as the last argument. + * @returns Ext.Container this */ static cascade( fn?:any, scope?:any, args?:any[] ): Ext.IContainer; - /** [Method] Center this Component in its container */ + /** [Method] Center this Component in its container + * @returns Ext.Component this + */ static center(): Ext.IComponent; /** [Method] Retrieves the first direct child of this container which matches the passed selector or component * @param selector String/Ext.Component An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching child Ext.Component (or null if no match was found). */ static child( selector?:any ): any; - static child( selector?:string ): any; - static child( selector?:Ext.IComponent ): any; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ static clearManagedListeners(): void; /** [Method] Clone the current component using the original config values passed into this instance by default * @param overrides Object A new config containing any properties to override in the cloned version. An id property can be passed on this object, otherwise one will be generated to avoid duplicates. + * @returns Ext.Component clone The cloned copy of this component */ static cloneConfig( overrides?:any ): Ext.IComponent; /** [Method] Closes the Panel */ @@ -27673,6 +29414,7 @@ declare module Ext { /** [Method] Collapses the panel body so that the body becomes hidden * @param direction String The direction to collapse towards. Must be one of Ext.Component.DIRECTION_TOP Ext.Component.DIRECTION_RIGHT Ext.Component.DIRECTION_BOTTOM Ext.Component.DIRECTION_LEFT Defaults to collapseDirection. * @param animate Boolean True to animate the transition, else false (defaults to the value of the animCollapse panel config). May also be specified as the animation duration in milliseconds. + * @returns Ext.panel.Panel this */ static collapse( direction?:string, animate?:boolean ): Ext.panel.IPanel; /** [Method] Displays a confirmation message box with Yes and No buttons comparable to JavaScript s confirm @@ -27680,75 +29422,80 @@ declare module Ext { * @param msg String The message box body text * @param fn Function The callback function invoked after the message box is closed. See show method for details. * @param scope Object The scope (this reference) in which the callback is executed. + * @returns Ext.window.MessageBox this */ static confirm( title?:string, msg?:string, fn?:any, scope?:any ): Ext.window.IMessageBox; /** [Method] Determines whether the passed Component is either an immediate child of this Container or whether it is a descendant * @param comp Ext.Component The Component to test. * @param deep Boolean Pass true to test for the Component being a descendant at any level. + * @returns Boolean true if the passed Component is contained at the specified level. */ static contains( comp?:Ext.IComponent, deep?:boolean ): boolean; /** [Method] converts a collapsdDir into an anchor argument for Element slideIn overridden in rtl mode to switch l and r * @param collapseDir Object */ static convertCollapseDir( collapseDir?:any ): void; - /** [Method] Inherit docs Disable all immediate children that was previously disabled Override disable because onDisable only gets */ + /** [Method] Inherit docs Disable all immediate children that was previously disabled Override disable because onDisable only gets + * @returns Ext.container.AbstractContainer this + */ static disable(): Ext.container.IAbstractContainer; /** [Method] Handles autoRender */ static doAutoRender(): void; - /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t */ + /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t + * @returns Ext.container.Container this + */ static doComponentLayout(): Ext.container.IContainer; /** [Method] Moves this floating Component into a constrain region * @param constrainTo String/HTMLElement/Ext.Element/Ext.util.Region The Element or Region into which this Component is to be constrained. Defaults to the element into which this floating Component was rendered. */ - static doConstrain( constrainTo?:any ): any; - static doConstrain( constrainTo?:string ): void; - static doConstrain( constrainTo?:HTMLElement ): void; - static doConstrain( constrainTo?:Ext.IElement ): void; - static doConstrain( constrainTo?:Ext.util.IRegion ): void; - /** [Method] Manually force this container s layout to be recalculated */ + static doConstrain( constrainTo?:any ): void; + /** [Method] Manually force this container s layout to be recalculated + * @returns Ext.container.Container this + */ static doLayout(): Ext.container.IContainer; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String/Ext.Component An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching descendant Ext.Component (or null if no match was found). */ static down( selector?:any ): any; - static down( selector?:string ): any; - static down( selector?:Ext.IComponent ): any; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Ensures that this component is attached to document body * @param runLayout Boolean True to run the component's layout. */ static ensureAttachedToBody( runLayout?:boolean ): void; /** [Method] Expands the panel body so that it becomes visible * @param animate Boolean True to animate the transition, else false (defaults to the value of the animCollapse panel config). May also be specified as the animation duration in milliseconds. + * @returns Ext.panel.Panel this */ static expand( animate?:boolean ): Ext.panel.IPanel; /** [Method] Find a container above this component at any level by a custom function * @param fn Function The custom function to call with the arguments (container, this component). + * @returns Ext.container.Container The first Container for which the custom function returns true */ static findParentBy( fn?:any ): Ext.container.IContainer; /** [Method] Find a container above this component at any level by xtype or class See also the up method * @param xtype String/Ext.Class The xtype string for a component, or the class of the component directly + * @returns Ext.container.Container The first Container which matches the given xtype or class */ - static findParentByType( xtype?:any ): any; - static findParentByType( xtype?:string ): Ext.container.IContainer; - static findParentByType( xtype?:Ext.IClass ): Ext.container.IContainer; + static findParentByType( xtype?:any ): Ext.container.IContainer; /** [Method] Retrieves plugin from this component s collection by its ptype * @param ptype String The Plugin's ptype as specified by the class's alias configuration. + * @returns Ext.AbstractPlugin plugin instance. */ static findPlugin( ptype?:string ): Ext.IAbstractPlugin; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; /** [Method] Try to focus this component @@ -27756,34 +29503,33 @@ declare module Ext { * @param delay Boolean/Number Delay the focus this number of milliseconds (true for 10 milliseconds). * @param callback Function Only needed if the delay parameter is used. A function to call upon focus. * @param scope Function Only needed if the delay parameter is used. The scope (this reference) in which to execute the callback. + * @returns Ext.Component The focused Component. Usually this Component. Some Containers may delegate focus to a descendant Component (Windows can do this through their defaultFocus config option. */ - static focus( selectText?:any, delay?:any, callback?:any, scope?:any ): any; - static focus( selectText?:boolean, delay?:boolean, callback?:any, scope?:any ): Ext.IComponent; - static focus( selectText?:boolean, delay?:number, callback?:any, scope?:any ): Ext.IComponent; + static focus( selectText?:boolean, delay?:any, callback?:any, scope?:any ): Ext.IComponent; /** [Method] Forces this component to redo its componentLayout */ static forceComponentLayout(): void; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - static getActiveAnimation(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - static getActiveAnimation(): boolean; + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + static getActiveAnimation(): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or id of the element to align to. * @param position String The position to align to * @param offsets Number[] Offset the positioning by [x, y] + * @returns Number[] [x, y] */ - static getAlignToXY( element?:any, position?:any, offsets?:any ): any; - static getAlignToXY( element?:Ext.util.IPositionable, position?:string, offsets?:number[] ): number[]; - static getAlignToXY( element?:HTMLElement, position?:string, offsets?:number[] ): number[]; - static getAlignToXY( element?:string, position?:string, offsets?:number[] ): number[]; + static getAlignToXY( element?:any, position?:string, offsets?:number[] ): number[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. See alignTo for details on supported anchor positions. * @param local Boolean True to get the local (element top/left-relative) anchor position instead of page coordinates * @param size Object An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size) + * @returns Number[] [x, y] An array containing the element's x and y coordinates */ static getAnchorXY( anchor?:string, local?:boolean, size?:any ): number[]; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param contentBox Boolean If true a box for the content of the element is returned. * @param local Boolean If true the element's left and top relative to its offsetParent are returned instead of page x/y. + * @returns Object box An object in the format: { x: <Element's X position>, y: <Element's Y position>, left: <Element's X position (an alias for x)>, top: <Element's Y position (an alias for y)>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. The result may also be used for setXY */ static getBox( contentBox?:boolean, local?:boolean ): any; /** [Method] Implements an upward event bubbling policy */ @@ -27791,146 +29537,171 @@ declare module Ext { /** [Method] Return the immediate child Component in which the passed element is located * @param el Ext.Element/HTMLElement/String The element to test (or ID of element). * @param deep Boolean If true, returns the deepest descendant Component which contains the passed element. + * @returns Ext.Component The child item which contains the passed element. */ - static getChildByElement( el?:any, deep?:any ): any; - static getChildByElement( el?:Ext.IElement, deep?:boolean ): Ext.IComponent; - static getChildByElement( el?:HTMLElement, deep?:boolean ): Ext.IComponent; - static getChildByElement( el?:string, deep?:boolean ): Ext.IComponent; - /** [Method] Returns the current collapsed state of the panel */ - static getCollapsed(): boolean; - /** [Method] Returns the current collapsed state of the panel */ - static getCollapsed(): string; + static getChildByElement( el?:any, deep?:boolean ): Ext.IComponent; + /** [Method] Returns the current collapsed state of the panel + * @returns Boolean/String False when not collapsed, otherwise the value of collapseDirection. + */ + static getCollapsed(): any; /** [Method] Attempts a default component lookup see Ext container Container getComponent * @param comp String/Number The component id, itemId or position to find + * @returns Ext.Component The component (if found) */ - static getComponent( comp?:any ): any; - static getComponent( comp?:string ): Ext.IComponent; - static getComponent( comp?:number ): Ext.IComponent; + static getComponent( comp?:any ): Ext.IComponent; /** [Method] Returns the X Y vector by which this Positionable s element must be translated to make a best attempt to constrain * @param constrainTo Ext.util.Positionable/HTMLElement/String/Ext.util.Region The Positionable, HTMLElement, element id, or Region into which the element is to be constrained. * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position * @param proposedSize Number[] A proposed [width, height] size to constrain instead of using the element's current size + * @returns Number[]/Boolean If the element needs to be translated, an [X, Y] vector by which this element must be translated. Otherwise, false. */ - static getConstrainVector( constrainTo?:any, proposedPosition?:any, proposedSize?:any ): any; - static getConstrainVector( constrainTo?:Ext.util.IPositionable, proposedPosition?:number[], proposedSize?:number[] ): number[]; - static getConstrainVector( constrainTo?:HTMLElement, proposedPosition?:number[], proposedSize?:number[] ): number[]; - static getConstrainVector( constrainTo?:string, proposedPosition?:number[], proposedSize?:number[] ): number[]; - static getConstrainVector( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], proposedSize?:number[] ): number[]; - /** [Method] Returns the X Y vector by which this Positionable s element must be translated to make a best attempt to constrain - * @param constrainTo Ext.util.Positionable/HTMLElement/String/Ext.util.Region The Positionable, HTMLElement, element id, or Region into which the element is to be constrained. - * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position - * @param proposedSize Number[] A proposed [width, height] size to constrain instead of using the element's current size - */ - static getConstrainVector( constrainTo?:Ext.util.IPositionable, proposedPosition?:number[], proposedSize?:number[] ): boolean; - static getConstrainVector( constrainTo?:HTMLElement, proposedPosition?:number[], proposedSize?:number[] ): boolean; - static getConstrainVector( constrainTo?:string, proposedPosition?:number[], proposedSize?:number[] ): boolean; - static getConstrainVector( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], proposedSize?:number[] ): boolean; + static getConstrainVector( constrainTo?:any, proposedPosition?:number[], proposedSize?:number[] ): any; /** [Method] Gets the configured default focus item */ static getDefaultFocus(): void; /** [Method] Finds a docked component by id itemId or position * @param comp String/Number The id, itemId or position of the docked component (see getComponent for details) + * @returns Ext.Component The docked component (if found) */ - static getDockedComponent( comp?:any ): any; - static getDockedComponent( comp?:string ): Ext.IComponent; - static getDockedComponent( comp?:number ): Ext.IComponent; + static getDockedComponent( comp?:any ): Ext.IComponent; /** [Method] Retrieves an array of all currently docked Components * @param selector String A ComponentQuery selector string to filter the returned items. * @param beforeBody Boolean An optional flag to limit the set of items to only those before the body (true) or after the body (false). All components are returned by default. + * @returns Ext.Component[] The array of docked components meeting the specified criteria. */ static getDockedItems( selector?:string, beforeBody?:boolean ): Ext.IComponent[]; - /** [Method] Retrieves the top level element representing this component */ + /** [Method] Retrieves the top level element representing this component + * @returns Ext.dom.Element + */ static getEl(): Ext.dom.IElement; /** [Method] Gets the Header for this panel */ static getHeader(): void; - /** [Method] Gets the current height of the component s underlying element */ + /** [Method] Gets the current height of the component s underlying element + * @returns Number + */ static getHeight(): number; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] This function takes the position argument passed to onRender and returns a DOM element that you can use in the insert * @param position String/Number/Ext.dom.Element/HTMLElement Index, element id or element you want to put this component before. + * @returns HTMLElement DOM element that you can use in the insertBefore + */ + static getInsertPosition( position?:any ): HTMLElement; + /** [Method] Returns the value of itemId assigned to this component or when that is not set returns the value of id + * @returns String */ - static getInsertPosition( position?:any ): any; - static getInsertPosition( position?:string ): HTMLElement; - static getInsertPosition( position?:number ): HTMLElement; - static getInsertPosition( position?:Ext.dom.IElement ): HTMLElement; - static getInsertPosition( position?:HTMLElement ): HTMLElement; - /** [Method] Returns the value of itemId assigned to this component or when that is not set returns the value of id */ static getItemId(): string; - /** [Method] Returns the layout instance currently associated with this Container */ + /** [Method] Returns the layout instance currently associated with this Container + * @returns Ext.layout.container.Container The layout + */ static getLayout(): Ext.layout.container.IContainer; - /** [Method] Gets the Ext ComponentLoader for this Component */ + /** [Method] Gets the Ext ComponentLoader for this Component + * @returns Ext.ComponentLoader The loader instance, null if it doesn't exist. + */ static getLoader(): Ext.IComponentLoader; - /** [Method] Overridden in Ext rtl AbstractComponent */ + /** [Method] Overridden in Ext rtl AbstractComponent + * @returns Number The local x coordinate + */ static getLocalX(): number; - /** [Method] Overridden in Ext rtl AbstractComponent */ + /** [Method] Overridden in Ext rtl AbstractComponent + * @returns Number[] The local XY position of the element + */ static getLocalXY(): number[]; - /** [Method] Returns the y coordinate of this element reletive to its offsetParent */ + /** [Method] Returns the y coordinate of this element reletive to its offsetParent + * @returns Number The local y coordinate + */ static getLocalY(): number; /** [Method] Returns the offsets of this element from the passed element * @param offsetsTo Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or element id to get get the offsets from. + * @returns Number[] The XY page offsets (e.g. [100, -200]) */ - static getOffsetsTo( offsetsTo?:any ): any; - static getOffsetsTo( offsetsTo?:Ext.util.IPositionable ): number[]; - static getOffsetsTo( offsetsTo?:HTMLElement ): number[]; - static getOffsetsTo( offsetsTo?:string ): number[]; + static getOffsetsTo( offsetsTo?:any ): number[]; /** [Method] Retrieves a plugin from this component s collection by its pluginId * @param pluginId String + * @returns Ext.AbstractPlugin plugin instance. */ static getPlugin( pluginId?:string ): Ext.IAbstractPlugin; /** [Method] Gets the current XY position of the component s underlying element * @param local Boolean If true the element's left and top are returned instead of page XY. + * @returns Number[] The XY position of the element (e.g., [100, 200]) */ static getPosition( local?:boolean ): number[]; /** [Method] Used by ComponentQuery child and down to retrieve all of the items which can potentially be considered a child of th * @param deep Object */ static getRefItems( deep?:any ): void; - /** [Method] Returns a region object that defines the area of this element */ + /** [Method] Returns a region object that defines the area of this element + * @returns Ext.util.Region A Region containing "top, left, bottom, right" properties. + */ static getRegion(): Ext.util.IRegion; - /** [Method] Gets the current size of the component s underlying element */ + /** [Method] Gets the current size of the component s underlying element + * @returns Object An object containing the element's size {width: (element width), height: (element height)} + */ static getSize(): any; /** [Method] Returns an object that describes how this component s width and height are managed * @param ownerCtSizeModel Object + * @returns Object The size model for this component. */ static getSizeModel( ownerCtSizeModel?:any ): any; - /** [Method] Returns the content region of this element */ + /** [Method] Returns the content region of this element + * @returns Ext.util.Region A Region containing "top, left, bottom, right" member data. + */ static getViewRegion(): Ext.util.IRegion; - /** [Method] Gets the current width of the component s underlying element */ + /** [Method] Gets the current width of the component s underlying element + * @returns Number + */ static getWidth(): number; - /** [Method] Gets the current X position of the DOM element based on page coordinates */ + /** [Method] Gets the current X position of the DOM element based on page coordinates + * @returns Number The X position of the element + */ static getX(): number; - /** [Method] Gets the xtype for this component as registered with Ext ComponentManager */ + /** [Method] Gets the xtype for this component as registered with Ext ComponentManager + * @returns String The xtype + */ static getXType(): string; - /** [Method] Returns this Component s xtype hierarchy as a slash delimited string */ + /** [Method] Returns this Component s xtype hierarchy as a slash delimited string + * @returns String The xtype hierarchy string + */ static getXTypes(): string; - /** [Method] Gets the current position of the DOM element based on page coordinates */ + /** [Method] Gets the current position of the DOM element based on page coordinates + * @returns Number[] The XY position of the element + */ static getXY(): number[]; - /** [Method] Gets the current Y position of the DOM element based on page coordinates */ + /** [Method] Gets the current Y position of the DOM element based on page coordinates + * @returns Number The Y position of the element + */ static getY(): number; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - static hasActiveFx(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - static hasActiveFx(): boolean; + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + static hasActiveFx(): any; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param className String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ static hasCls( className?:string ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Checks if there is currently a specified uiCls * @param cls String The cls to check. */ static hasUICls( cls?:string ): void; - /** [Method] Hides this Component setting it to invisible using the configured hideMode */ + /** [Method] Hides this Component setting it to invisible using the configured hideMode + * @returns Ext.Component this + */ static hide(): Ext.IComponent; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Initialize any events on this component */ @@ -27938,6 +29709,7 @@ declare module Ext { /** [Method] Inserts a Component into this Container at a specified index * @param index Number The index at which the Component will be inserted into the Container's items collection * @param component Ext.Component/Object The child Component to insert. Ext uses lazy rendering, and will only render the inserted Component should it become necessary. A Component config object may be passed in order to avoid the overhead of constructing a real Component object if lazy rendering might mean that the inserted Component will not be rendered immediately. To take advantage of this 'lazy instantiation', set the Ext.Component.xtype config property to the registered type of the Component wanted. For a list of all available xtypes, see Ext.enums.Widget. + * @returns Ext.Component component The Component (or config object) that was inserted with the Container's default config values applied. */ static insert( index?:number, component?:any ): Ext.IComponent; /** [Method] Inserts docked item s to the panel at the indicated position @@ -27947,6 +29719,7 @@ declare module Ext { static insertDocked( pos?:number, component?:any ): void; /** [Method] Tests whether this Component matches the selector string * @param selector String The selector string to test against. + * @returns Boolean true if this Component matches the selector. */ static is( selector?:string ): boolean; /** [Method] Determines whether this Container is an ancestor of the passed Component @@ -27955,36 +29728,54 @@ declare module Ext { static isAncestor( possibleDescendant?:Ext.IComponent ): void; /** [Method] Determines whether this component is the descendant of a particular container * @param container Ext.Container + * @returns Boolean true if the component is the descendant of a particular container, otherwise false. */ static isDescendantOf( container?:Ext.IContainer ): boolean; - /** [Method] Method to determine whether this Component is currently disabled */ + /** [Method] Method to determine whether this Component is currently disabled + * @returns Boolean the disabled state of this Component. + */ static isDisabled(): boolean; - /** [Method] Method to determine whether this Component is draggable */ + /** [Method] Method to determine whether this Component is draggable + * @returns Boolean the draggable state of this component. + */ static isDraggable(): boolean; - /** [Method] Method to determine whether this Component is droppable */ + /** [Method] Method to determine whether this Component is droppable + * @returns Boolean the droppable state of this component. + */ static isDroppable(): boolean; - /** [Method] Method to determine whether this Component is floating */ + /** [Method] Method to determine whether this Component is floating + * @returns Boolean the floating state of this component. + */ static isFloating(): boolean; - /** [Method] Method to determine whether this Component is currently set to hidden */ + /** [Method] Method to determine whether this Component is currently set to hidden + * @returns Boolean the hidden state of this Component. + */ static isHidden(): boolean; /** [Method] Determines whether this Component is the root of a layout */ static isLayoutRoot(): void; - /** [Method] Returns true if layout is suspended for this component */ + /** [Method] Returns true if layout is suspended for this component + * @returns Boolean true layout of this component is suspended. + */ static isLayoutSuspended(): boolean; /** [Method] Returns true if this component is visible * @param deep Object + * @returns Boolean true if this component is visible, false otherwise. */ static isVisible( deep?:any ): boolean; /** [Method] Tests whether or not this Component is of a specific xtype * @param xtype String The xtype to check for this Component * @param shallow Boolean true to check whether this Component is directly of the specified xtype, false to check whether this Component is descended from the xtype. + * @returns Boolean true if this component descends from the specified xtype, false otherwise. */ static isXType( xtype?:string, shallow?:boolean ): boolean; /** [Method] Fits the window within its current container and automatically replaces the maximize tool button with the restore * @param animate Boolean true to animate this Window to full size. + * @returns Ext.window.Window this */ static maximize( animate?:boolean ): Ext.window.IWindow; - /** [Method] Placeholder method for minimizing the window */ + /** [Method] Placeholder method for minimizing the window + * @returns Ext.window.Window this + */ static minimize(): Ext.window.IWindow; /** [Method] Shorthand for addManagedListener * @param item Ext.util.Observable/Ext.Element The item to which to add a listener/listeners. @@ -27992,32 +29783,30 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Moves a Component within the Container * @param fromIdx Number/Ext.Component The index/component to move. * @param toIdx Number The new index for the Component. + * @returns Ext.Component component The Component that was moved. */ - static move( fromIdx?:any, toIdx?:any ): any; - static move( fromIdx?:number, toIdx?:number ): Ext.IComponent; - static move( fromIdx?:Ext.IComponent, toIdx?:number ): Ext.IComponent; + static move( fromIdx?:any, toIdx?:number ): Ext.IComponent; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Returns the next node in the Component tree in tree traversal order * @param selector String A ComponentQuery selector to filter the following nodes. + * @returns Ext.Component The next node (or the next node which matches the selector). Returns null if there is no matching node. */ static nextNode( selector?:string ): Ext.IComponent; /** [Method] Returns the next sibling of this Component * @param selector String A ComponentQuery selector to filter the following items. + * @returns Ext.Component The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling. */ static nextSibling( selector?:string ): Ext.IComponent; /** [Method] Shorthand for addListener @@ -28025,6 +29814,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] This method is invoked after a new Component has been added @@ -28080,16 +29870,19 @@ declare module Ext { static postBlur( e?:Ext.IEventObject ): void; /** [Method] Returns the previous node in the Component tree in tree traversal order * @param selector String A ComponentQuery selector to filter the preceding nodes. + * @returns Ext.Component The previous node (or the previous node which matches the selector). Returns null if there is no matching node. */ static previousNode( selector?:string ): Ext.IComponent; /** [Method] Returns the previous sibling of this Component * @param selector String A ComponentQuery selector to filter the preceding items. + * @returns Ext.Component The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling. */ static previousSibling( selector?:string ): Ext.IComponent; /** [Method] Displays a message box with a progress bar * @param title String The title bar text * @param msg String The message box body text * @param progressText String The text to display inside the progress bar + * @returns Ext.window.MessageBox this */ static progress( title?:string, msg?:string, progressText?:string ): Ext.window.IMessageBox; /** [Method] Displays a message box with OK and Cancel buttons prompting the user to enter some text comparable to JavaScript s p @@ -28099,21 +29892,23 @@ declare module Ext { * @param scope Object The scope (this reference) in which the callback is executed. * @param multiline Boolean/Number True to create a multiline textbox using the defaultTextHeight property, or the height in pixels to create the textbox/ * @param value String Default value of the text input element + * @returns Ext.window.MessageBox this */ - static prompt( title?:any, msg?:any, fn?:any, scope?:any, multiline?:any, value?:any ): any; - static prompt( title?:string, msg?:string, fn?:any, scope?:any, multiline?:boolean, value?:string ): Ext.window.IMessageBox; - static prompt( title?:string, msg?:string, fn?:any, scope?:any, multiline?:number, value?:string ): Ext.window.IMessageBox; + static prompt( title?:string, msg?:string, fn?:any, scope?:any, multiline?:any, value?:string ): Ext.window.IMessageBox; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned. + * @returns Ext.Component[] Components which matched the selector */ static query( selector?:string ): Ext.IComponent[]; /** [Method] Retrieves all descendant components which match the passed function * @param fn Function The matcher function. It will be called with a single argument, the component being tested. * @param scope Object The scope in which to run the function. If not specified, it will default to the active component. + * @returns Ext.Component[] Components matched by the passed function */ static queryBy( fn?:any, scope?:any ): Ext.IComponent[]; /** [Method] Finds a component at any level under this container matching the id itemId * @param id String The id to find + * @returns Ext.Component The matching id, null if not found */ static queryById( id?:string ): Ext.IComponent; /** [Method] Called by Component doAutoRender Register a Container configured floating true with this Component s ZIndexManager @@ -28124,23 +29919,27 @@ declare module Ext { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes a component from this container * @param component Ext.Component/String The component reference or id to remove. * @param autoDestroy Boolean True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config. + * @returns Ext.Component component The Component that was removed. */ - static remove( component?:any, autoDestroy?:any ): any; - static remove( component?:Ext.IComponent, autoDestroy?:boolean ): Ext.IComponent; - static remove( component?:string, autoDestroy?:boolean ): Ext.IComponent; + static remove( component?:any, autoDestroy?:boolean ): Ext.IComponent; /** [Method] Removes all components from this container * @param autoDestroy Boolean True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config. + * @returns Ext.Component[] Array of the removed components */ static removeAll( autoDestroy?:boolean ): Ext.IComponent[]; - /** [Method] Remove any anchor to this element */ + /** [Method] Remove any anchor to this element + * @returns Ext.util.Positionable this + */ static removeAnchor(): Ext.util.IPositionable; /** [Method] Removes a CSS class from the body element * @param cls String The class to remove + * @returns Ext.panel.Panel this */ static removeBodyCls( cls?:string ): Ext.panel.IPanel; /** [Method] Removes items in the childEls array based on the return value of a supplied test function @@ -28149,16 +29948,13 @@ declare module Ext { static removeChildEls( testFn?:any ): void; /** [Method] Removes a CSS class from the top level element representing this component * @param cls String/String[] The CSS class name to remove. + * @returns Ext.Component Returns the Component to allow method chaining. */ - static removeCls( cls?:any ): any; - static removeCls( cls?:string ): Ext.IComponent; - static removeCls( cls?:string[] ): Ext.IComponent; + static removeCls( cls?:any ): Ext.IComponent; /** [Method] Removes a cls to the uiCls array which will also call removeUIClsFromElement and removes it from all elements of thi * @param cls String/String[] A string or an array of strings to remove to the uiCls. */ - static removeClsWithUI( cls?:any ): any; - static removeClsWithUI( cls?:string ): void; - static removeClsWithUI( cls?:string[] ): void; + static removeClsWithUI( cls?:any ): void; /** [Method] Removes the docked item from the panel * @param item Ext.Component The Component to remove. * @param autoDestroy Boolean Destroy the component after removal. @@ -28176,9 +29972,7 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] inherit docs * @param cls Object */ @@ -28187,15 +29981,10 @@ declare module Ext { * @param container Ext.Element/HTMLElement/String The element this Component should be rendered into. If it is being created from existing markup, this should be omitted. * @param position String/Number The element ID or DOM node index within the container before which this component will be inserted (defaults to appending to the end of the container) */ - static render( container?:any, position?:any ): any; - static render( container?:Ext.IElement, position?:string ): void; - static render( container?:HTMLElement, position?:string ): void; - static render( container?:string, position?:string ): void; - static render( container?:Ext.IElement, position?:number ): void; - static render( container?:HTMLElement, position?:number ): void; - static render( container?:string, position?:number ): void; + static render( container?:any, position?:any ): void; /** [Method] Restores a maximized window back to its original size and position prior to being maximized and also replaces the re * @param animate Object + * @returns Ext.window.Window this */ static restore( animate?:any ): Ext.window.IWindow; /** [Method] Resumes firing of the named event s @@ -28208,15 +29997,15 @@ declare module Ext { * @param propName String The name of the property to save. * @param state Object The state object in to which to save the property. * @param stateName String The name to use for the property in state. + * @returns Boolean True if the property was saved, false if not. */ static savePropToState( propName?:string, state?:any, stateName?:string ): boolean; /** [Method] Gathers additional named properties of the instance and adds their current values to the passed state object * @param propNames String/String[] The name (or array of names) of the property to save. * @param state Object The state object in to which to save the property values. + * @returns Object state */ static savePropsToState( propNames?:any, state?:any ): any; - static savePropsToState( propNames?:string, state?:any ): any; - static savePropsToState( propNames?:string[], state?:any ): any; /** [Method] Saves the state of the object to the persistence store */ static saveState(): void; /** [Method] Scrolls this Component s target element by the passed delta values optionally animating @@ -28225,7 +30014,9 @@ declare module Ext { * @param animate Boolean/Object Animate flag/config object if the delta values were passed separately. */ static scrollBy( deltaX?:any, deltaY?:any, animate?:any ): void; - /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence */ + /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence + * @returns Object this + */ static sequenceFx(): any; /** [Method] This method is called internally by Ext ZIndexManager to signal that a floating Component has either been moved to th * @param active Boolean True to activate the Component, false to deactivate it. @@ -28234,11 +30025,13 @@ declare module Ext { static setActive( active?:boolean, newActive?:Ext.IComponent ): void; /** [Method] Sets the overflow on the content element of the component * @param scroll Boolean True to allow the Component to auto scroll. + * @returns Ext.Component this */ static setAutoScroll( scroll?:boolean ): Ext.IComponent; /** [Method] Sets the body style according to the passed parameters * @param style Mixed A full style specification string, or object, or the name of a style property to set. * @param value String If the first param was a style property name, the style property value. + * @returns Ext.panel.Panel this */ static setBodyStyle( style?:any, value?:string ): Ext.panel.IPanel; /** [Method] @@ -28248,11 +30041,13 @@ declare module Ext { static setBorder( border?:any, targetEl?:any ): void; /** [Method] This method changes the region config property for this border region * @param region String The new region value ("north", "south", "east" or "west"). + * @returns String The previous value of the region property. */ static setBorderRegion( region?:string ): string; /** [Method] Sets the element s box * @param box Object The box to fill {x, y, width, height} * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ static setBox( box?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Enable or disable the component @@ -28262,22 +30057,23 @@ declare module Ext { /** [Method] Sets the dock position of this component in its parent panel * @param dock Object The dock position. * @param layoutParent Boolean true to re-layout parent. + * @returns Ext.Component this */ static setDocked( dock?:any, layoutParent?:boolean ): Ext.IComponent; /** [Method] Set the glyph for the panel s header * @param newGlyph Number/String The new glyph This parameter expects a format consistent with that of glyph */ - static setGlyph( newGlyph?:any ): any; - static setGlyph( newGlyph?:number ): void; - static setGlyph( newGlyph?:string ): void; + static setGlyph( newGlyph?:any ): void; /** [Method] Sets the height of the component * @param height Number The new height to set. This may be one of: A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS height style. undefined to leave the height unchanged. + * @returns Ext.Component this */ static setHeight( height?:number ): Ext.IComponent; /** [Method] Adds the specified icon to the dialog * @param icon String A CSS classname specifying the icon's background image url, or empty string to clear the icon * @param width Number The width of the icon. If not specified, the default is used * @param height Number The height of the icon. If not specified, the default is used + * @returns Ext.window.MessageBox this */ static setIcon( icon?:string, width?:number, height?:number ): Ext.window.IMessageBox; /** [Method] Set the iconCls for the panel s header @@ -28287,62 +30083,66 @@ declare module Ext { /** [Method] This method allows you to show or hide a LoadMask on top of this component * @param load Boolean/Object/String True to show the default LoadMask, a config object that will be passed to the LoadMask constructor, or a message String to show. False to hide the current LoadMask. * @param targetEl Boolean True to mask the targetEl of this Component instead of the this.el. For example, setting this to true on a Panel will cause only the body to be masked. + * @returns Ext.LoadMask The LoadMask instance that has just been shown. */ static setLoading( load?:any, targetEl?:boolean ): Ext.ILoadMask; /** [Method] Overridden in Ext rtl AbstractComponent * @param x Object + * @returns Ext.util.Positionable this */ static setLocalX( x?:any ): Ext.util.IPositionable; /** [Method] Overridden in Ext rtl AbstractComponent * @param x Object * @param y Object + * @returns Ext.util.Positionable this */ static setLocalXY( x?:any, y?:any ): Ext.util.IPositionable; /** [Method] Sets the local y coordinate of this element using CSS style * @param y Object + * @returns Ext.util.Positionable this */ static setLocalY( y?:any ): Ext.util.IPositionable; /** [Method] Sets the margin on the target element * @param margin Number/String The margin to set. See the margin config. */ - static setMargin( margin?:any ): any; - static setMargin( margin?:number ): void; - static setMargin( margin?:string ): void; + static setMargin( margin?:any ): void; /** [Method] Sets the overflow x y on the content element of the component * @param overflowX String The overflow-x value. * @param overflowY String The overflow-y value. + * @returns Ext.Component this */ static setOverflowXY( overflowX?:string, overflowY?:string ): Ext.IComponent; /** [Method] Sets the page XY position of the component * @param x Number/Number[] The new x position or an array of [x,y]. * @param y Number The new y position. * @param animate Boolean/Object True to animate the Component into its new position. You may also pass an animation configuration. + * @returns Ext.Component this */ - static setPagePosition( x?:any, y?:any, animate?:any ): any; - static setPagePosition( x?:number, y?:number, animate?:any ): Ext.IComponent; - static setPagePosition( x?:number[], y?:number, animate?:any ): Ext.IComponent; + static setPagePosition( x?:any, y?:number, animate?:any ): Ext.IComponent; /** [Method] Sets the left and top of the component * @param x Number/Number[]/Object The new left, an array of [x,y], or animation config object containing x and y properties. * @param y Number The new top. * @param animate Boolean/Object If true, the Component is animated into its new position. You may also pass an animation configuration. + * @returns Ext.Component this */ static setPosition( x?:any, y?:number, animate?:any ): Ext.IComponent; /** [Method] Sets the element s position and size to the specified region * @param region Ext.util.Region The region to fill * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ static setRegion( region?:Ext.util.IRegion, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the weight config property for this component * @param weight Number The new weight value. + * @returns Number The previous value of the weight property. */ static setRegionWeight( weight?:number ): number; /** [Method] Sets the width and height of this Component * @param width Number/String/Object The new width to set. This may be one of: A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS width style. A size object in the format {width: widthValue, height: heightValue}. undefined to leave the width unchanged. * @param height Number/String The new height to set (not required if a size object is passed as the first arg). This may be one of: A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS height style. Animation may not be used. undefined to leave the height unchanged. + * @returns Ext.Component this */ - static setSize( width?:any, height?:any ): any; - static setSize( width?:any, height?:number ): Ext.IComponent; - static setSize( width?:any, height?:string ): Ext.IComponent; + static setSize( width?:any, height?:any ): Ext.IComponent; /** [Method] Set a title for the panel s header * @param newTitle String */ @@ -28353,52 +30153,62 @@ declare module Ext { static setUI( ui?:any ): void; /** [Method] Convenience function to hide or show this component by Boolean * @param visible Boolean true to show, false to hide. + * @returns Ext.Component this */ static setVisible( visible?:boolean ): Ext.IComponent; /** [Method] Sets the width of the component * @param width Number The new width to setThis may be one of: A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS width style. + * @returns Ext.Component this */ static setWidth( width?:number ): Ext.IComponent; /** [Method] Sets the X position of the DOM element based on page coordinates * @param x Object * @param animate Object + * @returns Ext.util.Positionable this */ static setX( x?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the position of the DOM element in page coordinates * @param xy Object * @param animate Object + * @returns Ext.util.Positionable this */ static setXY( xy?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the Y position of the DOM element based on page coordinates * @param y Object * @param animate Object + * @returns Ext.util.Positionable this */ static setY( y?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Displays a new message box or reinitializes an existing message box based on the config options passed in * @param config Object The following config options are supported: + * @returns Ext.window.MessageBox this */ static show( config?:any ): Ext.window.IMessageBox; /** [Method] Displays component at specific xy position * @param x Number/Number[] The new x position or array of [x,y]. * @param y Number The new y position * @param animate Boolean/Object True to animate the Component into its new position. You may also pass an animation configuration. + * @returns Ext.Component this */ - static showAt( x?:any, y?:any, animate?:any ): any; - static showAt( x?:number, y?:number, animate?:any ): Ext.IComponent; - static showAt( x?:number[], y?:number, animate?:any ): Ext.IComponent; + static showAt( x?:any, y?:number, animate?:any ): Ext.IComponent; /** [Method] Shows this component by the specified Component or Element * @param component Ext.Component/Ext.dom.Element The Ext.Component or Ext.Element to show the component by. * @param position String Alignment position as used by Ext.util.Positionable.getAlignToXY. Defaults to defaultAlign. * @param offsets Number[] Alignment offsets as used by Ext.util.Positionable.getAlignToXY. + * @returns Ext.Component this + */ + static showBy( component?:any, position?:string, offsets?:number[] ): Ext.IComponent; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class */ - static showBy( component?:any, position?:any, offsets?:any ): any; - static showBy( component?:Ext.IComponent, position?:string, offsets?:number[] ): Ext.IComponent; - static showBy( component?:Ext.dom.IElement, position?:string, offsets?:number[] ): Ext.IComponent; - /** [Method] Get the reference to the class from which this object was instantiated */ static statics(): Ext.IClass; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ static stopAnimation(): Ext.IElement; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ static stopFx(): Ext.IElement; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. @@ -28408,25 +30218,33 @@ declare module Ext { * @param queueSuspended Boolean Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events. */ static suspendEvents( queueSuspended?:boolean ): void; - /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently */ + /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently + * @returns Object this + */ static syncFx(): any; - /** [Method] Sends this Component to the back of lower z index than any other visible windows */ + /** [Method] Sends this Component to the back of lower z index than any other visible windows + * @returns Ext.Component this + */ static toBack(): Ext.IComponent; /** [Method] Brings this floating Component to the front of any other visible floating Components managed by the same ZIndexManag * @param preventFocus Boolean Specify true to prevent the Component from being focused. + * @returns Ext.Component this */ static toFront( preventFocus?:boolean ): Ext.IComponent; - /** [Method] Shortcut for performing an expand or collapse based on the current state of the panel */ + /** [Method] Shortcut for performing an expand or collapse based on the current state of the panel + * @returns Ext.panel.Panel this + */ static toggleCollapse(): Ext.panel.IPanel; - /** [Method] A shortcut method for toggling between maximize and restore based on the current maximized state of the window */ + /** [Method] A shortcut method for toggling between maximize and restore based on the current maximized state of the window + * @returns Ext.window.Window this + */ static toggleMaximize(): Ext.window.IWindow; /** [Method] Translates the passed page coordinates into left top css values for the element * @param x Number/Array The page x or an array containing [x, y] * @param y Number The page y, required if x is not an array + * @returns Object An object with left and top properties. e.g. {left: (value), top: (value)} */ - static translatePoints( x?:any, y?:any ): any; - static translatePoints( x?:number, y?:number ): any; - static translatePoints( x?:any[], y?:number ): any; + static translatePoints( x?:any, y?:number ): any; /** [Method] Shorthand for removeListener * @param eventName String The type of event the handler was associated with. * @param fn Function The handler to remove. This must be a reference to the function passed into the Ext.util.Observable.addListener call. @@ -28436,14 +30254,9 @@ declare module Ext { /** [Method] Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed simple selector or * @param selector String/Ext.Component The simple selector component or actual component to test. If not passed the immediate owner/activater is returned. * @param limit String/Number/Ext.Component This may be a selector upon which to stop the upward scan, or a limit of teh number of steps, or Component reference to stop on. + * @returns Ext.container.Container The matching ancestor Container (or undefined if no match was found). */ - static up( selector?:any, limit?:any ): any; - static up( selector?:string, limit?:string ): Ext.container.IContainer; - static up( selector?:Ext.IComponent, limit?:string ): Ext.container.IContainer; - static up( selector?:string, limit?:number ): Ext.container.IContainer; - static up( selector?:Ext.IComponent, limit?:number ): Ext.container.IContainer; - static up( selector?:string, limit?:Ext.IComponent ): Ext.container.IContainer; - static up( selector?:Ext.IComponent, limit?:Ext.IComponent ): Ext.container.IContainer; + static up( selector?:any, limit?:any ): Ext.container.IContainer; /** [Method] Update the content area of a component * @param htmlOrData String/Object If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. If this component was not configured with a template, the components content area will be updated via Ext.Element update. * @param loadScripts Boolean Only legitimate when using the html configuration. @@ -28452,6 +30265,7 @@ declare module Ext { static update( htmlOrData?:any, loadScripts?:boolean, callback?:any ): void; /** [Method] Sets the current box measurements of the component s underlying element * @param box Object An object in the format {x, y, width, height} + * @returns Ext.Component this */ static updateBox( box?:any ): Ext.IComponent; /** [Method] Updates this component s layout @@ -28462,12 +30276,14 @@ declare module Ext { * @param value Number Any number between 0 and 1 (e.g., .5) * @param progressText String The progress text to display inside the progress bar. * @param msg String The message box's body text is replaced with the specified string (defaults to undefined so that any existing body text will not get overwritten by default unless a new value is passed in) + * @returns Ext.window.MessageBox this */ static updateProgress( value?:number, progressText?:string, msg?:string ): Ext.window.IMessageBox; /** [Method] Displays a message box with an infinitely auto updating progress bar * @param msg String The message box body text * @param title String The title bar text * @param config Object A Ext.ProgressBar.wait config object + * @returns Ext.window.MessageBox this */ static wait( msg?:string, title?:string, config?:any ): Ext.window.IMessageBox; } @@ -28478,40 +30294,35 @@ declare module Ext { export class Msg { /** [Method] Adds Component s to this Container * @param component Ext.Component[]|Object[]/Ext.Component.../Object... Either one or more Components to add or an Array of Components to add. See items for additional information. + * @returns Ext.Component[]/Ext.Component The Components that were added. */ - static add( component?:any ): Ext.IComponent[]; - /** [Method] Adds Component s to this Container - * @param component Ext.Component[]|Object[]/Ext.Component.../Object... Either one or more Components to add or an Array of Components to add. See items for additional information. - */ - static add( component?:any ): Ext.IComponent; + static add( component?:any ): any; /** [Method] Adds a CSS class to the body element * @param cls String The class to add + * @returns Ext.panel.Panel this */ static addBodyCls( cls?:string ): Ext.panel.IPanel; /** [Method] Adds each argument passed to this method to the childEls array */ static addChildEls(): void; /** [Method] Adds a CSS class to the top level element representing this component * @param cls String/String[] The CSS class name to add. + * @returns Ext.Component Returns the Component to allow method chaining. */ - static addClass( cls?:any ): any; - static addClass( cls?:string ): Ext.IComponent; - static addClass( cls?:string[] ): Ext.IComponent; + static addClass( cls?:any ): Ext.IComponent; /** [Method] Adds a CSS class to the top level element representing this component * @param cls String/String[] The CSS class name to add. + * @returns Ext.Component Returns the Component to allow method chaining. */ - static addCls( cls?:any ): any; - static addCls( cls?:string ): Ext.IComponent; - static addCls( cls?:string[] ): Ext.IComponent; + static addCls( cls?:any ): Ext.IComponent; /** [Method] Adds a cls to the uiCls array which will also call addUIClsToElement and adds to all elements of this component * @param classes String/String[] A string or an array of strings to add to the uiCls. * @param skip Object (Boolean) skip true to skip adding it to the class and do it later (via the return). */ - static addClsWithUI( classes?:any, skip?:any ): any; - static addClsWithUI( classes?:string, skip?:any ): void; - static addClsWithUI( classes?:string[], skip?:any ): void; + static addClsWithUI( classes?:any, skip?:any ): void; /** [Method] Adds docked item s to the container * @param component Object/Object[] The Component or array of components to add. The components must include a 'dock' parameter on each component to indicate where it should be docked ('top', 'right', 'bottom', 'left'). * @param pos Number The index at which the Component will be added + * @returns Ext.Component[] The added components. */ static addDocked( component?:any, pos?:number ): Ext.IComponent[]; /** [Method] Adds the specified events to the list of events which this Observable may fire @@ -28523,6 +30334,7 @@ declare module Ext { * @param listeners Object * @param scope Object * @param options Object + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( element?:any, listeners?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -28531,22 +30343,20 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Save a property to the given state object if it is not its default or configured value * @param state Object The state object. * @param propName String The name of the property on this object to save. * @param value String The value of the state property (defaults to this[propName]). + * @returns Boolean The state object or a new object if state was null and the property was saved. */ static addPropertyToState( state?:any, propName?:string, value?:string ): boolean; /** [Method] Add events that will trigger the state to be saved * @param events String/String[] The event name or an array of event names. */ - static addStateEvents( events?:any ): any; - static addStateEvents( events?:string ): void; - static addStateEvents( events?:string[] ): void; + static addStateEvents( events?:any ): void; /** [Method] Add tools to this panel * @param tools Object[]/Ext.panel.Tool[] The tools to add */ @@ -28575,14 +30385,13 @@ declare module Ext { * @param callback Function * @param scope Object */ - static afterShow( animateTarget?:any, callback?:any, scope?:any ): any; - static afterShow( animateTarget?:string, callback?:any, scope?:any ): void; - static afterShow( animateTarget?:Ext.IElement, callback?:any, scope?:any ): void; + static afterShow( animateTarget?:any, callback?:any, scope?:any ): void; /** [Method] Displays a standard read only message box with an OK button comparable to the basic JavaScript alert prompt * @param title String The title bar text * @param msg String The message box body text * @param fn Function The callback function invoked after the message box is closed. See show method for details. * @param scope Object The scope (this reference) in which the callback is executed. + * @returns Ext.window.MessageBox this */ static alert( title?:string, msg?:string, fn?:any, scope?:any ): Ext.window.IMessageBox; /** [Method] Aligns the element with another element relative to the specified anchor points @@ -28590,11 +30399,9 @@ declare module Ext { * @param position String The position to align to * @param offsets Number[] Offset the positioning by [x, y] * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ - static alignTo( element?:any, position?:any, offsets?:any, animate?:any ): any; - static alignTo( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; - static alignTo( element?:HTMLElement, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; - static alignTo( element?:string, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; + static alignTo( element?:any, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; /** [Method] Anchors an element to another element and realigns it when the window is resized * @param element Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or id of the element to align to. * @param position String The position to align to @@ -28602,16 +30409,12 @@ declare module Ext { * @param animate Boolean/Object true for the default animation or a standard Element animation config object * @param monitorScroll Boolean/Number True to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay in milliseconds. * @param callback Function The function to call after the animation finishes + * @returns Ext.util.Positionable this */ - static anchorTo( element?:any, position?:any, offsets?:any, animate?:any, monitorScroll?:any, callback?:any ): any; - static anchorTo( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - static anchorTo( element?:HTMLElement, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - static anchorTo( element?:string, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - static anchorTo( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; - static anchorTo( element?:HTMLElement, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; - static anchorTo( element?:string, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; + static anchorTo( element?:any, position?:string, offsets?:number[], animate?:any, monitorScroll?:any, callback?:any ): Ext.util.IPositionable; /** [Method] Performs custom animation on this object * @param animObj Object + * @returns Object this */ static animate( animObj?:any ): any; /** [Method] Applies the state to the object @@ -28639,6 +30442,7 @@ declare module Ext { * @param fn Function The function to call * @param scope Object The scope of the function. Defaults to current node. * @param args Array The args to call the function with. Defaults to passing the current component. + * @returns Ext.Component this */ static bubble( fn?:any, scope?:any, args?:any[] ): Ext.IComponent; /** [Method] Calculates the new x y position to move this Positionable into a constrain region @@ -28646,49 +30450,49 @@ declare module Ext { * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to coerce into constraints instead of using this Positionable's current position. * @param local Boolean The proposedPosition is local (relative to floatParent if a floating Component) * @param proposedSize Number[] A proposed [width, height] size to use when calculating constraints instead of using this Positionable's current size. + * @returns Number[] If the element needs to be translated, the new [X, Y] position within constraints if possible, giving priority to keeping the top and left edge in the constrain region. Otherwise, false. */ - static calculateConstrainedPosition( constrainTo?:any, proposedPosition?:any, local?:any, proposedSize?:any ): any; - static calculateConstrainedPosition( constrainTo?:string, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - static calculateConstrainedPosition( constrainTo?:HTMLElement, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - static calculateConstrainedPosition( constrainTo?:Ext.IElement, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - static calculateConstrainedPosition( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; + static calculateConstrainedPosition( constrainTo?:any, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Cancel any deferred focus on this component */ static cancelFocus(): void; /** [Method] Cascades down the component container heirarchy from this component passed in the first call calling the specified * @param fn Function The function to call * @param scope Object The scope of the function (defaults to current component) * @param args Array The args to call the function with. The current component always passed as the last argument. + * @returns Ext.Container this */ static cascade( fn?:any, scope?:any, args?:any[] ): Ext.IContainer; - /** [Method] Center this Component in its container */ + /** [Method] Center this Component in its container + * @returns Ext.Component this + */ static center(): Ext.IComponent; /** [Method] Retrieves the first direct child of this container which matches the passed selector or component * @param selector String/Ext.Component An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching child Ext.Component (or null if no match was found). */ static child( selector?:any ): any; - static child( selector?:string ): any; - static child( selector?:Ext.IComponent ): any; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ static clearManagedListeners(): void; /** [Method] Clone the current component using the original config values passed into this instance by default * @param overrides Object A new config containing any properties to override in the cloned version. An id property can be passed on this object, otherwise one will be generated to avoid duplicates. + * @returns Ext.Component clone The cloned copy of this component */ static cloneConfig( overrides?:any ): Ext.IComponent; /** [Method] Closes the Panel */ @@ -28696,6 +30500,7 @@ declare module Ext { /** [Method] Collapses the panel body so that the body becomes hidden * @param direction String The direction to collapse towards. Must be one of Ext.Component.DIRECTION_TOP Ext.Component.DIRECTION_RIGHT Ext.Component.DIRECTION_BOTTOM Ext.Component.DIRECTION_LEFT Defaults to collapseDirection. * @param animate Boolean True to animate the transition, else false (defaults to the value of the animCollapse panel config). May also be specified as the animation duration in milliseconds. + * @returns Ext.panel.Panel this */ static collapse( direction?:string, animate?:boolean ): Ext.panel.IPanel; /** [Method] Displays a confirmation message box with Yes and No buttons comparable to JavaScript s confirm @@ -28703,75 +30508,80 @@ declare module Ext { * @param msg String The message box body text * @param fn Function The callback function invoked after the message box is closed. See show method for details. * @param scope Object The scope (this reference) in which the callback is executed. + * @returns Ext.window.MessageBox this */ static confirm( title?:string, msg?:string, fn?:any, scope?:any ): Ext.window.IMessageBox; /** [Method] Determines whether the passed Component is either an immediate child of this Container or whether it is a descendant * @param comp Ext.Component The Component to test. * @param deep Boolean Pass true to test for the Component being a descendant at any level. + * @returns Boolean true if the passed Component is contained at the specified level. */ static contains( comp?:Ext.IComponent, deep?:boolean ): boolean; /** [Method] converts a collapsdDir into an anchor argument for Element slideIn overridden in rtl mode to switch l and r * @param collapseDir Object */ static convertCollapseDir( collapseDir?:any ): void; - /** [Method] Inherit docs Disable all immediate children that was previously disabled Override disable because onDisable only gets */ + /** [Method] Inherit docs Disable all immediate children that was previously disabled Override disable because onDisable only gets + * @returns Ext.container.AbstractContainer this + */ static disable(): Ext.container.IAbstractContainer; /** [Method] Handles autoRender */ static doAutoRender(): void; - /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t */ + /** [Method] This method needs to be called whenever you change something on this component that requires the Component s layout t + * @returns Ext.container.Container this + */ static doComponentLayout(): Ext.container.IContainer; /** [Method] Moves this floating Component into a constrain region * @param constrainTo String/HTMLElement/Ext.Element/Ext.util.Region The Element or Region into which this Component is to be constrained. Defaults to the element into which this floating Component was rendered. */ - static doConstrain( constrainTo?:any ): any; - static doConstrain( constrainTo?:string ): void; - static doConstrain( constrainTo?:HTMLElement ): void; - static doConstrain( constrainTo?:Ext.IElement ): void; - static doConstrain( constrainTo?:Ext.util.IRegion ): void; - /** [Method] Manually force this container s layout to be recalculated */ + static doConstrain( constrainTo?:any ): void; + /** [Method] Manually force this container s layout to be recalculated + * @returns Ext.container.Container this + */ static doLayout(): Ext.container.IContainer; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String/Ext.Component An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching descendant Ext.Component (or null if no match was found). */ static down( selector?:any ): any; - static down( selector?:string ): any; - static down( selector?:Ext.IComponent ): any; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Ensures that this component is attached to document body * @param runLayout Boolean True to run the component's layout. */ static ensureAttachedToBody( runLayout?:boolean ): void; /** [Method] Expands the panel body so that it becomes visible * @param animate Boolean True to animate the transition, else false (defaults to the value of the animCollapse panel config). May also be specified as the animation duration in milliseconds. + * @returns Ext.panel.Panel this */ static expand( animate?:boolean ): Ext.panel.IPanel; /** [Method] Find a container above this component at any level by a custom function * @param fn Function The custom function to call with the arguments (container, this component). + * @returns Ext.container.Container The first Container for which the custom function returns true */ static findParentBy( fn?:any ): Ext.container.IContainer; /** [Method] Find a container above this component at any level by xtype or class See also the up method * @param xtype String/Ext.Class The xtype string for a component, or the class of the component directly + * @returns Ext.container.Container The first Container which matches the given xtype or class */ - static findParentByType( xtype?:any ): any; - static findParentByType( xtype?:string ): Ext.container.IContainer; - static findParentByType( xtype?:Ext.IClass ): Ext.container.IContainer; + static findParentByType( xtype?:any ): Ext.container.IContainer; /** [Method] Retrieves plugin from this component s collection by its ptype * @param ptype String The Plugin's ptype as specified by the class's alias configuration. + * @returns Ext.AbstractPlugin plugin instance. */ static findPlugin( ptype?:string ): Ext.IAbstractPlugin; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; /** [Method] Try to focus this component @@ -28779,34 +30589,33 @@ declare module Ext { * @param delay Boolean/Number Delay the focus this number of milliseconds (true for 10 milliseconds). * @param callback Function Only needed if the delay parameter is used. A function to call upon focus. * @param scope Function Only needed if the delay parameter is used. The scope (this reference) in which to execute the callback. + * @returns Ext.Component The focused Component. Usually this Component. Some Containers may delegate focus to a descendant Component (Windows can do this through their defaultFocus config option. */ - static focus( selectText?:any, delay?:any, callback?:any, scope?:any ): any; - static focus( selectText?:boolean, delay?:boolean, callback?:any, scope?:any ): Ext.IComponent; - static focus( selectText?:boolean, delay?:number, callback?:any, scope?:any ): Ext.IComponent; + static focus( selectText?:boolean, delay?:any, callback?:any, scope?:any ): Ext.IComponent; /** [Method] Forces this component to redo its componentLayout */ static forceComponentLayout(): void; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - static getActiveAnimation(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - static getActiveAnimation(): boolean; + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + static getActiveAnimation(): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or id of the element to align to. * @param position String The position to align to * @param offsets Number[] Offset the positioning by [x, y] + * @returns Number[] [x, y] */ - static getAlignToXY( element?:any, position?:any, offsets?:any ): any; - static getAlignToXY( element?:Ext.util.IPositionable, position?:string, offsets?:number[] ): number[]; - static getAlignToXY( element?:HTMLElement, position?:string, offsets?:number[] ): number[]; - static getAlignToXY( element?:string, position?:string, offsets?:number[] ): number[]; + static getAlignToXY( element?:any, position?:string, offsets?:number[] ): number[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. See alignTo for details on supported anchor positions. * @param local Boolean True to get the local (element top/left-relative) anchor position instead of page coordinates * @param size Object An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size) + * @returns Number[] [x, y] An array containing the element's x and y coordinates */ static getAnchorXY( anchor?:string, local?:boolean, size?:any ): number[]; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param contentBox Boolean If true a box for the content of the element is returned. * @param local Boolean If true the element's left and top relative to its offsetParent are returned instead of page x/y. + * @returns Object box An object in the format: { x: <Element's X position>, y: <Element's Y position>, left: <Element's X position (an alias for x)>, top: <Element's Y position (an alias for y)>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. The result may also be used for setXY */ static getBox( contentBox?:boolean, local?:boolean ): any; /** [Method] Implements an upward event bubbling policy */ @@ -28814,146 +30623,171 @@ declare module Ext { /** [Method] Return the immediate child Component in which the passed element is located * @param el Ext.Element/HTMLElement/String The element to test (or ID of element). * @param deep Boolean If true, returns the deepest descendant Component which contains the passed element. + * @returns Ext.Component The child item which contains the passed element. */ - static getChildByElement( el?:any, deep?:any ): any; - static getChildByElement( el?:Ext.IElement, deep?:boolean ): Ext.IComponent; - static getChildByElement( el?:HTMLElement, deep?:boolean ): Ext.IComponent; - static getChildByElement( el?:string, deep?:boolean ): Ext.IComponent; - /** [Method] Returns the current collapsed state of the panel */ - static getCollapsed(): boolean; - /** [Method] Returns the current collapsed state of the panel */ - static getCollapsed(): string; + static getChildByElement( el?:any, deep?:boolean ): Ext.IComponent; + /** [Method] Returns the current collapsed state of the panel + * @returns Boolean/String False when not collapsed, otherwise the value of collapseDirection. + */ + static getCollapsed(): any; /** [Method] Attempts a default component lookup see Ext container Container getComponent * @param comp String/Number The component id, itemId or position to find + * @returns Ext.Component The component (if found) */ - static getComponent( comp?:any ): any; - static getComponent( comp?:string ): Ext.IComponent; - static getComponent( comp?:number ): Ext.IComponent; + static getComponent( comp?:any ): Ext.IComponent; /** [Method] Returns the X Y vector by which this Positionable s element must be translated to make a best attempt to constrain * @param constrainTo Ext.util.Positionable/HTMLElement/String/Ext.util.Region The Positionable, HTMLElement, element id, or Region into which the element is to be constrained. * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position * @param proposedSize Number[] A proposed [width, height] size to constrain instead of using the element's current size + * @returns Number[]/Boolean If the element needs to be translated, an [X, Y] vector by which this element must be translated. Otherwise, false. */ - static getConstrainVector( constrainTo?:any, proposedPosition?:any, proposedSize?:any ): any; - static getConstrainVector( constrainTo?:Ext.util.IPositionable, proposedPosition?:number[], proposedSize?:number[] ): number[]; - static getConstrainVector( constrainTo?:HTMLElement, proposedPosition?:number[], proposedSize?:number[] ): number[]; - static getConstrainVector( constrainTo?:string, proposedPosition?:number[], proposedSize?:number[] ): number[]; - static getConstrainVector( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], proposedSize?:number[] ): number[]; - /** [Method] Returns the X Y vector by which this Positionable s element must be translated to make a best attempt to constrain - * @param constrainTo Ext.util.Positionable/HTMLElement/String/Ext.util.Region The Positionable, HTMLElement, element id, or Region into which the element is to be constrained. - * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position - * @param proposedSize Number[] A proposed [width, height] size to constrain instead of using the element's current size - */ - static getConstrainVector( constrainTo?:Ext.util.IPositionable, proposedPosition?:number[], proposedSize?:number[] ): boolean; - static getConstrainVector( constrainTo?:HTMLElement, proposedPosition?:number[], proposedSize?:number[] ): boolean; - static getConstrainVector( constrainTo?:string, proposedPosition?:number[], proposedSize?:number[] ): boolean; - static getConstrainVector( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], proposedSize?:number[] ): boolean; + static getConstrainVector( constrainTo?:any, proposedPosition?:number[], proposedSize?:number[] ): any; /** [Method] Gets the configured default focus item */ static getDefaultFocus(): void; /** [Method] Finds a docked component by id itemId or position * @param comp String/Number The id, itemId or position of the docked component (see getComponent for details) + * @returns Ext.Component The docked component (if found) */ - static getDockedComponent( comp?:any ): any; - static getDockedComponent( comp?:string ): Ext.IComponent; - static getDockedComponent( comp?:number ): Ext.IComponent; + static getDockedComponent( comp?:any ): Ext.IComponent; /** [Method] Retrieves an array of all currently docked Components * @param selector String A ComponentQuery selector string to filter the returned items. * @param beforeBody Boolean An optional flag to limit the set of items to only those before the body (true) or after the body (false). All components are returned by default. + * @returns Ext.Component[] The array of docked components meeting the specified criteria. */ static getDockedItems( selector?:string, beforeBody?:boolean ): Ext.IComponent[]; - /** [Method] Retrieves the top level element representing this component */ + /** [Method] Retrieves the top level element representing this component + * @returns Ext.dom.Element + */ static getEl(): Ext.dom.IElement; /** [Method] Gets the Header for this panel */ static getHeader(): void; - /** [Method] Gets the current height of the component s underlying element */ + /** [Method] Gets the current height of the component s underlying element + * @returns Number + */ static getHeight(): number; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] This function takes the position argument passed to onRender and returns a DOM element that you can use in the insert * @param position String/Number/Ext.dom.Element/HTMLElement Index, element id or element you want to put this component before. + * @returns HTMLElement DOM element that you can use in the insertBefore + */ + static getInsertPosition( position?:any ): HTMLElement; + /** [Method] Returns the value of itemId assigned to this component or when that is not set returns the value of id + * @returns String */ - static getInsertPosition( position?:any ): any; - static getInsertPosition( position?:string ): HTMLElement; - static getInsertPosition( position?:number ): HTMLElement; - static getInsertPosition( position?:Ext.dom.IElement ): HTMLElement; - static getInsertPosition( position?:HTMLElement ): HTMLElement; - /** [Method] Returns the value of itemId assigned to this component or when that is not set returns the value of id */ static getItemId(): string; - /** [Method] Returns the layout instance currently associated with this Container */ + /** [Method] Returns the layout instance currently associated with this Container + * @returns Ext.layout.container.Container The layout + */ static getLayout(): Ext.layout.container.IContainer; - /** [Method] Gets the Ext ComponentLoader for this Component */ + /** [Method] Gets the Ext ComponentLoader for this Component + * @returns Ext.ComponentLoader The loader instance, null if it doesn't exist. + */ static getLoader(): Ext.IComponentLoader; - /** [Method] Overridden in Ext rtl AbstractComponent */ + /** [Method] Overridden in Ext rtl AbstractComponent + * @returns Number The local x coordinate + */ static getLocalX(): number; - /** [Method] Overridden in Ext rtl AbstractComponent */ + /** [Method] Overridden in Ext rtl AbstractComponent + * @returns Number[] The local XY position of the element + */ static getLocalXY(): number[]; - /** [Method] Returns the y coordinate of this element reletive to its offsetParent */ + /** [Method] Returns the y coordinate of this element reletive to its offsetParent + * @returns Number The local y coordinate + */ static getLocalY(): number; /** [Method] Returns the offsets of this element from the passed element * @param offsetsTo Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or element id to get get the offsets from. + * @returns Number[] The XY page offsets (e.g. [100, -200]) */ - static getOffsetsTo( offsetsTo?:any ): any; - static getOffsetsTo( offsetsTo?:Ext.util.IPositionable ): number[]; - static getOffsetsTo( offsetsTo?:HTMLElement ): number[]; - static getOffsetsTo( offsetsTo?:string ): number[]; + static getOffsetsTo( offsetsTo?:any ): number[]; /** [Method] Retrieves a plugin from this component s collection by its pluginId * @param pluginId String + * @returns Ext.AbstractPlugin plugin instance. */ static getPlugin( pluginId?:string ): Ext.IAbstractPlugin; /** [Method] Gets the current XY position of the component s underlying element * @param local Boolean If true the element's left and top are returned instead of page XY. + * @returns Number[] The XY position of the element (e.g., [100, 200]) */ static getPosition( local?:boolean ): number[]; /** [Method] Used by ComponentQuery child and down to retrieve all of the items which can potentially be considered a child of th * @param deep Object */ static getRefItems( deep?:any ): void; - /** [Method] Returns a region object that defines the area of this element */ + /** [Method] Returns a region object that defines the area of this element + * @returns Ext.util.Region A Region containing "top, left, bottom, right" properties. + */ static getRegion(): Ext.util.IRegion; - /** [Method] Gets the current size of the component s underlying element */ + /** [Method] Gets the current size of the component s underlying element + * @returns Object An object containing the element's size {width: (element width), height: (element height)} + */ static getSize(): any; /** [Method] Returns an object that describes how this component s width and height are managed * @param ownerCtSizeModel Object + * @returns Object The size model for this component. */ static getSizeModel( ownerCtSizeModel?:any ): any; - /** [Method] Returns the content region of this element */ + /** [Method] Returns the content region of this element + * @returns Ext.util.Region A Region containing "top, left, bottom, right" member data. + */ static getViewRegion(): Ext.util.IRegion; - /** [Method] Gets the current width of the component s underlying element */ + /** [Method] Gets the current width of the component s underlying element + * @returns Number + */ static getWidth(): number; - /** [Method] Gets the current X position of the DOM element based on page coordinates */ + /** [Method] Gets the current X position of the DOM element based on page coordinates + * @returns Number The X position of the element + */ static getX(): number; - /** [Method] Gets the xtype for this component as registered with Ext ComponentManager */ + /** [Method] Gets the xtype for this component as registered with Ext ComponentManager + * @returns String The xtype + */ static getXType(): string; - /** [Method] Returns this Component s xtype hierarchy as a slash delimited string */ + /** [Method] Returns this Component s xtype hierarchy as a slash delimited string + * @returns String The xtype hierarchy string + */ static getXTypes(): string; - /** [Method] Gets the current position of the DOM element based on page coordinates */ + /** [Method] Gets the current position of the DOM element based on page coordinates + * @returns Number[] The XY position of the element + */ static getXY(): number[]; - /** [Method] Gets the current Y position of the DOM element based on page coordinates */ + /** [Method] Gets the current Y position of the DOM element based on page coordinates + * @returns Number The Y position of the element + */ static getY(): number; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - static hasActiveFx(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - static hasActiveFx(): boolean; + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + static hasActiveFx(): any; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param className String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ static hasCls( className?:string ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Checks if there is currently a specified uiCls * @param cls String The cls to check. */ static hasUICls( cls?:string ): void; - /** [Method] Hides this Component setting it to invisible using the configured hideMode */ + /** [Method] Hides this Component setting it to invisible using the configured hideMode + * @returns Ext.Component this + */ static hide(): Ext.IComponent; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Initialize any events on this component */ @@ -28961,6 +30795,7 @@ declare module Ext { /** [Method] Inserts a Component into this Container at a specified index * @param index Number The index at which the Component will be inserted into the Container's items collection * @param component Ext.Component/Object The child Component to insert. Ext uses lazy rendering, and will only render the inserted Component should it become necessary. A Component config object may be passed in order to avoid the overhead of constructing a real Component object if lazy rendering might mean that the inserted Component will not be rendered immediately. To take advantage of this 'lazy instantiation', set the Ext.Component.xtype config property to the registered type of the Component wanted. For a list of all available xtypes, see Ext.enums.Widget. + * @returns Ext.Component component The Component (or config object) that was inserted with the Container's default config values applied. */ static insert( index?:number, component?:any ): Ext.IComponent; /** [Method] Inserts docked item s to the panel at the indicated position @@ -28970,6 +30805,7 @@ declare module Ext { static insertDocked( pos?:number, component?:any ): void; /** [Method] Tests whether this Component matches the selector string * @param selector String The selector string to test against. + * @returns Boolean true if this Component matches the selector. */ static is( selector?:string ): boolean; /** [Method] Determines whether this Container is an ancestor of the passed Component @@ -28978,36 +30814,54 @@ declare module Ext { static isAncestor( possibleDescendant?:Ext.IComponent ): void; /** [Method] Determines whether this component is the descendant of a particular container * @param container Ext.Container + * @returns Boolean true if the component is the descendant of a particular container, otherwise false. */ static isDescendantOf( container?:Ext.IContainer ): boolean; - /** [Method] Method to determine whether this Component is currently disabled */ + /** [Method] Method to determine whether this Component is currently disabled + * @returns Boolean the disabled state of this Component. + */ static isDisabled(): boolean; - /** [Method] Method to determine whether this Component is draggable */ + /** [Method] Method to determine whether this Component is draggable + * @returns Boolean the draggable state of this component. + */ static isDraggable(): boolean; - /** [Method] Method to determine whether this Component is droppable */ + /** [Method] Method to determine whether this Component is droppable + * @returns Boolean the droppable state of this component. + */ static isDroppable(): boolean; - /** [Method] Method to determine whether this Component is floating */ + /** [Method] Method to determine whether this Component is floating + * @returns Boolean the floating state of this component. + */ static isFloating(): boolean; - /** [Method] Method to determine whether this Component is currently set to hidden */ + /** [Method] Method to determine whether this Component is currently set to hidden + * @returns Boolean the hidden state of this Component. + */ static isHidden(): boolean; /** [Method] Determines whether this Component is the root of a layout */ static isLayoutRoot(): void; - /** [Method] Returns true if layout is suspended for this component */ + /** [Method] Returns true if layout is suspended for this component + * @returns Boolean true layout of this component is suspended. + */ static isLayoutSuspended(): boolean; /** [Method] Returns true if this component is visible * @param deep Object + * @returns Boolean true if this component is visible, false otherwise. */ static isVisible( deep?:any ): boolean; /** [Method] Tests whether or not this Component is of a specific xtype * @param xtype String The xtype to check for this Component * @param shallow Boolean true to check whether this Component is directly of the specified xtype, false to check whether this Component is descended from the xtype. + * @returns Boolean true if this component descends from the specified xtype, false otherwise. */ static isXType( xtype?:string, shallow?:boolean ): boolean; /** [Method] Fits the window within its current container and automatically replaces the maximize tool button with the restore * @param animate Boolean true to animate this Window to full size. + * @returns Ext.window.Window this */ static maximize( animate?:boolean ): Ext.window.IWindow; - /** [Method] Placeholder method for minimizing the window */ + /** [Method] Placeholder method for minimizing the window + * @returns Ext.window.Window this + */ static minimize(): Ext.window.IWindow; /** [Method] Shorthand for addManagedListener * @param item Ext.util.Observable/Ext.Element The item to which to add a listener/listeners. @@ -29015,32 +30869,30 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Moves a Component within the Container * @param fromIdx Number/Ext.Component The index/component to move. * @param toIdx Number The new index for the Component. + * @returns Ext.Component component The Component that was moved. */ - static move( fromIdx?:any, toIdx?:any ): any; - static move( fromIdx?:number, toIdx?:number ): Ext.IComponent; - static move( fromIdx?:Ext.IComponent, toIdx?:number ): Ext.IComponent; + static move( fromIdx?:any, toIdx?:number ): Ext.IComponent; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Returns the next node in the Component tree in tree traversal order * @param selector String A ComponentQuery selector to filter the following nodes. + * @returns Ext.Component The next node (or the next node which matches the selector). Returns null if there is no matching node. */ static nextNode( selector?:string ): Ext.IComponent; /** [Method] Returns the next sibling of this Component * @param selector String A ComponentQuery selector to filter the following items. + * @returns Ext.Component The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling. */ static nextSibling( selector?:string ): Ext.IComponent; /** [Method] Shorthand for addListener @@ -29048,6 +30900,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] This method is invoked after a new Component has been added @@ -29103,16 +30956,19 @@ declare module Ext { static postBlur( e?:Ext.IEventObject ): void; /** [Method] Returns the previous node in the Component tree in tree traversal order * @param selector String A ComponentQuery selector to filter the preceding nodes. + * @returns Ext.Component The previous node (or the previous node which matches the selector). Returns null if there is no matching node. */ static previousNode( selector?:string ): Ext.IComponent; /** [Method] Returns the previous sibling of this Component * @param selector String A ComponentQuery selector to filter the preceding items. + * @returns Ext.Component The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling. */ static previousSibling( selector?:string ): Ext.IComponent; /** [Method] Displays a message box with a progress bar * @param title String The title bar text * @param msg String The message box body text * @param progressText String The text to display inside the progress bar + * @returns Ext.window.MessageBox this */ static progress( title?:string, msg?:string, progressText?:string ): Ext.window.IMessageBox; /** [Method] Displays a message box with OK and Cancel buttons prompting the user to enter some text comparable to JavaScript s p @@ -29122,21 +30978,23 @@ declare module Ext { * @param scope Object The scope (this reference) in which the callback is executed. * @param multiline Boolean/Number True to create a multiline textbox using the defaultTextHeight property, or the height in pixels to create the textbox/ * @param value String Default value of the text input element + * @returns Ext.window.MessageBox this */ - static prompt( title?:any, msg?:any, fn?:any, scope?:any, multiline?:any, value?:any ): any; - static prompt( title?:string, msg?:string, fn?:any, scope?:any, multiline?:boolean, value?:string ): Ext.window.IMessageBox; - static prompt( title?:string, msg?:string, fn?:any, scope?:any, multiline?:number, value?:string ): Ext.window.IMessageBox; + static prompt( title?:string, msg?:string, fn?:any, scope?:any, multiline?:any, value?:string ): Ext.window.IMessageBox; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned. + * @returns Ext.Component[] Components which matched the selector */ static query( selector?:string ): Ext.IComponent[]; /** [Method] Retrieves all descendant components which match the passed function * @param fn Function The matcher function. It will be called with a single argument, the component being tested. * @param scope Object The scope in which to run the function. If not specified, it will default to the active component. + * @returns Ext.Component[] Components matched by the passed function */ static queryBy( fn?:any, scope?:any ): Ext.IComponent[]; /** [Method] Finds a component at any level under this container matching the id itemId * @param id String The id to find + * @returns Ext.Component The matching id, null if not found */ static queryById( id?:string ): Ext.IComponent; /** [Method] Called by Component doAutoRender Register a Container configured floating true with this Component s ZIndexManager @@ -29147,23 +31005,27 @@ declare module Ext { * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes a component from this container * @param component Ext.Component/String The component reference or id to remove. * @param autoDestroy Boolean True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config. + * @returns Ext.Component component The Component that was removed. */ - static remove( component?:any, autoDestroy?:any ): any; - static remove( component?:Ext.IComponent, autoDestroy?:boolean ): Ext.IComponent; - static remove( component?:string, autoDestroy?:boolean ): Ext.IComponent; + static remove( component?:any, autoDestroy?:boolean ): Ext.IComponent; /** [Method] Removes all components from this container * @param autoDestroy Boolean True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config. + * @returns Ext.Component[] Array of the removed components */ static removeAll( autoDestroy?:boolean ): Ext.IComponent[]; - /** [Method] Remove any anchor to this element */ + /** [Method] Remove any anchor to this element + * @returns Ext.util.Positionable this + */ static removeAnchor(): Ext.util.IPositionable; /** [Method] Removes a CSS class from the body element * @param cls String The class to remove + * @returns Ext.panel.Panel this */ static removeBodyCls( cls?:string ): Ext.panel.IPanel; /** [Method] Removes items in the childEls array based on the return value of a supplied test function @@ -29172,16 +31034,13 @@ declare module Ext { static removeChildEls( testFn?:any ): void; /** [Method] Removes a CSS class from the top level element representing this component * @param cls String/String[] The CSS class name to remove. + * @returns Ext.Component Returns the Component to allow method chaining. */ - static removeCls( cls?:any ): any; - static removeCls( cls?:string ): Ext.IComponent; - static removeCls( cls?:string[] ): Ext.IComponent; + static removeCls( cls?:any ): Ext.IComponent; /** [Method] Removes a cls to the uiCls array which will also call removeUIClsFromElement and removes it from all elements of thi * @param cls String/String[] A string or an array of strings to remove to the uiCls. */ - static removeClsWithUI( cls?:any ): any; - static removeClsWithUI( cls?:string ): void; - static removeClsWithUI( cls?:string[] ): void; + static removeClsWithUI( cls?:any ): void; /** [Method] Removes the docked item from the panel * @param item Ext.Component The Component to remove. * @param autoDestroy Boolean Destroy the component after removal. @@ -29199,9 +31058,7 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] inherit docs * @param cls Object */ @@ -29210,15 +31067,10 @@ declare module Ext { * @param container Ext.Element/HTMLElement/String The element this Component should be rendered into. If it is being created from existing markup, this should be omitted. * @param position String/Number The element ID or DOM node index within the container before which this component will be inserted (defaults to appending to the end of the container) */ - static render( container?:any, position?:any ): any; - static render( container?:Ext.IElement, position?:string ): void; - static render( container?:HTMLElement, position?:string ): void; - static render( container?:string, position?:string ): void; - static render( container?:Ext.IElement, position?:number ): void; - static render( container?:HTMLElement, position?:number ): void; - static render( container?:string, position?:number ): void; + static render( container?:any, position?:any ): void; /** [Method] Restores a maximized window back to its original size and position prior to being maximized and also replaces the re * @param animate Object + * @returns Ext.window.Window this */ static restore( animate?:any ): Ext.window.IWindow; /** [Method] Resumes firing of the named event s @@ -29231,15 +31083,15 @@ declare module Ext { * @param propName String The name of the property to save. * @param state Object The state object in to which to save the property. * @param stateName String The name to use for the property in state. + * @returns Boolean True if the property was saved, false if not. */ static savePropToState( propName?:string, state?:any, stateName?:string ): boolean; /** [Method] Gathers additional named properties of the instance and adds their current values to the passed state object * @param propNames String/String[] The name (or array of names) of the property to save. * @param state Object The state object in to which to save the property values. + * @returns Object state */ static savePropsToState( propNames?:any, state?:any ): any; - static savePropsToState( propNames?:string, state?:any ): any; - static savePropsToState( propNames?:string[], state?:any ): any; /** [Method] Saves the state of the object to the persistence store */ static saveState(): void; /** [Method] Scrolls this Component s target element by the passed delta values optionally animating @@ -29248,7 +31100,9 @@ declare module Ext { * @param animate Boolean/Object Animate flag/config object if the delta values were passed separately. */ static scrollBy( deltaX?:any, deltaY?:any, animate?:any ): void; - /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence */ + /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence + * @returns Object this + */ static sequenceFx(): any; /** [Method] This method is called internally by Ext ZIndexManager to signal that a floating Component has either been moved to th * @param active Boolean True to activate the Component, false to deactivate it. @@ -29257,11 +31111,13 @@ declare module Ext { static setActive( active?:boolean, newActive?:Ext.IComponent ): void; /** [Method] Sets the overflow on the content element of the component * @param scroll Boolean True to allow the Component to auto scroll. + * @returns Ext.Component this */ static setAutoScroll( scroll?:boolean ): Ext.IComponent; /** [Method] Sets the body style according to the passed parameters * @param style Mixed A full style specification string, or object, or the name of a style property to set. * @param value String If the first param was a style property name, the style property value. + * @returns Ext.panel.Panel this */ static setBodyStyle( style?:any, value?:string ): Ext.panel.IPanel; /** [Method] @@ -29271,11 +31127,13 @@ declare module Ext { static setBorder( border?:any, targetEl?:any ): void; /** [Method] This method changes the region config property for this border region * @param region String The new region value ("north", "south", "east" or "west"). + * @returns String The previous value of the region property. */ static setBorderRegion( region?:string ): string; /** [Method] Sets the element s box * @param box Object The box to fill {x, y, width, height} * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ static setBox( box?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Enable or disable the component @@ -29285,22 +31143,23 @@ declare module Ext { /** [Method] Sets the dock position of this component in its parent panel * @param dock Object The dock position. * @param layoutParent Boolean true to re-layout parent. + * @returns Ext.Component this */ static setDocked( dock?:any, layoutParent?:boolean ): Ext.IComponent; /** [Method] Set the glyph for the panel s header * @param newGlyph Number/String The new glyph This parameter expects a format consistent with that of glyph */ - static setGlyph( newGlyph?:any ): any; - static setGlyph( newGlyph?:number ): void; - static setGlyph( newGlyph?:string ): void; + static setGlyph( newGlyph?:any ): void; /** [Method] Sets the height of the component * @param height Number The new height to set. This may be one of: A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS height style. undefined to leave the height unchanged. + * @returns Ext.Component this */ static setHeight( height?:number ): Ext.IComponent; /** [Method] Adds the specified icon to the dialog * @param icon String A CSS classname specifying the icon's background image url, or empty string to clear the icon * @param width Number The width of the icon. If not specified, the default is used * @param height Number The height of the icon. If not specified, the default is used + * @returns Ext.window.MessageBox this */ static setIcon( icon?:string, width?:number, height?:number ): Ext.window.IMessageBox; /** [Method] Set the iconCls for the panel s header @@ -29310,62 +31169,66 @@ declare module Ext { /** [Method] This method allows you to show or hide a LoadMask on top of this component * @param load Boolean/Object/String True to show the default LoadMask, a config object that will be passed to the LoadMask constructor, or a message String to show. False to hide the current LoadMask. * @param targetEl Boolean True to mask the targetEl of this Component instead of the this.el. For example, setting this to true on a Panel will cause only the body to be masked. + * @returns Ext.LoadMask The LoadMask instance that has just been shown. */ static setLoading( load?:any, targetEl?:boolean ): Ext.ILoadMask; /** [Method] Overridden in Ext rtl AbstractComponent * @param x Object + * @returns Ext.util.Positionable this */ static setLocalX( x?:any ): Ext.util.IPositionable; /** [Method] Overridden in Ext rtl AbstractComponent * @param x Object * @param y Object + * @returns Ext.util.Positionable this */ static setLocalXY( x?:any, y?:any ): Ext.util.IPositionable; /** [Method] Sets the local y coordinate of this element using CSS style * @param y Object + * @returns Ext.util.Positionable this */ static setLocalY( y?:any ): Ext.util.IPositionable; /** [Method] Sets the margin on the target element * @param margin Number/String The margin to set. See the margin config. */ - static setMargin( margin?:any ): any; - static setMargin( margin?:number ): void; - static setMargin( margin?:string ): void; + static setMargin( margin?:any ): void; /** [Method] Sets the overflow x y on the content element of the component * @param overflowX String The overflow-x value. * @param overflowY String The overflow-y value. + * @returns Ext.Component this */ static setOverflowXY( overflowX?:string, overflowY?:string ): Ext.IComponent; /** [Method] Sets the page XY position of the component * @param x Number/Number[] The new x position or an array of [x,y]. * @param y Number The new y position. * @param animate Boolean/Object True to animate the Component into its new position. You may also pass an animation configuration. + * @returns Ext.Component this */ - static setPagePosition( x?:any, y?:any, animate?:any ): any; - static setPagePosition( x?:number, y?:number, animate?:any ): Ext.IComponent; - static setPagePosition( x?:number[], y?:number, animate?:any ): Ext.IComponent; + static setPagePosition( x?:any, y?:number, animate?:any ): Ext.IComponent; /** [Method] Sets the left and top of the component * @param x Number/Number[]/Object The new left, an array of [x,y], or animation config object containing x and y properties. * @param y Number The new top. * @param animate Boolean/Object If true, the Component is animated into its new position. You may also pass an animation configuration. + * @returns Ext.Component this */ static setPosition( x?:any, y?:number, animate?:any ): Ext.IComponent; /** [Method] Sets the element s position and size to the specified region * @param region Ext.util.Region The region to fill * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ static setRegion( region?:Ext.util.IRegion, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the weight config property for this component * @param weight Number The new weight value. + * @returns Number The previous value of the weight property. */ static setRegionWeight( weight?:number ): number; /** [Method] Sets the width and height of this Component * @param width Number/String/Object The new width to set. This may be one of: A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS width style. A size object in the format {width: widthValue, height: heightValue}. undefined to leave the width unchanged. * @param height Number/String The new height to set (not required if a size object is passed as the first arg). This may be one of: A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS height style. Animation may not be used. undefined to leave the height unchanged. + * @returns Ext.Component this */ - static setSize( width?:any, height?:any ): any; - static setSize( width?:any, height?:number ): Ext.IComponent; - static setSize( width?:any, height?:string ): Ext.IComponent; + static setSize( width?:any, height?:any ): Ext.IComponent; /** [Method] Set a title for the panel s header * @param newTitle String */ @@ -29376,52 +31239,62 @@ declare module Ext { static setUI( ui?:any ): void; /** [Method] Convenience function to hide or show this component by Boolean * @param visible Boolean true to show, false to hide. + * @returns Ext.Component this */ static setVisible( visible?:boolean ): Ext.IComponent; /** [Method] Sets the width of the component * @param width Number The new width to setThis may be one of: A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels). A String used to set the CSS width style. + * @returns Ext.Component this */ static setWidth( width?:number ): Ext.IComponent; /** [Method] Sets the X position of the DOM element based on page coordinates * @param x Object * @param animate Object + * @returns Ext.util.Positionable this */ static setX( x?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the position of the DOM element in page coordinates * @param xy Object * @param animate Object + * @returns Ext.util.Positionable this */ static setXY( xy?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the Y position of the DOM element based on page coordinates * @param y Object * @param animate Object + * @returns Ext.util.Positionable this */ static setY( y?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Displays a new message box or reinitializes an existing message box based on the config options passed in * @param config Object The following config options are supported: + * @returns Ext.window.MessageBox this */ static show( config?:any ): Ext.window.IMessageBox; /** [Method] Displays component at specific xy position * @param x Number/Number[] The new x position or array of [x,y]. * @param y Number The new y position * @param animate Boolean/Object True to animate the Component into its new position. You may also pass an animation configuration. + * @returns Ext.Component this */ - static showAt( x?:any, y?:any, animate?:any ): any; - static showAt( x?:number, y?:number, animate?:any ): Ext.IComponent; - static showAt( x?:number[], y?:number, animate?:any ): Ext.IComponent; + static showAt( x?:any, y?:number, animate?:any ): Ext.IComponent; /** [Method] Shows this component by the specified Component or Element * @param component Ext.Component/Ext.dom.Element The Ext.Component or Ext.Element to show the component by. * @param position String Alignment position as used by Ext.util.Positionable.getAlignToXY. Defaults to defaultAlign. * @param offsets Number[] Alignment offsets as used by Ext.util.Positionable.getAlignToXY. + * @returns Ext.Component this + */ + static showBy( component?:any, position?:string, offsets?:number[] ): Ext.IComponent; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class */ - static showBy( component?:any, position?:any, offsets?:any ): any; - static showBy( component?:Ext.IComponent, position?:string, offsets?:number[] ): Ext.IComponent; - static showBy( component?:Ext.dom.IElement, position?:string, offsets?:number[] ): Ext.IComponent; - /** [Method] Get the reference to the class from which this object was instantiated */ static statics(): Ext.IClass; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ static stopAnimation(): Ext.IElement; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ static stopFx(): Ext.IElement; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. @@ -29431,25 +31304,33 @@ declare module Ext { * @param queueSuspended Boolean Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events. */ static suspendEvents( queueSuspended?:boolean ): void; - /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently */ + /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently + * @returns Object this + */ static syncFx(): any; - /** [Method] Sends this Component to the back of lower z index than any other visible windows */ + /** [Method] Sends this Component to the back of lower z index than any other visible windows + * @returns Ext.Component this + */ static toBack(): Ext.IComponent; /** [Method] Brings this floating Component to the front of any other visible floating Components managed by the same ZIndexManag * @param preventFocus Boolean Specify true to prevent the Component from being focused. + * @returns Ext.Component this */ static toFront( preventFocus?:boolean ): Ext.IComponent; - /** [Method] Shortcut for performing an expand or collapse based on the current state of the panel */ + /** [Method] Shortcut for performing an expand or collapse based on the current state of the panel + * @returns Ext.panel.Panel this + */ static toggleCollapse(): Ext.panel.IPanel; - /** [Method] A shortcut method for toggling between maximize and restore based on the current maximized state of the window */ + /** [Method] A shortcut method for toggling between maximize and restore based on the current maximized state of the window + * @returns Ext.window.Window this + */ static toggleMaximize(): Ext.window.IWindow; /** [Method] Translates the passed page coordinates into left top css values for the element * @param x Number/Array The page x or an array containing [x, y] * @param y Number The page y, required if x is not an array + * @returns Object An object with left and top properties. e.g. {left: (value), top: (value)} */ - static translatePoints( x?:any, y?:any ): any; - static translatePoints( x?:number, y?:number ): any; - static translatePoints( x?:any[], y?:number ): any; + static translatePoints( x?:any, y?:number ): any; /** [Method] Shorthand for removeListener * @param eventName String The type of event the handler was associated with. * @param fn Function The handler to remove. This must be a reference to the function passed into the Ext.util.Observable.addListener call. @@ -29459,14 +31340,9 @@ declare module Ext { /** [Method] Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed simple selector or * @param selector String/Ext.Component The simple selector component or actual component to test. If not passed the immediate owner/activater is returned. * @param limit String/Number/Ext.Component This may be a selector upon which to stop the upward scan, or a limit of teh number of steps, or Component reference to stop on. + * @returns Ext.container.Container The matching ancestor Container (or undefined if no match was found). */ - static up( selector?:any, limit?:any ): any; - static up( selector?:string, limit?:string ): Ext.container.IContainer; - static up( selector?:Ext.IComponent, limit?:string ): Ext.container.IContainer; - static up( selector?:string, limit?:number ): Ext.container.IContainer; - static up( selector?:Ext.IComponent, limit?:number ): Ext.container.IContainer; - static up( selector?:string, limit?:Ext.IComponent ): Ext.container.IContainer; - static up( selector?:Ext.IComponent, limit?:Ext.IComponent ): Ext.container.IContainer; + static up( selector?:any, limit?:any ): Ext.container.IContainer; /** [Method] Update the content area of a component * @param htmlOrData String/Object If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. If this component was not configured with a template, the components content area will be updated via Ext.Element update. * @param loadScripts Boolean Only legitimate when using the html configuration. @@ -29475,6 +31351,7 @@ declare module Ext { static update( htmlOrData?:any, loadScripts?:boolean, callback?:any ): void; /** [Method] Sets the current box measurements of the component s underlying element * @param box Object An object in the format {x, y, width, height} + * @returns Ext.Component this */ static updateBox( box?:any ): Ext.IComponent; /** [Method] Updates this component s layout @@ -29485,12 +31362,14 @@ declare module Ext { * @param value Number Any number between 0 and 1 (e.g., .5) * @param progressText String The progress text to display inside the progress bar. * @param msg String The message box's body text is replaced with the specified string (defaults to undefined so that any existing body text will not get overwritten by default unless a new value is passed in) + * @returns Ext.window.MessageBox this */ static updateProgress( value?:number, progressText?:string, msg?:string ): Ext.window.IMessageBox; /** [Method] Displays a message box with an infinitely auto updating progress bar * @param msg String The message box body text * @param title String The title bar text * @param config Object A Ext.ProgressBar.wait config object + * @returns Ext.window.MessageBox this */ static wait( msg?:string, title?:string, config?:any ): Ext.window.IMessageBox; } @@ -29501,19 +31380,19 @@ declare module Ext { export class ModelManager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a new instance of a Model using the given data * @param data Object Data to initialize the Model's fields with * @param name String The name of the model to create @@ -29527,24 +31406,31 @@ declare module Ext { static each( fn?:any, scope?:any ): void; /** [Method] Returns an item by id * @param id String The id of the item + * @returns Object The item, undefined if not found. */ static get( id?:string ): any; - /** [Method] Gets the number of items in the collection */ + /** [Method] Gets the number of items in the collection + * @returns Number The number of items in the collection. + */ static getCount(): number; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Returns the Ext data Model class for a given model name * @param id String/Object The classname of the model or the model class itself. + * @returns Ext.data.Model a model class. */ static getModel( id?:any ): Ext.data.IModel; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Checks if an item type is registered * @param type String The mnemonic string by which the class may be looked up + * @returns Boolean Whether the type is registered. */ static isRegistered( type?:string ): boolean; /** [Method] Registers a function that will be called when an item with the specified id is added to the manager @@ -29557,7 +31443,9 @@ declare module Ext { * @param item Object The item to register */ static register( item?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters an item by removing it from this manager * @param item Object The item to unregister @@ -29571,19 +31459,19 @@ declare module Ext { export class ModelMgr { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a new instance of a Model using the given data * @param data Object Data to initialize the Model's fields with * @param name String The name of the model to create @@ -29597,24 +31485,31 @@ declare module Ext { static each( fn?:any, scope?:any ): void; /** [Method] Returns an item by id * @param id String The id of the item + * @returns Object The item, undefined if not found. */ static get( id?:string ): any; - /** [Method] Gets the number of items in the collection */ + /** [Method] Gets the number of items in the collection + * @returns Number The number of items in the collection. + */ static getCount(): number; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Returns the Ext data Model class for a given model name * @param id String/Object The classname of the model or the model class itself. + * @returns Ext.data.Model a model class. */ static getModel( id?:any ): Ext.data.IModel; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Checks if an item type is registered * @param type String The mnemonic string by which the class may be looked up + * @returns Boolean Whether the type is registered. */ static isRegistered( type?:string ): boolean; /** [Method] Registers a function that will be called when an item with the specified id is added to the manager @@ -29627,7 +31522,9 @@ declare module Ext { * @param item Object The item to register */ static register( item?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters an item by removing it from this manager * @param item Object The item to unregister @@ -29643,20 +31540,24 @@ declare module Ext { * @param number Number The number to check * @param min Number The minimum number in the range * @param max Number The maximum number in the range + * @returns Number The constrained value if outside the range, otherwise the current value */ static constrain( number?:number, min?:number, max?:number ): number; /** [Method] Corrects floating point numbers that overflow to a non precise value because of their floating nature for example 0 * @param The Number number + * @returns Number The correctly rounded number */ static correctFloat( The?:number ): number; /** [Method] Validate that a value is numeric and convert it to a number if necessary * @param value Object * @param defaultValue Number The value to return if the original value is non-numeric + * @returns Number value, if numeric, defaultValue otherwise */ static from( value?:any, defaultValue?:number ): number; /** [Method] Returns a random integer between the specified range inclusive * @param from Number Lowest value to return. * @param to Number Highst value to return. + * @returns Number A random integer within the specified range. */ static randomInt( from?:number, to?:number ): number; /** [Method] Snaps the passed number between stopping points based upon a passed increment value @@ -29664,6 +31565,7 @@ declare module Ext { * @param increment Number The increment by which the value must move. * @param minValue Number The minimum value to which the returned value must be constrained. Overrides the increment. * @param maxValue Number The maximum value to which the returned value must be constrained. Overrides the increment. + * @returns Number The value of the nearest snap target. */ static snap( value?:number, increment?:number, minValue?:number, maxValue?:number ): number; /** [Method] Snaps the passed number between stopping points based upon a passed increment value @@ -29671,6 +31573,7 @@ declare module Ext { * @param increment Number The increment by which the value must move. * @param minValue Number The minimum value to which the returned value must be constrained. * @param maxValue Number The maximum value to which the returned value must be constrained. + * @returns Number The value of the nearest snap target. */ static snapInRange( value?:number, increment?:number, minValue?:number, maxValue?:number ): number; /** [Method] Formats a number using fixed point notation @@ -29697,11 +31600,13 @@ declare module Ext { /** [Method] Shallow compares the contents of 2 objects using strict equality * @param object1 Object * @param object2 Object + * @returns Boolean true if the objects are equal. */ static equals( object1?:any, object2?:any ): boolean; /** [Method] Converts a query string back into an object * @param queryString String The query string to decode * @param recursive Boolean Whether or not to recursively decode the string. This format is supported by PHP / Ruby on Rails servers and similar. + * @returns Object */ static fromQueryString( queryString?:string, recursive?:boolean ): any; /** [Method] Returns the first matching key corresponding to the given value @@ -29711,34 +31616,41 @@ declare module Ext { static getKey( object?:any, value?:any ): void; /** [Method] Gets all keys of the given object as an array * @param object Object + * @returns String[] An array of keys from the object */ static getKeys( object?:any ): string[]; /** [Method] Gets the total number of this object s own properties var size Ext Object getSize name Jacky loves * @param object Object + * @returns Number size */ static getSize( object?:any ): number; /** [Method] Gets all values of the given object as an array * @param object Object + * @returns Array An array of values from the object */ static getValues( object?:any ): any[]; /** [Method] Checks if there are any properties on this object * @param object Object + * @returns Boolean true if there no properties on the object. */ static isEmpty( object?:any ): boolean; /** [Method] Merges any number of objects recursively without referencing them or their children * @param destination Object The object into which all subsequent objects are merged. * @param object Object... Any number of objects to merge into the destination. + * @returns Object merged The destination object with all passed objects merged in. */ static merge( destination:any, ...object:any[] ): any; /** [Method] Converts a name value pair to an array of objects with support for nested structures * @param name String * @param value Object/Array * @param recursive Boolean True to traverse object recursively + * @returns Array */ static toQueryObjects( name?:string, value?:any, recursive?:boolean ): any[]; /** [Method] Takes an object and converts it to an encoded query string * @param object Object The object to encode * @param recursive Boolean Whether or not to interpret the object in recursive format. (PHP / Ruby on Rails servers and similar). + * @returns String queryString */ static toQueryString( object?:any, recursive?:boolean ): string; } @@ -29773,11 +31685,13 @@ declare module Ext.panel { isPanel?: boolean; /** [Method] Adds a CSS class to the body element * @param cls String The class to add + * @returns Ext.panel.Panel this */ addBodyCls?( cls?:string ): Ext.panel.IPanel; /** [Method] Adds docked item s to the container * @param component Object/Object[] The Component or array of components to add. The components must include a 'dock' parameter on each component to indicate where it should be docked ('top', 'right', 'bottom', 'left'). * @param pos Number The index at which the Component will be added + * @returns Ext.Component[] The added components. */ addDocked?( component?:any, pos?:number ): Ext.IComponent[]; /** [Method] inherit docs @@ -29786,19 +31700,18 @@ declare module Ext.panel { addUIClsToElement?( cls?:any ): void; /** [Method] Attempts a default component lookup see Ext container Container getComponent * @param comp String/Number The component id, itemId or position to find + * @returns Ext.Component The component (if found) */ - getComponent?( comp?:any ): any; - getComponent?( comp?:string ): Ext.IComponent; - getComponent?( comp?:number ): Ext.IComponent; + getComponent?( comp?:any ): Ext.IComponent; /** [Method] Finds a docked component by id itemId or position * @param comp String/Number The id, itemId or position of the docked component (see getComponent for details) + * @returns Ext.Component The docked component (if found) */ - getDockedComponent?( comp?:any ): any; - getDockedComponent?( comp?:string ): Ext.IComponent; - getDockedComponent?( comp?:number ): Ext.IComponent; + getDockedComponent?( comp?:any ): Ext.IComponent; /** [Method] Retrieves an array of all currently docked Components * @param selector String A ComponentQuery selector string to filter the returned items. * @param beforeBody Boolean An optional flag to limit the set of items to only those before the body (true) or after the body (false). All components are returned by default. + * @returns Ext.Component[] The array of docked components meeting the specified criteria. */ getDockedItems?( selector?:string, beforeBody?:boolean ): Ext.IComponent[]; /** [Method] Used by ComponentQuery child and down to retrieve all of the items which can potentially be considered a child of th @@ -29820,6 +31733,7 @@ declare module Ext.panel { onDockedRemove?( component?:Ext.IComponent ): void; /** [Method] Removes a CSS class from the body element * @param cls String The class to remove + * @returns Ext.panel.Panel this */ removeBodyCls?( cls?:string ): Ext.panel.IPanel; /** [Method] Removes the docked item from the panel @@ -29834,6 +31748,7 @@ declare module Ext.panel { /** [Method] Sets the body style according to the passed parameters * @param style Mixed A full style specification string, or object, or the name of a style property to set. * @param value String If the first param was a style property name, the style property value. + * @returns Ext.panel.Panel this */ setBodyStyle?( style?:any, value?:string ): Ext.panel.IPanel; } @@ -29853,6 +31768,7 @@ declare module Ext.panel { createFrame?(): void; /** [Method] Returns a reference to the actual element to drag * @param e Object + * @returns HTMLElement the html element */ getDragEl?( e?:any ): HTMLElement; } @@ -29893,7 +31809,9 @@ declare module Ext.panel { afterLayout?(): void; /** [Method] Occurs before componentLayout is run */ beforeLayout?(): void; - /** [Method] Gets the tools for this header */ + /** [Method] Gets the tools for this header + * @returns Ext.panel.Tool[] The tools + */ getTools?(): Ext.panel.ITool[]; /** [Method] Set up the tools lt tool type gt link in the owning Panel * @param component Object @@ -29907,9 +31825,7 @@ declare module Ext.panel { /** [Method] Sets glyph that provides the icon image for this header * @param glyph Number/String the numeric charCode or string charCode/font-family. This parameter expects a format consistent with that of glyph */ - setGlyph?( glyph?:any ): any; - setGlyph?( glyph?:number ): void; - setGlyph?( glyph?:string ): void; + setGlyph?( glyph?:any ): void; /** [Method] Sets the image path that provides the icon image for this header * @param icon String The new icon path */ @@ -30025,6 +31941,7 @@ declare module Ext.panel { /** [Method] Collapses the panel body so that the body becomes hidden * @param direction String The direction to collapse towards. Must be one of Ext.Component.DIRECTION_TOP Ext.Component.DIRECTION_RIGHT Ext.Component.DIRECTION_BOTTOM Ext.Component.DIRECTION_LEFT Defaults to collapseDirection. * @param animate Boolean True to animate the transition, else false (defaults to the value of the animCollapse panel config). May also be specified as the animation duration in milliseconds. + * @returns Ext.panel.Panel this */ collapse?( direction?:string, animate?:boolean ): Ext.panel.IPanel; /** [Method] converts a collapsdDir into an anchor argument for Element slideIn overridden in rtl mode to switch l and r @@ -30033,20 +31950,24 @@ declare module Ext.panel { convertCollapseDir?( collapseDir?:any ): void; /** [Method] Expands the panel body so that it becomes visible * @param animate Boolean True to animate the transition, else false (defaults to the value of the animCollapse panel config). May also be specified as the animation duration in milliseconds. + * @returns Ext.panel.Panel this */ expand?( animate?:boolean ): Ext.panel.IPanel; - /** [Method] Returns the current collapsed state of the panel */ - getCollapsed?(): boolean; - /** [Method] Returns the current collapsed state of the panel */ - getCollapsed?(): string; + /** [Method] Returns the current collapsed state of the panel + * @returns Boolean/String False when not collapsed, otherwise the value of collapseDirection. + */ + getCollapsed?(): any; /** [Method] Gets the Header for this panel */ getHeader?(): void; - /** [Method] The supplied default state gathering method for the AbstractComponent class */ + /** [Method] The supplied default state gathering method for the AbstractComponent class + * @returns Object + */ getState?(): any; /** [Method] Determines whether this Component is the root of a layout */ isLayoutRoot?(): void; /** [Method] Returns true if this component is visible * @param deep Object + * @returns Boolean true if this component is visible, false otherwise. */ isVisible?( deep?:any ): boolean; /** [Method] Possibly animates down to a target element */ @@ -30065,9 +31986,7 @@ declare module Ext.panel { /** [Method] Set the glyph for the panel s header * @param newGlyph Number/String The new glyph This parameter expects a format consistent with that of glyph */ - setGlyph?( newGlyph?:any ): any; - setGlyph?( newGlyph?:number ): void; - setGlyph?( newGlyph?:string ): void; + setGlyph?( newGlyph?:any ): void; /** [Method] Set the icon for the panel s header * @param newIcon String The new icon path */ @@ -30084,7 +32003,9 @@ declare module Ext.panel { * @param ui Object */ setUI?( ui?:any ): void; - /** [Method] Shortcut for performing an expand or collapse based on the current state of the panel */ + /** [Method] Shortcut for performing an expand or collapse based on the current state of the panel + * @returns Ext.panel.Panel this + */ toggleCollapse?(): Ext.panel.IPanel; } } @@ -30189,6 +32110,7 @@ declare module Ext { /** [Method] Collapses the panel body so that the body becomes hidden * @param direction String The direction to collapse towards. Must be one of Ext.Component.DIRECTION_TOP Ext.Component.DIRECTION_RIGHT Ext.Component.DIRECTION_BOTTOM Ext.Component.DIRECTION_LEFT Defaults to collapseDirection. * @param animate Boolean True to animate the transition, else false (defaults to the value of the animCollapse panel config). May also be specified as the animation duration in milliseconds. + * @returns Ext.panel.Panel this */ collapse?( direction?:string, animate?:boolean ): Ext.panel.IPanel; /** [Method] converts a collapsdDir into an anchor argument for Element slideIn overridden in rtl mode to switch l and r @@ -30197,20 +32119,24 @@ declare module Ext { convertCollapseDir?( collapseDir?:any ): void; /** [Method] Expands the panel body so that it becomes visible * @param animate Boolean True to animate the transition, else false (defaults to the value of the animCollapse panel config). May also be specified as the animation duration in milliseconds. + * @returns Ext.panel.Panel this */ expand?( animate?:boolean ): Ext.panel.IPanel; - /** [Method] Returns the current collapsed state of the panel */ - getCollapsed?(): boolean; - /** [Method] Returns the current collapsed state of the panel */ - getCollapsed?(): string; + /** [Method] Returns the current collapsed state of the panel + * @returns Boolean/String False when not collapsed, otherwise the value of collapseDirection. + */ + getCollapsed?(): any; /** [Method] Gets the Header for this panel */ getHeader?(): void; - /** [Method] The supplied default state gathering method for the AbstractComponent class */ + /** [Method] The supplied default state gathering method for the AbstractComponent class + * @returns Object + */ getState?(): any; /** [Method] Determines whether this Component is the root of a layout */ isLayoutRoot?(): void; /** [Method] Returns true if this component is visible * @param deep Object + * @returns Boolean true if this component is visible, false otherwise. */ isVisible?( deep?:any ): boolean; /** [Method] Possibly animates down to a target element */ @@ -30229,9 +32155,7 @@ declare module Ext { /** [Method] Set the glyph for the panel s header * @param newGlyph Number/String The new glyph This parameter expects a format consistent with that of glyph */ - setGlyph?( newGlyph?:any ): any; - setGlyph?( newGlyph?:number ): void; - setGlyph?( newGlyph?:string ): void; + setGlyph?( newGlyph?:any ): void; /** [Method] Set the icon for the panel s header * @param newIcon String The new icon path */ @@ -30248,7 +32172,9 @@ declare module Ext { * @param ui Object */ setUI?( ui?:any ): void; - /** [Method] Shortcut for performing an expand or collapse based on the current state of the panel */ + /** [Method] Shortcut for performing an expand or collapse based on the current state of the panel + * @returns Ext.panel.Panel this + */ toggleCollapse?(): Ext.panel.IPanel; } } @@ -30260,11 +32186,17 @@ declare module Ext.panel { moveOnDrag?: boolean; /** [Property] (Ext.panel.Panel) */ panel?: Ext.panel.IPanel; - /** [Method] Gets the proxy s element */ + /** [Method] Gets the proxy s element + * @returns Ext.Element The proxy's element + */ getEl?(): Ext.IElement; - /** [Method] Gets the proxy s ghost Panel */ + /** [Method] Gets the proxy s ghost Panel + * @returns Ext.panel.Panel The proxy's ghost Panel + */ getGhost?(): Ext.panel.IPanel; - /** [Method] Gets the proxy element */ + /** [Method] Gets the proxy element + * @returns Ext.Element The proxy's element + */ getProxy?(): Ext.IElement; /** [Method] Hides the proxy */ hide?(): void; @@ -30285,11 +32217,17 @@ declare module Ext.dd { moveOnDrag?: boolean; /** [Property] (Ext.panel.Panel) */ panel?: Ext.panel.IPanel; - /** [Method] Gets the proxy s element */ + /** [Method] Gets the proxy s element + * @returns Ext.Element The proxy's element + */ getEl?(): Ext.IElement; - /** [Method] Gets the proxy s ghost Panel */ + /** [Method] Gets the proxy s ghost Panel + * @returns Ext.panel.Panel The proxy's ghost Panel + */ getGhost?(): Ext.panel.IPanel; - /** [Method] Gets the proxy element */ + /** [Method] Gets the proxy element + * @returns Ext.Element The proxy's element + */ getProxy?(): Ext.IElement; /** [Method] Hides the proxy */ hide?(): void; @@ -30372,13 +32310,21 @@ declare module Ext.panel { applyState?( state?:any ): void; /** [Method] This method is obsolete in 4 1 */ determineScrollbars?(): void; - /** [Method] Returns the selection model being used and creates it via the configuration if it has not been created already */ + /** [Method] Returns the selection model being used and creates it via the configuration if it has not been created already + * @returns Ext.selection.Model selModel + */ getSelectionModel?(): Ext.selection.IModel; - /** [Method] The supplied default state gathering method for the AbstractComponent class */ + /** [Method] The supplied default state gathering method for the AbstractComponent class + * @returns Object + */ getState?(): any; - /** [Method] Returns the store associated with this Panel */ + /** [Method] Returns the store associated with this Panel + * @returns Ext.data.Store The store + */ getStore?(): Ext.data.IStore; - /** [Method] Gets the view for this panel */ + /** [Method] Gets the view for this panel + * @returns Ext.view.Table + */ getView?(): Ext.view.ITable; /** [Method] This method is obsolete in 4 1 */ invalidateScroller?(): void; @@ -30426,6 +32372,7 @@ declare module Ext.panel { onDestroy?(): void; /** [Method] Sets the type of the tool * @param type String The new type. See the type config. + * @returns Ext.panel.Tool this */ setType?( type?:string ): Ext.panel.ITool; } @@ -30440,28 +32387,32 @@ declare module Ext.perf { export class Monitor { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -30471,28 +32422,32 @@ declare module Ext { export class Perf { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -30520,7 +32475,9 @@ declare module Ext.picker { colors?: string[]; /** [Method] Clears any selection and sets the value to null */ clear?(): void; - /** [Method] Get the currently selected color value */ + /** [Method] Get the currently selected color value + * @returns String value The selected value. Null if nothing is selected. + */ getValue?(): string; /** [Method] Template method called when this Component s DOM structure is created */ onRender?(): void; @@ -30555,7 +32512,9 @@ declare module Ext { colors?: string[]; /** [Method] Clears any selection and sets the value to null */ clear?(): void; - /** [Method] Get the currently selected color value */ + /** [Method] Get the currently selected color value + * @returns String value The selected value. Null if nothing is selected. + */ getValue?(): string; /** [Method] Template method called when this Component s DOM structure is created */ onRender?(): void; @@ -30636,55 +32595,71 @@ declare module Ext.picker { todayTip?: string; /** [Method] Gets a single character to represent the day of the week * @param value Object + * @returns String The character */ getDayInitial?( value?:any ): string; - /** [Method] Gets the current selected value of the date field */ + /** [Method] Gets the current selected value of the date field + * @returns Date The selected date + */ getValue?(): any; /** [Method] Hides the month picker if it s visible * @param animate Boolean Indicates whether to animate this action. If the animate parameter is not specified, the behavior will use disableAnim to determine whether to animate or not. + * @returns Ext.picker.Date this */ hideMonthPicker?( animate?:boolean ): Ext.picker.IDate; /** [Method] private inherit docs */ initComponent?(): void; - /** [Method] Sets the current value to today */ + /** [Method] Sets the current value to today + * @returns Ext.picker.Date this + */ selectToday?(): Ext.picker.IDate; /** [Method] Replaces any existing disabled dates with new values and refreshes the DatePicker * @param disabledDates String[]/RegExp An array of date strings (see the disabledDates config for details on supported values), or a JavaScript regular expression used to disable a pattern of dates. + * @returns Ext.picker.Date this */ - setDisabledDates?( disabledDates?:any ): any; - setDisabledDates?( disabledDates?:string[] ): Ext.picker.IDate; - setDisabledDates?( disabledDates?:RegExp ): Ext.picker.IDate; + setDisabledDates?( disabledDates?:any ): Ext.picker.IDate; /** [Method] Replaces any existing disabled days by index 0 6 with new values and refreshes the DatePicker * @param disabledDays Number[] An array of disabled day indexes. See the disabledDays config for details on supported values. + * @returns Ext.picker.Date this */ setDisabledDays?( disabledDays?:number[] ): Ext.picker.IDate; /** [Method] Replaces any existing maxDate with the new value and refreshes the DatePicker * @param value Date The maximum date that can be selected + * @returns Ext.picker.Date this */ setMaxDate?( value?:any ): Ext.picker.IDate; /** [Method] Replaces any existing minDate with the new value and refreshes the DatePicker * @param value Date The minimum date that can be selected + * @returns Ext.picker.Date this */ setMinDate?( value?:any ): Ext.picker.IDate; /** [Method] Sets the value of the date field * @param value Date The date to set + * @returns Ext.picker.Date this */ setValue?( value?:any ): Ext.picker.IDate; /** [Method] Show the month picker * @param animate Boolean Indicates whether to animate this action. If the animate parameter is not specified, the behavior will use disableAnim to determine whether to animate or not. + * @returns Ext.picker.Date this */ showMonthPicker?( animate?:boolean ): Ext.picker.IDate; /** [Method] Show the next month * @param e Object + * @returns Ext.picker.Date this */ showNextMonth?( e?:any ): Ext.picker.IDate; - /** [Method] Show the next year */ + /** [Method] Show the next year + * @returns Ext.picker.Date this + */ showNextYear?(): Ext.picker.IDate; /** [Method] Show the previous month * @param e Object + * @returns Ext.picker.Date this */ showPrevMonth?( e?:any ): Ext.picker.IDate; - /** [Method] Show the previous year */ + /** [Method] Show the previous year + * @returns Ext.picker.Date this + */ showPrevYear?(): Ext.picker.IDate; } } @@ -30758,55 +32733,71 @@ declare module Ext { todayTip?: string; /** [Method] Gets a single character to represent the day of the week * @param value Object + * @returns String The character */ getDayInitial?( value?:any ): string; - /** [Method] Gets the current selected value of the date field */ + /** [Method] Gets the current selected value of the date field + * @returns Date The selected date + */ getValue?(): any; /** [Method] Hides the month picker if it s visible * @param animate Boolean Indicates whether to animate this action. If the animate parameter is not specified, the behavior will use disableAnim to determine whether to animate or not. + * @returns Ext.picker.Date this */ hideMonthPicker?( animate?:boolean ): Ext.picker.IDate; /** [Method] private inherit docs */ initComponent?(): void; - /** [Method] Sets the current value to today */ + /** [Method] Sets the current value to today + * @returns Ext.picker.Date this + */ selectToday?(): Ext.picker.IDate; /** [Method] Replaces any existing disabled dates with new values and refreshes the DatePicker * @param disabledDates String[]/RegExp An array of date strings (see the disabledDates config for details on supported values), or a JavaScript regular expression used to disable a pattern of dates. + * @returns Ext.picker.Date this */ - setDisabledDates?( disabledDates?:any ): any; - setDisabledDates?( disabledDates?:string[] ): Ext.picker.IDate; - setDisabledDates?( disabledDates?:RegExp ): Ext.picker.IDate; + setDisabledDates?( disabledDates?:any ): Ext.picker.IDate; /** [Method] Replaces any existing disabled days by index 0 6 with new values and refreshes the DatePicker * @param disabledDays Number[] An array of disabled day indexes. See the disabledDays config for details on supported values. + * @returns Ext.picker.Date this */ setDisabledDays?( disabledDays?:number[] ): Ext.picker.IDate; /** [Method] Replaces any existing maxDate with the new value and refreshes the DatePicker * @param value Date The maximum date that can be selected + * @returns Ext.picker.Date this */ setMaxDate?( value?:any ): Ext.picker.IDate; /** [Method] Replaces any existing minDate with the new value and refreshes the DatePicker * @param value Date The minimum date that can be selected + * @returns Ext.picker.Date this */ setMinDate?( value?:any ): Ext.picker.IDate; /** [Method] Sets the value of the date field * @param value Date The date to set + * @returns Ext.picker.Date this */ setValue?( value?:any ): Ext.picker.IDate; /** [Method] Show the month picker * @param animate Boolean Indicates whether to animate this action. If the animate parameter is not specified, the behavior will use disableAnim to determine whether to animate or not. + * @returns Ext.picker.Date this */ showMonthPicker?( animate?:boolean ): Ext.picker.IDate; /** [Method] Show the next month * @param e Object + * @returns Ext.picker.Date this */ showNextMonth?( e?:any ): Ext.picker.IDate; - /** [Method] Show the next year */ + /** [Method] Show the next year + * @returns Ext.picker.Date this + */ showNextYear?(): Ext.picker.IDate; /** [Method] Show the previous month * @param e Object + * @returns Ext.picker.Date this */ showPrevMonth?( e?:any ): Ext.picker.IDate; - /** [Method] Show the previous year */ + /** [Method] Show the previous year + * @returns Ext.picker.Date this + */ showPrevYear?(): Ext.picker.IDate; } } @@ -30830,17 +32821,21 @@ declare module Ext.picker { * @param offset Number The offset to move by. */ adjustYear?( offset?:number ): void; - /** [Method] Gets the selected value */ + /** [Method] Gets the selected value + * @returns Number[] The selected value + */ getValue?(): number[]; - /** [Method] Checks whether the picker has a selection */ + /** [Method] Checks whether the picker has a selection + * @returns Boolean Returns true if both a month and year have been selected + */ hasSelection?(): boolean; /** [Method] Allows addition of behavior to the destroy operation */ onDestroy?(): void; /** [Method] Set the value for the picker * @param value Date/Number[] The value to set. It can be a Date object, where the month/year will be extracted, or it can be an array, with the month as the first index and the year as the second. + * @returns Ext.picker.Month this */ - setValue?( value?:any ): any; - setValue?( value?:number[] ): Ext.picker.IMonth; + setValue?( value?:any ): Ext.picker.IMonth; } } declare module Ext { @@ -30863,17 +32858,21 @@ declare module Ext { * @param offset Number The offset to move by. */ adjustYear?( offset?:number ): void; - /** [Method] Gets the selected value */ + /** [Method] Gets the selected value + * @returns Number[] The selected value + */ getValue?(): number[]; - /** [Method] Checks whether the picker has a selection */ + /** [Method] Checks whether the picker has a selection + * @returns Boolean Returns true if both a month and year have been selected + */ hasSelection?(): boolean; /** [Method] Allows addition of behavior to the destroy operation */ onDestroy?(): void; /** [Method] Set the value for the picker * @param value Date/Number[] The value to set. It can be a Date object, where the month/year will be extracted, or it can be an array, with the month as the first index and the year as the second. + * @returns Ext.picker.Month this */ - setValue?( value?:any ): any; - setValue?( value?:number[] ): Ext.picker.IMonth; + setValue?( value?:any ): Ext.picker.IMonth; } } declare module Ext.picker { @@ -30912,22 +32911,23 @@ declare module Ext { export class PluginManager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a new Plugin from the specified config object using the config object s ptype to determine the class to insta * @param config Object A configuration object for the Plugin you wish to create. * @param defaultType Function The constructor to provide the default Plugin type if the config object does not contain a ptype. (Optional if the config contains a ptype). + * @returns Ext.Component The newly instantiated Plugin. */ static create( config?:any, defaultType?:any ): Ext.IComponent; /** [Method] Executes the specified function once for each item in the collection @@ -30938,24 +32938,31 @@ declare module Ext { /** [Method] Returns all plugins registered with the given type * @param type String The type to search for * @param defaultsOnly Boolean True to only return plugins of this type where the plugin's isDefault property is truthy + * @returns Ext.AbstractPlugin[] All matching plugins */ static findByType( type?:string, defaultsOnly?:boolean ): Ext.IAbstractPlugin[]; /** [Method] Returns an item by id * @param id String The id of the item + * @returns Object The item, undefined if not found. */ static get( id?:string ): any; - /** [Method] Gets the number of items in the collection */ + /** [Method] Gets the number of items in the collection + * @returns Number The number of items in the collection. + */ static getCount(): number; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Checks if an item type is registered * @param type String The mnemonic string by which the class may be looked up + * @returns Boolean Whether the type is registered. */ static isRegistered( type?:string ): boolean; /** [Method] Registers a function that will be called when an item with the specified id is added to the manager @@ -30973,7 +32980,9 @@ declare module Ext { * @param cls Function The new instance class. */ static registerType( type?:string, cls?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters an item by removing it from this manager * @param item Object The item to unregister @@ -30987,22 +32996,23 @@ declare module Ext { export class PluginMgr { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a new Plugin from the specified config object using the config object s ptype to determine the class to insta * @param config Object A configuration object for the Plugin you wish to create. * @param defaultType Function The constructor to provide the default Plugin type if the config object does not contain a ptype. (Optional if the config contains a ptype). + * @returns Ext.Component The newly instantiated Plugin. */ static create( config?:any, defaultType?:any ): Ext.IComponent; /** [Method] Executes the specified function once for each item in the collection @@ -31013,24 +33023,31 @@ declare module Ext { /** [Method] Returns all plugins registered with the given type * @param type String The type to search for * @param defaultsOnly Boolean True to only return plugins of this type where the plugin's isDefault property is truthy + * @returns Ext.AbstractPlugin[] All matching plugins */ static findByType( type?:string, defaultsOnly?:boolean ): Ext.IAbstractPlugin[]; /** [Method] Returns an item by id * @param id String The id of the item + * @returns Object The item, undefined if not found. */ static get( id?:string ): any; - /** [Method] Gets the number of items in the collection */ + /** [Method] Gets the number of items in the collection + * @returns Number The number of items in the collection. + */ static getCount(): number; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Checks if an item type is registered * @param type String The mnemonic string by which the class may be looked up + * @returns Boolean Whether the type is registered. */ static isRegistered( type?:string ): boolean; /** [Method] Registers a function that will be called when an item with the specified id is added to the manager @@ -31048,7 +33065,9 @@ declare module Ext { * @param cls Function The new instance class. */ static registerType( type?:string, cls?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters an item by removing it from this manager * @param item Object The item to unregister @@ -31076,9 +33095,13 @@ declare module Ext { value?: number; /** [Method] private */ initComponent?(): void; - /** [Method] Initialized the renderData to be used when rendering the renderTpl */ + /** [Method] Initialized the renderData to be used when rendering the renderTpl + * @returns Object Object with keys and values that are going to be applied to the renderTpl + */ initRenderData?(): any; - /** [Method] Returns true if the progress bar is currently in a wait operation */ + /** [Method] Returns true if the progress bar is currently in a wait operation + * @returns Boolean True if waiting, else false + */ isWaiting?(): boolean; /** [Method] Allows addition of behavior to the destroy operation */ onDestroy?(): void; @@ -31086,20 +33109,24 @@ declare module Ext { onRender?(): void; /** [Method] Resets the progress bar value to 0 and text to empty string * @param hide Boolean True to hide the progress bar. + * @returns Ext.ProgressBar this */ reset?( hide?:boolean ): Ext.IProgressBar; /** [Method] Updates the progress bar value and optionally its text * @param value Number A floating point value between 0 and 1 (e.g., .5) * @param text String The string to display in the progress text element * @param animate Boolean Whether to animate the transition of the progress bar. If this value is not specified, the default for the class is used + * @returns Ext.ProgressBar this */ updateProgress?( value?:number, text?:string, animate?:boolean ): Ext.IProgressBar; /** [Method] Updates the progress bar text * @param text String The string to display in the progress text element + * @returns Ext.ProgressBar this */ updateText?( text?:string ): Ext.IProgressBar; /** [Method] Initiates an auto updating progress bar * @param config Object Configuration options + * @returns Ext.ProgressBar this */ wait?( config?:any ): Ext.IProgressBar; } @@ -31108,27 +33135,28 @@ declare module Ext { export interface IQueryable extends Ext.IBase { /** [Method] Retrieves the first direct child of this container which matches the passed selector or component * @param selector String/Ext.Component An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching child Ext.Component (or null if no match was found). */ child?( selector?:any ): any; - child?( selector?:string ): any; - child?( selector?:Ext.IComponent ): any; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String/Ext.Component An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching descendant Ext.Component (or null if no match was found). */ down?( selector?:any ): any; - down?( selector?:string ): any; - down?( selector?:Ext.IComponent ): any; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned. + * @returns Ext.Component[] Components which matched the selector */ query?( selector?:string ): Ext.IComponent[]; /** [Method] Retrieves all descendant components which match the passed function * @param fn Function The matcher function. It will be called with a single argument, the component being tested. * @param scope Object The scope in which to run the function. If not specified, it will default to the active component. + * @returns Ext.Component[] Components matched by the passed function */ queryBy?( fn?:any, scope?:any ): Ext.IComponent[]; /** [Method] Finds a component at any level under this container matching the id itemId * @param id String The id to find + * @returns Ext.Component The matching id, null if not found */ queryById?( id?:string ): Ext.IComponent; } @@ -31202,6 +33230,7 @@ declare module Ext.resizer { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -31210,10 +33239,9 @@ declare module Ext.resizer { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -31221,27 +33249,30 @@ declare module Ext.resizer { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the element that was configured with the el or target config property */ + /** [Method] Returns the element that was configured with the el or target config property + * @returns Ext.Element element + */ getEl?(): Ext.IElement; - /** [Method] Returns the element or component that was configured with the target config property */ - getTarget?(): Ext.IElement; - /** [Method] Returns the element or component that was configured with the target config property */ - getTarget?(): Ext.IComponent; + /** [Method] Returns the element or component that was configured with the target config property + * @returns Ext.Element/Ext.Component + */ + getTarget?(): any; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -31250,30 +33281,29 @@ declare module Ext.resizer { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -31288,9 +33318,7 @@ declare module Ext.resizer { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Perform a manual resize and fires the resize event * @param width Number * @param height Number @@ -31365,6 +33393,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -31373,10 +33402,9 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -31384,27 +33412,30 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the element that was configured with the el or target config property */ + /** [Method] Returns the element that was configured with the el or target config property + * @returns Ext.Element element + */ getEl?(): Ext.IElement; - /** [Method] Returns the element or component that was configured with the target config property */ - getTarget?(): Ext.IElement; - /** [Method] Returns the element or component that was configured with the target config property */ - getTarget?(): Ext.IComponent; + /** [Method] Returns the element or component that was configured with the target config property + * @returns Ext.Element/Ext.Component + */ + getTarget?(): any; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -31413,30 +33444,29 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -31451,9 +33481,7 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Perform a manual resize and fires the resize event * @param width Number * @param height Number @@ -31487,10 +33515,9 @@ declare module Ext.resizer { constrainTo?: any; /** [Method] Create a proxy for this resizer * @param target Ext.Component/Ext.Element The target + * @returns Ext.Element A proxy element */ - createProxy?( target?:any ): any; - createProxy?( target?:Ext.IComponent ): Ext.IElement; - createProxy?( target?:Ext.IElement ): Ext.IElement; + createProxy?( target?:any ): Ext.IElement; /** [Method] Template method which should be overridden by each DragTracker instance * @param e Object */ @@ -31539,7 +33566,9 @@ declare module Ext.resizer { getTrackerConfig?(): void; /** [Method] Template method called when this Component s DOM structure is created */ onRender?(): void; - /** [Method] Work around IE bug */ + /** [Method] Work around IE bug + * @returns Ext.Component this + */ setSize?(): Ext.IComponent; } } @@ -31654,9 +33683,7 @@ declare module Ext.selection { * @param records Ext.data.Model[]/Number An array of records or an index * @param suppressEvent Boolean True to not fire a deselect event */ - deselect?( records?:any, suppressEvent?:any ): any; - deselect?( records?:Ext.data.IModel[], suppressEvent?:boolean ): void; - deselect?( records?:number, suppressEvent?:boolean ): void; + deselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Deselects all records in the view * @param suppressEvent Boolean True to suppress any deselect events */ @@ -31665,46 +33692,54 @@ declare module Ext.selection { * @param startRow Ext.data.Model/Number The record or index of the first row in the range * @param endRow Ext.data.Model/Number The record or index of the last row in the range */ - deselectRange?( startRow?:any, endRow?:any ): any; - deselectRange?( startRow?:Ext.data.IModel, endRow?:Ext.data.IModel ): void; - deselectRange?( startRow?:number, endRow?:Ext.data.IModel ): void; - deselectRange?( startRow?:Ext.data.IModel, endRow?:number ): void; - deselectRange?( startRow?:number, endRow?:number ): void; - /** [Method] Returns the count of selected records */ + deselectRange?( startRow?:any, endRow?:any ): void; + /** [Method] Returns the count of selected records + * @returns Number The number of selected records + */ getCount?(): number; - /** [Method] */ + /** [Method] + * @returns Ext.data.Model Returns the last selected record. + */ getLastSelected?(): Ext.data.IModel; - /** [Method] Returns an array of the currently selected records */ + /** [Method] Returns an array of the currently selected records + * @returns Ext.data.Model[] The selected records + */ getSelection?(): Ext.data.IModel[]; - /** [Method] Returns the current selectionMode */ + /** [Method] Returns the current selectionMode + * @returns String The selectionMode: 'SINGLE', 'MULTI' or 'SIMPLE'. + */ getSelectionMode?(): string; - /** [Method] Gets the current store instance */ + /** [Method] Gets the current store instance + * @returns Ext.data.AbstractStore The store, null if one does not exist. + */ getStore?(): Ext.data.IAbstractStore; - /** [Method] Gets the listeners to bind to a new store */ + /** [Method] Gets the listeners to bind to a new store + * @returns Object The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance. + */ getStoreListeners?(): any; - /** [Method] Returns true if there are any a selected records */ + /** [Method] Returns true if there are any a selected records + * @returns Boolean + */ hasSelection?(): boolean; /** [Method] Determines if this record is currently focused * @param record Ext.data.Model */ isFocused?( record?:Ext.data.IModel ): void; - /** [Method] Returns true if the selections are locked */ + /** [Method] Returns true if the selections are locked + * @returns Boolean + */ isLocked?(): boolean; /** [Method] Returns true if the specified row is selected * @param from Ext.data.Model/Number The start of the range to check. * @param to Ext.data.Model/Number The end of the range to check. + * @returns Boolean */ - isRangeSelected?( from?:any, to?:any ): any; - isRangeSelected?( from?:Ext.data.IModel, to?:Ext.data.IModel ): boolean; - isRangeSelected?( from?:number, to?:Ext.data.IModel ): boolean; - isRangeSelected?( from?:Ext.data.IModel, to?:number ): boolean; - isRangeSelected?( from?:number, to?:number ): boolean; + isRangeSelected?( from?:any, to?:any ): boolean; /** [Method] Returns true if the specified row is selected * @param record Ext.data.Model/Number The record or index of the record to check + * @returns Boolean */ - isSelected?( record?:any ): any; - isSelected?( record?:Ext.data.IModel ): boolean; - isSelected?( record?:number ): boolean; + isSelected?( record?:any ): boolean; /** [Method] Template method it is called when a new store is bound to the current instance * @param store Ext.data.AbstractStore The store being bound * @param initial Boolean True if this store is being bound as initialization of the instance. @@ -31720,9 +33755,7 @@ declare module Ext.selection { * @param keepExisting Boolean True to retain existing selections * @param suppressEvent Boolean True to not fire a select event */ - select?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - select?( records?:Ext.data.IModel[], keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; + select?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; /** [Method] Selects all records in the view * @param suppressEvent Boolean True to suppress any select events */ @@ -31732,11 +33765,7 @@ declare module Ext.selection { * @param endRow Ext.data.Model/Number The record or index of the last row in the range * @param keepExisting Boolean True to retain existing selections */ - selectRange?( startRow?:any, endRow?:any, keepExisting?:any ): any; - selectRange?( startRow?:Ext.data.IModel, endRow?:Ext.data.IModel, keepExisting?:boolean ): void; - selectRange?( startRow?:number, endRow?:Ext.data.IModel, keepExisting?:boolean ): void; - selectRange?( startRow?:Ext.data.IModel, endRow?:number, keepExisting?:boolean ): void; - selectRange?( startRow?:number, endRow?:number, keepExisting?:boolean ): void; + selectRange?( startRow?:any, endRow?:any, keepExisting?:boolean ): void; /** [Method] Sets a record as the last focused record * @param record Ext.data.Model */ @@ -31780,9 +33809,7 @@ declare module Ext { * @param records Ext.data.Model[]/Number An array of records or an index * @param suppressEvent Boolean True to not fire a deselect event */ - deselect?( records?:any, suppressEvent?:any ): any; - deselect?( records?:Ext.data.IModel[], suppressEvent?:boolean ): void; - deselect?( records?:number, suppressEvent?:boolean ): void; + deselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Deselects all records in the view * @param suppressEvent Boolean True to suppress any deselect events */ @@ -31791,46 +33818,54 @@ declare module Ext { * @param startRow Ext.data.Model/Number The record or index of the first row in the range * @param endRow Ext.data.Model/Number The record or index of the last row in the range */ - deselectRange?( startRow?:any, endRow?:any ): any; - deselectRange?( startRow?:Ext.data.IModel, endRow?:Ext.data.IModel ): void; - deselectRange?( startRow?:number, endRow?:Ext.data.IModel ): void; - deselectRange?( startRow?:Ext.data.IModel, endRow?:number ): void; - deselectRange?( startRow?:number, endRow?:number ): void; - /** [Method] Returns the count of selected records */ + deselectRange?( startRow?:any, endRow?:any ): void; + /** [Method] Returns the count of selected records + * @returns Number The number of selected records + */ getCount?(): number; - /** [Method] */ + /** [Method] + * @returns Ext.data.Model Returns the last selected record. + */ getLastSelected?(): Ext.data.IModel; - /** [Method] Returns an array of the currently selected records */ + /** [Method] Returns an array of the currently selected records + * @returns Ext.data.Model[] The selected records + */ getSelection?(): Ext.data.IModel[]; - /** [Method] Returns the current selectionMode */ + /** [Method] Returns the current selectionMode + * @returns String The selectionMode: 'SINGLE', 'MULTI' or 'SIMPLE'. + */ getSelectionMode?(): string; - /** [Method] Gets the current store instance */ + /** [Method] Gets the current store instance + * @returns Ext.data.AbstractStore The store, null if one does not exist. + */ getStore?(): Ext.data.IAbstractStore; - /** [Method] Gets the listeners to bind to a new store */ + /** [Method] Gets the listeners to bind to a new store + * @returns Object The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance. + */ getStoreListeners?(): any; - /** [Method] Returns true if there are any a selected records */ + /** [Method] Returns true if there are any a selected records + * @returns Boolean + */ hasSelection?(): boolean; /** [Method] Determines if this record is currently focused * @param record Ext.data.Model */ isFocused?( record?:Ext.data.IModel ): void; - /** [Method] Returns true if the selections are locked */ + /** [Method] Returns true if the selections are locked + * @returns Boolean + */ isLocked?(): boolean; /** [Method] Returns true if the specified row is selected * @param from Ext.data.Model/Number The start of the range to check. * @param to Ext.data.Model/Number The end of the range to check. + * @returns Boolean */ - isRangeSelected?( from?:any, to?:any ): any; - isRangeSelected?( from?:Ext.data.IModel, to?:Ext.data.IModel ): boolean; - isRangeSelected?( from?:number, to?:Ext.data.IModel ): boolean; - isRangeSelected?( from?:Ext.data.IModel, to?:number ): boolean; - isRangeSelected?( from?:number, to?:number ): boolean; + isRangeSelected?( from?:any, to?:any ): boolean; /** [Method] Returns true if the specified row is selected * @param record Ext.data.Model/Number The record or index of the record to check + * @returns Boolean */ - isSelected?( record?:any ): any; - isSelected?( record?:Ext.data.IModel ): boolean; - isSelected?( record?:number ): boolean; + isSelected?( record?:any ): boolean; /** [Method] Template method it is called when a new store is bound to the current instance * @param store Ext.data.AbstractStore The store being bound * @param initial Boolean True if this store is being bound as initialization of the instance. @@ -31846,9 +33881,7 @@ declare module Ext { * @param keepExisting Boolean True to retain existing selections * @param suppressEvent Boolean True to not fire a select event */ - select?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - select?( records?:Ext.data.IModel[], keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; + select?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; /** [Method] Selects all records in the view * @param suppressEvent Boolean True to suppress any select events */ @@ -31858,11 +33891,7 @@ declare module Ext { * @param endRow Ext.data.Model/Number The record or index of the last row in the range * @param keepExisting Boolean True to retain existing selections */ - selectRange?( startRow?:any, endRow?:any, keepExisting?:any ): any; - selectRange?( startRow?:Ext.data.IModel, endRow?:Ext.data.IModel, keepExisting?:boolean ): void; - selectRange?( startRow?:number, endRow?:Ext.data.IModel, keepExisting?:boolean ): void; - selectRange?( startRow?:Ext.data.IModel, endRow?:number, keepExisting?:boolean ): void; - selectRange?( startRow?:number, endRow?:number, keepExisting?:boolean ): void; + selectRange?( startRow?:any, endRow?:any, keepExisting?:boolean ): void; /** [Method] Sets a record as the last focused record * @param record Ext.data.Model */ @@ -31892,11 +33921,13 @@ declare module Ext.selection { /** [Method] Selects the record immediately following the currently selected record * @param keepExisting Boolean True to retain existing selections * @param suppressEvent Boolean Set to false to not fire a select event + * @returns Boolean true if there is a next record, else false */ selectNext?( keepExisting?:boolean, suppressEvent?:boolean ): boolean; /** [Method] Selects the record that precedes the currently selected record * @param keepExisting Boolean True to retain existing selections * @param suppressEvent Boolean Set to false to not fire a select event + * @returns Boolean true if there is a previous record, else false */ selectPrevious?( keepExisting?:boolean, suppressEvent?:boolean ): boolean; } @@ -31938,10 +33969,7 @@ declare module Ext { /** [Method] Displays the shadow under the target element * @param targetEl String/HTMLElement/Ext.Element The id or element under which the shadow should display */ - show?( targetEl?:any ): any; - show?( targetEl?:string ): void; - show?( targetEl?:HTMLElement ): void; - show?( targetEl?:Ext.IElement ): void; + show?( targetEl?:any ): void; } } declare module Ext { @@ -31950,28 +33978,32 @@ declare module Ext { export class ShadowPool { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -32013,19 +34045,27 @@ declare module Ext.slider { thumbs?: any[]; /** [Method] Creates a new thumb and adds it to the slider * @param value Number The initial value to set on the thumb. + * @returns any The thumb */ addThumb?( value?:number ): any; /** [Method] private */ beforeDestroy?(): void; - /** [Method] private override */ + /** [Method] private override + * @returns any The template data + */ getSubTplData?(): any; - /** [Method] Returns the value that would be included in a standard form submit for this field */ + /** [Method] Returns the value that would be included in a standard form submit for this field + * @returns any The value to be submitted, or null. + */ getSubmitValue?(): any; /** [Method] Returns the current value of the slider * @param index Number The index of the thumb to return a value for + * @returns any The current value of the slider at the given index, or an array of all thumb values if no index is given. */ getValue?( index?:number ): any; - /** [Method] Returns an array of values one for the location of each thumb */ + /** [Method] Returns an array of values one for the location of each thumb + * @returns any The set of thumb values + */ getValues?(): any; /** [Method] private override */ initComponent?(): void; @@ -32055,10 +34095,9 @@ declare module Ext.slider { * @param index Number/Number[] Index of the thumb to move. Alternatively, it can be an array of values to set for each thumb in the slider. * @param value Number The value to set the slider to. (This will be constrained within minValue and maxValue) * @param animate Boolean Turn on or off animation + * @returns any this */ - setValue?( index?:any, value?:any, animate?:any ): any; - setValue?( index?:number, value?:number, animate?:boolean ): any; - setValue?( index?:number[], value?:number, animate?:boolean ): any; + setValue?( index?:any, value?:number, animate?:boolean ): any; /** [Method] Synchronizes thumbs position to the proper proportion of the total component width based on the current slider value */ syncThumbs?(): void; } @@ -32101,19 +34140,27 @@ declare module Ext.slider { thumbs?: any[]; /** [Method] Creates a new thumb and adds it to the slider * @param value Number The initial value to set on the thumb. + * @returns any The thumb */ addThumb?( value?:number ): any; /** [Method] private */ beforeDestroy?(): void; - /** [Method] private override */ + /** [Method] private override + * @returns any The template data + */ getSubTplData?(): any; - /** [Method] Returns the value that would be included in a standard form submit for this field */ + /** [Method] Returns the value that would be included in a standard form submit for this field + * @returns any The value to be submitted, or null. + */ getSubmitValue?(): any; /** [Method] Returns the current value of the slider * @param index Number The index of the thumb to return a value for + * @returns any The current value of the slider at the given index, or an array of all thumb values if no index is given. */ getValue?( index?:number ): any; - /** [Method] Returns an array of values one for the location of each thumb */ + /** [Method] Returns an array of values one for the location of each thumb + * @returns any The set of thumb values + */ getValues?(): any; /** [Method] private override */ initComponent?(): void; @@ -32143,17 +34190,18 @@ declare module Ext.slider { * @param index Number/Number[] Index of the thumb to move. Alternatively, it can be an array of values to set for each thumb in the slider. * @param value Number The value to set the slider to. (This will be constrained within minValue and maxValue) * @param animate Boolean Turn on or off animation + * @returns any this */ - setValue?( index?:any, value?:any, animate?:any ): any; - setValue?( index?:number, value?:number, animate?:boolean ): any; - setValue?( index?:number[], value?:number, animate?:boolean ): any; + setValue?( index?:any, value?:number, animate?:boolean ): any; /** [Method] Synchronizes thumbs position to the proper proportion of the total component width based on the current slider value */ syncThumbs?(): void; } } declare module Ext.slider { export interface ISingle extends Ext.slider.IMulti { - /** [Method] Returns the current value of the slider */ + /** [Method] Returns the current value of the slider + * @returns any The current value of the slider + */ getValue?(): any; /** [Method] Programmatically sets the value of the Slider * @param value Number The value to set the slider to. (This will be constrained within minValue and maxValue) @@ -32164,7 +34212,9 @@ declare module Ext.slider { } declare module Ext { export interface ISlider extends Ext.slider.IMulti { - /** [Method] Returns the current value of the slider */ + /** [Method] Returns the current value of the slider + * @returns any The current value of the slider + */ getValue?(): any; /** [Method] Programmatically sets the value of the Slider * @param value Number The value to set the slider to. (This will be constrained within minValue and maxValue) @@ -32175,7 +34225,9 @@ declare module Ext { } declare module Ext.form { export interface ISliderField extends Ext.slider.IMulti { - /** [Method] Returns the current value of the slider */ + /** [Method] Returns the current value of the slider + * @returns any The current value of the slider + */ getValue?(): any; /** [Method] Programmatically sets the value of the Slider * @param value Number The value to set the slider to. (This will be constrained within minValue and maxValue) @@ -32186,7 +34238,9 @@ declare module Ext.form { } declare module Ext.slider { export interface ISingleSlider extends Ext.slider.IMulti { - /** [Method] Returns the current value of the slider */ + /** [Method] Returns the current value of the slider + * @returns any The current value of the slider + */ getValue?(): any; /** [Method] Programmatically sets the value of the Slider * @param value Number The value to set the slider to. (This will be constrained within minValue and maxValue) @@ -32197,7 +34251,9 @@ declare module Ext.slider { } declare module Ext.slider { export interface ISlider extends Ext.slider.IMulti { - /** [Method] Returns the current value of the slider */ + /** [Method] Returns the current value of the slider + * @returns any The current value of the slider + */ getValue?(): any; /** [Method] Programmatically sets the value of the Slider * @param value Number The value to set the slider to. (This will be constrained within minValue and maxValue) @@ -32234,6 +34290,7 @@ declare module Ext.slider { position?: string; /** [Method] Used to create the text that appears in the Tip s body * @param thumb Ext.slider.Thumb The Thumb that the Tip is attached to + * @returns String The text to display in the tip */ getText?( thumb?:Ext.slider.IThumb ): string; } @@ -32278,19 +34335,19 @@ declare module Ext.state { export class Manager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Clears a value from the state * @param name String The key name */ @@ -32298,16 +34355,21 @@ declare module Ext.state { /** [Method] Returns the current value for a key * @param name String The key name * @param defaultValue Object The default value to return if the key lookup does not match + * @returns Object The state data */ static get( name?:string, defaultValue?:any ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; - /** [Method] Gets the currently configured state provider */ + /** [Method] Gets the currently configured state provider + * @returns Ext.state.Provider The state provider + */ static getProvider(): Ext.state.IProvider; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Sets the value for a key @@ -32319,7 +34381,9 @@ declare module Ext.state { * @param stateProvider Ext.state.Provider The state provider to set */ static setProvider( stateProvider?:Ext.state.IProvider ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -32336,6 +34400,7 @@ declare module Ext.state { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -32344,10 +34409,9 @@ declare module Ext.state { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Clears a value from the state * @param name String The key name */ @@ -32358,35 +34422,39 @@ declare module Ext.state { clearManagedListeners?(): void; /** [Method] Decodes a string previously encoded with encodeValue * @param value String The value to decode + * @returns Object The decoded value */ decodeValue?( value?:string ): any; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Encodes a value including type information * @param value Object The value to encode + * @returns String The encoded value */ encodeValue?( value?:any ): string; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Returns the current value for a key * @param name String The key name * @param defaultValue Object A default value to return if the key's value is not found + * @returns Object The state data */ get?( name?:string, defaultValue?:any ): any; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -32395,30 +34463,29 @@ declare module Ext.state { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -32433,9 +34500,7 @@ declare module Ext.state { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -32482,6 +34547,7 @@ declare module Ext.state { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -32490,16 +34556,13 @@ declare module Ext.state { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Add events that will trigger the state to be saved * @param events String/String[] The event name or an array of event names. */ - addStateEvents?( events?:any ): any; - addStateEvents?( events?:string ): void; - addStateEvents?( events?:string[] ): void; + addStateEvents?( events?:any ): void; /** [Method] Applies the state to the object * @param state Object The state */ @@ -32513,23 +34576,26 @@ declare module Ext.state { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Gets the current state of the object */ + /** [Method] Gets the current state of the object + * @returns Object The current state + */ getState?(): any; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -32538,30 +34604,29 @@ declare module Ext.state { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -32576,9 +34641,7 @@ declare module Ext.state { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -32589,15 +34652,15 @@ declare module Ext.state { * @param propName String The name of the property to save. * @param state Object The state object in to which to save the property. * @param stateName String The name to use for the property in state. + * @returns Boolean True if the property was saved, false if not. */ savePropToState?( propName?:string, state?:any, stateName?:string ): boolean; /** [Method] Gathers additional named properties of the instance and adds their current values to the passed state object * @param propNames String/String[] The name (or array of names) of the property to save. * @param state Object The state object in to which to save the property values. + * @returns Object state */ savePropsToState?( propNames?:any, state?:any ): any; - savePropsToState?( propNames?:string, state?:any ): any; - savePropsToState?( propNames?:string[], state?:any ): any; /** [Method] Saves the state of the object to the persistence store */ saveState?(): void; /** [Method] Suspends firing of the named event s @@ -32626,16 +34689,19 @@ declare module Ext { static addCharacterEntities( entities?:any ): void; /** [Method] Capitalize the given string * @param string String + * @returns String */ static capitalize( string?:string ): string; /** [Method] Converts a string of characters into a legal parse able JavaScript var name as long as the passed string contains at * @param s String A string to be converted into a var name. + * @returns String A legal JavaScript var name. */ static createVarName( s?:string ): string; /** [Method] Truncate a string and add an ellipsis to the end if it exceeds the specified length * @param value String The string to truncate. * @param length Number The maximum length to allow before truncating. * @param word Boolean true to try to find a common word break. + * @returns String The converted text. */ static ellipsis( value?:string, length?:number, word?:boolean ): string; /** [Method] Checks if a string ends with a substring @@ -32646,35 +34712,42 @@ declare module Ext { static endsWith( s?:string, start?:string, ignoreCase?:boolean ): void; /** [Method] Escapes the passed string for and * @param string String The string to escape + * @returns String The escaped string */ static escape( string?:string ): string; /** [Method] Escapes the passed string for use in a regular expression * @param string String + * @returns String */ static escapeRegex( string?:string ): string; /** [Method] Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens * @param string String The tokenized string to be formatted. * @param values Mixed... The values to replace tokens {0}, {1}, etc in order. + * @returns String The formatted string. */ static format( string:string, ...values:any[] ): string; /** [Method] Convert certain characters amp lt and from their HTML character equivalents * @param value String The string to decode. + * @returns String The decoded text. */ static htmlDecode( value?:string ): string; /** [Method] Convert certain characters amp lt and to their HTML character equivalents for literal display in web * @param value String The string to encode. + * @returns String The encoded text. */ static htmlEncode( value?:string ): string; /** [Method] Inserts a substring into a string * @param s String The original string. * @param value String The substring to insert. * @param index Number The index to insert the substring. Negative indexes will insert from the end of the string. Example: Ext.String.insert("abcdefg", "h", -1); // abcdefhg + * @returns String The value with the inserted substring */ static insert( s?:string, value?:string, index?:number ): string; /** [Method] Pads the left side of a string with a specified character * @param string String The original string. * @param size Number The total length of the output string. * @param character String The character with which to pad the original string. + * @returns String The padded string. */ static leftPad( string?:string, size?:number, character?:string ): string; /** [Method] Returns a string with a specified number of repetitions a given string pattern @@ -32688,9 +34761,7 @@ declare module Ext { /** [Method] Splits a string of space separated words into an array trimming as needed * @param words String/Array */ - static splitWords( words?:any ): any; - static splitWords( words?:string ): void; - static splitWords( words?:any[] ): void; + static splitWords( words?:any ): void; /** [Method] Checks if a string starts with a substring * @param s String The original string * @param start String The substring to check @@ -32701,19 +34772,23 @@ declare module Ext { * @param string String The current string. * @param value String The value to compare to the current string. * @param other String The new value to use if the string already equals the first value passed in. + * @returns String The new value. */ static toggle( string?:string, value?:string, other?:string ): string; /** [Method] Trims whitespace from either end of a string leaving spaces within the string intact * @param string String The string to trim. + * @returns String The trimmed string. */ static trim( string?:string ): string; /** [Method] Uncapitalize the given string * @param string String + * @returns String */ static uncapitalize( string?:string ): string; /** [Method] Appends content to the query string of a URL handling logic for whether to place a question mark or ampersand * @param url String The URL to append to. * @param string String The content to append to the URL. + * @returns String The resulting URL */ static urlAppend( url?:string, string?:string ): string; } @@ -32744,7 +34819,9 @@ declare module Ext.tab { afterLayout?(): void; /** [Method] Allows addition of behavior after rendering is complete */ afterRender?(): void; - /** [Method] Returns the layout instance currently associated with this Container */ + /** [Method] Returns the layout instance currently associated with this Container + * @returns Ext.layout.container.Container The layout + */ getLayout?(): Ext.layout.container.IContainer; /** [Method] This method is invoked after a new Component has been removed * @param tab Object @@ -32778,9 +34855,13 @@ declare module Ext.tab { tabBar?: any; /** [Config Option] ("top"/"bottom"/"left"/"right") */ tabPosition?: any; - /** [Method] Returns the item that is currently active inside this TabPanel */ + /** [Method] Returns the item that is currently active inside this TabPanel + * @returns Ext.Component The currently active item. + */ getActiveTab?(): Ext.IComponent; - /** [Method] Returns the Ext tab Bar currently used in this TabPanel */ + /** [Method] Returns the Ext tab Bar currently used in this TabPanel + * @returns Ext.tab.Bar The TabBar + */ getTabBar?(): Ext.tab.IBar; /** [Method] Makes sure we have a Tab for each item added to the TabPanel * @param item Object @@ -32789,11 +34870,9 @@ declare module Ext.tab { onAdd?( item?:any, index?:any ): void; /** [Method] Makes the given card active * @param card String/Number/Ext.Component The card to make active. Either an ID, index or the component itself. + * @returns Ext.Component The resulting active child Component. The call may have been vetoed, or otherwise modified by an event listener. */ - setActiveTab?( card?:any ): any; - setActiveTab?( card?:string ): Ext.IComponent; - setActiveTab?( card?:number ): Ext.IComponent; - setActiveTab?( card?:Ext.IComponent ): Ext.IComponent; + setActiveTab?( card?:any ): Ext.IComponent; } } declare module Ext { @@ -32820,9 +34899,13 @@ declare module Ext { tabBar?: any; /** [Config Option] ("top"/"bottom"/"left"/"right") */ tabPosition?: any; - /** [Method] Returns the item that is currently active inside this TabPanel */ + /** [Method] Returns the item that is currently active inside this TabPanel + * @returns Ext.Component The currently active item. + */ getActiveTab?(): Ext.IComponent; - /** [Method] Returns the Ext tab Bar currently used in this TabPanel */ + /** [Method] Returns the Ext tab Bar currently used in this TabPanel + * @returns Ext.tab.Bar The TabBar + */ getTabBar?(): Ext.tab.IBar; /** [Method] Makes sure we have a Tab for each item added to the TabPanel * @param item Object @@ -32831,11 +34914,9 @@ declare module Ext { onAdd?( item?:any, index?:any ): void; /** [Method] Makes the given card active * @param card String/Number/Ext.Component The card to make active. Either an ID, index or the component itself. + * @returns Ext.Component The resulting active child Component. The call may have been vetoed, or otherwise modified by an event listener. */ - setActiveTab?( card?:any ): any; - setActiveTab?( card?:string ): Ext.IComponent; - setActiveTab?( card?:number ): Ext.IComponent; - setActiveTab?( card?:Ext.IComponent ): Ext.IComponent; + setActiveTab?( card?:any ): Ext.IComponent; } } declare module Ext.tab { @@ -32866,7 +34947,9 @@ declare module Ext.tab { * @param silent Object */ enable?( silent?:any ): void; - /** [Method] This method returns an object which provides substitution parameters for the XTemplate used to create this Button s D */ + /** [Method] This method returns an object which provides substitution parameters for the XTemplate used to create this Button s D + * @returns Object Substitution data for a Template. The default implementation which provides data for the default template returns an Object containing the following properties: + */ getTemplateArgs?(): any; /** [Method] inherit docs */ initComponent?(): void; @@ -32892,105 +34975,61 @@ declare module Ext { * @param el String/HTMLElement/Ext.Element The context element * @param values Object/Array The template values. See applyTemplate for details. * @param returnElement Boolean true to return an Ext.Element. + * @returns HTMLElement/Ext.Element The new node or Element */ - append?( el?:any, values?:any, returnElement?:any ): any; - append?( el?:string, values?:any, returnElement?:boolean ): HTMLElement; - append?( el?:HTMLElement, values?:any, returnElement?:boolean ): HTMLElement; - append?( el?:Ext.IElement, values?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Applies the supplied values to the template and appends the new node s to the specified el - * @param el String/HTMLElement/Ext.Element The context element - * @param values Object/Array The template values. See applyTemplate for details. - * @param returnElement Boolean true to return an Ext.Element. - */ - append?( el?:string, values?:any, returnElement?:boolean ): Ext.IElement; - append?( el?:HTMLElement, values?:any, returnElement?:boolean ): Ext.IElement; - append?( el?:Ext.IElement, values?:any, returnElement?:boolean ): Ext.IElement; + append?( el?:any, values?:any, returnElement?:boolean ): any; /** [Method] Returns an HTML fragment of this template with the specified values applied * @param values Object/Array The template values. Can be an array if your params are numeric: var tpl = new Ext.Template('Name: {0}, Age: {1}'); tpl.apply(['John', 25]); or an object: var tpl = new Ext.Template('Name: {name}, Age: {age}'); tpl.apply({name: 'John', age: 25}); + * @returns String The HTML fragment */ apply?( values?:any ): string; /** [Method] Appends the result of this template to the provided output array * @param values Object/Array The template values. See apply. * @param out Array The array to which output is pushed. + * @returns Array The given out array. */ applyOut?( values?:any, out?:any[] ): any[]; /** [Method] Alias for apply * @param values Object/Array The template values. Can be an array if your params are numeric: var tpl = new Ext.Template('Name: {0}, Age: {1}'); tpl.apply(['John', 25]); or an object: var tpl = new Ext.Template('Name: {name}, Age: {age}'); tpl.apply({name: 'John', age: 25}); + * @returns String The HTML fragment */ applyTemplate?( values?:any ): string; - /** [Method] Compiles the template into an internal function eliminating the RegEx overhead */ + /** [Method] Compiles the template into an internal function eliminating the RegEx overhead + * @returns Ext.Template this + */ compile?(): Ext.ITemplate; /** [Method] Applies the supplied values to the template and inserts the new node s after el * @param el String/HTMLElement/Ext.Element The context element * @param values Object/Array The template values. See applyTemplate for details. * @param returnElement Boolean true to return a Ext.Element. + * @returns HTMLElement/Ext.Element The new node or Element */ - insertAfter?( el?:any, values?:any, returnElement?:any ): any; - insertAfter?( el?:string, values?:any, returnElement?:boolean ): HTMLElement; - insertAfter?( el?:HTMLElement, values?:any, returnElement?:boolean ): HTMLElement; - insertAfter?( el?:Ext.IElement, values?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Applies the supplied values to the template and inserts the new node s after el - * @param el String/HTMLElement/Ext.Element The context element - * @param values Object/Array The template values. See applyTemplate for details. - * @param returnElement Boolean true to return a Ext.Element. - */ - insertAfter?( el?:string, values?:any, returnElement?:boolean ): Ext.IElement; - insertAfter?( el?:HTMLElement, values?:any, returnElement?:boolean ): Ext.IElement; - insertAfter?( el?:Ext.IElement, values?:any, returnElement?:boolean ): Ext.IElement; + insertAfter?( el?:any, values?:any, returnElement?:boolean ): any; /** [Method] Applies the supplied values to the template and inserts the new node s before el * @param el String/HTMLElement/Ext.Element The context element * @param values Object/Array The template values. See applyTemplate for details. * @param returnElement Boolean true to return a Ext.Element. + * @returns HTMLElement/Ext.Element The new node or Element */ - insertBefore?( el?:any, values?:any, returnElement?:any ): any; - insertBefore?( el?:string, values?:any, returnElement?:boolean ): HTMLElement; - insertBefore?( el?:HTMLElement, values?:any, returnElement?:boolean ): HTMLElement; - insertBefore?( el?:Ext.IElement, values?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Applies the supplied values to the template and inserts the new node s before el - * @param el String/HTMLElement/Ext.Element The context element - * @param values Object/Array The template values. See applyTemplate for details. - * @param returnElement Boolean true to return a Ext.Element. - */ - insertBefore?( el?:string, values?:any, returnElement?:boolean ): Ext.IElement; - insertBefore?( el?:HTMLElement, values?:any, returnElement?:boolean ): Ext.IElement; - insertBefore?( el?:Ext.IElement, values?:any, returnElement?:boolean ): Ext.IElement; + insertBefore?( el?:any, values?:any, returnElement?:boolean ): any; /** [Method] Applies the supplied values to the template and inserts the new node s as the first child of el * @param el String/HTMLElement/Ext.Element The context element * @param values Object/Array The template values. See applyTemplate for details. * @param returnElement Boolean true to return a Ext.Element. + * @returns HTMLElement/Ext.Element The new node or Element */ - insertFirst?( el?:any, values?:any, returnElement?:any ): any; - insertFirst?( el?:string, values?:any, returnElement?:boolean ): HTMLElement; - insertFirst?( el?:HTMLElement, values?:any, returnElement?:boolean ): HTMLElement; - insertFirst?( el?:Ext.IElement, values?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Applies the supplied values to the template and inserts the new node s as the first child of el - * @param el String/HTMLElement/Ext.Element The context element - * @param values Object/Array The template values. See applyTemplate for details. - * @param returnElement Boolean true to return a Ext.Element. - */ - insertFirst?( el?:string, values?:any, returnElement?:boolean ): Ext.IElement; - insertFirst?( el?:HTMLElement, values?:any, returnElement?:boolean ): Ext.IElement; - insertFirst?( el?:Ext.IElement, values?:any, returnElement?:boolean ): Ext.IElement; + insertFirst?( el?:any, values?:any, returnElement?:boolean ): any; /** [Method] Applies the supplied values to the template and overwrites the content of el with the new node s * @param el String/HTMLElement/Ext.Element The context element * @param values Object/Array The template values. See applyTemplate for details. * @param returnElement Boolean true to return a Ext.Element. + * @returns HTMLElement/Ext.Element The new node or Element */ - overwrite?( el?:any, values?:any, returnElement?:any ): any; - overwrite?( el?:string, values?:any, returnElement?:boolean ): HTMLElement; - overwrite?( el?:HTMLElement, values?:any, returnElement?:boolean ): HTMLElement; - overwrite?( el?:Ext.IElement, values?:any, returnElement?:boolean ): HTMLElement; - /** [Method] Applies the supplied values to the template and overwrites the content of el with the new node s - * @param el String/HTMLElement/Ext.Element The context element - * @param values Object/Array The template values. See applyTemplate for details. - * @param returnElement Boolean true to return a Ext.Element. - */ - overwrite?( el?:string, values?:any, returnElement?:boolean ): Ext.IElement; - overwrite?( el?:HTMLElement, values?:any, returnElement?:boolean ): Ext.IElement; - overwrite?( el?:Ext.IElement, values?:any, returnElement?:boolean ): Ext.IElement; + overwrite?( el?:any, values?:any, returnElement?:boolean ): any; /** [Method] Sets the HTML used as the template and optionally compiles it * @param html String * @param compile Boolean True to compile the template. + * @returns Ext.Template this */ set?( html?:string, compile?:boolean ): Ext.ITemplate; } @@ -33001,9 +35040,12 @@ declare module Ext { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -33013,16 +35055,18 @@ declare module Ext { /** [Method] Creates a template from the passed element s value display none textarea preferred or innerHTML * @param el String/HTMLElement A DOM element or its id * @param config Object Config object + * @returns Ext.Template The created template + */ + static from( el?:any, config?:any ): Ext.ITemplate; + /** [Method] Get the current class name in string format + * @returns String className */ - static from( el?:any, config?:any ): any; - static from( el?:string, config?:any ): Ext.ITemplate; - static from( el?:HTMLElement, config?:any ): Ext.ITemplate; - /** [Method] Get the current class name in string format */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -33038,10 +35082,7 @@ declare module Ext.tip { /** [Method] Hides a visible tip or cancels an impending show for a particular element * @param el String/HTMLElement/Ext.Element The element that is the target of the tip or ID of the element. */ - cancelShow?( el?:any ): any; - cancelShow?( el?:string ): void; - cancelShow?( el?:HTMLElement ): void; - cancelShow?( el?:Ext.IElement ): void; + cancelShow?( el?:any ): void; /** [Method] Configures a new quick tip instance and assigns it to a target element * @param config Object The config object with the following properties: */ @@ -33049,10 +35090,7 @@ declare module Ext.tip { /** [Method] Removes this quick tip from its element and destroys it * @param el String/HTMLElement/Ext.Element The element from which the quick tip is to be removed or ID of the element. */ - unregister?( el?:any ): any; - unregister?( el?:string ): void; - unregister?( el?:HTMLElement ): void; - unregister?( el?:Ext.IElement ): void; + unregister?( el?:any ): void; } } declare module Ext { @@ -33066,10 +35104,7 @@ declare module Ext { /** [Method] Hides a visible tip or cancels an impending show for a particular element * @param el String/HTMLElement/Ext.Element The element that is the target of the tip or ID of the element. */ - cancelShow?( el?:any ): any; - cancelShow?( el?:string ): void; - cancelShow?( el?:HTMLElement ): void; - cancelShow?( el?:Ext.IElement ): void; + cancelShow?( el?:any ): void; /** [Method] Configures a new quick tip instance and assigns it to a target element * @param config Object The config object with the following properties: */ @@ -33077,10 +35112,7 @@ declare module Ext { /** [Method] Removes this quick tip from its element and destroys it * @param el String/HTMLElement/Ext.Element The element from which the quick tip is to be removed or ID of the element. */ - unregister?( el?:any ): any; - unregister?( el?:string ): void; - unregister?( el?:HTMLElement ): void; - unregister?( el?:Ext.IElement ): void; + unregister?( el?:any ): void; } } declare module Ext.tip { @@ -33089,19 +35121,19 @@ declare module Ext.tip { export class QuickTipManager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Destroys the QuickTips instance */ static destroy(): void; /** [Method] Disables quick tips globally */ @@ -33110,9 +35142,12 @@ declare module Ext.tip { static enable(): void; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; - /** [Method] Gets the single QuickTip instance used to show tips from all registered elements */ + /** [Method] Gets the single QuickTip instance used to show tips from all registered elements + * @returns Ext.tip.QuickTip + */ static getQuickTip(): Ext.tip.IQuickTip; /** [Method] Initializes the global QuickTips instance and prepare any quick tips * @param autoRender Boolean True to render the QuickTips container immediately to preload images. @@ -33121,15 +35156,20 @@ declare module Ext.tip { static init( autoRender?:boolean, config?:any ): void; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Returns true if quick tips are enabled else false */ + /** [Method] Returns true if quick tips are enabled else false + * @returns Boolean + */ static isEnabled(): boolean; /** [Method] Configures a new quick tip instance and assigns it to a target element * @param config Object The config object */ static register( config?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Alias of register * @param config Object The config object @@ -33138,10 +35178,7 @@ declare module Ext.tip { /** [Method] Removes any registered quick tip from the target element and destroys it * @param el String/HTMLElement/Ext.Element The element from which the quick tip is to be removed or ID of the element. */ - static unregister( el?:any ): any; - static unregister( el?:string ): void; - static unregister( el?:HTMLElement ): void; - static unregister( el?:Ext.IElement ): void; + static unregister( el?:any ): void; } } declare module Ext { @@ -33150,19 +35187,19 @@ declare module Ext { export class QuickTips { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Destroys the QuickTips instance */ static destroy(): void; /** [Method] Disables quick tips globally */ @@ -33171,9 +35208,12 @@ declare module Ext { static enable(): void; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; - /** [Method] Gets the single QuickTip instance used to show tips from all registered elements */ + /** [Method] Gets the single QuickTip instance used to show tips from all registered elements + * @returns Ext.tip.QuickTip + */ static getQuickTip(): Ext.tip.IQuickTip; /** [Method] Initializes the global QuickTips instance and prepare any quick tips * @param autoRender Boolean True to render the QuickTips container immediately to preload images. @@ -33182,15 +35222,20 @@ declare module Ext { static init( autoRender?:boolean, config?:any ): void; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Returns true if quick tips are enabled else false */ + /** [Method] Returns true if quick tips are enabled else false + * @returns Boolean + */ static isEnabled(): boolean; /** [Method] Configures a new quick tip instance and assigns it to a target element * @param config Object The config object */ static register( config?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Alias of register * @param config Object The config object @@ -33199,10 +35244,7 @@ declare module Ext { /** [Method] Removes any registered quick tip from the target element and destroys it * @param el String/HTMLElement/Ext.Element The element from which the quick tip is to be removed or ID of the element. */ - static unregister( el?:any ): any; - static unregister( el?:string ): void; - static unregister( el?:HTMLElement ): void; - static unregister( el?:Ext.IElement ): void; + static unregister( el?:any ): void; } } declare module Ext.tip { @@ -33298,10 +35340,7 @@ declare module Ext.tip { /** [Method] Binds this ToolTip to the specified element * @param t String/HTMLElement/Ext.Element The Element, HtmlElement, or ID of an element to bind to */ - setTarget?( t?:any ): any; - setTarget?( t?:string ): void; - setTarget?( t?:HTMLElement ): void; - setTarget?( t?:Ext.IElement ): void; + setTarget?( t?:any ): void; } } declare module Ext { @@ -33333,10 +35372,7 @@ declare module Ext { /** [Method] Binds this ToolTip to the specified element * @param t String/HTMLElement/Ext.Element The Element, HtmlElement, or ID of an element to bind to */ - setTarget?( t?:any ): any; - setTarget?( t?:string ): void; - setTarget?( t?:HTMLElement ): void; - setTarget?( t?:Ext.IElement ): void; + setTarget?( t?:any ): void; } } declare module Ext.toolbar { @@ -33353,7 +35389,9 @@ declare module Ext.toolbar { disable?(): void; /** [Method] Enable the component */ enable?(): void; - /** [Method] Try to focus this component */ + /** [Method] Try to focus this component + * @returns Ext.Component The focused Component. Usually this Component. Some Containers may delegate focus to a descendant Component (Windows can do this through their defaultFocus config option. + */ focus?(): Ext.IComponent; } } @@ -33392,18 +35430,20 @@ declare module Ext.toolbar { /** [Method] Binds a store to this instance * @param store Ext.data.AbstractStore/String The store to bind or ID of the store. When no store given (or when null or undefined passed), unbinds the existing store. */ - bindStore?( store?:any ): any; - bindStore?( store?:Ext.data.IAbstractStore ): void; - bindStore?( store?:string ): void; + bindStore?( store?:any ): void; /** [Method] Binds listeners for this component to the store * @param store Ext.data.AbstractStore The store to bind to */ bindStoreListeners?( store?:Ext.data.IAbstractStore ): void; /** [Method] Refresh the current page has the same effect as clicking the refresh button */ doRefresh?(): void; - /** [Method] Gets the current store instance */ + /** [Method] Gets the current store instance + * @returns Ext.data.AbstractStore The store, null if one does not exist. + */ getStore?(): Ext.data.IAbstractStore; - /** [Method] Gets the listeners to bind to a new store */ + /** [Method] Gets the listeners to bind to a new store + * @returns Object The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance. + */ getStoreListeners?(): any; /** [Method] Move to the first page has the same effect as clicking the first button */ moveFirst?(): void; @@ -33468,18 +35508,20 @@ declare module Ext { /** [Method] Binds a store to this instance * @param store Ext.data.AbstractStore/String The store to bind or ID of the store. When no store given (or when null or undefined passed), unbinds the existing store. */ - bindStore?( store?:any ): any; - bindStore?( store?:Ext.data.IAbstractStore ): void; - bindStore?( store?:string ): void; + bindStore?( store?:any ): void; /** [Method] Binds listeners for this component to the store * @param store Ext.data.AbstractStore The store to bind to */ bindStoreListeners?( store?:Ext.data.IAbstractStore ): void; /** [Method] Refresh the current page has the same effect as clicking the refresh button */ doRefresh?(): void; - /** [Method] Gets the current store instance */ + /** [Method] Gets the current store instance + * @returns Ext.data.AbstractStore The store, null if one does not exist. + */ getStore?(): Ext.data.IAbstractStore; - /** [Method] Gets the listeners to bind to a new store */ + /** [Method] Gets the listeners to bind to a new store + * @returns Object The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance. + */ getStoreListeners?(): any; /** [Method] Move to the first page has the same effect as clicking the first button */ moveFirst?(): void; @@ -33555,12 +35597,9 @@ declare module Ext.toolbar { isToolbar?: boolean; /** [Method] Adds element s to the toolbar this function takes a variable number of arguments of mixed type and adds them to t * @param args Ext.Component.../Object.../String.../HTMLElement... The following types of arguments are all valid: config: A valid button config object HtmlElement: Any standard HTML element Field: Any form field Item: Any subclass of Ext.toolbar.Item String: Any generic string (gets wrapped in a Ext.toolbar.TextItem). Note that there are a few special strings that are treated differently as explained next: '-': Creates a separator element ' ': Creates a spacer element '->': Creates a fill element + * @returns Ext.Component[]/Ext.Component The Components that were added. */ - add?( args?:any ): Ext.IComponent[]; - /** [Method] Adds element s to the toolbar this function takes a variable number of arguments of mixed type and adds them to t - * @param args Ext.Component.../Object.../String.../HTMLElement... The following types of arguments are all valid: config: A valid button config object HtmlElement: Any standard HTML element Field: Any form field Item: Any subclass of Ext.toolbar.Item String: Any generic string (gets wrapped in a Ext.toolbar.TextItem). Note that there are a few special strings that are treated differently as explained next: '-': Creates a separator element ' ': Creates a spacer element '->': Creates a fill element - */ - add?( args?:any ): Ext.IComponent; + add?( args?:any ): any; /** [Method] Used by ComponentQuery child and down to retrieve all of the items which can potentially be considered a child of th * @param deep Object */ @@ -33568,6 +35607,7 @@ declare module Ext.toolbar { /** [Method] Inserts a Component into this Container at a specified index * @param index Number The index at which the Component will be inserted. * @param component Ext.Component/Object/String/HTMLElement See add method for overview of possible values. + * @returns Ext.Component The component that was inserted. */ insert?( index?:number, component?:any ): Ext.IComponent; } @@ -33592,12 +35632,9 @@ declare module Ext { isToolbar?: boolean; /** [Method] Adds element s to the toolbar this function takes a variable number of arguments of mixed type and adds them to t * @param args Ext.Component.../Object.../String.../HTMLElement... The following types of arguments are all valid: config: A valid button config object HtmlElement: Any standard HTML element Field: Any form field Item: Any subclass of Ext.toolbar.Item String: Any generic string (gets wrapped in a Ext.toolbar.TextItem). Note that there are a few special strings that are treated differently as explained next: '-': Creates a separator element ' ': Creates a spacer element '->': Creates a fill element + * @returns Ext.Component[]/Ext.Component The Components that were added. */ - add?( args?:any ): Ext.IComponent[]; - /** [Method] Adds element s to the toolbar this function takes a variable number of arguments of mixed type and adds them to t - * @param args Ext.Component.../Object.../String.../HTMLElement... The following types of arguments are all valid: config: A valid button config object HtmlElement: Any standard HTML element Field: Any form field Item: Any subclass of Ext.toolbar.Item String: Any generic string (gets wrapped in a Ext.toolbar.TextItem). Note that there are a few special strings that are treated differently as explained next: '-': Creates a separator element ' ': Creates a spacer element '->': Creates a fill element - */ - add?( args?:any ): Ext.IComponent; + add?( args?:any ): any; /** [Method] Used by ComponentQuery child and down to retrieve all of the items which can potentially be considered a child of th * @param deep Object */ @@ -33605,6 +35642,7 @@ declare module Ext { /** [Method] Inserts a Component into this Container at a specified index * @param index Number The index at which the Component will be inserted. * @param component Ext.Component/Object/String/HTMLElement See add method for overview of possible values. + * @returns Ext.Component The component that was inserted. */ insert?( index?:number, component?:any ): Ext.IComponent; } @@ -33683,9 +35721,13 @@ declare module Ext.tree { * @param scope Object The scope of the callback function */ expandPath?( path?:string, field?:string, separator?:string, callback?:any, scope?:any ): void; - /** [Method] Retrieve an array of checked records */ + /** [Method] Retrieve an array of checked records + * @returns Ext.data.NodeInterface[] An array containing the checked records + */ getChecked?(): Ext.data.INodeInterface[]; - /** [Method] Returns the root node for this tree */ + /** [Method] Returns the root node for this tree + * @returns Ext.data.NodeInterface + */ getRootNode?(): Ext.data.INodeInterface; /** [Method] Expand the tree to the path of a particular node then select it * @param path String The path to select. The path should include a leading separator. @@ -33697,6 +35739,7 @@ declare module Ext.tree { selectPath?( path?:string, field?:string, separator?:string, callback?:any, scope?:any ): void; /** [Method] Sets root node of this tree * @param root Ext.data.Model/Ext.data.NodeInterface/Object + * @returns Ext.data.NodeInterface The new root */ setRootNode?( root?:any ): Ext.data.INodeInterface; } @@ -33763,9 +35806,13 @@ declare module Ext.tree { * @param scope Object The scope of the callback function */ expandPath?( path?:string, field?:string, separator?:string, callback?:any, scope?:any ): void; - /** [Method] Retrieve an array of checked records */ + /** [Method] Retrieve an array of checked records + * @returns Ext.data.NodeInterface[] An array containing the checked records + */ getChecked?(): Ext.data.INodeInterface[]; - /** [Method] Returns the root node for this tree */ + /** [Method] Returns the root node for this tree + * @returns Ext.data.NodeInterface + */ getRootNode?(): Ext.data.INodeInterface; /** [Method] Expand the tree to the path of a particular node then select it * @param path String The path to select. The path should include a leading separator. @@ -33777,6 +35824,7 @@ declare module Ext.tree { selectPath?( path?:string, field?:string, separator?:string, callback?:any, scope?:any ): void; /** [Method] Sets root node of this tree * @param root Ext.data.Model/Ext.data.NodeInterface/Object + * @returns Ext.data.NodeInterface The new root */ setRootNode?( root?:any ): Ext.data.INodeInterface; } @@ -33843,9 +35891,13 @@ declare module Ext { * @param scope Object The scope of the callback function */ expandPath?( path?:string, field?:string, separator?:string, callback?:any, scope?:any ): void; - /** [Method] Retrieve an array of checked records */ + /** [Method] Retrieve an array of checked records + * @returns Ext.data.NodeInterface[] An array containing the checked records + */ getChecked?(): Ext.data.INodeInterface[]; - /** [Method] Returns the root node for this tree */ + /** [Method] Returns the root node for this tree + * @returns Ext.data.NodeInterface + */ getRootNode?(): Ext.data.INodeInterface; /** [Method] Expand the tree to the path of a particular node then select it * @param path String The path to select. The path should include a leading separator. @@ -33857,6 +35909,7 @@ declare module Ext { selectPath?( path?:string, field?:string, separator?:string, callback?:any, scope?:any ): void; /** [Method] Sets root node of this tree * @param root Ext.data.Model/Ext.data.NodeInterface/Object + * @returns Ext.data.NodeInterface The new root */ setRootNode?( root?:any ): Ext.data.INodeInterface; } @@ -33935,7 +35988,9 @@ declare module Ext.tree { * @param scope Object The scope of the callback function. */ expand?( record?:Ext.data.IModel, deep?:boolean, callback?:any, scope?:any ): void; - /** [Method] Gets the listeners to bind to a new store */ + /** [Method] Gets the listeners to bind to a new store + * @returns Object The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance. + */ getStoreListeners?(): any; /** [Method] Gets the base TreeStore from the bound TreePanel */ getTreeStore?(): void; @@ -33974,6 +36029,7 @@ declare module Ext.tree { * @param dd Object * @param e Object * @param data Object + * @returns String status The CSS class that communicates the drop status back to the source so that the underlying Ext.dd.StatusProxy can be updated */ onContainerOver?( dd?:any, e?:any, data?:any ): string; /** [Method] The mouse is no longer over a tree node so dropping is not valid @@ -33988,6 +36044,7 @@ declare module Ext.tree { * @param dragZone Object * @param e Object * @param data Object + * @returns String status The CSS class that communicates the drop status back to the source so that the underlying Ext.dd.StatusProxy can be updated */ onNodeOver?( node?:any, dragZone?:any, e?:any, data?:any ): string; } @@ -34001,6 +36058,7 @@ declare module Ext.util { /** [Method] Adds an item to the collection * @param key String/Object The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param obj Object The item to add. + * @returns Object The item added. */ add?( key?:any, obj?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -34016,6 +36074,7 @@ declare module Ext.util { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -34024,30 +36083,34 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all items from the collection */ clear?(): void; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ clearManagedListeners?(): void; - /** [Method] Creates a shallow copy of this collection */ + /** [Method] Creates a shallow copy of this collection + * @returns Ext.util.MixedCollection + */ clone?(): Ext.util.IMixedCollection; /** [Method] Collects unique values of a particular property in this MixedCollection * @param property String The property to collect on * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param allowBlank Boolean Pass true to allow null, undefined or empty string values + * @returns Array The unique values */ collect?( property?:string, root?:string, allowBlank?:boolean ): any[]; /** [Method] Returns true if the collection contains the passed Object as an item * @param o Object The Object to look for in the collection. + * @returns Boolean True if the collection contains the Object as an item. */ contains?( o?:any ): boolean; /** [Method] Returns true if the collection contains the passed Object as a key * @param key String The key to look for in the collection. + * @returns Boolean True if the collection contains the Object as a key. */ containsKey?( key?:string ): boolean; /** [Method] Executes the specified function once for every item in the collection @@ -34063,23 +36126,19 @@ declare module Ext.util { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Filters the objects in this collection by a set of Filters or by a single property value pair with optional paramete * @param property Ext.util.Filter[]/String A property on your objects, or an array of Filter objects * @param value String/RegExp Either string that the property values should start with or a RegExp to test against the property * @param anyMatch Boolean True to match any part of the string, not just the beginning * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Ext.util.MixedCollection The new filtered collection */ - filter?( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any; - filter?( property?:Ext.util.IFilter[], value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - filter?( property?:string, value?:string, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - filter?( property?:Ext.util.IFilter[], value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; - filter?( property?:string, value?:RegExp, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; + filter?( property?:any, value?:any, anyMatch?:boolean, caseSensitive?:boolean ): Ext.util.IMixedCollection; /** [Method] Filter by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. + * @returns Ext.util.MixedCollection The new filtered collection */ filterBy?( fn?:any, scope?:any ): Ext.util.IMixedCollection; /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function */ @@ -34087,6 +36146,7 @@ declare module Ext.util { /** [Method] Returns the first item in the collection which elicits a true return value from the passed selection function * @param fn Function The selection function to execute for each item. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the browser window. + * @returns Object The first item in the collection which returned true from the selection function, or null if none was found. */ findBy?( fn?:any, scope?:any ): any; /** [Method] Finds the index of the first matching object in this collection by a specific property value @@ -34095,74 +36155,87 @@ declare module Ext.util { * @param start Number The index to start searching at. * @param anyMatch Boolean True to match any part of the string, not just the beginning. * @param caseSensitive Boolean True for case sensitive comparison. + * @returns Number The matched index or -1 */ - findIndex?( property?:any, value?:any, start?:any, anyMatch?:any, caseSensitive?:any ): any; - findIndex?( property?:string, value?:string, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; - findIndex?( property?:string, value?:RegExp, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; + findIndex?( property?:string, value?:any, start?:number, anyMatch?:boolean, caseSensitive?:boolean ): number; /** [Method] Find the index of the first matching object in this collection by a function * @param fn Function The function to be called. * @param scope Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param start Number The index to start searching at. + * @returns Number The matched index or -1 */ findIndexBy?( fn?:any, scope?:any, start?:number ): number; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; - /** [Method] Returns the first item in the collection */ + /** [Method] Returns the first item in the collection + * @returns Object the first item in the collection.. + */ first?(): any; /** [Method] Returns the item associated with the passed key OR index * @param key String/Number The key or index of the item. + * @returns Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null. */ get?( key?:any ): any; - get?( key?:string ): any; - get?( key?:number ): any; /** [Method] Returns the item at the specified index * @param index Number The index of the item. + * @returns Object The item at the specified index. */ getAt?( index?:number ): any; /** [Method] Returns the item associated with the passed key * @param key String/Number The key of the item. + * @returns Object The item associated with the passed key. */ getByKey?( key?:any ): any; - getByKey?( key?:string ): any; - getByKey?( key?:number ): any; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ getCount?(): number; /** [Method] A function which will be called passing a newly added object when the object is added without a separate id * @param item Object The item for which to find the key. + * @returns Object The key for the passed item. */ getKey?( item?:any ): any; /** [Method] Returns a range of items in this collection * @param startIndex Number The starting index. Defaults to 0. * @param endIndex Number The ending index. Defaults to the last item. + * @returns Array An array of items */ getRange?( startIndex?:number, endIndex?:number ): any[]; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Returns index within the collection of the passed Object * @param o Object The item to find the index of. + * @returns Number index of the item. Returns -1 if not found. */ indexOf?( o?:any ): number; /** [Method] Returns index within the collection of the passed key * @param key String The key to find the index of. + * @returns Number index of the key. */ indexOfKey?( key?:string ): number; /** [Method] Inserts an item at the specified index in the collection * @param index Number The index to insert the item at. * @param key String/Object/String[]/Object[] The key to associate with the new item, or the item itself. May also be an array of either to insert multiple items at once. * @param o Object/Object[] If the second parameter was a key, the new item. May also be an array to insert multiple items at once. + * @returns Object The item inserted or an array of items inserted. */ insert?( index?:number, key?:any, o?:any ): any; - /** [Method] Returns the last item in the collection */ + /** [Method] Returns the last item in the collection + * @returns Object the last item in the collection.. + */ last?(): any; /** [Method] Shorthand for addManagedListener * @param item Ext.util.Observable/Ext.Element The item to which to add a listener/listeners. @@ -34170,46 +36243,49 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Remove an item from the collection * @param o Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ remove?( o?:any ): any; /** [Method] Remove all items in the collection * @param items Array An array of items to be removed. + * @returns Ext.util.MixedCollection this object */ removeAll?( items?:any[] ): Ext.util.IMixedCollection; /** [Method] Remove an item from a specified index in the collection * @param index Number The index within the collection of the item to remove. + * @returns Object The item removed or false if no item was removed. */ removeAt?( index?:number ): any; /** [Method] Removes an item associated with the passed key fom the collection * @param key String The key of the item to remove. If null is passed, all objects which yielded no key from the configured getKey function are removed. + * @returns Object Only returned if removing at a specified key. The item removed or false if no item was removed. */ removeAtKey?( key?:string ): any; /** [Method] Removes an event handler @@ -34224,17 +36300,17 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Remove a range of items starting at a specified index in the collection * @param index Number The index within the collection of the item to remove. * @param removeCount Number The nuber of items to remove beginning at the specified index. + * @returns Object The last item removed or false if no item was removed. */ removeRange?( index?:number, removeCount?:number ): any; /** [Method] Replaces an item in the collection * @param key String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter. * @param o Object {Object} o (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ replace?( key?:string, o?:any ): any; /** [Method] Resumes firing of the named event s @@ -34248,6 +36324,7 @@ declare module Ext.util { * @param root String 'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object * @param start Number The record index to start at * @param end Number The record index to end at + * @returns Number The total */ sum?( property?:string, root?:string, start?:number, end?:number ): number; /** [Method] Suspends firing of the named event s @@ -34275,21 +36352,29 @@ declare module Ext.util { export interface IAnimate extends Ext.IBase { /** [Method] Performs custom animation on this object. ... */ animate?: any; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - getActiveAnimation?(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - getActiveAnimation?(): boolean; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - hasActiveFx?(): Ext.fx.IAnim; - /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false */ - hasActiveFx?(): boolean; - /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence */ + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + getActiveAnimation?(): any; + /** [Method] Returns the current animation if this object has any effects actively running or queued else returns false + * @returns Ext.fx.Anim/Boolean Anim if element has active effects, else false + */ + hasActiveFx?(): any; + /** [Method] Ensures that all effects queued after sequenceFx is called on this object are run in sequence + * @returns Object this + */ sequenceFx?(): any; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ stopAnimation?(): Ext.IElement; - /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that */ + /** [Method] Stops any running effects and clears this object s internal effects queue if it contains any additional effects that + * @returns Ext.Element The Element + */ stopFx?(): Ext.IElement; - /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently */ + /** [Method] Ensures that all effects queued after syncFx is called on this object are run concurrently + * @returns Object this + */ syncFx?(): any; } } @@ -34298,17 +36383,18 @@ declare module Ext.util { /** [Method] Binds a store to this instance * @param store Ext.data.AbstractStore/String The store to bind or ID of the store. When no store given (or when null or undefined passed), unbinds the existing store. */ - bindStore?( store?:any ): any; - bindStore?( store?:Ext.data.IAbstractStore ): void; - bindStore?( store?:string ): void; + bindStore?( store?:any ): void; /** [Method] Binds listeners for this component to the store * @param store Ext.data.AbstractStore The store to bind to */ bindStoreListeners?( store?:Ext.data.IAbstractStore ): void; - /** [Method] Gets the current store instance */ + /** [Method] Gets the current store instance + * @returns Ext.data.AbstractStore The store, null if one does not exist. + */ getStore?(): Ext.data.IAbstractStore; /** [Method] Gets the listeners to bind to a new store * @param store Ext.data.Store The Store which is being bound to for which a listeners object should be returned. + * @returns Object The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance. */ getStoreListeners?( store?:Ext.data.IStore ): any; /** [Method] Template method it is called when a new store is bound to the current instance @@ -34381,19 +36467,19 @@ declare module Ext.util { export class Cookies { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes a cookie with the provided name from the browser if found by setting its expiration date to sometime in the p * @param name String The name of the cookie to remove * @param path String The path for the cookie. This must be included if you included a path while setting the cookie. @@ -34401,14 +36487,17 @@ declare module Ext.util { static clear( name?:string, path?:string ): void; /** [Method] Retrieves cookies that are accessible by the current page * @param name String The name of the cookie to get + * @returns Object Returns the cookie value for the specified name; null if the cookie name does not exist. */ static get( name?:string ): any; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Creates a cookie with the specified name and value @@ -34420,7 +36509,9 @@ declare module Ext.util { * @param secure Boolean Specify true to indicate that the cookie should only be accessible via SSL on a page using the HTTPS protocol. Defaults to false. Note that this will only work if the page calling this code uses the HTTPS protocol, otherwise the cookie will be created with default options. */ static set( name?:string, value?:any, expires?:any, path?:string, domain?:string, secure?:boolean ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -34430,56 +36521,64 @@ declare module Ext.util { export class CSS { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Creates a rule * @param styleSheet CSSStyleSheet The StyleSheet to create the rule in as returned from createStyleSheet. * @param selector String The selector to target the rule. * @param property String The cssText specification eg "color:red;font-weight:bold;text-decoration:underline" + * @returns CSSStyleRule The created rule */ static createRule( styleSheet?:CSSStyleSheet, selector?:string, property?:string ): CSSStyleRule; /** [Method] Creates a stylesheet from a text blob of rules * @param cssText String The text containing the css rules * @param id String An id to add to the stylesheet for later removal + * @returns CSSStyleSheet */ static createStyleSheet( cssText?:string, id?:string ): CSSStyleSheet; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Gets an an individual CSS rule by selector s * @param selector String/String[] The CSS selector or an array of selectors to try. The first selector that is found is returned. * @param refreshCache Boolean true to refresh the internal cache if you have recently updated any rules or added styles dynamically + * @returns CSSStyleRule The CSS rule or null if one is not found */ - static getRule( selector?:any, refreshCache?:any ): any; - static getRule( selector?:string, refreshCache?:boolean ): CSSStyleRule; - static getRule( selector?:string[], refreshCache?:boolean ): CSSStyleRule; + static getRule( selector?:any, refreshCache?:boolean ): CSSStyleRule; /** [Method] Gets all css rules for the document * @param refreshCache Boolean true to refresh the internal cache + * @returns Object An object (hash) of rules indexed by selector */ static getRules( refreshCache?:boolean ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; - /** [Method] Refresh the rule cache if you have dynamically added stylesheets */ + /** [Method] Refresh the rule cache if you have dynamically added stylesheets + * @returns Object An object (hash) of rules indexed by selector + */ static refreshCache(): any; /** [Method] Removes a style or link tag by id * @param id String The id of the tag */ static removeStyleSheet( id?:string ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Dynamically swaps an existing stylesheet reference for a new one * @param id String The id of an existing link tag to remove @@ -34490,10 +36589,9 @@ declare module Ext.util { * @param selector String/String[] If it's an array it tries each selector until it finds one. Stops immediately once one is found. * @param property String The css property or a cssText specification eg "color:red;font-weight:bold;text-decoration:underline" * @param value String The new value for the property + * @returns Boolean true If a rule was found and updated */ - static updateRule( selector?:any, property?:any, value?:any ): any; - static updateRule( selector?:string, property?:string, value?:string ): boolean; - static updateRule( selector?:string[], property?:string, value?:string ): boolean; + static updateRule( selector?:any, property?:string, value?:string ): boolean; } } declare module Ext.util { @@ -34565,9 +36663,12 @@ declare module Ext.util { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -34576,14 +36677,18 @@ declare module Ext.util { static createAlias( alias?:any, origin?:any ): void; /** [Method] Creates a single filter function which encapsulates the passed Filter array * @param filters Ext.util.Filter[] The filter set for which to create a filter function + * @returns Function a function, which when passed a candidate object returns true if the candidate passes all the specified Filters. */ static createFilterFn( filters?:Ext.util.IFilter[] ): any; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -34600,25 +36705,26 @@ declare module Ext.util { shadow?: any; /** [Config Option] (Number) */ shadowOffset?: number; - /** [Method] Center this Component in its container */ + /** [Method] Center this Component in its container + * @returns Ext.Component this + */ center?(): Ext.IComponent; /** [Method] Moves this floating Component into a constrain region * @param constrainTo String/HTMLElement/Ext.Element/Ext.util.Region The Element or Region into which this Component is to be constrained. Defaults to the element into which this floating Component was rendered. */ - doConstrain?( constrainTo?:any ): any; - doConstrain?( constrainTo?:string ): void; - doConstrain?( constrainTo?:HTMLElement ): void; - doConstrain?( constrainTo?:Ext.IElement ): void; - doConstrain?( constrainTo?:Ext.util.IRegion ): void; + doConstrain?( constrainTo?:any ): void; /** [Method] This method is called internally by Ext ZIndexManager to signal that a floating Component has either been moved to th * @param active Boolean True to activate the Component, false to deactivate it. * @param newActive Ext.Component The newly active Component which is taking over topmost zIndex position. */ setActive?( active?:boolean, newActive?:Ext.IComponent ): void; - /** [Method] Sends this Component to the back of lower z index than any other visible windows */ + /** [Method] Sends this Component to the back of lower z index than any other visible windows + * @returns Ext.Component this + */ toBack?(): Ext.IComponent; /** [Method] Brings this floating Component to the front of any other visible floating Components managed by the same ZIndexManag * @param preventFocus Boolean Specify true to prevent the Component from being focused. + * @returns Ext.Component this */ toFront?( preventFocus?:boolean ): Ext.IComponent; } @@ -34633,6 +36739,7 @@ declare module Ext.util { static attributes( attributes?:any ): void; /** [Method] Alias for Ext String capitalize * @param string String + * @returns String */ static capitalize( string?:string ): string; /** [Method] Format a number as a currency @@ -34640,86 +36747,96 @@ declare module Ext.util { * @param sign String The currency sign to use (defaults to currencySign) * @param decimals Number The number of decimals to use for the currency (defaults to currencyPrecision) * @param end Boolean True if the currency sign should be at the end of the string (defaults to currencyAtEnd) + * @returns String The formatted currency string */ - static currency( value?:any, sign?:any, decimals?:any, end?:any ): any; - static currency( value?:number, sign?:string, decimals?:number, end?:boolean ): string; - static currency( value?:string, sign?:string, decimals?:number, end?:boolean ): string; + static currency( value?:any, sign?:string, decimals?:number, end?:boolean ): string; /** [Method] Formats the passed date using the specified format pattern * @param value String/Date The value to format. If a string is passed, it is converted to a Date by the Javascript's built-in Date.parse method. * @param format String Any valid date format string. Defaults to Ext.Date.defaultFormat. + * @returns String The formatted date string. */ - static date( value?:any, format?:any ): any; - static date( value?:string, format?:string ): string; static date( value?:any, format?:string ): string; /** [Method] Returns a date rendering function that can be reused to apply a date format multiple times efficiently * @param format String Any valid date format string. Defaults to Ext.Date.defaultFormat. + * @returns Function The date formatting function */ static dateRenderer( format?:string ): any; /** [Method] Checks a reference and converts it to the default value if it s empty * @param value Object Reference to check * @param defaultValue String The value to insert of it's undefined. + * @returns String */ static defaultValue( value?:any, defaultValue?:string ): string; /** [Method] Alias for Ext String ellipsis * @param value String The string to truncate. * @param length Number The maximum length to allow before truncating. * @param word Boolean true to try to find a common word break. + * @returns String The converted text. */ static ellipsis( value?:string, length?:number, word?:boolean ): string; /** [Method] Escapes the passed string for use in a regular expression * @param str String + * @returns String */ static escapeRegex( str?:string ): string; /** [Method] Simple format for a file size xxx bytes xxx KB xxx MB * @param size Number/String The numeric value to format + * @returns String The formatted file size */ - static fileSize( size?:any ): any; - static fileSize( size?:number ): string; - static fileSize( size?:string ): string; + static fileSize( size?:any ): string; /** [Method] Alias for Ext String format * @param string String The tokenized string to be formatted. * @param values Mixed... The values to replace tokens {0}, {1}, etc in order. + * @returns String The formatted string. */ static format( string:string, ...values:any[] ): string; /** [Method] Alias for Ext String htmlDecode * @param value String The string to decode. + * @returns String The decoded text. */ static htmlDecode( value?:string ): string; /** [Method] Alias for Ext String htmlEncode * @param value String The string to encode. + * @returns String The encoded text. */ static htmlEncode( value?:string ): string; /** [Method] Alias for Ext String leftPad * @param string String The original string. * @param size Number The total length of the output string. * @param character String The character with which to pad the original string. + * @returns String The padded string. */ static leftPad( string?:string, size?:number, character?:string ): string; /** [Method] Converts a string to all lower case letters * @param value String The text to convert + * @returns String The converted text */ static lowercase( value?:string ): string; - /** [Method] It does simple math for use in a template for example var tpl new Ext Template value 10 value math 10 */ + /** [Method] It does simple math for use in a template for example var tpl new Ext Template value 10 value math 10 + * @returns Function A function that operates on the passed value. + */ static math(): any; /** [Method] Converts newline characters to the HTML tag lt br gt * @param v String The string value to format. + * @returns String The string with embedded <br/> tags in place of newlines. */ static nl2br( v?:string ): string; /** [Method] Formats the passed number according to the passed format string * @param v Number The number to format. * @param format String The way you would like to format this text. + * @returns String The formatted number. */ static number( v?:number, format?:string ): string; /** [Method] Returns a number rendering function that can be reused to apply a number format multiple times efficiently * @param format String Any valid number format string for number + * @returns Function The number formatting function */ static numberRenderer( format?:string ): any; /** [Method] Parses a number or string representing margin sizes into an object * @param v Number/String The encoded margins + * @returns Object An object with margin sizes for top, right, bottom and left */ static parseBox( v?:any ): any; - static parseBox( v?:number ): any; - static parseBox( v?:string ): any; /** [Method] Selectively do a plural form of a word based on a numeric value * @param value Number The value to compare against * @param singular String The singular form of the word @@ -34729,48 +36846,53 @@ declare module Ext.util { /** [Method] Rounds the passed number to the required decimal precision * @param value Number/String The numeric value to round. * @param precision Number The number of decimal places to which to round the first parameter's value. + * @returns Number The rounded value. */ - static round( value?:any, precision?:any ): any; - static round( value?:number, precision?:number ): number; - static round( value?:string, precision?:number ): number; + static round( value?:any, precision?:number ): number; /** [Method] Strips all script tags * @param value Object The text from which to strip script tags + * @returns String The stripped text */ static stripScripts( value?:any ): string; /** [Method] Strips all HTML tags * @param value Object The text from which to strip tags + * @returns String The stripped text */ static stripTags( value?:any ): string; /** [Method] Returns a substring from within an original string * @param value String The original text * @param start Number The start index of the substring * @param length Number The length of the substring + * @returns String The substring */ static substr( value?:string, start?:number, length?:number ): string; /** [Method] Alias for Ext String trim * @param string String The string to trim. + * @returns String The trimmed string. */ static trim( string?:string ): string; /** [Method] Checks a reference and converts it to empty string if it is undefined * @param value Object Reference to check + * @returns Object Empty string if converted, otherwise the original value */ static undef( value?:any ): any; /** [Method] Converts a string to all upper case letters * @param value String The text to convert + * @returns String The converted text */ static uppercase( value?:string ): string; /** [Method] Format a number as US currency * @param value Number/String The numeric value to format + * @returns String The formatted currency string */ - static usMoney( value?:any ): any; - static usMoney( value?:number ): string; - static usMoney( value?:string ): string; + static usMoney( value?:any ): string; } } declare module Ext.util { export interface IGrouper extends Ext.util.ISorter { /** [Method] Returns the value for grouping to be used * @param instance Ext.data.Model The Model instance + * @returns String The group string for this model */ getGroupString?( instance?:Ext.data.IModel ): string; } @@ -34782,6 +36904,7 @@ declare module Ext.util { /** [Method] Adds an item to the collection * @param key String/Object The key to associate with the item, or the new item. If a getKey implementation was specified for this HashMap, or if the key of the stored items is in a property called id, the HashMap will be able to derive the key for the new item. In this case just pass the new item in this parameter. * @param o Object The item to add. + * @returns Object The item added. */ add?( key?:any, o?:any ): any; /** [Method] Adds the specified events to the list of events which this Observable may fire @@ -34793,6 +36916,7 @@ declare module Ext.util { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -34801,65 +36925,79 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all items from the hash * @param initial Object + * @returns Ext.util.HashMap this */ clear?( initial?:any ): Ext.util.IHashMap; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ clearManagedListeners?(): void; - /** [Method] Performs a shallow copy on this hash */ + /** [Method] Performs a shallow copy on this hash + * @returns Ext.util.HashMap The new hash object. + */ clone?(): Ext.util.IHashMap; /** [Method] Checks whether a value exists in the hash * @param value Object The value to check for. + * @returns Boolean True if the value exists in the dictionary. */ contains?( value?:any ): boolean; /** [Method] Checks whether a key exists in the hash * @param key String The key to check for. + * @returns Boolean True if they key exists in the hash. */ containsKey?( key?:string ): boolean; /** [Method] Executes the specified function once for each item in the hash * @param fn Function The function to execute. * @param scope Object The scope to execute in. Defaults to this. + * @returns Ext.util.HashMap this */ each?( fn?:any, scope?:any ): Ext.util.IHashMap; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Retrieves an item with a particular key * @param key String The key to lookup. + * @returns Object The value at that key. If it doesn't exist, undefined is returned. */ get?( key?:string ): any; - /** [Method] Gets the number of items in the hash */ + /** [Method] Gets the number of items in the hash + * @returns Number The number of items in the hash. + */ getCount?(): number; /** [Method] Extracts the key from an object * @param o Object The object to get the key from + * @returns String The key to use. */ getKey?( o?:any ): string; - /** [Method] Return all of the keys in the hash */ + /** [Method] Return all of the keys in the hash + * @returns Array An array of keys. + */ getKeys?(): any[]; - /** [Method] Return all of the values in the hash */ + /** [Method] Return all of the values in the hash + * @returns Array An array of values. + */ getValues?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -34868,38 +37006,39 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Remove an item from the hash * @param o Object The value of the item to remove. + * @returns Boolean True if the item was successfully removed. */ remove?( o?:any ): boolean; /** [Method] Remove an item from the hash * @param key String The key to remove. + * @returns Boolean True if the item was successfully removed. */ removeAtKey?( key?:string ): boolean; /** [Method] Removes an event handler @@ -34914,12 +37053,11 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Replaces an item in the hash * @param key String The key of the item. * @param value Object The new value for the item. + * @returns Object The new value of the item. */ replace?( key?:string, value?:any ): any; /** [Method] Resumes firing of the named event s @@ -34962,6 +37100,7 @@ declare module Ext.util { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -34970,27 +37109,26 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Programmatically steps back one step in browser history equivalent to the user pressing the Back button */ static back(): void; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ @@ -34998,29 +37136,33 @@ declare module Ext.util { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; /** [Method] Programmatically steps forward one step in browser history equivalent to the user pressing the Forward button */ static forward(): void; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; - /** [Method] Retrieves the currently active history token */ + /** [Method] Retrieves the currently active history token + * @returns String The token + */ static getToken(): string; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initializes the global History instance @@ -35030,6 +37172,7 @@ declare module Ext.util { static init( onReady?:any, scope?:any ): void; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Shorthand for addManagedListener @@ -35038,30 +37181,29 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -35076,16 +37218,16 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ static resumeEvent( ...eventName:any[] ): void; /** [Method] Resumes firing events see suspendEvents */ static resumeEvents(): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. @@ -35121,6 +37263,7 @@ declare module Ext { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -35129,27 +37272,26 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static addManagedListener( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Programmatically steps back one step in browser history equivalent to the user pressing the Back button */ static back(): void; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Removes all listeners for this object including the managed listeners */ static clearListeners(): void; /** [Method] Removes all managed listeners for this object */ @@ -35157,29 +37299,33 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( eventNames?:any ): any; - static enableBubble( eventNames?:string ): void; - static enableBubble( eventNames?:string[] ): void; + static enableBubble( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEvent( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ static fireEventArgs( eventName?:string, args?:any[] ): boolean; /** [Method] Programmatically steps forward one step in browser history equivalent to the user pressing the Forward button */ static forward(): void; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; - /** [Method] Retrieves the currently active history token */ + /** [Method] Retrieves the currently active history token + * @returns String The token + */ static getToken(): string; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initializes the global History instance @@ -35189,6 +37335,7 @@ declare module Ext { static init( onReady?:any, scope?:any ): void; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Shorthand for addManagedListener @@ -35197,30 +37344,29 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static mon( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - static mon( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static mun( item?:any, ename?:any, fn?:any, scope?:any ): any; - static mun( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static mun( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static mun( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ static on( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ static relayEvents( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -35235,16 +37381,16 @@ declare module Ext { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): any; - static removeManagedListener( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - static removeManagedListener( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + static removeManagedListener( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ static resumeEvent( ...eventName:any[] ): void; /** [Method] Resumes firing events see suspendEvents */ static resumeEvents(): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Suspends firing of the named event s * @param eventName String... Multiple event names to suspend. @@ -35268,21 +37414,22 @@ declare module Ext.util { export class Inflector { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Returns the correct Model name for a given string * @param word String The word to classify + * @returns String The classified version of the word */ static classify( word?:string ): string; /** [Method] Removes all registered pluralization rules */ @@ -35291,18 +37438,22 @@ declare module Ext.util { static clearSingulars(): void; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Returns true if the given word is transnumeral the word is its own singular and plural form e g * @param word String The word to test + * @returns Boolean True if the word is transnumeral */ static isTransnumeral( word?:string ): boolean; /** [Method] Ordinalizes a given number by adding a prefix such as st nd rd or th based on the last digit of the number * @param number Number The number to ordinalize + * @returns String The ordinalized number */ static ordinalize( number?:number ): string; /** [Method] Adds a new pluralization rule to the Inflector @@ -35312,6 +37463,7 @@ declare module Ext.util { static plural( matcher?:RegExp, replacer?:string ): void; /** [Method] Returns the pluralized form of a word e g * @param word String The word to pluralize + * @returns String The pluralized form of the word */ static pluralize( word?:string ): string; /** [Method] Adds a new singularization rule to the Inflector @@ -35321,9 +37473,12 @@ declare module Ext.util { static singular( matcher?:RegExp, replacer?:string ): void; /** [Method] Returns the singularized form of a word e g * @param word String The word to singularize + * @returns String The singularized form of the word */ static singularize( word?:string ): string; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -35353,7 +37508,9 @@ declare module Ext.util { disable?(): void; /** [Method] Enables this KeyMap */ enable?(): void; - /** [Method] Returns true if this KeyMap is enabled */ + /** [Method] Returns true if this KeyMap is enabled + * @returns Boolean + */ isEnabled?(): boolean; /** [Method] Shorthand for adding a single key listener * @param key Number/Number[]/Object Either the numeric key code, array of key codes or an object with the following options: {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)} @@ -35403,7 +37560,9 @@ declare module Ext { disable?(): void; /** [Method] Enables this KeyMap */ enable?(): void; - /** [Method] Returns true if this KeyMap is enabled */ + /** [Method] Returns true if this KeyMap is enabled + * @returns Boolean + */ isEnabled?(): boolean; /** [Method] Shorthand for adding a single key listener * @param key Number/Number[]/Object Either the numeric key code, array of key codes or an object with the following options: {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)} @@ -35502,22 +37661,28 @@ declare module Ext.util { /** [Method] Adds an item to the collection * @param key Object * @param newValue Object + * @returns Object The item added. */ add?( key?:any, newValue?:any ): any; /** [Method] Removes all items from the hash * @param initial Object + * @returns Ext.util.HashMap this */ clear?( initial?:any ): Ext.util.IHashMap; - /** [Method] Performs a shallow copy on this haLruCachesh */ + /** [Method] Performs a shallow copy on this haLruCachesh + * @returns Ext.util.HashMap The new hash object. + */ clone?(): Ext.util.IHashMap; /** [Method] Executes the specified function once for each item in the cache * @param fn Function The function to execute. * @param scope Object The scope (this reference) to execute in. Defaults to this LruCache. * @param reverse Boolean Pass true to iterate the list in reverse (most recent first) order. + * @returns Ext.util.LruCache this */ each?( fn?:any, scope?:any, reverse?:boolean ): Ext.util.ILruCache; /** [Method] Retrieves an item with a particular key * @param key Object + * @returns Object The value at that key. If it doesn't exist, undefined is returned. */ get?( key?:any ): any; /** [Method] Purge the least recently used entries if the maxSize has been exceeded */ @@ -35532,23 +37697,17 @@ declare module Ext.util { * @param props String/String[] The property or array of properties to capture. * @param target Object The object from which to capture properties. */ - capture?( props?:any, target?:any ): any; - capture?( props?:string, target?:any ): void; - capture?( props?:string[], target?:any ): void; + capture?( props?:any, target?:any ): void; /** [Method] Removes the specified properties from this memento * @param props String/String[] The property or array of properties to remove. */ - remove?( props?:any ): any; - remove?( props?:string ): void; - remove?( props?:string[] ): void; + remove?( props?:any ): void; /** [Method] Restores the specified properties from this memento to the target object * @param props String/String[] The property or array of properties to restore. * @param clear Boolean True to remove the restored properties from this memento or false to keep them (default is true). * @param target Object The object to which to restore properties. */ - restore?( props?:any, clear?:any, target?:any ): any; - restore?( props?:string, clear?:boolean, target?:any ): void; - restore?( props?:string[], clear?:boolean, target?:any ): void; + restore?( props?:any, clear?:boolean, target?:any ): void; /** [Method] Restores all captured properties in this memento to the target object * @param clear Boolean True to remove the restored properties from this memento or false to keep them (default is true). * @param target Object The object to which to restore properties. @@ -35563,11 +37722,14 @@ declare module Ext.util { /** [Method] Calculates the insertion index of the new item based upon the comparison function passed or the current sort order * @param newItem Object The new object to find the insertion position of. * @param sorterFn Function The function to sort by. This is the same as the sorting function passed to sortBy. It accepts 2 items from this MixedCollection, and returns -1 0, or 1 depending on the relative sort positions of the 2 compared items. If omitted, a function generated from the currently defined set of sorters will be used. + * @returns Number The insertion point to add the new item into this MixedCollection at using insert */ findInsertionIndex?( newItem?:any, sorterFn?:any ): number; /** [Method] Returns a comparator function which compares two items and returns 1 0 or 1 depending on the currently defined set */ generateComparator?(): void; - /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place */ + /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place + * @returns Ext.util.Sorter The sorter, null if none exist + */ getFirstSorter?(): Ext.util.ISorter; /** [Method] Performs initialization of this mixin */ initSortable?(): void; @@ -35578,10 +37740,9 @@ declare module Ext.util { /** [Method] Sorts the data in the Store by one or more of its properties * @param sorters String/Ext.util.Sorter[] Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations. * @param direction String The overall direction to sort the data by. + * @returns Ext.util.Sorter[] */ - sort?( sorters?:any, direction?:any ): any; - sort?( sorters?:string, direction?:string ): Ext.util.ISorter[]; - sort?( sorters?:Ext.util.ISorter[], direction?:string ): Ext.util.ISorter[]; + sort?( sorters?:any, direction?:string ): Ext.util.ISorter[]; /** [Method] Sorts the collection by a single sorter function * @param sorterFn Function The function to sort by */ @@ -35610,6 +37771,7 @@ declare module Ext.util { * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Adds listeners to any Observable object or Ext Element which are automatically removed when this Component is destr @@ -35618,10 +37780,9 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ addManagedListener?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Removes all listeners for this object including the managed listeners */ clearListeners?(): void; /** [Method] Removes all managed listeners for this object */ @@ -35629,21 +37790,22 @@ declare module Ext.util { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param eventNames String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( eventNames?:any ): any; - enableBubble?( eventNames?:string ): void; - enableBubble?( eventNames?:string[] ): void; + enableBubble?( eventNames?:any ): void; /** [Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList * @param eventName String The name of the event to fire. * @param args Object... Variable number of parameters are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Fires the specified event with the passed parameter list * @param eventName String The name of the event to fire. * @param args Object[] An array of parameters which are passed to handlers. + * @returns Boolean returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs?( eventName?:string, args?:any[] ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event or whether the event bubbles * @param eventName String The name of the event to check for + * @returns Boolean true if the event is being listened for or bubbles, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Shorthand for addManagedListener @@ -35652,30 +37814,29 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. * @param options Object If the ename parameter was an event name, this is the addListener options. + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ mon?( item?:any, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any, options?:any ): any; - mon?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Shorthand for removeManagedListener * @param item Ext.util.Observable/Ext.Element The item from which to remove a listener/listeners. * @param ename Object/String The event name, or an object containing event name properties. * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - mun?( item?:any, ename?:any, fn?:any, scope?:any ): any; - mun?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - mun?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + mun?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Shorthand for addListener * @param eventName String/Object The name of the event to listen for. May also be an object who's property names are event names. * @param fn Function The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below. * @param scope Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. * @param options Object An object containing handler configuration. Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler. This object may contain any of the following properties: + * @returns Object Only when the destroyable option is specified. A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy(); */ on?( eventName?:any, fn?:any, scope?:any, options?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param origin Object The Observable whose events this object is to relay. * @param events String[] Array of event names to relay. * @param prefix String A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. + * @returns Object A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy(); */ relayEvents?( origin?:any, events?:string[], prefix?:string ): any; /** [Method] Removes an event handler @@ -35690,9 +37851,7 @@ declare module Ext.util { * @param fn Function If the ename parameter was an event name, this is the handler function. * @param scope Object If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed. */ - removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): any; - removeManagedListener?( item?:Ext.util.IObservable, ename?:any, fn?:any, scope?:any ): void; - removeManagedListener?( item?:Ext.IElement, ename?:any, fn?:any, scope?:any ): void; + removeManagedListener?( item?:any, ename?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing of the named event s * @param eventName String... Multiple event names to resume. */ @@ -35721,6 +37880,7 @@ declare module Ext.util { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; /** [Method] Starts capture on the specified Observable @@ -35729,14 +37889,18 @@ declare module Ext.util { * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Observable firing the event. */ static capture( o?:Ext.util.IObservable, fn?:any, scope?:any ): void; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter * @param origin String/Object The original method name */ static createAlias( alias?:any, origin?:any ): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; @@ -35747,6 +37911,7 @@ declare module Ext.util { static observe( c?:any, listeners?:any ): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; /** [Method] Removes all added captures from the Observable @@ -35763,30 +37928,33 @@ declare module Ext.util { export interface IPoint extends Ext.util.IRegion { /** [Method] Compare this point and another point * @param p Ext.util.Point/Object The point to compare with, either an instance of Ext.util.Point or an object with left and top properties + * @returns Boolean Returns whether they are equivalent */ equals?( p?:any ): boolean; /** [Method] Determins whether this Point contained by the passed Region Component or element * @param region Ext.util.Region/Ext.Component/Ext.dom.Element/HTMLElement The rectangle to check that this Point is within. + * @returns Boolean */ - isContainedBy?( region?:any ): any; - isContainedBy?( region?:Ext.util.IRegion ): boolean; - isContainedBy?( region?:Ext.IComponent ): boolean; - isContainedBy?( region?:Ext.dom.IElement ): boolean; - isContainedBy?( region?:HTMLElement ): boolean; + isContainedBy?( region?:any ): boolean; /** [Method] Whether the given point is not away from this point within the given threshold amount * @param p Ext.util.Point/Object The point to check with, either an instance of Ext.util.Point or an object with left and top properties * @param threshold Object/Number Can be either an object with x and y properties or a number + * @returns Boolean */ isWithin?( p?:any, threshold?:any ): boolean; /** [Method] Compare this point with another point when the x and y values of both points are rounded * @param p Ext.util.Point/Object The point to compare with, either an instance of Ext.util.Point or an object with x and y properties + * @returns Boolean */ roundedEquals?( p?:any ): boolean; - /** [Method] Returns a human eye friendly string that represents this point useful for debugging */ + /** [Method] Returns a human eye friendly string that represents this point useful for debugging + * @returns String + */ toString?(): string; /** [Method] Alias for translateBy * @param x Ext.util.Offset/Object Object containing the x and y properties. Or the x value is using the two argument form. * @param y Number The y value unless using an Offset object. + * @returns Ext.util.Region this This Region */ translate?( x?:any, y?:number ): Ext.util.IRegion; } @@ -35797,9 +37965,12 @@ declare module Ext.util { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -35808,14 +37979,18 @@ declare module Ext.util { static createAlias( alias?:any, origin?:any ): void; /** [Method] Returns a new instance of Ext util Point base on the pageX pageY values of the given event * @param e Ext.EventObject/Event The event + * @returns Ext.util.Point */ static fromEvent( e?:any ): Ext.util.IPoint; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -35827,11 +38002,9 @@ declare module Ext.util { * @param position String The position to align to * @param offsets Number[] Offset the positioning by [x, y] * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ - alignTo?( element?:any, position?:any, offsets?:any, animate?:any ): any; - alignTo?( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; - alignTo?( element?:HTMLElement, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; - alignTo?( element?:string, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; + alignTo?( element?:any, position?:string, offsets?:number[], animate?:any ): Ext.util.IPositionable; /** [Method] Anchors an element to another element and realigns it when the window is resized * @param element Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or id of the element to align to. * @param position String The position to align to @@ -35839,86 +38012,80 @@ declare module Ext.util { * @param animate Boolean/Object true for the default animation or a standard Element animation config object * @param monitorScroll Boolean/Number True to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay in milliseconds. * @param callback Function The function to call after the animation finishes + * @returns Ext.util.Positionable this */ - anchorTo?( element?:any, position?:any, offsets?:any, animate?:any, monitorScroll?:any, callback?:any ): any; - anchorTo?( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - anchorTo?( element?:HTMLElement, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - anchorTo?( element?:string, position?:string, offsets?:number[], animate?:any, monitorScroll?:boolean, callback?:any ): Ext.util.IPositionable; - anchorTo?( element?:Ext.util.IPositionable, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; - anchorTo?( element?:HTMLElement, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; - anchorTo?( element?:string, position?:string, offsets?:number[], animate?:any, monitorScroll?:number, callback?:any ): Ext.util.IPositionable; + anchorTo?( element?:any, position?:string, offsets?:number[], animate?:any, monitorScroll?:any, callback?:any ): Ext.util.IPositionable; /** [Method] Calculates the new x y position to move this Positionable into a constrain region * @param constrainTo String/HTMLElement/Ext.Element/Ext.util.Region The Element or Region into which this Component is to be constrained. Defaults to the element into which this Positionable was rendered, or this Component's {@link Ext.Component.constrainTo. * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to coerce into constraints instead of using this Positionable's current position. * @param local Boolean The proposedPosition is local (relative to floatParent if a floating Component) * @param proposedSize Number[] A proposed [width, height] size to use when calculating constraints instead of using this Positionable's current size. + * @returns Number[] If the element needs to be translated, the new [X, Y] position within constraints if possible, giving priority to keeping the top and left edge in the constrain region. Otherwise, false. */ - calculateConstrainedPosition?( constrainTo?:any, proposedPosition?:any, local?:any, proposedSize?:any ): any; - calculateConstrainedPosition?( constrainTo?:string, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - calculateConstrainedPosition?( constrainTo?:HTMLElement, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - calculateConstrainedPosition?( constrainTo?:Ext.IElement, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; - calculateConstrainedPosition?( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; + calculateConstrainedPosition?( constrainTo?:any, proposedPosition?:number[], local?:boolean, proposedSize?:number[] ): number[]; /** [Method] Gets the x y coordinates to align this element with another element * @param element Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or id of the element to align to. * @param position String The position to align to * @param offsets Number[] Offset the positioning by [x, y] + * @returns Number[] [x, y] */ - getAlignToXY?( element?:any, position?:any, offsets?:any ): any; - getAlignToXY?( element?:Ext.util.IPositionable, position?:string, offsets?:number[] ): number[]; - getAlignToXY?( element?:HTMLElement, position?:string, offsets?:number[] ): number[]; - getAlignToXY?( element?:string, position?:string, offsets?:number[] ): number[]; + getAlignToXY?( element?:any, position?:string, offsets?:number[] ): number[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. See alignTo for details on supported anchor positions. * @param local Boolean True to get the local (element top/left-relative) anchor position instead of page coordinates * @param size Object An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size) + * @returns Number[] [x, y] An array containing the element's x and y coordinates */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): number[]; /** [Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param contentBox Boolean If true a box for the content of the element is returned. * @param local Boolean If true the element's left and top relative to its offsetParent are returned instead of page x/y. + * @returns Object box An object in the format: { x: <Element's X position>, y: <Element's Y position>, left: <Element's X position (an alias for x)>, top: <Element's Y position (an alias for y)>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. The result may also be used for setXY */ getBox?( contentBox?:boolean, local?:boolean ): any; /** [Method] Returns the X Y vector by which this Positionable s element must be translated to make a best attempt to constrain * @param constrainTo Ext.util.Positionable/HTMLElement/String/Ext.util.Region The Positionable, HTMLElement, element id, or Region into which the element is to be constrained. * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position * @param proposedSize Number[] A proposed [width, height] size to constrain instead of using the element's current size + * @returns Number[]/Boolean If the element needs to be translated, an [X, Y] vector by which this element must be translated. Otherwise, false. */ - getConstrainVector?( constrainTo?:any, proposedPosition?:any, proposedSize?:any ): any; - getConstrainVector?( constrainTo?:Ext.util.IPositionable, proposedPosition?:number[], proposedSize?:number[] ): number[]; - getConstrainVector?( constrainTo?:HTMLElement, proposedPosition?:number[], proposedSize?:number[] ): number[]; - getConstrainVector?( constrainTo?:string, proposedPosition?:number[], proposedSize?:number[] ): number[]; - getConstrainVector?( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], proposedSize?:number[] ): number[]; - /** [Method] Returns the X Y vector by which this Positionable s element must be translated to make a best attempt to constrain - * @param constrainTo Ext.util.Positionable/HTMLElement/String/Ext.util.Region The Positionable, HTMLElement, element id, or Region into which the element is to be constrained. - * @param proposedPosition Number[] A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position - * @param proposedSize Number[] A proposed [width, height] size to constrain instead of using the element's current size + getConstrainVector?( constrainTo?:any, proposedPosition?:number[], proposedSize?:number[] ): any; + /** [Method] Returns the x coordinate of this element reletive to its offsetParent + * @returns Number The local x coordinate */ - getConstrainVector?( constrainTo?:Ext.util.IPositionable, proposedPosition?:number[], proposedSize?:number[] ): boolean; - getConstrainVector?( constrainTo?:HTMLElement, proposedPosition?:number[], proposedSize?:number[] ): boolean; - getConstrainVector?( constrainTo?:string, proposedPosition?:number[], proposedSize?:number[] ): boolean; - getConstrainVector?( constrainTo?:Ext.util.IRegion, proposedPosition?:number[], proposedSize?:number[] ): boolean; - /** [Method] Returns the x coordinate of this element reletive to its offsetParent */ getLocalX?(): number; - /** [Method] Returns the x and y coordinates of this element relative to its offsetParent */ + /** [Method] Returns the x and y coordinates of this element relative to its offsetParent + * @returns Number[] The local XY position of the element + */ getLocalXY?(): number[]; - /** [Method] Returns the y coordinate of this element reletive to its offsetParent */ + /** [Method] Returns the y coordinate of this element reletive to its offsetParent + * @returns Number The local y coordinate + */ getLocalY?(): number; /** [Method] Returns the offsets of this element from the passed element * @param offsetsTo Ext.util.Positionable/HTMLElement/String The Positionable, HTMLElement, or element id to get get the offsets from. + * @returns Number[] The XY page offsets (e.g. [100, -200]) + */ + getOffsetsTo?( offsetsTo?:any ): number[]; + /** [Method] Returns a region object that defines the area of this element + * @returns Ext.util.Region A Region containing "top, left, bottom, right" properties. */ - getOffsetsTo?( offsetsTo?:any ): any; - getOffsetsTo?( offsetsTo?:Ext.util.IPositionable ): number[]; - getOffsetsTo?( offsetsTo?:HTMLElement ): number[]; - getOffsetsTo?( offsetsTo?:string ): number[]; - /** [Method] Returns a region object that defines the area of this element */ getRegion?(): Ext.util.IRegion; - /** [Method] Returns the content region of this element */ + /** [Method] Returns the content region of this element + * @returns Ext.util.Region A Region containing "top, left, bottom, right" member data. + */ getViewRegion?(): Ext.util.IRegion; - /** [Method] Gets the current X position of the DOM element based on page coordinates */ + /** [Method] Gets the current X position of the DOM element based on page coordinates + * @returns Number The X position of the element + */ getX?(): number; - /** [Method] Gets the current position of the DOM element based on page coordinates */ + /** [Method] Gets the current position of the DOM element based on page coordinates + * @returns Number[] The XY position of the element + */ getXY?(): number[]; - /** [Method] Gets the current Y position of the DOM element based on page coordinates */ + /** [Method] Gets the current Y position of the DOM element based on page coordinates + * @returns Number The Y position of the element + */ getY?(): number; /** [Method] Move the element relative to its current position * @param direction String Possible values are: "l" (or "left") "r" (or "right") "t" (or "top", or "up") "b" (or "bottom", or "down") @@ -35926,55 +38093,62 @@ declare module Ext.util { * @param animate Boolean/Object true for the default animation or a standard Element animation config object */ move?( direction?:string, distance?:number, animate?:any ): void; - /** [Method] Remove any anchor to this element */ + /** [Method] Remove any anchor to this element + * @returns Ext.util.Positionable this + */ removeAnchor?(): Ext.util.IPositionable; /** [Method] Sets the element s box * @param box Object The box to fill {x, y, width, height} * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ setBox?( box?:any, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the local x coordinate of this element using CSS style * @param x Number The x coordinate. A value of null sets the left style to 'auto'. + * @returns Ext.util.Positionable this */ setLocalX?( x?:number ): Ext.util.IPositionable; /** [Method] Sets the local x and y coordinates of this element using CSS style * @param x Number/Array The x coordinate or an array containing [x, y]. A value of null sets the left style to 'auto' * @param y Number The y coordinate, required if x is not an array. A value of null sets the top style to 'auto' + * @returns Ext.util.Positionable this */ - setLocalXY?( x?:any, y?:any ): any; - setLocalXY?( x?:number, y?:number ): Ext.util.IPositionable; - setLocalXY?( x?:any[], y?:number ): Ext.util.IPositionable; + setLocalXY?( x?:any, y?:number ): Ext.util.IPositionable; /** [Method] Sets the local y coordinate of this element using CSS style * @param y Number The y coordinate. A value of null sets the top style to 'auto'. + * @returns Ext.util.Positionable this */ setLocalY?( y?:number ): Ext.util.IPositionable; /** [Method] Sets the element s position and size to the specified region * @param region Ext.util.Region The region to fill * @param animate Boolean/Object true for the default animation or a standard Element animation config object + * @returns Ext.util.Positionable this */ setRegion?( region?:Ext.util.IRegion, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the X position of the DOM element based on page coordinates * @param The Number X position * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.util.Positionable this */ setX?( The?:number, animate?:any ): Ext.util.IPositionable; /** [Method] Sets the position of the DOM element in page coordinates * @param pos Number[] Contains X & Y [x, y] values for new position (coordinates are page-based) * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.util.Positionable this */ setXY?( pos?:number[], animate?:any ): Ext.util.IPositionable; /** [Method] Sets the Y position of the DOM element based on page coordinates * @param The Number Y position * @param animate Boolean/Object True for the default animation, or a standard Element animation config object + * @returns Ext.util.Positionable this */ setY?( The?:number, animate?:any ): Ext.util.IPositionable; /** [Method] Translates the passed page coordinates into left top css values for the element * @param x Number/Array The page x or an array containing [x, y] * @param y Number The page y, required if x is not an array + * @returns Object An object with left and top properties. e.g. {left: (value), top: (value)} */ - translatePoints?( x?:any, y?:any ): any; - translatePoints?( x?:number, y?:number ): any; - translatePoints?( x?:any[], y?:number ): any; + translatePoints?( x?:any, y?:number ): any; } } declare module Ext.util { @@ -35989,25 +38163,30 @@ declare module Ext.util { styleProp?: string; /** [Method] Adds class to the element * @param cls String One or more classnames separated with spaces. + * @returns Ext.util.ProtoElement this */ addCls?( cls?:string ): Ext.util.IProtoElement; /** [Method] Indicates that the current state of the object has been flushed to the DOM so we need to track any subsequent changes */ flush?(): void; /** [Method] True if the element has given class * @param cls String + * @returns Boolean */ hasCls?( cls?:string ): boolean; /** [Method] Removes class from the element * @param cls String One or more classnames separated with spaces. + * @returns Ext.util.ProtoElement this */ removeCls?( cls?:string ): Ext.util.IProtoElement; /** [Method] Adds styles to the element * @param prop String/Object The style property to be set, or an object of multiple styles. * @param value String The value to apply to the given property. + * @returns Ext.util.ProtoElement this */ setStyle?( prop?:any, value?:string ): Ext.util.IProtoElement; /** [Method] Writes style and class properties to given object * @param to Object + * @returns Object to */ writeTo?( to?:any ): any; } @@ -36016,10 +38195,13 @@ declare module Ext.util { export interface IQueue extends Ext.IBase { /** [Method] Removes all items from the collection */ clear?(): void; - /** [Method] Returns the number of items in the collection */ + /** [Method] Returns the number of items in the collection + * @returns Number the number of items in the collection. + */ getCount?(): number; /** [Method] Remove an item from the collection * @param obj Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ remove?( obj?:any ): any; } @@ -36031,71 +38213,83 @@ declare module Ext.util { * @param right Number right offset * @param bottom Number bottom offset * @param left Number left offset + * @returns Ext.util.Region this */ adjust?( top?:number, right?:number, bottom?:number, left?:number ): Ext.util.IRegion; /** [Method] Modifies the current region to be constrained to the targetRegion * @param targetRegion Ext.util.Region + * @returns Ext.util.Region this */ constrainTo?( targetRegion?:Ext.util.IRegion ): Ext.util.IRegion; /** [Method] Checks if this region completely contains the region that is passed in * @param region Ext.util.Region + * @returns Boolean */ contains?( region?:Ext.util.IRegion ): boolean; - /** [Method] Create a copy of this Region */ + /** [Method] Create a copy of this Region + * @returns Ext.util.Region + */ copy?(): Ext.util.IRegion; /** [Method] Copy the values of another Region to this Region * @param p Ext.util.Region The region to copy from. + * @returns Ext.util.Region This Region */ copyFrom?( p?:Ext.util.IRegion ): Ext.util.IRegion; /** [Method] Check whether this region is equivalent to the given region * @param region Ext.util.Region The region to compare with + * @returns Boolean */ equals?( region?:Ext.util.IRegion ): boolean; /** [Method] Get the offset amount of a point outside the region * @param axis String * @param p Ext.util.Point the point + * @returns Ext.util.Offset */ getOutOfBoundOffset?( axis?:string, p?:Ext.util.IPoint ): Ext.util.IOffset; /** [Method] Get the offset amount on the x axis * @param p Number the offset + * @returns Number */ getOutOfBoundOffsetX?( p?:number ): number; /** [Method] Get the offset amount on the y axis * @param p Number the offset + * @returns Number */ getOutOfBoundOffsetY?( p?:number ): number; /** [Method] Checks if this region intersects the region passed in * @param region Ext.util.Region + * @returns Ext.util.Region/Boolean Returns the intersected region or false if there is no intersection. */ - intersect?( region?:Ext.util.IRegion ): Ext.util.IRegion; - /** [Method] Checks if this region intersects the region passed in - * @param region Ext.util.Region - */ - intersect?( region?:Ext.util.IRegion ): boolean; + intersect?( region?:Ext.util.IRegion ): any; /** [Method] Check whether the point offset is out of bound * @param axis String * @param p Ext.util.Point/Number the point / offset + * @returns Boolean */ - isOutOfBound?( axis?:any, p?:any ): any; - isOutOfBound?( axis?:string, p?:Ext.util.IPoint ): boolean; - isOutOfBound?( axis?:string, p?:number ): boolean; + isOutOfBound?( axis?:string, p?:any ): boolean; /** [Method] Check whether the offset is out of bound in the x axis * @param p Number the offset + * @returns Boolean */ isOutOfBoundX?( p?:number ): boolean; /** [Method] Check whether the offset is out of bound in the y axis * @param p Number the offset + * @returns Boolean */ isOutOfBoundY?( p?:number ): boolean; - /** [Method] Round all the properties of this region */ + /** [Method] Round all the properties of this region + * @returns Ext.util.Region this This Region + */ round?(): Ext.util.IRegion; /** [Method] Translate this region by the given offset amount * @param x Ext.util.Offset/Object Object containing the x and y properties. Or the x value is using the two argument form. * @param y Number The y value unless using an Offset object. + * @returns Ext.util.Region this This Region */ translateBy?( x?:any, y?:number ): Ext.util.IRegion; /** [Method] Returns the smallest region that contains the current AND targetRegion * @param region Ext.util.Region + * @returns Ext.util.Region a new region */ union?( region?:Ext.util.IRegion ): Ext.util.IRegion; } @@ -36106,9 +38300,12 @@ declare module Ext.util { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -36117,21 +38314,23 @@ declare module Ext.util { static createAlias( alias?:any, origin?:any ): void; /** [Method] Creates a Region from a box Object which contains four numeric properties top right bottom and left * @param o Object An object with top, right, bottom and left properties. + * @returns Ext.util.Region region The Region constructed based on the passed object */ static from( o?:any ): Ext.util.IRegion; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Retrieves an Ext util Region for a particular element * @param el String/HTMLElement/Ext.Element An element ID, htmlElement or Ext.Element representing an element in the document. + * @returns Ext.util.Region region */ - static getRegion( el?:any ): any; - static getRegion( el?:string ): Ext.util.IRegion; - static getRegion( el?:HTMLElement ): Ext.util.IRegion; - static getRegion( el?:Ext.IElement ): Ext.util.IRegion; + static getRegion( el?:any ): Ext.util.IRegion; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -36148,13 +38347,12 @@ declare module Ext.util { ensureAttachedToBody?( runLayout?:boolean ): void; /** [Method] This function takes the position argument passed to onRender and returns a DOM element that you can use in the insert * @param position String/Number/Ext.dom.Element/HTMLElement Index, element id or element you want to put this component before. + * @returns HTMLElement DOM element that you can use in the insertBefore + */ + getInsertPosition?( position?:any ): HTMLElement; + /** [Method] Initialized the renderData to be used when rendering the renderTpl + * @returns Object Object with keys and values that are going to be applied to the renderTpl */ - getInsertPosition?( position?:any ): any; - getInsertPosition?( position?:string ): HTMLElement; - getInsertPosition?( position?:number ): HTMLElement; - getInsertPosition?( position?:Ext.dom.IElement ): HTMLElement; - getInsertPosition?( position?:HTMLElement ): HTMLElement; - /** [Method] Initialized the renderData to be used when rendering the renderTpl */ initRenderData?(): any; /** [Method] Template method called when this Component s DOM structure is created * @param parentNode Ext.core.Element The parent Element in which this Component's encapsulating element is contained. @@ -36165,13 +38363,7 @@ declare module Ext.util { * @param container Ext.Element/HTMLElement/String The element this Component should be rendered into. If it is being created from existing markup, this should be omitted. * @param position String/Number The element ID or DOM node index within the container before which this component will be inserted (defaults to appending to the end of the container) */ - render?( container?:any, position?:any ): any; - render?( container?:Ext.IElement, position?:string ): void; - render?( container?:HTMLElement, position?:string ): void; - render?( container?:string, position?:string ): void; - render?( container?:Ext.IElement, position?:number ): void; - render?( container?:HTMLElement, position?:number ): void; - render?( container?:string, position?:number ): void; + render?( container?:any, position?:any ): void; } } declare module Ext.util { @@ -36186,17 +38378,18 @@ declare module Ext.util { isSortable?: boolean; /** [Method] Returns a comparator function which compares two items and returns 1 0 or 1 depending on the currently defined set */ generateComparator?(): void; - /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place */ + /** [Method] Gets the first sorter from the sorters collection excluding any groupers that may be in place + * @returns Ext.util.Sorter The sorter, null if none exist + */ getFirstSorter?(): Ext.util.ISorter; /** [Method] Performs initialization of this mixin */ initSortable?(): void; /** [Method] Sorts the data in the Store by one or more of its properties * @param sorters String/Ext.util.Sorter[] Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations. * @param direction String The overall direction to sort the data by. + * @returns Ext.util.Sorter[] */ - sort?( sorters?:any, direction?:any ): any; - sort?( sorters?:string, direction?:string ): Ext.util.ISorter[]; - sort?( sorters?:Ext.util.ISorter[], direction?:string ): Ext.util.ISorter[]; + sort?( sorters?:any, direction?:string ): Ext.util.ISorter[]; } export class Sortable { /** [Method] Add methods properties to the prototype of this class @@ -36205,9 +38398,12 @@ declare module Ext.util { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -36216,14 +38412,18 @@ declare module Ext.util { static createAlias( alias?:any, origin?:any ): void; /** [Method] Creates a single comparator function which encapsulates the passed Sorter array * @param sorters Ext.util.Sorter[] The sorter set for which to create a comparator function + * @returns Function a function, which when passed two comparable objects returns the result of the whole sorter comparator functions. */ static createComparator( sorters?:Ext.util.ISorter[] ): any; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -36258,27 +38458,29 @@ declare module Ext.util { export class TaskManager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Destroys this instance stopping all tasks that are currently running */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Creates a new Task instance @@ -36287,12 +38489,16 @@ declare module Ext.util { static newTask( config?:any ): void; /** [Method] Starts a new task * @param task Object A config object that supports the following properties: + * @returns Object The task */ static start( task?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Stops an existing running task * @param task Object The task to stop + * @returns Object The task */ static stop( task?:any ): any; /** [Method] Stops all tasks that are currently running */ @@ -36305,27 +38511,29 @@ declare module Ext { export class TaskManager { /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Destroys this instance stopping all tasks that are currently running */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Creates a new Task instance @@ -36334,12 +38542,16 @@ declare module Ext { static newTask( config?:any ): void; /** [Method] Starts a new task * @param task Object A config object that supports the following properties: + * @returns Object The task */ static start( task?:any ): any; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Stops an existing running task * @param task Object The task to stop + * @returns Object The task */ static stop( task?:any ): any; /** [Method] Stops all tasks that are currently running */ @@ -36360,10 +38572,12 @@ declare module Ext.util { newTask?( config?:any ): void; /** [Method] Starts a new task * @param task Object A config object that supports the following properties: + * @returns Object The task */ start?( task?:any ): any; /** [Method] Stops an existing running task * @param task Object The task to stop + * @returns Object The task */ stop?( task?:any ): any; /** [Method] Stops all tasks that are currently running */ @@ -36393,22 +38607,22 @@ declare module Ext.util { /** [Method] Binds this TextMetrics instance to a new element * @param el String/HTMLElement/Ext.Element The element or its ID. */ - bind?( el?:any ): any; - bind?( el?:string ): void; - bind?( el?:HTMLElement ): void; - bind?( el?:Ext.IElement ): void; + bind?( el?:any ): void; /** [Method] Destroy this instance */ destroy?(): void; /** [Method] Returns the measured height of the specified text * @param text String The text to measure + * @returns Number height The height in pixels */ getHeight?( text?:string ): number; /** [Method] Returns the size of the specified text based on the internal element s style and width properties * @param text String The text to measure + * @returns Object An object containing the text's size {width: (width), height: (height)} */ getSize?( text?:string ): any; /** [Method] Returns the measured width of the specified text * @param text String The text to measure + * @returns Number width The width in pixels */ getWidth?( text?:string ): number; /** [Method] Sets a fixed width on the internal measurement element @@ -36423,9 +38637,12 @@ declare module Ext.util { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -36434,7 +38651,9 @@ declare module Ext.util { static createAlias( alias?:any, origin?:any ): void; /** [Method] Destroy the TextMetrics instance created by measure */ static destroy(): void; - /** [Method] Get the current class name in string format */ + /** [Method] Get the current class name in string format + * @returns String className + */ static getName(): string; /** [Method] Adds members to class */ static implement(): void; @@ -36442,12 +38661,12 @@ declare module Ext.util { * @param el String/HTMLElement The element, dom node or id from which to copy existing CSS styles that can affect the size of the rendered text * @param text String The text to measure * @param fixedWidth Number If the text will be multiline, you have to set a fixed width in order to accurately measure the text height + * @returns Object An object containing the text's size {width: (width), height: (height)} */ - static measure( el?:any, text?:any, fixedWidth?:any ): any; - static measure( el?:string, text?:string, fixedWidth?:number ): any; - static measure( el?:HTMLElement, text?:string, fixedWidth?:number ): any; + static measure( el?:any, text?:string, fixedWidth?:number ): any; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -36456,87 +38675,93 @@ declare module Ext { export interface IVersion { /** [Method] Returns whether this version equals to the supplied argument * @param target String/Number The version to compare with + * @returns Boolean True if this version equals to the target, false otherwise + */ + equals?( target?:any ): boolean; + /** [Method] Returns the build component value + * @returns Number build */ - equals?( target?:any ): any; - equals?( target?:string ): boolean; - equals?( target?:number ): boolean; - /** [Method] Returns the build component value */ getBuild?(): number; - /** [Method] Returns the major component value */ + /** [Method] Returns the major component value + * @returns Number major + */ getMajor?(): number; - /** [Method] Returns the minor component value */ + /** [Method] Returns the minor component value + * @returns Number minor + */ getMinor?(): number; - /** [Method] Returns the patch component value */ + /** [Method] Returns the patch component value + * @returns Number patch + */ getPatch?(): number; - /** [Method] Returns the release component value */ + /** [Method] Returns the release component value + * @returns Number release + */ getRelease?(): number; - /** [Method] Returns shortVersion version without dots and release */ + /** [Method] Returns shortVersion version without dots and release + * @returns String + */ getShortVersion?(): string; /** [Method] Convenient alias to isGreaterThan * @param target String/Number + * @returns Boolean */ - gt?( target?:any ): any; - gt?( target?:string ): boolean; - gt?( target?:number ): boolean; + gt?( target?:any ): boolean; /** [Method] Convenient alias to isGreaterThanOrEqual * @param target String/Number + * @returns Boolean */ - gtEq?( target?:any ): any; - gtEq?( target?:string ): boolean; - gtEq?( target?:number ): boolean; + gtEq?( target?:any ): boolean; /** [Method] Returns whether this version if greater than the supplied argument * @param target String/Number The version to compare with + * @returns Boolean True if this version if greater than the target, false otherwise */ - isGreaterThan?( target?:any ): any; - isGreaterThan?( target?:string ): boolean; - isGreaterThan?( target?:number ): boolean; + isGreaterThan?( target?:any ): boolean; /** [Method] Returns whether this version if greater than or equal to the supplied argument * @param target String/Number The version to compare with + * @returns Boolean True if this version if greater than or equal to the target, false otherwise */ - isGreaterThanOrEqual?( target?:any ): any; - isGreaterThanOrEqual?( target?:string ): boolean; - isGreaterThanOrEqual?( target?:number ): boolean; + isGreaterThanOrEqual?( target?:any ): boolean; /** [Method] Returns whether this version if smaller than the supplied argument * @param target String/Number The version to compare with + * @returns Boolean True if this version if smaller than the target, false otherwise */ - isLessThan?( target?:any ): any; - isLessThan?( target?:string ): boolean; - isLessThan?( target?:number ): boolean; + isLessThan?( target?:any ): boolean; /** [Method] Returns whether this version if less than or equal to the supplied argument * @param target String/Number The version to compare with + * @returns Boolean True if this version if less than or equal to the target, false otherwise */ - isLessThanOrEqual?( target?:any ): any; - isLessThanOrEqual?( target?:string ): boolean; - isLessThanOrEqual?( target?:number ): boolean; + isLessThanOrEqual?( target?:any ): boolean; /** [Method] Convenient alias to isLessThan * @param target String/Number + * @returns Boolean */ - lt?( target?:any ): any; - lt?( target?:string ): boolean; - lt?( target?:number ): boolean; + lt?( target?:any ): boolean; /** [Method] Convenient alias to isLessThanOrEqual * @param target String/Number + * @returns Boolean */ - ltEq?( target?:any ): any; - ltEq?( target?:string ): boolean; - ltEq?( target?:number ): boolean; + ltEq?( target?:any ): boolean; /** [Method] Returns whether this version matches the supplied argument * @param target String/Number The version to compare with + * @returns Boolean True if this version matches the target, false otherwise + */ + match?( target?:any ): boolean; + /** [Method] Returns this format major minor patch build release + * @returns Number[] */ - match?( target?:any ): any; - match?( target?:string ): boolean; - match?( target?:number ): boolean; - /** [Method] Returns this format major minor patch build release */ toArray?(): number[]; } export class Version { /** [Method] Compare 2 specified versions starting from left to right * @param current String The current version to compare to * @param target String The target version to compare to + * @returns Number Returns -1 if the current version is smaller than the target version, 1 if greater, and 0 if they're equivalent */ static compare( current?:string, target?:string ): number; /** [Method] Converts a version component to a comparable value * @param value Object The value to convert + * @returns Object */ static getComponentValue( value?:any ): any; } @@ -36600,17 +38825,17 @@ declare module Ext.view { /** [Method] Function which can be overridden which returns the data object passed to this DataView s template to render the whole * @param records Ext.data.Model[] An Array of Ext.data.Models to be rendered into the DataView. * @param startIndex Number the index number of the Record being prepared for rendering. + * @returns Object[] An Array of data objects to be processed by a repeating XTemplate. May also contain named properties. */ collectData?( records?:Ext.data.IModel[], startIndex?:number ): any[]; /** [Method] Deselects a record instance by record instance or index * @param records Ext.data.Model[]/Number An array of records or an index * @param suppressEvent Boolean Set to false to not fire a deselect event */ - deselect?( records?:any, suppressEvent?:any ): any; - deselect?( records?:Ext.data.IModel[], suppressEvent?:boolean ): void; - deselect?( records?:number, suppressEvent?:boolean ): void; + deselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Returns the template node the passed child belongs to or null if it doesn t belong to one * @param node HTMLElement + * @returns HTMLElement The template node */ findItemByChild?( node?:HTMLElement ): HTMLElement; /** [Method] Returns the template node by the Ext EventObject or null if it is not found @@ -36619,56 +38844,61 @@ declare module Ext.view { findTargetByEvent?( e?:Ext.IEventObject ): void; /** [Method] Gets a template node * @param nodeInfo HTMLElement/String/Number/Ext.data.Model An HTMLElement template node, index of a template node, the id of a template node or the record associated with the node. + * @returns HTMLElement The node or null if it wasn't found */ - getNode?( nodeInfo?:any ): any; - getNode?( nodeInfo?:HTMLElement ): HTMLElement; - getNode?( nodeInfo?:string ): HTMLElement; - getNode?( nodeInfo?:number ): HTMLElement; - getNode?( nodeInfo?:Ext.data.IModel ): HTMLElement; + getNode?( nodeInfo?:any ): HTMLElement; /** [Method] Gets a range nodes * @param start Number The index of the first node in the range * @param end Number The index of the last node in the range + * @returns HTMLElement[] An array of nodes */ getNodes?( start?:number, end?:number ): HTMLElement[]; /** [Method] Gets a record from a node * @param node Ext.Element/HTMLElement The node to evaluate + * @returns Ext.data.Model record The Ext.data.Model object */ - getRecord?( node?:any ): any; - getRecord?( node?:Ext.IElement ): Ext.data.IModel; - getRecord?( node?:HTMLElement ): Ext.data.IModel; + getRecord?( node?:any ): Ext.data.IModel; /** [Method] Gets an array of the records from an array of nodes * @param nodes HTMLElement[] The nodes to evaluate + * @returns Ext.data.Model[] records The Ext.data.Model objects */ getRecords?( nodes?:HTMLElement[] ): Ext.data.IModel[]; - /** [Method] Gets the currently selected nodes */ + /** [Method] Gets the currently selected nodes + * @returns HTMLElement[] An array of HTMLElements + */ getSelectedNodes?(): HTMLElement[]; - /** [Method] Gets an array of the selected records */ + /** [Method] Gets an array of the selected records + * @returns Ext.data.Model[] An array of Ext.data.Model objects + */ getSelectedRecords?(): Ext.data.IModel[]; - /** [Method] Gets the number of selected nodes */ + /** [Method] Gets the number of selected nodes + * @returns Number The node count + */ getSelectionCount?(): number; - /** [Method] Gets the selection model for this view */ + /** [Method] Gets the selection model for this view + * @returns Ext.selection.Model The selection model + */ getSelectionModel?(): Ext.selection.IModel; - /** [Method] Returns the store associated with this DataView */ + /** [Method] Returns the store associated with this DataView + * @returns Ext.data.Store The store + */ getStore?(): Ext.data.IStore; - /** [Method] Gets the listeners to bind to a new store */ + /** [Method] Gets the listeners to bind to a new store + * @returns Object The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance. + */ getStoreListeners?(): any; /** [Method] Finds the index of the passed node * @param nodeInfo HTMLElement/String/Number/Ext.data.Model An HTMLElement template node, index of a template node, the id of a template node or a record associated with a node. + * @returns Number The index of the node or -1 */ - indexOf?( nodeInfo?:any ): any; - indexOf?( nodeInfo?:HTMLElement ): number; - indexOf?( nodeInfo?:string ): number; - indexOf?( nodeInfo?:number ): number; - indexOf?( nodeInfo?:Ext.data.IModel ): number; + indexOf?( nodeInfo?:any ): number; /** [Method] private */ initComponent?(): void; /** [Method] Returns true if the passed node is selected else false * @param node HTMLElement/Number/Ext.data.Model The node, node index or record to check + * @returns Boolean True if selected, else false */ - isSelected?( node?:any ): any; - isSelected?( node?:HTMLElement ): boolean; - isSelected?( node?:number ): boolean; - isSelected?( node?:Ext.data.IModel ): boolean; + isSelected?( node?:any ): boolean; /** [Method] Template method it is called when a new store is bound to the current instance * @param store Object * @param initial Object @@ -36687,6 +38917,7 @@ declare module Ext.view { * @param data Object/Object[] The raw data object that was used to create the Record. * @param recordIndex Number the index number of the Record being prepared for rendering. * @param record Ext.data.Model The Record being prepared for rendering. + * @returns Array/Object The formatted data in a format expected by the internal template's overwrite() method. (either an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})) */ prepareData?( data?:any, recordIndex?:number, record?:Ext.data.IModel ): any; /** [Method] Refreshes the view by reloading the data from the store and re rendering the template */ @@ -36700,9 +38931,7 @@ declare module Ext.view { * @param keepExisting Boolean * @param suppressEvent Boolean Set to false to not fire a select event */ - select?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - select?( records?:Ext.data.IModel[], keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; + select?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; /** [Method] Unbinds listeners from this component to the store * @param store Ext.data.AbstractStore The store to unbind from */ @@ -36740,33 +38969,35 @@ declare module Ext.view { bindStore?( store?:any, initial?:any ): void; /** [Method] Retrieves the first direct child of this container which matches the passed selector or component * @param selector String/Ext.Component An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching child Ext.Component (or null if no match was found). */ child?( selector?:any ): any; - child?( selector?:string ): any; - child?( selector?:Ext.IComponent ): any; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String/Ext.Component An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching descendant Ext.Component (or null if no match was found). */ down?( selector?:any ): any; - down?( selector?:string ): any; - down?( selector?:Ext.IComponent ): any; /** [Method] A method that returns the inner template for displaying items in the list * @param displayField String The displayField for the BoundList. + * @returns String The inner template */ getInnerTpl?( displayField?:string ): string; /** [Method] Allows addition of behavior to the destroy operation */ onDestroy?(): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned. + * @returns Ext.Component[] Components which matched the selector */ query?( selector?:string ): Ext.IComponent[]; /** [Method] Retrieves all descendant components which match the passed function * @param fn Function The matcher function. It will be called with a single argument, the component being tested. * @param scope Object The scope in which to run the function. If not specified, it will default to the active component. + * @returns Ext.Component[] Components matched by the passed function */ queryBy?( fn?:any, scope?:any ): Ext.IComponent[]; /** [Method] Finds a component at any level under this container matching the id itemId * @param id String The id to find + * @returns Ext.Component The matching id, null if not found */ queryById?( id?:string ): Ext.IComponent; /** [Method] Refreshes the view by reloading the data from the store and re rendering the template */ @@ -36804,33 +39035,35 @@ declare module Ext { bindStore?( store?:any, initial?:any ): void; /** [Method] Retrieves the first direct child of this container which matches the passed selector or component * @param selector String/Ext.Component An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching child Ext.Component (or null if no match was found). */ child?( selector?:any ): any; - child?( selector?:string ): any; - child?( selector?:Ext.IComponent ): any; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String/Ext.Component An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned. + * @returns Object Ext.Component The matching descendant Ext.Component (or null if no match was found). */ down?( selector?:any ): any; - down?( selector?:string ): any; - down?( selector?:Ext.IComponent ): any; /** [Method] A method that returns the inner template for displaying items in the list * @param displayField String The displayField for the BoundList. + * @returns String The inner template */ getInnerTpl?( displayField?:string ): string; /** [Method] Allows addition of behavior to the destroy operation */ onDestroy?(): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned. + * @returns Ext.Component[] Components which matched the selector */ query?( selector?:string ): Ext.IComponent[]; /** [Method] Retrieves all descendant components which match the passed function * @param fn Function The matcher function. It will be called with a single argument, the component being tested. * @param scope Object The scope in which to run the function. If not specified, it will default to the active component. + * @returns Ext.Component[] Components matched by the passed function */ queryBy?( fn?:any, scope?:any ): Ext.IComponent[]; /** [Method] Finds a component at any level under this container matching the id itemId * @param id String The id to find + * @returns Ext.Component The matching id, null if not found */ queryById?( id?:string ): Ext.IComponent; /** [Method] Refreshes the view by reloading the data from the store and re rendering the template */ @@ -36857,11 +39090,13 @@ declare module Ext.view { containerScroll?: any; /** [Method] Called when a mousedown occurs in this container * @param e Object + * @returns Object The dragData */ getDragData?( e?:any ): any; /** [Method] Called before a repair of an invalid drop to get the XY to animate to * @param e Object * @param data Object + * @returns Number[] The xy location (e.g. [100, 200]) */ getRepairXY?( e?:any, data?:any ): number[]; /** [Method] Sets up the DragDrop object @@ -36873,6 +39108,7 @@ declare module Ext.view { /** [Method] Called once drag threshold has been reached to initialize the proxy element * @param x Object * @param y Object + * @returns Boolean true to continue the drag, false to cancel */ onInitDrag?( x?:any, y?:any ): boolean; } @@ -36883,6 +39119,7 @@ declare module Ext.view { destroy?(): void; /** [Method] Returns a custom data object associated with the DOM node that is the target of the event * @param e Object + * @returns Object data The custom data */ getTargetFromEvent?( e?:any ): any; /** [Method] Moved out of the DropZone without dropping @@ -36896,12 +39133,14 @@ declare module Ext.view { * @param dd Object * @param e Object * @param data Object + * @returns Boolean True if the drop was valid, else false */ onContainerDrop?( dd?:any, e?:any, data?:any ): boolean; /** [Method] The mouse is past the end of all nodes or there are no nodes * @param dd Object * @param e Object * @param data Object + * @returns String status The CSS class that communicates the drop status back to the source so that the underlying Ext.dd.StatusProxy can be updated */ onContainerOver?( dd?:any, e?:any, data?:any ): string; /** [Method] Called when the DropZone determines that a Ext dd DragSource has been dropped onto the drop node @@ -36909,6 +39148,7 @@ declare module Ext.view { * @param dragZone Object * @param e Object * @param data Object + * @returns Boolean True if the drop was valid, else false */ onNodeDrop?( targetNode?:any, dragZone?:any, e?:any, data?:any ): boolean; /** [Method] The mouse is over a View node @@ -36916,6 +39156,7 @@ declare module Ext.view { * @param dragZone Object * @param e Object * @param data Object + * @returns String status The CSS class that communicates the drop status back to the source so that the underlying Ext.dd.StatusProxy can be updated */ onNodeOver?( node?:any, dragZone?:any, e?:any, data?:any ): string; } @@ -36928,39 +39169,26 @@ declare module Ext.view { clear?( removeDom?:boolean ): void; /** [Method] Clears this NodeCache and adds the elements passed * @param els HTMLElement[] An array of DOM elements from which to fill this NodeCache. + * @returns Ext.view.NodeCache this */ fill?( els?:HTMLElement[] ): Ext.view.INodeCache; /** [Method] Find the index of the passed element within the composite collection * @param el String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.dom.Element, or an HtmlElement to find within the composite collection. + * @returns Number The index of the passed Ext.dom.Element in the composite collection, or -1 if not found. */ - indexOf?( el?:any ): any; - indexOf?( el?:string ): number; - indexOf?( el?:HTMLElement ): number; - indexOf?( el?:Ext.IElement ): number; - indexOf?( el?:number ): number; + indexOf?( el?:any ): number; /** [Method] Removes the specified element s * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite or an array of any of those. * @param removeDom Boolean True to also remove the element from the document */ - removeElement?( el?:any, removeDom?:any ): any; - removeElement?( el?:string, removeDom?:boolean ): void; - removeElement?( el?:HTMLElement, removeDom?:boolean ): void; - removeElement?( el?:Ext.IElement, removeDom?:boolean ): void; - removeElement?( el?:number, removeDom?:boolean ): void; + removeElement?( el?:any, removeDom?:boolean ): void; /** [Method] Replaces the specified element with the passed element * @param el String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite to replace. * @param replacement String/Ext.Element The id of an element or the Element itself. * @param domReplace Boolean True to remove and replace the element in the document too. + * @returns Ext.view.NodeCache this */ - replaceElement?( el?:any, replacement?:any, domReplace?:any ): any; - replaceElement?( el?:string, replacement?:string, domReplace?:boolean ): Ext.view.INodeCache; - replaceElement?( el?:HTMLElement, replacement?:string, domReplace?:boolean ): Ext.view.INodeCache; - replaceElement?( el?:Ext.IElement, replacement?:string, domReplace?:boolean ): Ext.view.INodeCache; - replaceElement?( el?:number, replacement?:string, domReplace?:boolean ): Ext.view.INodeCache; - replaceElement?( el?:string, replacement?:Ext.IElement, domReplace?:boolean ): Ext.view.INodeCache; - replaceElement?( el?:HTMLElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.view.INodeCache; - replaceElement?( el?:Ext.IElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.view.INodeCache; - replaceElement?( el?:number, replacement?:Ext.IElement, domReplace?:boolean ): Ext.view.INodeCache; + replaceElement?( el?:any, replacement?:any, domReplace?:boolean ): Ext.view.INodeCache; /** [Method] Appends prepends records depending on direction flag * @param newRecords Ext.data.Model[] Items to append/prepend * @param direction Number -1' = scroll up,0` = scroll down. @@ -36997,22 +39225,17 @@ declare module Ext.view { * @param rowInfo HTMLElement/String/Number/Ext.data.Model An HTMLElement, index or instance of a model representing this row * @param cls String */ - addRowCls?( rowInfo?:any, cls?:any ): any; - addRowCls?( rowInfo?:HTMLElement, cls?:string ): void; - addRowCls?( rowInfo?:string, cls?:string ): void; - addRowCls?( rowInfo?:number, cls?:string ): void; - addRowCls?( rowInfo?:Ext.data.IModel, cls?:string ): void; + addRowCls?( rowInfo?:any, cls?:string ): void; /** [Method] Sizes the passed header to fit the max content width * @param header Ext.grid.column.Column/Number The header (or index of header) to auto size. */ - autoSizeColumn?( header?:any ): any; - autoSizeColumn?( header?:Ext.grid.column.IColumn ): void; - autoSizeColumn?( header?:number ): void; + autoSizeColumn?( header?:any ): void; /** [Method] Invoked before the Component is destroyed */ beforeDestroy?(): void; /** [Method] Function which can be overridden which returns the data object passed to this DataView s template to render the whole * @param records Object * @param startIndex Object + * @returns Object[] An Array of data objects to be processed by a repeating XTemplate. May also contain named properties. */ collectData?( records?:any, startIndex?:any ): any[]; /** [Method] Expands a particular header to fit the max content width @@ -37022,21 +39245,14 @@ declare module Ext.view { /** [Method] Try to focus this component * @param selectText Object * @param delay Object + * @returns Ext.Component The focused Component. Usually this Component. Some Containers may delegate focus to a descendant Component (Windows can do this through their defaultFocus config option. */ focus?( selectText?:any, delay?:any ): Ext.IComponent; /** [Method] Focuses a particular row and brings it into view * @param row HTMLElement/String/Number/Ext.data.Model An HTMLElement template node, index of a template node, the id of a template node or the * @param delay Boolean/Number Delay the focus this number of milliseconds (true for 10 milliseconds). record associated with the node. */ - focusRow?( row?:any, delay?:any ): any; - focusRow?( row?:HTMLElement, delay?:boolean ): void; - focusRow?( row?:string, delay?:boolean ): void; - focusRow?( row?:number, delay?:boolean ): void; - focusRow?( row?:Ext.data.IModel, delay?:boolean ): void; - focusRow?( row?:HTMLElement, delay?:number ): void; - focusRow?( row?:string, delay?:number ): void; - focusRow?( row?:number, delay?:number ): void; - focusRow?( row?:Ext.data.IModel, delay?:number ): void; + focusRow?( row?:any, delay?:any ): void; /** [Method] Returns a CSS selector which selects the outermost element s in this view */ getBodySelector?(): void; /** [Method] Returns a CSS selector which selects a particular column if the desired header is passed or a general cell selector @@ -37051,6 +39267,7 @@ declare module Ext.view { getDataRowSelector?(): void; /** [Method] Get a reference to a feature * @param id String The id of the feature + * @returns Ext.grid.feature.Feature The feature. Undefined if not found */ getFeature?( id?:string ): Ext.grid.feature.IFeature; /** [Method] Returns a CSS selector which selects items of the view rendered by the rowTpl */ @@ -37058,21 +39275,20 @@ declare module Ext.view { /** [Method] Returns the node given the passed Record or index or node * @param nodeInfo HTMLElement/String/Number/Ext.data.Model The node or record * @param dataRow Boolean true to return the data row (not the top level row if wrapped), false to return the top level row. + * @returns HTMLElement The node or null if it wasn't found */ - getNode?( nodeInfo?:any, dataRow?:any ): any; - getNode?( nodeInfo?:HTMLElement, dataRow?:boolean ): HTMLElement; - getNode?( nodeInfo?:string, dataRow?:boolean ): HTMLElement; - getNode?( nodeInfo?:number, dataRow?:boolean ): HTMLElement; - getNode?( nodeInfo?:Ext.data.IModel, dataRow?:boolean ): HTMLElement; + getNode?( nodeInfo?:any, dataRow?:boolean ): HTMLElement; /** [Method] Returns a CSS selector which selects the element which contains record nodes */ getNodeContainerSelector?(): void; /** [Method] Gets the current XY position of the component s underlying element * @param record Object * @param header Object + * @returns Number[] The XY position of the element (e.g., [100, 200]) */ getPosition?( record?:any, header?:any ): number[]; /** [Method] Gets a record from a node * @param node Object + * @returns Ext.data.Model record The Ext.data.Model object */ getRecord?( node?:any ): Ext.data.IModel; /** [Method] Override this function to apply custom CSS classes to rows during rendering @@ -37080,10 +39296,12 @@ declare module Ext.view { * @param index Number The row index. * @param rowParams Object DEPRECATED. For row body use the getAdditionalData method of the rowbody feature. * @param store Ext.data.Store The store this grid is bound to + * @returns String a CSS class name to add to the row. */ getRowClass?( record?:Ext.data.IModel, index?:number, rowParams?:any, store?:Ext.data.IStore ): string; /** [Method] Finds the index of the passed node * @param node Object + * @returns Number The index of the node or -1 */ indexOf?( node?:any ): number; /** [Method] private */ @@ -37096,11 +39314,7 @@ declare module Ext.view { * @param rowInfo HTMLElement/String/Number/Ext.data.Model An HTMLElement, index or instance of a model representing this row * @param cls String */ - removeRowCls?( rowInfo?:any, cls?:any ): any; - removeRowCls?( rowInfo?:HTMLElement, cls?:string ): void; - removeRowCls?( rowInfo?:string, cls?:string ): void; - removeRowCls?( rowInfo?:number, cls?:string ): void; - removeRowCls?( rowInfo?:Ext.data.IModel, cls?:string ): void; + removeRowCls?( rowInfo?:any, cls?:string ): void; /** [Method] Navigates from the passed record by the passed increment which may be ve or ve Skips hidden records * @param startRec Ext.data.Model The Record to start from. * @param distance Number The distance to move from the record. May be +ve or -ve. @@ -37228,6 +39442,7 @@ declare module Ext.window { * @param msg String The message box body text * @param fn Function The callback function invoked after the message box is closed. See show method for details. * @param scope Object The scope (this reference) in which the callback is executed. + * @returns Ext.window.MessageBox this */ alert?( title?:string, msg?:string, fn?:any, scope?:any ): Ext.window.IMessageBox; /** [Method] Displays a confirmation message box with Yes and No buttons comparable to JavaScript s confirm @@ -37235,9 +39450,12 @@ declare module Ext.window { * @param msg String The message box body text * @param fn Function The callback function invoked after the message box is closed. See show method for details. * @param scope Object The scope (this reference) in which the callback is executed. + * @returns Ext.window.MessageBox this */ confirm?( title?:string, msg?:string, fn?:any, scope?:any ): Ext.window.IMessageBox; - /** [Method] Hides this Component setting it to invisible using the configured hideMode */ + /** [Method] Hides this Component setting it to invisible using the configured hideMode + * @returns Ext.Component this + */ hide?(): Ext.IComponent; /** [Method] Allows addition of behavior to the show operation */ onShow?(): void; @@ -37245,6 +39463,7 @@ declare module Ext.window { * @param title String The title bar text * @param msg String The message box body text * @param progressText String The text to display inside the progress bar + * @returns Ext.window.MessageBox this */ progress?( title?:string, msg?:string, progressText?:string ): Ext.window.IMessageBox; /** [Method] Displays a message box with OK and Cancel buttons prompting the user to enter some text comparable to JavaScript s p @@ -37254,30 +39473,33 @@ declare module Ext.window { * @param scope Object The scope (this reference) in which the callback is executed. * @param multiline Boolean/Number True to create a multiline textbox using the defaultTextHeight property, or the height in pixels to create the textbox/ * @param value String Default value of the text input element + * @returns Ext.window.MessageBox this */ - prompt?( title?:any, msg?:any, fn?:any, scope?:any, multiline?:any, value?:any ): any; - prompt?( title?:string, msg?:string, fn?:any, scope?:any, multiline?:boolean, value?:string ): Ext.window.IMessageBox; - prompt?( title?:string, msg?:string, fn?:any, scope?:any, multiline?:number, value?:string ): Ext.window.IMessageBox; + prompt?( title?:string, msg?:string, fn?:any, scope?:any, multiline?:any, value?:string ): Ext.window.IMessageBox; /** [Method] Adds the specified icon to the dialog * @param icon String A CSS classname specifying the icon's background image url, or empty string to clear the icon * @param width Number The width of the icon. If not specified, the default is used * @param height Number The height of the icon. If not specified, the default is used + * @returns Ext.window.MessageBox this */ setIcon?( icon?:string, width?:number, height?:number ): Ext.window.IMessageBox; /** [Method] Displays a new message box or reinitializes an existing message box based on the config options passed in * @param config Object The following config options are supported: + * @returns Ext.window.MessageBox this */ show?( config?:any ): Ext.window.IMessageBox; /** [Method] Updates a progress style message box s text and progress bar * @param value Number Any number between 0 and 1 (e.g., .5) * @param progressText String The progress text to display inside the progress bar. * @param msg String The message box's body text is replaced with the specified string (defaults to undefined so that any existing body text will not get overwritten by default unless a new value is passed in) + * @returns Ext.window.MessageBox this */ updateProgress?( value?:number, progressText?:string, msg?:string ): Ext.window.IMessageBox; /** [Method] Displays a message box with an infinitely auto updating progress bar * @param msg String The message box body text * @param title String The title bar text * @param config Object A Ext.ProgressBar.wait config object + * @returns Ext.window.MessageBox this */ wait?( msg?:string, title?:string, config?:any ): Ext.window.IMessageBox; } @@ -37354,17 +39576,23 @@ declare module Ext.window { getDefaultFocus?(): void; /** [Method] Fits the window within its current container and automatically replaces the maximize tool button with the restore * @param animate Boolean true to animate this Window to full size. + * @returns Ext.window.Window this */ maximize?( animate?:boolean ): Ext.window.IWindow; - /** [Method] Placeholder method for minimizing the window */ + /** [Method] Placeholder method for minimizing the window + * @returns Ext.window.Window this + */ minimize?(): Ext.window.IWindow; /** [Method] Allows addition of behavior to the show operation */ onShow?(): void; /** [Method] Restores a maximized window back to its original size and position prior to being maximized and also replaces the re * @param animate Object + * @returns Ext.window.Window this */ restore?( animate?:any ): Ext.window.IWindow; - /** [Method] A shortcut method for toggling between maximize and restore based on the current maximized state of the window */ + /** [Method] A shortcut method for toggling between maximize and restore based on the current maximized state of the window + * @returns Ext.window.Window this + */ toggleMaximize?(): Ext.window.IWindow; } } @@ -37440,17 +39668,23 @@ declare module Ext { getDefaultFocus?(): void; /** [Method] Fits the window within its current container and automatically replaces the maximize tool button with the restore * @param animate Boolean true to animate this Window to full size. + * @returns Ext.window.Window this */ maximize?( animate?:boolean ): Ext.window.IWindow; - /** [Method] Placeholder method for minimizing the window */ + /** [Method] Placeholder method for minimizing the window + * @returns Ext.window.Window this + */ minimize?(): Ext.window.IWindow; /** [Method] Allows addition of behavior to the show operation */ onShow?(): void; /** [Method] Restores a maximized window back to its original size and position prior to being maximized and also replaces the re * @param animate Object + * @returns Ext.window.Window this */ restore?( animate?:any ): Ext.window.IWindow; - /** [Method] A shortcut method for toggling between maximize and restore based on the current maximized state of the window */ + /** [Method] A shortcut method for toggling between maximize and restore based on the current maximized state of the window + * @returns Ext.window.Window this + */ toggleMaximize?(): Ext.window.IWindow; } } @@ -37460,23 +39694,24 @@ declare module Ext { export class WindowManager { /** [Method] Brings the specified Component to the front of any other active Components in this ZIndexManager * @param comp String/Object The id of the Component or a Ext.Component instance + * @returns Boolean True if the dialog was brought to the front, else false if it was already in front */ static bringToFront( comp?:any ): boolean; /** [Method] Call the original method that was previously overridden with override Ext define My Cat constructor functi * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments) + * @returns Object Returns the result of calling the overridden method */ static callOverridden( args?:any ): any; - static callOverridden( args?:any[] ): any; /** [Method] Call the parent method of the current method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments) + * @returns Object Returns the result of calling the parent method */ static callParent( args?:any ): any; - static callParent( args?:any[] ): any; /** [Method] This method is used by an override to call the superclass method but bypass any overridden method * @param args Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments) + * @returns Object Returns the result of calling the superclass method */ static callSuper( args?:any ): any; - static callSuper( args?:any[] ): any; /** [Method] Executes the specified function once for every Component in this ZIndexManager passing each Component as the only pa * @param fn Function The function to execute for each item * @param scope Object The scope (this reference) in which the function is executed. Defaults to the current Component in the iteration. @@ -37494,23 +39729,29 @@ declare module Ext { static eachTopDown( fn?:any, scope?:any ): void; /** [Method] Gets a registered Component by id * @param id String/Object The id of the Component or a Ext.Component instance + * @returns Ext.Component */ static get( id?:any ): Ext.IComponent; - /** [Method] Gets the currently active Component in this ZIndexManager */ + /** [Method] Gets the currently active Component in this ZIndexManager + * @returns Ext.Component The active Component + */ static getActive(): Ext.IComponent; /** [Method] Returns zero or more Components in this ZIndexManager using the custom search function passed to this method * @param fn Function The search function * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Component being tested. That gets passed to the function if not specified. + * @returns Array An array of zero or more matching windows */ static getBy( fn?:any, scope?:any ): any[]; /** [Method] Returns the initial configuration passed to constructor when instantiating this class * @param name String Name of the config option to return. + * @returns Object/Mixed The full config object or a single config value when name parameter specified. */ static getInitialConfig( name?:string ): any; /** [Method] Hides all Components managed by this ZIndexManager */ static hideAll(): void; /** [Method] Initialize configuration for this class * @param config Object + * @returns Ext.Base this */ static initConfig( config?:any ): Ext.IBase; /** [Method] Registers a floating Ext Component with this ZIndexManager @@ -37519,9 +39760,12 @@ declare module Ext { static register( comp?:Ext.IComponent ): void; /** [Method] Sends the specified Component to the back of other active Components in this ZIndexManager * @param comp String/Object The id of the Component or a Ext.Component instance + * @returns Ext.Component The Component */ static sendToBack( comp?:any ): Ext.IComponent; - /** [Method] Get the reference to the class from which this object was instantiated */ + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; /** [Method] Unregisters a Ext Component from this ZIndexManager * @param comp Ext.Component The Component to unregister. @@ -37537,6 +39781,7 @@ declare module Ext { * @param values Object * @param out Object * @param parent Object + * @returns Array The given out array. */ applyOut?( values?:any, out?:any, parent?:any ): any[]; } @@ -37547,9 +39792,12 @@ declare module Ext { static addMembers( members?:any ): void; /** [Method] Add override static properties of this class * @param members Object + * @returns Ext.Base this */ static addStatics( members?:any ): Ext.IBase; - /** [Method] Create a new instance of this Class */ + /** [Method] Create a new instance of this Class + * @returns Object the created instance. + */ static create(): any; /** [Method] Create aliases for existing prototype methods * @param alias String/Object The new method name, or an object to set multiple aliases. See flexSetter @@ -37559,21 +39807,24 @@ declare module Ext { /** [Method] Creates a template from the passed element s value display none textarea preferred or innerHTML * @param el String/HTMLElement A DOM element or its id * @param config Object Config object + * @returns Ext.Template The created template + */ + static from( el?:any, config?:any ): Ext.ITemplate; + /** [Method] Get the current class name in string format + * @returns String className */ - static from( el?:any, config?:any ): any; - static from( el?:string, config?:any ): Ext.ITemplate; - static from( el?:HTMLElement, config?:any ): Ext.ITemplate; - /** [Method] Get the current class name in string format */ static getName(): string; /** [Method] Gets an XTemplate from an object an instance of an Ext define d class * @param instance Object The object from which to get the XTemplate (must be an instance of an Ext.define'd class). * @param name String The name of the property by which to get the XTemplate. + * @returns Ext.XTemplate The XTemplate instance or null if not found. */ static getTpl( instance?:any, name?:string ): Ext.IXTemplate; /** [Method] Adds members to class */ static implement(): void; /** [Method] Override members of this class * @param members Object The properties to add to this class. This should be specified as an object literal containing one or more properties. + * @returns Ext.Base this class */ static override( members?:any ): Ext.IBase; } @@ -37710,6 +39961,7 @@ declare module Ext { export interface IZIndexManager extends Ext.IBase { /** [Method] Brings the specified Component to the front of any other active Components in this ZIndexManager * @param comp String/Object The id of the Component or a Ext.Component instance + * @returns Boolean True if the dialog was brought to the front, else false if it was already in front */ bringToFront?( comp?:any ): boolean; /** [Method] Executes the specified function once for every Component in this ZIndexManager passing each Component as the only pa @@ -37729,13 +39981,17 @@ declare module Ext { eachTopDown?( fn?:any, scope?:any ): void; /** [Method] Gets a registered Component by id * @param id String/Object The id of the Component or a Ext.Component instance + * @returns Ext.Component */ get?( id?:any ): Ext.IComponent; - /** [Method] Gets the currently active Component in this ZIndexManager */ + /** [Method] Gets the currently active Component in this ZIndexManager + * @returns Ext.Component The active Component + */ getActive?(): Ext.IComponent; /** [Method] Returns zero or more Components in this ZIndexManager using the custom search function passed to this method * @param fn Function The search function * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Component being tested. That gets passed to the function if not specified. + * @returns Array An array of zero or more matching windows */ getBy?( fn?:any, scope?:any ): any[]; /** [Method] Hides all Components managed by this ZIndexManager */ @@ -37746,6 +40002,7 @@ declare module Ext { register?( comp?:Ext.IComponent ): void; /** [Method] Sends the specified Component to the back of other active Components in this ZIndexManager * @param comp String/Object The id of the Component or a Ext.Component instance + * @returns Ext.Component The Component */ sendToBack?( comp?:any ): Ext.IComponent; /** [Method] Unregisters a Ext Component from this ZIndexManager @@ -37758,6 +40015,7 @@ declare module Ext { export interface IWindowGroup extends Ext.IBase { /** [Method] Brings the specified Component to the front of any other active Components in this ZIndexManager * @param comp String/Object The id of the Component or a Ext.Component instance + * @returns Boolean True if the dialog was brought to the front, else false if it was already in front */ bringToFront?( comp?:any ): boolean; /** [Method] Executes the specified function once for every Component in this ZIndexManager passing each Component as the only pa @@ -37777,13 +40035,17 @@ declare module Ext { eachTopDown?( fn?:any, scope?:any ): void; /** [Method] Gets a registered Component by id * @param id String/Object The id of the Component or a Ext.Component instance + * @returns Ext.Component */ get?( id?:any ): Ext.IComponent; - /** [Method] Gets the currently active Component in this ZIndexManager */ + /** [Method] Gets the currently active Component in this ZIndexManager + * @returns Ext.Component The active Component + */ getActive?(): Ext.IComponent; /** [Method] Returns zero or more Components in this ZIndexManager using the custom search function passed to this method * @param fn Function The search function * @param scope Object The scope (this reference) in which the function is executed. Defaults to the Component being tested. That gets passed to the function if not specified. + * @returns Array An array of zero or more matching windows */ getBy?( fn?:any, scope?:any ): any[]; /** [Method] Hides all Components managed by this ZIndexManager */ @@ -37794,6 +40056,7 @@ declare module Ext { register?( comp?:Ext.IComponent ): void; /** [Method] Sends the specified Component to the back of other active Components in this ZIndexManager * @param comp String/Object The id of the Component or a Ext.Component instance + * @returns Ext.Component The Component */ sendToBack?( comp?:any ): Ext.IComponent; /** [Method] Unregisters a Ext Component from this ZIndexManager