From b88f66b4a7375ea4a6fa896df62ce2d645d94a48 Mon Sep 17 00:00:00 2001 From: Brian Kotek Date: Thu, 5 Sep 2013 00:58:21 -0400 Subject: [PATCH] Update Sencha Touch definition to TypeScript 0.9.1 --- sencha_touch/SenchaTouch.d.ts | 15348 ++++++++++++++++++++------------ 1 file changed, 9737 insertions(+), 5611 deletions(-) diff --git a/sencha_touch/SenchaTouch.d.ts b/sencha_touch/SenchaTouch.d.ts index 54d79d3dcd..b2865706dd 100644 --- a/sencha_touch/SenchaTouch.d.ts +++ b/sencha_touch/SenchaTouch.d.ts @@ -14,6 +14,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 @@ -23,12 +24,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 @@ -66,17 +71,29 @@ declare module Ext { left?: any; /** [Config Option] (Number/String) */ right?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns Number + */ getBottom?(): number; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of height */ + /** [Method] Returns the value of height + * @returns String + */ getHeight?(): string; - /** [Method] Returns the value of left */ + /** [Method] Returns the value of left + * @returns Number + */ getLeft?(): number; - /** [Method] Returns the value of right */ + /** [Method] Returns the value of right + * @returns Number + */ getRight?(): number; /** [Method] Sets the value of baseCls * @param baseCls String @@ -120,16 +137,14 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -141,9 +156,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -151,24 +164,22 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 */ static clearListeners(): void; /** [Method] */ @@ -176,71 +187,111 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of async */ + /** [Method] Returns the value of async + * @returns Boolean + */ static getAsync(): boolean; - /** [Method] Returns the value of autoAbort */ + /** [Method] Returns the value of autoAbort + * @returns Boolean + */ static getAutoAbort(): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Returns the value of defaultHeaders */ + /** [Method] Returns the value of defaultHeaders + * @returns Object + */ static getDefaultHeaders(): any; - /** [Method] Returns the value of defaultPostHeader */ + /** [Method] Returns the value of defaultPostHeader + * @returns String + */ static getDefaultPostHeader(): string; - /** [Method] Returns the value of defaultXhrHeader */ + /** [Method] Returns the value of defaultXhrHeader + * @returns String + */ static getDefaultXhrHeader(): string; - /** [Method] Returns the value of disableCaching */ + /** [Method] Returns the value of disableCaching + * @returns Boolean + */ static getDisableCaching(): boolean; - /** [Method] Returns the value of disableCachingParam */ + /** [Method] Returns the value of disableCachingParam + * @returns String + */ static getDisableCachingParam(): string; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ static getExtraParams(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns String + */ static getMethod(): string; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ static getPassword(): string; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ static getTimeout(): number; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ static getUrl(): string; - /** [Method] Returns the value of useDefaultHeader */ + /** [Method] Returns the value of useDefaultHeader + * @returns Boolean + */ static getUseDefaultHeader(): boolean; - /** [Method] Returns the value of useDefaultXhrHeader */ + /** [Method] Returns the value of useDefaultXhrHeader + * @returns Boolean + */ static getUseDefaultXhrHeader(): boolean; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ static getUsername(): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Determines whether this object has a request outstanding * @param request Object The request to check. + * @returns Boolean True if there is an outstanding request. */ static isLoading( request?:any ): boolean; /** [Method] Alias for addManagedListener @@ -250,18 +301,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -269,33 +316,31 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Checks if the response status was successful * @param status Number The status code. * @param xhr Object + * @returns Object An object containing success/status state. */ static parseStatus( status?:number, xhr?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -304,16 +349,14 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -321,20 +364,17 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?: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 post-processing in a callback because it is passed to callback functions.) + * @returns Object/null The request object. This may be used to cancel the request. */ static request( options?:any ): any; /** [Method] Resumes firing events see suspendEvents @@ -352,9 +392,7 @@ declare module Ext { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of defaultHeaders * @param defaultHeaders Object */ @@ -390,6 +428,7 @@ 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] Sets the value of password @@ -416,7 +455,9 @@ declare module Ext { * @param username String */ static setUsername( username?: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] Suspends the firing of all events */ static suspendEvents(): void; @@ -427,35 +468,28 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Uploads a form using a hidden iframe * @param form String/HTMLElement/Ext.Element The form to upload. * @param url String The url to post to. * @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 { @@ -464,28 +498,30 @@ declare module Ext { export class Anim { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param el Object * @param runConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( el?:any, runConfig?:any ): any; /** [Method] Used to run an animation on a specific element @@ -493,10 +529,10 @@ declare module Ext { * @param anim String The animation type, defined in Ext.anims. * @param config Object The config object for the animation. */ - static run( el?:any, anim?:any, config?:any ): any; - static run( el?:Ext.IElement, anim?:string, config?:any ): void; - static run( el?:HTMLElement, anim?:string, config?:any ): void; - /** [Method] Get the reference to the class from which this object was instantiated */ + static run( el?:any, anim?:string, config?:any ): void; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class + */ static statics(): Ext.IClass; } } @@ -506,27 +542,29 @@ declare module Ext { export class AnimationQueue { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] @@ -535,7 +573,9 @@ declare module Ext { * @param args Object */ static start( fn?:any, scope?:any, args?: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] * @param fn Object @@ -569,23 +609,41 @@ declare module Ext.app { url?: string; /** [Method] Starts execution of this Action by calling each of the beforeFilters in turn if any are specified before calling t */ execute?(): void; - /** [Method] Returns the value of action */ + /** [Method] Returns the value of action + * @returns String + */ getAction?(): string; - /** [Method] Returns the value of application */ + /** [Method] Returns the value of application + * @returns Ext.app.Application + */ getApplication?(): Ext.app.IApplication; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Array + */ getArgs?(): any[]; - /** [Method] Returns the value of beforeFilters */ + /** [Method] Returns the value of beforeFilters + * @returns Array + */ getBeforeFilters?(): any[]; - /** [Method] Returns the value of controller */ + /** [Method] Returns the value of controller + * @returns Ext.app.Controller + */ getController?(): Ext.app.IController; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns Object + */ getTitle?(): any; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; /** [Method] Resumes the execution of this Action or starts it if it had not been started already */ resume?(): void; @@ -668,33 +726,48 @@ declare module Ext.app { * @param addToHistory Boolean Sets the browser's url to the action's url. */ dispatch?( action?:Ext.app.IAction, addToHistory?:boolean ): void; - /** [Method] Returns the value of appFolder */ + /** [Method] Returns the value of appFolder + * @returns String + */ getAppFolder?(): string; /** [Method] Returns the Controller instance for the given controller name * @param name String The name of the Controller. * @param profileName String Optional profile name. If passed, this is the same as calling getController('profileName.controllerName'). + * @returns Ext.app.Controller controller instance or undefined. */ getController?( name?:string, profileName?:string ): Ext.app.IController; - /** [Method] Returns the value of controllers */ + /** [Method] Returns the value of controllers + * @returns Array + */ getControllers?(): any[]; - /** [Method] Returns the value of currentProfile */ + /** [Method] Returns the value of currentProfile + * @returns Ext.app.Profile + */ getCurrentProfile?(): Ext.app.IProfile; - /** [Method] Returns the value of history */ + /** [Method] Returns the value of history + * @returns Ext.app.History + */ getHistory?(): Ext.app.IHistory; - /** [Method] Returns the value of launch */ + /** [Method] Returns the value of launch + * @returns Function + */ getLaunch?(): any; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of profiles */ + /** [Method] Returns the value of profiles + * @returns Array + */ getProfiles?(): any[]; - /** [Method] Returns the value of router */ + /** [Method] Returns the value of router + * @returns Ext.app.Router + */ getRouter?(): Ext.app.IRouter; /** [Method] Redirects the browser to the given url * @param url String/Ext.data.Model The String url to redirect to. */ - redirectTo?( url?:any ): any; - redirectTo?( url?:string ): void; - redirectTo?( url?:Ext.data.IModel ): void; + redirectTo?( url?:any ): void; /** [Method] Sets the value of appFolder * @param appFolder String */ @@ -757,16 +830,14 @@ declare module Ext.app { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -778,9 +849,7 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -788,9 +857,7 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -798,52 +865,75 @@ declare module Ext.app { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of application */ + /** [Method] Returns the value of application + * @returns Ext.app.Application + */ getApplication?(): Ext.app.IApplication; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of control */ + /** [Method] Returns the value of control + * @returns Object + */ getControl?(): any; /** [Method] Returns a reference to another Controller * @param controllerName Object * @param profile Object + * @returns Object */ getController?( controllerName?:any, profile?:any ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Returns a reference to a Model * @param modelName Object + * @returns Object */ getModel?( modelName?:any ): any; - /** [Method] Returns the value of models */ + /** [Method] Returns the value of models + * @returns String[] + */ getModels?(): string[]; - /** [Method] Returns the value of refs */ + /** [Method] Returns the value of refs + * @returns Object + */ getRefs?(): any; - /** [Method] Returns the value of routes */ + /** [Method] Returns the value of routes + * @returns Object + */ getRoutes?(): any; - /** [Method] Returns the value of stores */ + /** [Method] Returns the value of stores + * @returns String[] + */ getStores?(): string[]; - /** [Method] Returns the value of views */ + /** [Method] Returns the value of views + * @returns Array + */ getViews?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -853,18 +943,14 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -872,32 +958,30 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Convenient way to redirect to a new url * @param place Object + * @returns Object */ redirectTo?( place?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -906,16 +990,14 @@ declare module Ext.app { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -923,18 +1005,14 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -950,9 +1028,7 @@ declare module Ext.app { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of control * @param control Object */ @@ -990,25 +1066,21 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.app { @@ -1030,16 +1102,14 @@ declare module Ext.app { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -1051,9 +1121,7 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -1061,9 +1129,7 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Navigate to the previous active action */ back?(): void; /** [Method] Removes all listeners for this object */ @@ -1073,33 +1139,44 @@ declare module Ext.app { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of actions */ + /** [Method] Returns the value of actions + * @returns Array + */ getActions?(): any[]; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of token */ + /** [Method] Returns the value of token + * @returns String + */ getToken?(): string; - /** [Method] Returns the value of updateUrl */ + /** [Method] Returns the value of updateUrl + * @returns Boolean + */ getUpdateUrl?(): boolean; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -1109,18 +1186,14 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -1128,28 +1201,25 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -1158,16 +1228,14 @@ declare module Ext.app { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -1175,18 +1243,14 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -1198,9 +1262,7 @@ declare module Ext.app { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -1222,25 +1284,21 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.app { @@ -1265,16 +1323,14 @@ declare module Ext.app { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -1286,9 +1342,7 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -1296,9 +1350,7 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -1306,44 +1358,65 @@ declare module Ext.app { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of application */ + /** [Method] Returns the value of application + * @returns Ext.app.Application + */ getApplication?(): Ext.app.IApplication; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of controllers */ + /** [Method] Returns the value of controllers + * @returns Array + */ getControllers?(): any[]; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of models */ + /** [Method] Returns the value of models + * @returns Array + */ getModels?(): any[]; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of namespace */ + /** [Method] Returns the value of namespace + * @returns String + */ getNamespace?(): string; - /** [Method] Returns the value of stores */ + /** [Method] Returns the value of stores + * @returns Array + */ getStores?(): any[]; - /** [Method] Returns the value of views */ + /** [Method] Returns the value of views + * @returns Array + */ getViews?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; - /** [Method] Determines whether or not this Profile is active on the device isActive is executed on */ + /** [Method] Determines whether or not this Profile is active on the device isActive is executed on + * @returns Boolean True if this Profile should be activated on the device it is running on, false otherwise + */ isActive?(): boolean; /** [Method] The launch function is called by the Application if this Profile s isActive function returned true */ launch?(): void; @@ -1354,18 +1427,14 @@ declare module Ext.app { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -1373,28 +1442,25 @@ declare module Ext.app { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -1403,16 +1469,14 @@ declare module Ext.app { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -1420,18 +1484,14 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -1443,9 +1503,7 @@ declare module Ext.app { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of controllers * @param controllers Array */ @@ -1483,25 +1541,21 @@ declare module Ext.app { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.app { @@ -1516,16 +1570,25 @@ declare module Ext.app { url?: string; /** [Property] (Object) */ paramsInMatchString?: any; - /** [Method] Returns the value of action */ + /** [Method] Returns the value of action + * @returns String + */ getAction?(): string; - /** [Method] Returns the value of conditions */ + /** [Method] Returns the value of conditions + * @returns Object + */ getConditions?(): any; - /** [Method] Returns the value of controller */ + /** [Method] Returns the value of controller + * @returns String + */ getController?(): string; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; /** [Method] Attempts to recognize a given url string and return controller action pair for it * @param url String The url to recognize. + * @returns Object/Boolean The matched data, or false if no match. */ recognize?( url?:string ): any; /** [Method] Sets the value of action @@ -1561,12 +1624,17 @@ declare module Ext.app { * @param fn Function The fn to call */ draw?( fn?:any ): void; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ getDefaults?(): any; - /** [Method] Returns the value of routes */ + /** [Method] Returns the value of routes + * @returns Array + */ getRoutes?(): any[]; /** [Method] Recognizes a url string connected to the Router return the controller action pair plus any additional config associa * @param url String The url to recognize. + * @returns Object/undefined If the url was recognized, the controller and action to call, else undefined. */ recognize?( url?:string ): any; /** [Method] Sets the value of defaults @@ -1585,20 +1653,24 @@ declare module Ext { export class Array { /** [Method] Filter through an array and remove empty item as defined in Ext isEmpty * @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 @@ -1606,28 +1678,33 @@ 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). + * @returns Boolean See description for the fn parameter. */ static each( iterable?:any, fn?:any, scope?:any, reverse?:boolean ): 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] 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 @@ -1639,6 +1716,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. + * @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 @@ -1650,60 +1728,64 @@ 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 on which to replace. * @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 comparison 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 comparison 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] 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 @@ -1711,49 +1793,58 @@ 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 * @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 (can be 0). + * @returns Array An array containing the removed items. */ static splice( array?:any[], index?:number, removeCount?:number ): 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. * @param end Number a zero-based index that specifies the end of extraction. + * @returns Array */ static toArray( iterable?:any, start?:number, end?:number ): 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[]; } @@ -1764,9 +1855,13 @@ declare module Ext { cls?: any; /** [Config Option] (String) */ url?: string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; /** [Method] Sets the value of cls * @param cls String @@ -1784,27 +1879,29 @@ declare module Ext { self?: Ext.IClass; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ destroy?(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ getInitialConfig?( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ initConfig?( instanceConfig?:any ): any; } @@ -1815,23 +1912,29 @@ 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] * @param args Object */ static callParent( args?: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 any className + */ static getName(): 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; } @@ -1858,34 +1961,39 @@ declare module Ext { export class Browser { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] A hybrid property can be either accessed as a method call for example if Ext browser is IE * @param value String The OS name to check. + * @returns Boolean */ static is( value?:string ): 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; } } @@ -1923,33 +2031,61 @@ declare module Ext { text?: string; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of autoEvent */ + /** [Method] Returns the value of autoEvent + * @returns String + */ getAutoEvent?(): string; - /** [Method] Returns the value of badgeCls */ + /** [Method] Returns the value of badgeCls + * @returns String + */ getBadgeCls?(): string; - /** [Method] Returns the value of badgeText */ + /** [Method] Returns the value of badgeText + * @returns String + */ getBadgeText?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of handler */ + /** [Method] Returns the value of handler + * @returns Function + */ getHandler?(): any; - /** [Method] Returns the value of icon */ + /** [Method] Returns the value of icon + * @returns String + */ getIcon?(): string; - /** [Method] Returns the value of iconAlign */ + /** [Method] Returns the value of iconAlign + * @returns String + */ getIconAlign?(): string; - /** [Method] Returns the value of iconCls */ + /** [Method] Returns the value of iconCls + * @returns String + */ getIconCls?(): string; - /** [Method] Returns the value of labelCls */ + /** [Method] Returns the value of labelCls + * @returns String + */ getLabelCls?(): string; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; - /** [Method] Returns the value of pressedDelay */ + /** [Method] Returns the value of pressedDelay + * @returns Number/Boolean + */ getPressedDelay?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; - /** [Method] Returns the value of text */ + /** [Method] Returns the value of text + * @returns String + */ getText?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -2004,9 +2140,7 @@ declare module Ext { /** [Method] Sets the value of pressedDelay * @param pressedDelay Number/Boolean */ - setPressedDelay?( pressedDelay?:any ): any; - setPressedDelay?( pressedDelay?:number ): void; - setPressedDelay?( pressedDelay?:boolean ): void; + setPressedDelay?( pressedDelay?:any ): void; /** [Method] Sets the value of scope * @param scope Object */ @@ -2033,35 +2167,65 @@ declare module Ext.carousel { ui?: string; /** [Method] */ destroy?(): void; - /** [Method] Returns the index of the currently active card */ + /** [Method] Returns the index of the currently active card + * @returns Number The index of the currently active card. + */ getActiveIndex?(): number; - /** [Method] Returns the value of animation */ + /** [Method] Returns the value of animation + * @returns Object + */ getAnimation?(): any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bufferSize */ + /** [Method] Returns the value of bufferSize + * @returns Number + */ getBufferSize?(): number; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of directionLock */ + /** [Method] Returns the value of directionLock + * @returns Boolean + */ getDirectionLock?(): boolean; - /** [Method] Returns the value of indicator */ + /** [Method] Returns the value of indicator + * @returns any + */ getIndicator?(): any; - /** [Method] Returns the value of itemConfig */ + /** [Method] Returns the value of itemConfig + * @returns Object + */ getItemConfig?(): any; - /** [Method] Returns the value of itemLength */ + /** [Method] Returns the value of itemLength + * @returns Object + */ getItemLength?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns true when direction is horizontal */ + /** [Method] Returns true when direction is horizontal + * @returns Boolean + */ isHorizontal?(): boolean; - /** [Method] Returns true when direction is vertical */ + /** [Method] Returns true when direction is vertical + * @returns Boolean + */ isVertical?(): boolean; - /** [Method] Switches to the next card */ + /** [Method] Switches to the next card + * @returns Ext.carousel.Carousel this + */ next?(): Ext.carousel.ICarousel; - /** [Method] Switches to the previous card */ + /** [Method] Switches to the previous card + * @returns Ext.carousel.Carousel this + */ prev?(): Ext.carousel.ICarousel; - /** [Method] Switches to the previous card */ + /** [Method] Switches to the previous card + * @returns Ext.carousel.Carousel this + */ previous?(): Ext.carousel.ICarousel; /** [Method] Sets the value of animation * @param animation Object @@ -2113,35 +2277,65 @@ declare module Ext { ui?: string; /** [Method] */ destroy?(): void; - /** [Method] Returns the index of the currently active card */ + /** [Method] Returns the index of the currently active card + * @returns Number The index of the currently active card. + */ getActiveIndex?(): number; - /** [Method] Returns the value of animation */ + /** [Method] Returns the value of animation + * @returns Object + */ getAnimation?(): any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bufferSize */ + /** [Method] Returns the value of bufferSize + * @returns Number + */ getBufferSize?(): number; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of directionLock */ + /** [Method] Returns the value of directionLock + * @returns Boolean + */ getDirectionLock?(): boolean; - /** [Method] Returns the value of indicator */ + /** [Method] Returns the value of indicator + * @returns any + */ getIndicator?(): any; - /** [Method] Returns the value of itemConfig */ + /** [Method] Returns the value of itemConfig + * @returns Object + */ getItemConfig?(): any; - /** [Method] Returns the value of itemLength */ + /** [Method] Returns the value of itemLength + * @returns Object + */ getItemLength?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns true when direction is horizontal */ + /** [Method] Returns true when direction is horizontal + * @returns Boolean + */ isHorizontal?(): boolean; - /** [Method] Returns true when direction is vertical */ + /** [Method] Returns true when direction is vertical + * @returns Boolean + */ isVertical?(): boolean; - /** [Method] Switches to the next card */ + /** [Method] Switches to the next card + * @returns Ext.carousel.Carousel this + */ next?(): Ext.carousel.ICarousel; - /** [Method] Switches to the previous card */ + /** [Method] Switches to the previous card + * @returns Ext.carousel.Carousel this + */ prev?(): Ext.carousel.ICarousel; - /** [Method] Switches to the previous card */ + /** [Method] Switches to the previous card + * @returns Ext.carousel.Carousel this + */ previous?(): Ext.carousel.ICarousel; /** [Method] Sets the value of animation * @param animation Object @@ -2187,9 +2381,13 @@ declare module Ext.carousel { baseCls?: string; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -2205,11 +2403,17 @@ declare module Ext.carousel { export interface IInfinite extends Ext.carousel.ICarousel { /** [Config Option] (Boolean) */ indicator?: boolean; - /** [Method] Returns the value of indicator */ + /** [Method] Returns the value of indicator + * @returns Object + */ getIndicator?(): any; - /** [Method] Returns the value of innerItemConfig */ + /** [Method] Returns the value of innerItemConfig + * @returns Object + */ getInnerItemConfig?(): any; - /** [Method] Returns the value of maxItemIndex */ + /** [Method] Returns the value of maxItemIndex + * @returns Object + */ getMaxItemIndex?(): any; /** [Method] Sets the value of indicator * @param indicator Object @@ -2231,11 +2435,17 @@ declare module Ext.carousel { baseCls?: string; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of translatable */ + /** [Method] Returns the value of translatable + * @returns Boolean + */ getTranslatable?(): boolean; /** [Method] Sets the value of baseCls * @param baseCls String @@ -2285,43 +2495,70 @@ declare module Ext.chart { bindStore?( store?:Ext.data.IStore ): void; /** [Method] Cancel a scheduled layout */ cancelLayout?(): void; - /** [Method] Returns the value of axes */ + /** [Method] Returns the value of axes + * @returns Ext.chart.axis.Axis/Array/Object + */ getAxes?(): any; - /** [Method] Returns the value of background */ + /** [Method] Returns the value of background + * @returns Object + */ getBackground?(): any; - /** [Method] Returns the value of colors */ + /** [Method] Returns the value of colors + * @returns Boolean/Array + */ getColors?(): any; - /** [Method] Returns the value of highlightItem */ + /** [Method] Returns the value of highlightItem + * @returns Object + */ getHighlightItem?(): any; - /** [Method] Returns the value of innerPadding */ + /** [Method] Returns the value of innerPadding + * @returns Object + */ getInnerPadding?(): any; - /** [Method] Returns the value of insetPadding */ + /** [Method] Returns the value of insetPadding + * @returns Object|Number + */ getInsetPadding?(): any; - /** [Method] Returns the value of interactions */ + /** [Method] Returns the value of interactions + * @returns Array + */ getInteractions?(): any[]; /** [Method] Given an x y point relative to the chart find and return the first series item that matches that point * @param x Number * @param y Number + * @returns Object An object with series and item properties, or false if no item found. */ getItemForPoint?( x?:number, y?:number ): any; /** [Method] Given an x y point relative to the chart find and return all series items that match that point * @param x Number * @param y Number + * @returns Array An array of objects with series and item properties. */ getItemsForPoint?( x?:number, y?:number ): any[]; - /** [Method] Returns the value of legend */ + /** [Method] Returns the value of legend + * @returns Ext.chart.Legend/Object + */ getLegend?(): any; - /** [Method] Return the legend store that contains all the legend information */ + /** [Method] Return the legend store that contains all the legend information + * @returns Ext.data.Store + */ getLegendStore?(): Ext.data.IStore; - /** [Method] Returns the value of series */ + /** [Method] Returns the value of series + * @returns Ext.chart.series.Series/Array + */ getSeries?(): any; - /** [Method] Returns the value of shadow */ + /** [Method] Returns the value of shadow + * @returns Boolean/Object + */ getShadow?(): any; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.Store + */ getStore?(): Ext.data.IStore; /** [Method] Get a surface by the given id or create one if it doesn t exist * @param name Object * @param type Object + * @returns Ext.draw.Surface */ getSurface?( name?:any, type?:any ): Ext.draw.ISurface; /** [Method] Allows addition of behavior to the rendering phase */ @@ -2347,9 +2584,7 @@ declare module Ext.chart { /** [Method] Sets the value of colors * @param colors Boolean/Array */ - setColors?( colors?:any ): any; - setColors?( colors?:boolean ): void; - setColors?( colors?:any[] ): void; + setColors?( colors?:any ): void; /** [Method] Sets the value of highlightItem * @param highlightItem Object */ @@ -2373,9 +2608,7 @@ declare module Ext.chart { /** [Method] Sets the value of series * @param series Ext.chart.series.Series/Array */ - setSeries?( series?:any ): any; - setSeries?( series?:Ext.chart.series.ISeries ): void; - setSeries?( series?:any[] ): void; + setSeries?( series?:any ): void; /** [Method] Sets the value of shadow * @param shadow Boolean/Object */ @@ -2438,16 +2671,14 @@ declare module Ext.chart.axis { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -2459,9 +2690,7 @@ declare module Ext.chart.axis { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -2469,9 +2698,7 @@ declare module Ext.chart.axis { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -2479,78 +2706,128 @@ declare module Ext.chart.axis { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of background */ + /** [Method] Returns the value of background + * @returns Object + */ getBackground?(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of chart */ + /** [Method] Returns the value of chart + * @returns Ext.chart.AbstractChart + */ getChart?(): Ext.chart.IAbstractChart; /** [Method] Mapping data value into coordinate * @param value * * @param field String * @param idx Number * @param items Ext.util.MixedCollection + * @returns Number */ getCoordFor?( value?:any, field?:string, idx?:number, items?:Ext.util.IMixedCollection ): number; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Array + */ getFields?(): any[]; - /** [Method] Returns the value of grid */ + /** [Method] Returns the value of grid + * @returns Object + */ getGrid?(): any; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ getHidden?(): boolean; - /** [Method] Returns the value of increment */ + /** [Method] Returns the value of increment + * @returns Number + */ getIncrement?(): number; - /** [Method] Returns the value of label */ + /** [Method] Returns the value of label + * @returns Object + */ getLabel?(): any; - /** [Method] Returns the value of labelInSpan */ + /** [Method] Returns the value of labelInSpan + * @returns Boolean + */ getLabelInSpan?(): boolean; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object|Ext.chart.axis.layout.Layout + */ getLayout?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of maxZoom */ + /** [Method] Returns the value of maxZoom + * @returns Number + */ getMaxZoom?(): number; - /** [Method] Returns the value of maximum */ + /** [Method] Returns the value of maximum + * @returns Number + */ getMaximum?(): number; - /** [Method] Returns the value of minZoom */ + /** [Method] Returns the value of minZoom + * @returns Number + */ getMinZoom?(): number; - /** [Method] Returns the value of minimum */ + /** [Method] Returns the value of minimum + * @returns Number + */ getMinimum?(): number; - /** [Method] Returns the value of needHighPrecision */ + /** [Method] Returns the value of needHighPrecision + * @returns Boolean + */ getNeedHighPrecision?(): boolean; - /** [Method] Returns the value of position */ + /** [Method] Returns the value of position + * @returns String + */ getPosition?(): string; - /** [Method] Get the range derived from all the bound series */ + /** [Method] Get the range derived from all the bound series + * @returns Array + */ getRange?(): any[]; - /** [Method] Returns the value of renderer */ + /** [Method] Returns the value of renderer + * @returns Function + */ getRenderer?(): any; - /** [Method] Returns the value of segmenter */ + /** [Method] Returns the value of segmenter + * @returns Object|Ext.chart.axis.segmenter.Segmenter + */ getSegmenter?(): any; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns Object + */ getStyle?(): any; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String|Object + */ getTitle?(): any; - /** [Method] Returns the value of titleMargin */ + /** [Method] Returns the value of titleMargin + * @returns Number + */ getTitleMargin?(): number; - /** [Method] Returns the value of visibleRange */ + /** [Method] Returns the value of visibleRange + * @returns Array + */ getVisibleRange?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -2560,18 +2837,14 @@ declare module Ext.chart.axis { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -2579,30 +2852,27 @@ declare module Ext.chart.axis { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Invoked when data has changed */ processData?(): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -2611,16 +2881,14 @@ declare module Ext.chart.axis { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -2628,18 +2896,14 @@ declare module Ext.chart.axis { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Invokes renderFrame on this axis s surface s */ renderFrame?(): void; /** [Method] Resumes firing events see suspendEvents @@ -2653,9 +2917,7 @@ declare module Ext.chart.axis { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of chart * @param chart Ext.chart.AbstractChart */ @@ -2718,6 +2980,7 @@ declare module Ext.chart.axis { setPosition?( position?:string ): void; /** [Method] Sets the value of renderer * @param renderer Function + * @returns String The label to display. */ setRenderer?( renderer?:any ): string; /** [Method] Sets the value of segmenter @@ -2749,25 +3012,21 @@ declare module Ext.chart.axis { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.chart.axis { @@ -2776,9 +3035,13 @@ declare module Ext.chart.axis { layout?: any; /** [Config Option] (Object|Ext.chart.axis.segmenter.Segmenter) */ segmenter?: any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns String + */ getLayout?(): string; - /** [Method] Returns the value of segmenter */ + /** [Method] Returns the value of segmenter + * @returns String + */ getSegmenter?(): string; /** [Method] Sets the value of layout * @param layout String @@ -2796,9 +3059,13 @@ declare module Ext.chart.axis.layout { } declare module Ext.chart.axis.layout { export interface IContinuous extends Ext.chart.axis.layout.ILayout { - /** [Method] Returns the value of adjustMaximumByMajorUnit */ + /** [Method] Returns the value of adjustMaximumByMajorUnit + * @returns Boolean + */ getAdjustMaximumByMajorUnit?(): boolean; - /** [Method] Returns the value of adjustMinimumByMajorUnit */ + /** [Method] Returns the value of adjustMinimumByMajorUnit + * @returns Boolean + */ getAdjustMinimumByMajorUnit?(): boolean; /** [Method] Sets the value of adjustMaximumByMajorUnit * @param adjustMaximumByMajorUnit Boolean @@ -2821,6 +3088,7 @@ declare module Ext.chart.axis.layout { export interface IDiscrete extends Ext.chart.axis.layout.ILayout { /** [Method] Calculates the position of tick marks for the axis * @param context Object + * @returns * */ calculateLayout?( context?:any ): any; /** [Method] Calculates the position of major ticks for the axis @@ -2851,6 +3119,7 @@ declare module Ext.chart.axis.layout { axis?: Ext.chart.axis.IAxis; /** [Method] Calculates the position of tick marks for the axis * @param context Object + * @returns * */ calculateLayout?( context?:any ): any; /** [Method] Calculates the position of major ticks for the axis @@ -2861,7 +3130,9 @@ declare module Ext.chart.axis.layout { * @param context Object */ calculateMinorTicks?( context?:any ): void; - /** [Method] Returns the value of axis */ + /** [Method] Returns the value of axis + * @returns Ext.chart.axis.Axis + */ getAxis?(): Ext.chart.axis.IAxis; /** [Method] Processes the data of the series bound to the axis * @param series Object The bound series. @@ -2893,11 +3164,17 @@ declare module Ext.chart.axis { layout?: any; /** [Config Option] (Object|Ext.chart.axis.segmenter.Segmenter) */ segmenter?: any; - /** [Method] Returns the value of aggregator */ + /** [Method] Returns the value of aggregator + * @returns String + */ getAggregator?(): string; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns String + */ getLayout?(): string; - /** [Method] Returns the value of segmenter */ + /** [Method] Returns the value of segmenter + * @returns String + */ getSegmenter?(): string; /** [Method] Sets the value of aggregator * @param aggregator String @@ -2925,12 +3202,14 @@ declare module Ext.chart.axis.segmenter { * @param value Object * @param step Object * @param unit Object + * @returns * Aligned value. */ align?( value?:any, step?:any, unit?:any ): any; /** [Method] Returns the difference between the min and max value based on the given unit scale * @param min Object * @param max Object * @param unit Object + * @returns Number The number of units between min and max. It is the minimum n that min + n * unit >= max. */ diff?( min?:any, max?:any, unit?:any ): number; /** [Method] Given a start point and estimated step size of a range determine the preferred step size @@ -2938,11 +3217,13 @@ declare module Ext.chart.axis.segmenter { * @param estStepSize Object * @param minIdx Object * @param data Object + * @returns Object Return the step size by an object of step x unit. */ preferredStep?( min?:any, estStepSize?:any, minIdx?:any, data?:any ): any; /** [Method] This method formats the value * @param value Object * @param context Object + * @returns String */ renderer?( value?:any, context?:any ): string; } @@ -2959,22 +3240,26 @@ declare module Ext.chart.axis.segmenter { * @param value Object * @param step Object * @param unit Object + * @returns * Aligned value. */ align?( value?:any, step?:any, unit?:any ): any; /** [Method] Returns the difference between the min and max value based on the given unit scale * @param min Object * @param max Object * @param unit Object + * @returns Number The number of units between min and max. It is the minimum n that min + n * unit >= max. */ diff?( min?:any, max?:any, unit?:any ): number; /** [Method] Given a start point and estimated step size of a range determine the preferred step size * @param min Object * @param estStepSize Object + * @returns Object Return the step size by an object of step x unit. */ preferredStep?( min?:any, estStepSize?:any ): any; /** [Method] This method formats the value * @param value Object * @param context Object + * @returns String */ renderer?( value?:any, context?:any ): string; } @@ -2993,28 +3278,35 @@ declare module Ext.chart.axis.segmenter { * @param value * The value to be aligned. * @param step Number The step of units. * @param unit * The unit. + * @returns * Aligned value. */ align?( value?:any, step?:number, unit?:any ): any; /** [Method] Returns the difference between the min and max value based on the given unit scale * @param min * The smaller value. * @param max * The larger value. * @param unit * The unit scale. Unit can be any type. + * @returns Number The number of units between min and max. It is the minimum n that min + n * unit >= max. */ diff?( min?:any, max?:any, unit?:any ): number; /** [Method] Convert from any data into the target type * @param value * The value to convert from + * @returns * The converted value. */ from?( value?:any ): any; - /** [Method] Returns the value of axis */ + /** [Method] Returns the value of axis + * @returns Ext.chart.axis.Axis + */ getAxis?(): Ext.chart.axis.IAxis; /** [Method] Given a start point and estimated step size of a range determine the preferred step size * @param start * The start point of range. * @param estStepSize * The estimated step size. + * @returns Object Return the step size by an object of step x unit. */ preferredStep?( start?:any, estStepSize?:any ): any; /** [Method] This method formats the value * @param value * The value to format. * @param context Object Axis layout context. + * @returns String */ renderer?( value?:any, context?:any ): string; /** [Method] Sets the value of axis @@ -3037,28 +3329,35 @@ declare module Ext.chart.axis.segmenter { * @param date Object * @param step Object * @param unit Object + * @returns * Aligned value. */ align?( date?:any, step?:any, unit?:any ): any; /** [Method] Returns the difference between the min and max value based on the given unit scale * @param min Object * @param max Object * @param unit Object + * @returns Number The number of units between min and max. It is the minimum n that min + n * unit >= max. */ diff?( min?:any, max?:any, unit?:any ): number; /** [Method] Convert from any data into the target type * @param value Object + * @returns * The converted value. */ from?( value?:any ): any; - /** [Method] Returns the value of step */ + /** [Method] Returns the value of step + * @returns Object + */ getStep?(): any; /** [Method] Given a start point and estimated step size of a range determine the preferred step size * @param min Object * @param estStepSize Object + * @returns Object Return the step size by an object of step x unit. */ preferredStep?( min?:any, estStepSize?:any ): any; /** [Method] This method formats the value * @param value Object * @param context Object + * @returns String */ renderer?( value?:any, context?:any ): string; /** [Method] Sets the value of step @@ -3124,22 +3423,33 @@ declare module Ext.chart.axis.sprite { * @param marker Object {Ext.chart.Markers} */ bindMarker?( name?:any, marker?:any ): void; - /** [Method] Returns the value of axis */ + /** [Method] Returns the value of axis + * @returns Ext.chart.axis.Axis + */ getAxis?(): Ext.chart.axis.IAxis; /** [Method] Returns the bounding box for the given Sprite as calculated with the Canvas engine */ getBBox?(): void; - /** [Method] Returns the value of label */ + /** [Method] Returns the value of label + * @returns Object + */ getLabel?(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object|Ext.chart.axis.layout.Layout + */ getLayout?(): any; - /** [Method] Returns the value of renderer */ + /** [Method] Returns the value of renderer + * @returns Function + */ getRenderer?(): any; - /** [Method] Returns the value of segmenter */ + /** [Method] Returns the value of segmenter + * @returns Object|Ext.chart.axis.segmenter.Segmenter + */ getSegmenter?(): any; /** [Method] Render method * @param surface Object * @param ctx Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any ): any; /** [Method] Sets the value of axis @@ -3180,25 +3490,42 @@ declare module Ext.chart.axis { step?: any[]; /** [Config Option] (Date) */ toDate?: any; - /** [Method] Returns the value of aggregator */ + /** [Method] Returns the value of aggregator + * @returns String + */ getAggregator?(): string; - /** [Method] Returns the value of calculateByLabelSize */ + /** [Method] Returns the value of calculateByLabelSize + * @returns Boolean + */ getCalculateByLabelSize?(): boolean; /** [Method] Mapping data value into coordinate * @param value Object + * @returns Number */ getCoordFor?( value?:any ): number; - /** [Method] Returns the value of dateFormat */ + /** [Method] Returns the value of dateFormat + * @returns String/Boolean + */ getDateFormat?(): any; - /** [Method] Returns the value of fromDate */ + /** [Method] Returns the value of fromDate + * @returns Date + */ getFromDate?(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns String + */ getLayout?(): string; - /** [Method] Returns the value of segmenter */ + /** [Method] Returns the value of segmenter + * @returns String + */ getSegmenter?(): string; - /** [Method] Returns the value of step */ + /** [Method] Returns the value of step + * @returns Array + */ getStep?(): any[]; - /** [Method] Returns the value of toDate */ + /** [Method] Returns the value of toDate + * @returns Date + */ getToDate?(): any; /** [Method] Sets the value of aggregator * @param aggregator String @@ -3211,9 +3538,7 @@ declare module Ext.chart.axis { /** [Method] Sets the value of dateFormat * @param dateFormat String/Boolean */ - setDateFormat?( dateFormat?:any ): any; - setDateFormat?( dateFormat?:string ): void; - setDateFormat?( dateFormat?:boolean ): void; + setDateFormat?( dateFormat?:any ): void; /** [Method] Sets the value of fromDate * @param fromDate Date */ @@ -3240,9 +3565,13 @@ declare module Ext.chart { export interface ICartesianChart extends Ext.chart.IAbstractChart { /** [Config Option] (Boolean) */ flipXY?: boolean; - /** [Method] Returns the value of flipXY */ + /** [Method] Returns the value of flipXY + * @returns Boolean + */ getFlipXY?(): boolean; - /** [Method] Returns the value of innerRegion */ + /** [Method] Returns the value of innerRegion + * @returns Array + */ getInnerRegion?(): any[]; /** [Method] Place water mark after resize */ onPlaceWatermark?(): void; @@ -3264,9 +3593,13 @@ declare module Ext.chart { export interface IChart extends Ext.chart.IAbstractChart { /** [Config Option] (Boolean) */ flipXY?: boolean; - /** [Method] Returns the value of flipXY */ + /** [Method] Returns the value of flipXY + * @returns Boolean + */ getFlipXY?(): boolean; - /** [Method] Returns the value of innerRegion */ + /** [Method] Returns the value of innerRegion + * @returns Array + */ getInnerRegion?(): any[]; /** [Method] Place water mark after resize */ onPlaceWatermark?(): void; @@ -3294,13 +3627,16 @@ declare module Ext.chart.grid { * @param surface Object * @param ctx Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any ): any; } } declare module Ext.chart.grid { export interface IRadialGrid extends Ext.draw.sprite.IPath { - /** [Method] Render method */ + /** [Method] Render method + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. + */ render?(): any; /** [Method] Update the path * @param path Object @@ -3315,6 +3651,7 @@ declare module Ext.chart.grid { * @param surface Object * @param ctx Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any ): any; } @@ -3335,16 +3672,14 @@ declare module Ext.chart.interactions { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -3356,9 +3691,7 @@ declare module Ext.chart.interactions { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -3366,9 +3699,7 @@ declare module Ext.chart.interactions { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -3376,41 +3707,54 @@ declare module Ext.chart.interactions { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of chart */ + /** [Method] Returns the value of chart + * @returns Ext.chart.AbstractChart + */ getChart?(): Ext.chart.IAbstractChart; - /** [Method] Returns the value of enabled */ + /** [Method] Returns the value of enabled + * @returns Boolean + */ getEnabled?(): boolean; - /** [Method] Returns the value of gesture */ + /** [Method] Returns the value of gesture + * @returns String + */ getGesture?(): string; /** [Method] Find and return a single series item corresponding to the given event or null if no matching item is found * @param e Event + * @returns Object the item object or null if none found. */ getItemForEvent?( e?:Event ): any; /** [Method] Find and return all series items corresponding to the given event * @param e Event + * @returns Array array of matching item objects */ getItemsForEvent?( e?:Event ): any[]; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] A method to be implemented by subclasses where all event attachment should occur */ @@ -3422,18 +3766,14 @@ declare module Ext.chart.interactions { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -3441,30 +3781,27 @@ declare module Ext.chart.interactions { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Placeholder method */ onGesture?(): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -3473,16 +3810,14 @@ declare module Ext.chart.interactions { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -3490,18 +3825,14 @@ declare module Ext.chart.interactions { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -3509,9 +3840,7 @@ declare module Ext.chart.interactions { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of chart * @param chart Ext.chart.AbstractChart */ @@ -3537,25 +3866,21 @@ declare module Ext.chart.interactions { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.chart.interactions { @@ -3564,11 +3889,17 @@ declare module Ext.chart.interactions { axes?: any; /** [Config Option] (String) */ gesture?: string; - /** [Method] Returns the value of axes */ + /** [Method] Returns the value of axes + * @returns Object/Array + */ getAxes?(): any; - /** [Method] Returns the value of gesture */ + /** [Method] Returns the value of gesture + * @returns String + */ getGesture?(): string; - /** [Method] Returns the value of undoButton */ + /** [Method] Returns the value of undoButton + * @returns Object + */ getUndoButton?(): any; /** [Method] Placeholder method * @param e Object @@ -3592,7 +3923,9 @@ declare module Ext.chart.interactions { export interface IItemHighlight extends Ext.chart.interactions.IAbstract { /** [Config Option] (String) */ gesture?: string; - /** [Method] Returns the value of gesture */ + /** [Method] Returns the value of gesture + * @returns String + */ getGesture?(): string; /** [Method] Placeholder method * @param series Object @@ -3612,9 +3945,13 @@ declare module Ext.chart.interactions { gesture?: string; /** [Config Option] (Object) */ panel?: any; - /** [Method] Returns the value of gesture */ + /** [Method] Returns the value of gesture + * @returns String + */ getGesture?(): string; - /** [Method] Returns the value of panel */ + /** [Method] Returns the value of panel + * @returns Object + */ getPanel?(): any; /** [Method] Placeholder method * @param series Object @@ -3641,21 +3978,37 @@ declare module Ext.chart.interactions { showOverflowArrows?: boolean; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of axes */ + /** [Method] Returns the value of axes + * @returns Object/Array + */ getAxes?(): any; - /** [Method] Returns the value of hideLabelInGesture */ + /** [Method] Returns the value of hideLabelInGesture + * @returns Boolean + */ getHideLabelInGesture?(): boolean; - /** [Method] Returns the value of maxZoom */ + /** [Method] Returns the value of maxZoom + * @returns Object + */ getMaxZoom?(): any; - /** [Method] Returns the value of minZoom */ + /** [Method] Returns the value of minZoom + * @returns Object + */ getMinZoom?(): any; - /** [Method] Returns the value of modeToggleButton */ + /** [Method] Returns the value of modeToggleButton + * @returns Object + */ getModeToggleButton?(): any; - /** [Method] Returns the value of panGesture */ + /** [Method] Returns the value of panGesture + * @returns String + */ getPanGesture?(): string; - /** [Method] Returns the value of showOverflowArrows */ + /** [Method] Returns the value of showOverflowArrows + * @returns Boolean + */ getShowOverflowArrows?(): boolean; - /** [Method] Returns the value of zoomOnPanGesture */ + /** [Method] Returns the value of zoomOnPanGesture + * @returns Boolean + */ getZoomOnPanGesture?(): boolean; /** [Method] Placeholder method * @param e Object @@ -3699,7 +4052,9 @@ declare module Ext.chart.interactions { export interface IRotate extends Ext.chart.interactions.IAbstract { /** [Config Option] (String) */ gesture?: string; - /** [Method] Returns the value of gesture */ + /** [Method] Returns the value of gesture + * @returns String + */ getGesture?(): string; /** [Method] Placeholder method * @param e Object @@ -3729,6 +4084,7 @@ declare module Ext.chart.label { /** [Method] Invoked when changes need to pushed down to the sprite * @param attr Object * @param changes Object + * @returns Mixed */ pushDown?( attr?:any, changes?:any ): any; } @@ -3737,12 +4093,15 @@ declare module Ext.chart.label { export interface ILabel extends Ext.draw.sprite.IText { /** [Config Option] (Object) */ fx?: any; - /** [Method] Returns the value of fx */ + /** [Method] Returns the value of fx + * @returns Object + */ getFx?(): any; /** [Method] Render method * @param surface Object * @param ctx Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any ): any; /** [Method] Sets the value of fx @@ -3769,23 +4128,41 @@ declare module Ext.chart { position?: string; /** [Config Option] (Boolean) */ toggleable?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of disableSelection */ + /** [Method] Returns the value of disableSelection + * @returns Boolean + */ getDisableSelection?(): boolean; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ getDocked?(): string; - /** [Method] Returns the value of horizontalHeight */ + /** [Method] Returns the value of horizontalHeight + * @returns Number + */ getHorizontalHeight?(): number; - /** [Method] Returns the value of inline */ + /** [Method] Returns the value of inline + * @returns Boolean + */ getInline?(): boolean; - /** [Method] Returns the value of itemTpl */ + /** [Method] Returns the value of itemTpl + * @returns Array + */ getItemTpl?(): any[]; - /** [Method] Returns the value of padding */ + /** [Method] Returns the value of padding + * @returns Number + */ getPadding?(): number; - /** [Method] Returns the value of toggleable */ + /** [Method] Returns the value of toggleable + * @returns Boolean + */ getToggleable?(): boolean; - /** [Method] Returns the value of verticalWidth */ + /** [Method] Returns the value of verticalWidth + * @returns Number + */ getVerticalWidth?(): number; /** [Method] Sets the value of baseCls * @param baseCls String @@ -3844,7 +4221,9 @@ declare module Ext.chart { * @param category String */ clear?( category?:string ): void; - /** [Method] Not supported */ + /** [Method] Not supported + * @returns null + */ getBBox?(): any; /** [Method] * @param category String @@ -3859,13 +4238,12 @@ declare module Ext.chart { * @param canonical Boolean * @param keepRevision Boolean */ - putMarkerFor?( category?:any, markerAttr?:any, index?:any, canonical?:any, keepRevision?:any ): any; - putMarkerFor?( category?:string, markerAttr?:any, index?:string, canonical?:boolean, keepRevision?:boolean ): void; - putMarkerFor?( category?:string, markerAttr?:any, index?:number, canonical?:boolean, keepRevision?:boolean ): void; + putMarkerFor?( category?:string, markerAttr?:any, index?:any, canonical?:boolean, keepRevision?:boolean ): void; /** [Method] Render method * @param surface Object * @param ctx Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any ): any; } @@ -3876,9 +4254,13 @@ declare module Ext.chart { center?: any[]; /** [Config Option] (Number) */ radius?: number; - /** [Method] Returns the value of center */ + /** [Method] Returns the value of center + * @returns Array + */ getCenter?(): any[]; - /** [Method] Returns the value of radius */ + /** [Method] Returns the value of radius + * @returns Number + */ getRadius?(): number; /** [Method] Redraw the chart */ redraw?(): void; @@ -3909,6 +4291,7 @@ declare module Ext.chart.series { /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object * @param y Object + * @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 at least the following: */ getItemForPoint?( x?:any, y?:any ): any; } @@ -3927,13 +4310,21 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of closeField */ + /** [Method] Returns the value of closeField + * @returns String + */ getCloseField?(): string; - /** [Method] Returns the value of highField */ + /** [Method] Returns the value of highField + * @returns String + */ getHighField?(): string; - /** [Method] Returns the value of lowField */ + /** [Method] Returns the value of lowField + * @returns String + */ getLowField?(): string; - /** [Method] Returns the value of openField */ + /** [Method] Returns the value of openField + * @returns String + */ getOpenField?(): string; /** [Method] Sets the value of closeField * @param closeField String @@ -3966,17 +4357,26 @@ declare module Ext.chart.series { /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object * @param y Object + * @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 at least the following: */ getItemForPoint?( x?:any, y?:any ): any; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of xAxis */ + /** [Method] Returns the value of xAxis + * @returns Ext.chart.axis.Axis + */ getXAxis?(): Ext.chart.axis.IAxis; - /** [Method] Returns the value of xField */ + /** [Method] Returns the value of xField + * @returns String + */ getXField?(): string; - /** [Method] Returns the value of yAxis */ + /** [Method] Returns the value of yAxis + * @returns Ext.chart.axis.Axis + */ getYAxis?(): Ext.chart.axis.IAxis; - /** [Method] Returns the value of yField */ + /** [Method] Returns the value of yField + * @returns String + */ getYField?(): string; /** [Method] Provide legend information to target array * @param target Object @@ -4034,45 +4434,83 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of angleField */ + /** [Method] Returns the value of angleField + * @returns String + */ getAngleField?(): string; - /** [Method] Returns the value of center */ + /** [Method] Returns the value of center + * @returns Array + */ getCenter?(): any[]; - /** [Method] Returns the value of colors */ + /** [Method] Returns the value of colors + * @returns Array + */ getColors?(): any[]; - /** [Method] Returns the value of donut */ + /** [Method] Returns the value of donut + * @returns Number + */ getDonut?(): number; - /** [Method] Returns the value of field */ + /** [Method] Returns the value of field + * @returns String + */ getField?(): string; - /** [Method] Returns the value of maximum */ + /** [Method] Returns the value of maximum + * @returns Number + */ getMaximum?(): number; - /** [Method] Returns the value of minimum */ + /** [Method] Returns the value of minimum + * @returns Number + */ getMinimum?(): number; - /** [Method] Returns the value of needle */ + /** [Method] Returns the value of needle + * @returns Boolean + */ getNeedle?(): boolean; - /** [Method] Returns the value of needleLength */ + /** [Method] Returns the value of needleLength + * @returns Number + */ getNeedleLength?(): number; - /** [Method] Returns the value of needleLengthRatio */ + /** [Method] Returns the value of needleLengthRatio + * @returns Number + */ getNeedleLengthRatio?(): number; - /** [Method] Returns the value of needleWidth */ + /** [Method] Returns the value of needleWidth + * @returns Number + */ getNeedleWidth?(): number; - /** [Method] Returns the value of radius */ + /** [Method] Returns the value of radius + * @returns Number + */ getRadius?(): number; - /** [Method] Returns the value of region */ + /** [Method] Returns the value of region + * @returns Array + */ getRegion?(): any[]; - /** [Method] Returns the value of rotation */ + /** [Method] Returns the value of rotation + * @returns Number + */ getRotation?(): number; - /** [Method] Returns the value of sectors */ + /** [Method] Returns the value of sectors + * @returns Array + */ getSectors?(): any[]; - /** [Method] Returns the value of showInLegend */ + /** [Method] Returns the value of showInLegend + * @returns Boolean + */ getShowInLegend?(): boolean; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of totalAngle */ + /** [Method] Returns the value of totalAngle + * @returns Object + */ getTotalAngle?(): any; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number + */ getValue?(): number; - /** [Method] Returns the value of wholeDisk */ + /** [Method] Returns the value of wholeDisk + * @returns Boolean + */ getWholeDisk?(): boolean; /** [Method] Sets the value of angleField * @param angleField String @@ -4172,15 +4610,25 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of aggregator */ + /** [Method] Returns the value of aggregator + * @returns Object + */ getAggregator?(): any; - /** [Method] Returns the value of fill */ + /** [Method] Returns the value of fill + * @returns Boolean + */ getFill?(): boolean; - /** [Method] Returns the value of selectionTolerance */ + /** [Method] Returns the value of selectionTolerance + * @returns Number + */ getSelectionTolerance?(): number; - /** [Method] Returns the value of smooth */ + /** [Method] Returns the value of smooth + * @returns Boolean/Number + */ getSmooth?(): any; - /** [Method] Returns the value of step */ + /** [Method] Returns the value of step + * @returns Boolean + */ getStep?(): boolean; /** [Method] Sets the value of aggregator * @param aggregator Object @@ -4197,9 +4645,7 @@ declare module Ext.chart.series { /** [Method] Sets the value of smooth * @param smooth Boolean/Number */ - setSmooth?( smooth?:any ): any; - setSmooth?( smooth?:boolean ): void; - setSmooth?( smooth?:number ): void; + setSmooth?( smooth?:any ): void; /** [Method] Sets the value of step * @param step Boolean */ @@ -4226,22 +4672,33 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of donut */ + /** [Method] Returns the value of donut + * @returns Boolean/Number + */ getDonut?(): any; /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object * @param y Object + * @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 at least the following: */ getItemForPoint?( x?:any, y?:any ): any; - /** [Method] Returns the value of labelField */ + /** [Method] Returns the value of labelField + * @returns String + */ getLabelField?(): string; - /** [Method] Returns the value of rotation */ + /** [Method] Returns the value of rotation + * @returns Number + */ getRotation?(): number; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns Object + */ getStyle?(): any; - /** [Method] Returns the value of totalAngle */ + /** [Method] Returns the value of totalAngle + * @returns Number + */ getTotalAngle?(): number; /** [Method] Provide legend information to target array * @param target Object @@ -4250,9 +4707,7 @@ declare module Ext.chart.series { /** [Method] Sets the value of donut * @param donut Boolean/Number */ - setDonut?( donut?:any ): any; - setDonut?( donut?:boolean ): void; - setDonut?( donut?:number ): void; + setDonut?( donut?:any ): void; /** [Method] Sets the value of hidden * @param hidden Array */ @@ -4287,19 +4742,31 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of distortion */ + /** [Method] Returns the value of distortion + * @returns Number + */ getDistortion?(): number; - /** [Method] Returns the value of donut */ + /** [Method] Returns the value of donut + * @returns Boolean/Number + */ getDonut?(): any; - /** [Method] Returns the value of field */ + /** [Method] Returns the value of field + * @returns String + */ getField?(): string; - /** [Method] Returns the value of region */ + /** [Method] Returns the value of region + * @returns Array + */ getRegion?(): any[]; - /** [Method] Returns the value of rotation */ + /** [Method] Returns the value of rotation + * @returns Number + */ getRotation?(): number; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of thickness */ + /** [Method] Returns the value of thickness + * @returns Number + */ getThickness?(): number; /** [Method] Sets the value of distortion * @param distortion Number @@ -4308,9 +4775,7 @@ declare module Ext.chart.series { /** [Method] Sets the value of donut * @param donut Boolean/Number */ - setDonut?( donut?:any ): any; - setDonut?( donut?:boolean ): void; - setDonut?( donut?:number ): void; + setDonut?( donut?:any ): void; /** [Method] Sets the value of field * @param field String */ @@ -4347,25 +4812,45 @@ declare module Ext.chart.series { xField?: string; /** [Config Option] (String) */ yField?: string; - /** [Method] Returns the value of center */ + /** [Method] Returns the value of center + * @returns Array + */ getCenter?(): any[]; - /** [Method] Returns the value of offsetX */ + /** [Method] Returns the value of offsetX + * @returns Number + */ getOffsetX?(): number; - /** [Method] Returns the value of offsetY */ + /** [Method] Returns the value of offsetY + * @returns Number + */ getOffsetY?(): number; - /** [Method] Returns the value of radius */ + /** [Method] Returns the value of radius + * @returns Number + */ getRadius?(): number; - /** [Method] Returns the value of rotation */ + /** [Method] Returns the value of rotation + * @returns Number + */ getRotation?(): number; - /** [Method] Returns the value of showInLegend */ + /** [Method] Returns the value of showInLegend + * @returns Boolean + */ getShowInLegend?(): boolean; - /** [Method] Returns the value of xAxis */ + /** [Method] Returns the value of xAxis + * @returns Object + */ getXAxis?(): any; - /** [Method] Returns the value of xField */ + /** [Method] Returns the value of xField + * @returns String + */ getXField?(): string; - /** [Method] Returns the value of yAxis */ + /** [Method] Returns the value of yAxis + * @returns Object + */ getYAxis?(): any; - /** [Method] Returns the value of yField */ + /** [Method] Returns the value of yField + * @returns String + */ getYField?(): string; /** [Method] Sets the value of center * @param center Array @@ -4420,6 +4905,7 @@ declare module Ext.chart.series { /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object * @param y Object + * @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 at least the following: */ getItemForPoint?( x?:any, y?:any ): any; } @@ -4432,7 +4918,9 @@ declare module Ext.chart.series { seriesType?: string; /** [Property] (String) */ type?: string; - /** [Method] Returns the value of itemInstancing */ + /** [Method] Returns the value of itemInstancing + * @returns Object + */ getItemInstancing?(): any; /** [Method] Provide legend information to target array * @param target Object @@ -4496,16 +4984,14 @@ declare module Ext.chart.series { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -4517,9 +5003,7 @@ declare module Ext.chart.series { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -4527,9 +5011,7 @@ declare module Ext.chart.series { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -4537,73 +5019,117 @@ 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 events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of animate */ + /** [Method] Returns the value of animate + * @returns Object + */ getAnimate?(): any; - /** [Method] Returns the value of background */ + /** [Method] Returns the value of background + * @returns Object + */ getBackground?(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of colors */ + /** [Method] Returns the value of colors + * @returns Array + */ getColors?(): any[]; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean|Array + */ getHidden?(): any; - /** [Method] Returns the value of highlightCfg */ + /** [Method] Returns the value of highlightCfg + * @returns Object + */ getHighlightCfg?(): any; - /** [Method] Returns the value of highlightItem */ + /** [Method] Returns the value of highlightItem + * @returns Object + */ getHighlightItem?(): any; /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Number * @param y Number * @param target Object optional target to receive the result + * @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 at least the following: */ getItemForPoint?( x?:number, y?:number, target?:any ): any; - /** [Method] Returns the value of itemInstancing */ + /** [Method] Returns the value of itemInstancing + * @returns Object + */ getItemInstancing?(): any; - /** [Method] Returns the value of label */ + /** [Method] Returns the value of label + * @returns Object + */ getLabel?(): any; - /** [Method] Returns the value of labelField */ + /** [Method] Returns the value of labelField + * @returns String + */ getLabelField?(): string; - /** [Method] Returns the value of labelOverflowPadding */ + /** [Method] Returns the value of labelOverflowPadding + * @returns Number + */ getLabelOverflowPadding?(): number; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of marker */ + /** [Method] Returns the value of marker + * @returns Object + */ getMarker?(): any; - /** [Method] Returns the value of markerSubStyle */ + /** [Method] Returns the value of markerSubStyle + * @returns Object + */ getMarkerSubStyle?(): any; - /** [Method] Returns the value of overlaySurface */ + /** [Method] Returns the value of overlaySurface + * @returns Object + */ getOverlaySurface?(): any; - /** [Method] Returns the value of renderer */ + /** [Method] Returns the value of renderer + * @returns Function + */ getRenderer?(): any; - /** [Method] Returns the value of showInLegend */ + /** [Method] Returns the value of showInLegend + * @returns Boolean + */ getShowInLegend?(): boolean; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns Object + */ getStyle?(): any; - /** [Method] Returns the value of subStyle */ + /** [Method] Returns the value of subStyle + * @returns Object + */ getSubStyle?(): any; - /** [Method] Returns the value of surface */ + /** [Method] Returns the value of surface + * @returns Object + */ getSurface?(): any; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -4613,18 +5139,14 @@ declare module Ext.chart.series { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -4632,25 +5154,21 @@ declare module Ext.chart.series { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Provide legend information to target array * @param target Array The information consists: */ @@ -4658,6 +5176,7 @@ declare module Ext.chart.series { /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -4666,16 +5185,14 @@ declare module Ext.chart.series { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -4683,18 +5200,14 @@ declare module Ext.chart.series { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -4710,9 +5223,7 @@ declare module Ext.chart.series { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of colors * @param colors Array */ @@ -4720,9 +5231,7 @@ declare module Ext.chart.series { /** [Method] Sets the value of hidden * @param hidden Boolean|Array */ - setHidden?( hidden?:any ): any; - setHidden?( hidden?:boolean ): void; - setHidden?( hidden?:any[] ): void; + setHidden?( hidden?:any ): void; /** [Method] * @param index Number * @param value Boolean @@ -4770,6 +5279,7 @@ declare module Ext.chart.series { setOverlaySurface?( overlaySurface?:any ): void; /** [Method] Sets the value of renderer * @param renderer Function + * @returns Object The attributes that have been changed or added. Note: it is usually possible to add or modify the attributes directly into the config parameter and not return anything, but returning an object with only those attributes that have been changed may allow for optimizations in the rendering of some series. Example to draw every other item in red: renderer: function (sprite, config, rendererData, index) { if (index % 2 == 0) { return { strokeStyle: 'red' }; } } */ setRenderer?( renderer?:any ): any; /** [Method] Sets the value of showInLegend @@ -4805,25 +5315,21 @@ declare module Ext.chart.series { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.chart.series.sprite { @@ -4836,7 +5342,9 @@ declare module Ext.chart.series.sprite { dataLow?: any; /** [Config Option] (Object) */ dataOpen?: any; - /** [Method] Returns the value of aggregator */ + /** [Method] Returns the value of aggregator + * @returns Object + */ getAggregator?(): any; /** [Method] Render the given visible clip range * @param surface Object @@ -4879,6 +5387,7 @@ declare module Ext.chart.series.sprite { /** [Method] Get the nearest item index from point x y * @param x Object * @param y Object + * @returns Number The index */ getIndexNearPoint?( x?:any, y?:any ): number; /** [Method] Render the given visible clip range @@ -4925,6 +5434,7 @@ declare module Ext.chart.series.sprite { selectionTolerance?: number; /** [Method] Does a binary search of the data on the x axis using the given key * @param key Object + * @returns * */ binarySearch?( key?:any ): any; /** [Method] @@ -4932,19 +5442,25 @@ declare module Ext.chart.series.sprite { * @param marker Object {Ext.chart.Markers} */ bindMarker?( name?:any, marker?:any ): void; - /** [Method] Returns the value of field */ + /** [Method] Returns the value of field + * @returns String + */ getField?(): string; - /** [Method] Returns the value of flipXY */ + /** [Method] Returns the value of flipXY + * @returns Boolean + */ getFlipXY?(): boolean; /** [Method] Get the nearest item index from point x y * @param x Number * @param y Number + * @returns Number The index */ getIndexNearPoint?( x?:number, y?:number ): number; /** [Method] Render method * @param surface Object * @param ctx Object * @param region Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, region?:any ): any; /** [Method] Render the given visible clip range @@ -5044,12 +5560,15 @@ declare module Ext.chart.series.sprite { * @param marker Object {Ext.chart.Markers} */ bindMarker?( name?:any, marker?:any ): void; - /** [Method] Returns the value of rendererIndex */ + /** [Method] Returns the value of rendererIndex + * @returns Number + */ getRendererIndex?(): number; /** [Method] Render method * @param ctx Object * @param surface Object * @param clipRegion Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( ctx?:any, surface?:any, clipRegion?:any ): any; /** [Method] Sets the value of rendererIndex @@ -5095,7 +5614,9 @@ declare module Ext.chart.series.sprite { * @param marker Object {Ext.chart.Markers} */ bindMarker?( name?:any, marker?:any ): void; - /** [Method] Returns the value of field */ + /** [Method] Returns the value of field + * @returns Object + */ getField?(): any; /** [Method] Sets the value of field * @param field Object @@ -5112,6 +5633,7 @@ declare module Ext.chart.series.sprite { /** [Method] Render method * @param surface Object * @param ctx Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any ): any; } @@ -5132,6 +5654,7 @@ declare module Ext.chart.series.sprite { /** [Method] Get the nearest item index from point x y * @param x Object * @param y Object + * @returns Number The index */ getIndexNearPoint?( x?:any, y?:any ): number; } @@ -5145,11 +5668,14 @@ declare module Ext.chart.series { /** [Method] For a given x y point relative to the main region find a corresponding item from this series if any * @param x Object * @param y Object + * @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 at least the following: */ getItemForPoint?( x?:any, y?:any ): any; /** [Method] Performs drawing of this series */ getSprites?(): void; - /** [Method] Returns the value of stacked */ + /** [Method] Returns the value of stacked + * @returns Boolean + */ getStacked?(): boolean; /** [Method] Provide legend information to target array * @param target Object @@ -5201,70 +5727,83 @@ 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] 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] Get the name of the class by its reference or its instance usually invoked by the shorthand Ext getClassName Ext Cl * @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 Array classNames */ static getNamesByExpression( expression?:string ): any[]; /** [Method] Instantiate a class by either full name alias or alternate name usually invoked by the convenient shorthand Ext cre * @param name String * @param args Mixed Additional arguments after the name will be passed to the class' constructor. + * @returns Object instance */ static instantiate( name?:string, args?:any ): any; /** [Method] Instantiate a class by its alias usually invoked by the convenient shorthand Ext createByAlias If Ext Loader is enab * @param alias String * @param args Mixed... 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 * @param name String * @param value Mixed @@ -5392,111 +5931,209 @@ declare module Ext { disable?(): void; /** [Method] Enables this Component */ enable?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of border */ + /** [Method] Returns the value of border + * @returns Number/String + */ getBorder?(): any; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns any + */ getBottom?(): any; - /** [Method] Returns the value of centered */ + /** [Method] Returns the value of centered + * @returns Boolean + */ getCentered?(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns any + */ getCls?(): any; - /** [Method] Returns the value of contentEl */ + /** [Method] Returns the value of contentEl + * @returns Ext.Element/HTMLElement/String + */ getContentEl?(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ getDisabled?(): boolean; - /** [Method] Returns the value of disabledCls */ + /** [Method] Returns the value of disabledCls + * @returns String + */ getDisabledCls?(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ getDocked?(): string; - /** [Method] Retrieves the top level element representing this component */ + /** [Method] Retrieves the top level element representing this component + * @returns Ext.dom.Element + */ getEl?(): Ext.dom.IElement; - /** [Method] Returns the value of enterAnimation */ + /** [Method] Returns the value of enterAnimation + * @returns String/Mixed + */ getEnterAnimation?(): any; - /** [Method] Returns the value of exitAnimation */ + /** [Method] Returns the value of exitAnimation + * @returns String/Mixed + */ getExitAnimation?(): any; - /** [Method] Returns the value of flex */ + /** [Method] Returns the value of flex + * @returns Number + */ getFlex?(): number; - /** [Method] Returns the value of floatingCls */ + /** [Method] Returns the value of floatingCls + * @returns String + */ getFloatingCls?(): string; - /** [Method] Returns the value of height */ + /** [Method] Returns the value of height + * @returns Number/String + */ getHeight?(): any; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ getHidden?(): boolean; - /** [Method] Returns the value of hiddenCls */ + /** [Method] Returns the value of hiddenCls + * @returns String + */ getHiddenCls?(): string; - /** [Method] Returns the value of hideAnimation */ + /** [Method] Returns the value of hideAnimation + * @returns String/Mixed + */ getHideAnimation?(): any; - /** [Method] Returns the value of html */ + /** [Method] Returns the value of html + * @returns String/Ext.Element/HTMLElement + */ getHtml?(): any; - /** [Method] Returns the value of itemId */ + /** [Method] Returns the value of itemId + * @returns String + */ getItemId?(): string; - /** [Method] Returns the value of left */ + /** [Method] Returns the value of left + * @returns Number/String + */ getLeft?(): any; - /** [Method] Returns the value of margin */ + /** [Method] Returns the value of margin + * @returns Number/String + */ getMargin?(): any; - /** [Method] Returns the value of maxHeight */ + /** [Method] Returns the value of maxHeight + * @returns Number/String + */ getMaxHeight?(): any; - /** [Method] Returns the value of maxWidth */ + /** [Method] Returns the value of maxWidth + * @returns Number/String + */ getMaxWidth?(): any; - /** [Method] Returns the value of minHeight */ + /** [Method] Returns the value of minHeight + * @returns Number/String + */ getMinHeight?(): any; - /** [Method] Returns the value of minWidth */ + /** [Method] Returns the value of minWidth + * @returns Number/String + */ getMinWidth?(): any; - /** [Method] Returns the value of padding */ + /** [Method] Returns the value of padding + * @returns Number/String + */ getPadding?(): any; - /** [Method] Returns the parent of this component if it has one */ + /** [Method] Returns the parent of this component if it has one + * @returns Ext.Component The parent of this component. + */ getParent?(): Ext.IComponent; - /** [Method] Returns the value of plugins */ + /** [Method] Returns the value of plugins + * @returns Object/Array + */ getPlugins?(): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of renderTo */ + /** [Method] Returns the value of renderTo + * @returns Ext.Element + */ getRenderTo?(): Ext.IElement; - /** [Method] Returns the value of right */ + /** [Method] Returns the value of right + * @returns Number/String + */ getRight?(): any; - /** [Method] Returns the value of showAnimation */ + /** [Method] Returns the value of showAnimation + * @returns String/Mixed + */ getShowAnimation?(): any; - /** [Method] Returns the height and width of the Component */ + /** [Method] Returns the height and width of the Component + * @returns Object The current height and width of the Component. + */ getSize?(): any; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns String/Object + */ getStyle?(): any; - /** [Method] Returns the value of styleHtmlCls */ + /** [Method] Returns the value of styleHtmlCls + * @returns String + */ getStyleHtmlCls?(): string; - /** [Method] Returns the value of styleHtmlContent */ + /** [Method] Returns the value of styleHtmlContent + * @returns Boolean + */ getStyleHtmlContent?(): boolean; - /** [Method] Returns the value of top */ + /** [Method] Returns the value of top + * @returns Number/String + */ getTop?(): any; - /** [Method] Returns the value of tpl */ + /** [Method] Returns the value of tpl + * @returns String/String[]/Ext.Template[]/Ext.XTemplate[] + */ getTpl?(): any; - /** [Method] Returns the value of tplWriteMode */ + /** [Method] Returns the value of tplWriteMode + * @returns String + */ getTplWriteMode?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of width */ + /** [Method] Returns the value of width + * @returns Number/String + */ getWidth?(): any; - /** [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] Returns the value of zIndex */ + /** [Method] Returns the value of zIndex + * @returns Number + */ getZIndex?(): number; - /** [Method] Returns true if this component has a parent */ + /** [Method] Returns true if this component has a parent + * @returns Boolean true if this component has a parent. + */ hasParent?(): boolean; /** [Method] Hides this Component * @param animation Object/Boolean + * @returns Ext.Component */ hide?( animation?:any ): Ext.IComponent; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; - /** [Method] Returns true if this Component is currently disabled */ + /** [Method] Returns true if this Component is currently disabled + * @returns Boolean true if currently disabled. + */ isDisabled?(): boolean; - /** [Method] Returns true if this Component is currently hidden */ + /** [Method] Returns true if this Component is currently hidden + * @returns Boolean true if currently hidden. + */ isHidden?(): 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 false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype. + * @returns Boolean true if this component descends from the specified xtype, false otherwise. */ isXType?( xtype?:string, shallow?:boolean ): boolean; /** [Method] Removes the given CSS class es from this Component s rendered element @@ -5521,15 +6158,11 @@ declare module Ext { /** [Method] Sets the value of border * @param border Number/String */ - setBorder?( border?:any ): any; - setBorder?( border?:number ): void; - setBorder?( border?:string ): void; + setBorder?( border?:any ): void; /** [Method] Sets the value of bottom * @param bottom Number/String */ - setBottom?( bottom?:any ): any; - setBottom?( bottom?:number ): void; - setBottom?( bottom?:string ): void; + setBottom?( bottom?:any ): void; /** [Method] Sets the value of centered * @param centered Boolean */ @@ -5537,16 +6170,11 @@ declare module Ext { /** [Method] Sets the value of cls * @param cls String/String[] */ - setCls?( cls?:any ): any; - setCls?( cls?:string ): void; - setCls?( cls?:string[] ): void; + setCls?( cls?:any ): void; /** [Method] Sets the value of contentEl * @param contentEl Ext.Element/HTMLElement/String */ - setContentEl?( contentEl?:any ): any; - setContentEl?( contentEl?:Ext.IElement ): void; - setContentEl?( contentEl?:HTMLElement ): void; - setContentEl?( contentEl?:string ): void; + setContentEl?( contentEl?:any ): void; /** [Method] Sets the value of data * @param data Object */ @@ -5570,13 +6198,11 @@ declare module Ext { /** [Method] Sets the value of enterAnimation * @param enterAnimation String/Mixed */ - setEnterAnimation?( enterAnimation?:any ): any; - setEnterAnimation?( enterAnimation?:string ): void; + setEnterAnimation?( enterAnimation?:any ): void; /** [Method] Sets the value of exitAnimation * @param exitAnimation String/Mixed */ - setExitAnimation?( exitAnimation?:any ): any; - setExitAnimation?( exitAnimation?:string ): void; + setExitAnimation?( exitAnimation?:any ): void; /** [Method] Sets the value of flex * @param flex Number */ @@ -5592,9 +6218,7 @@ declare module Ext { /** [Method] Sets the value of height * @param height Number/String */ - setHeight?( height?:any ): any; - setHeight?( height?:number ): void; - setHeight?( height?:string ): void; + setHeight?( height?:any ): void; /** [Method] Sets the value of hidden * @param hidden Boolean */ @@ -5606,15 +6230,11 @@ declare module Ext { /** [Method] Sets the value of hideAnimation * @param hideAnimation String/Mixed */ - setHideAnimation?( hideAnimation?:any ): any; - setHideAnimation?( hideAnimation?:string ): void; + setHideAnimation?( hideAnimation?:any ): void; /** [Method] Sets the value of html * @param html String/Ext.Element/HTMLElement */ - setHtml?( html?:any ): any; - setHtml?( html?:string ): void; - setHtml?( html?:Ext.IElement ): void; - setHtml?( html?:HTMLElement ): void; + setHtml?( html?:any ): void; /** [Method] Sets the value of itemId * @param itemId String */ @@ -5622,45 +6242,31 @@ declare module Ext { /** [Method] Sets the value of left * @param left Number/String */ - setLeft?( left?:any ): any; - setLeft?( left?:number ): void; - setLeft?( left?:string ): void; + setLeft?( left?:any ): void; /** [Method] Sets the value of margin * @param margin Number/String */ - setMargin?( margin?:any ): any; - setMargin?( margin?:number ): void; - setMargin?( margin?:string ): void; + setMargin?( margin?:any ): void; /** [Method] Sets the value of maxHeight * @param maxHeight Number/String */ - setMaxHeight?( maxHeight?:any ): any; - setMaxHeight?( maxHeight?:number ): void; - setMaxHeight?( maxHeight?:string ): void; + setMaxHeight?( maxHeight?:any ): void; /** [Method] Sets the value of maxWidth * @param maxWidth Number/String */ - setMaxWidth?( maxWidth?:any ): any; - setMaxWidth?( maxWidth?:number ): void; - setMaxWidth?( maxWidth?:string ): void; + setMaxWidth?( maxWidth?:any ): void; /** [Method] Sets the value of minHeight * @param minHeight Number/String */ - setMinHeight?( minHeight?:any ): any; - setMinHeight?( minHeight?:number ): void; - setMinHeight?( minHeight?:string ): void; + setMinHeight?( minHeight?:any ): void; /** [Method] Sets the value of minWidth * @param minWidth Number/String */ - setMinWidth?( minWidth?:any ): any; - setMinWidth?( minWidth?:number ): void; - setMinWidth?( minWidth?:string ): void; + setMinWidth?( minWidth?:any ): void; /** [Method] Sets the value of padding * @param padding Number/String */ - setPadding?( padding?:any ): any; - setPadding?( padding?:number ): void; - setPadding?( padding?:string ): void; + setPadding?( padding?:any ): void; /** [Method] Sets the value of plugins * @param plugins Object/Array */ @@ -5676,16 +6282,13 @@ declare module Ext { /** [Method] Sets the value of right * @param right Number/String */ - setRight?( right?:any ): any; - setRight?( right?:number ): void; - setRight?( right?:string ): void; + setRight?( right?:any ): void; /** [Method] This method has moved to Ext Container */ setScrollable?(): void; /** [Method] Sets the value of showAnimation * @param showAnimation String/Mixed */ - setShowAnimation?( showAnimation?:any ): any; - setShowAnimation?( showAnimation?:string ): void; + setShowAnimation?( showAnimation?:any ): void; /** [Method] Sets the size of the Component * @param width Number The new width for the Component. * @param height Number The new height for the Component. @@ -5706,17 +6309,11 @@ declare module Ext { /** [Method] Sets the value of top * @param top Number/String */ - setTop?( top?:any ): any; - setTop?( top?:number ): void; - setTop?( top?:string ): void; + setTop?( top?:any ): void; /** [Method] Sets the value of tpl * @param tpl String/String[]/Ext.Template[]/Ext.XTemplate[] */ - setTpl?( tpl?:any ): any; - setTpl?( tpl?:string ): void; - setTpl?( tpl?:string[] ): void; - setTpl?( tpl?:Ext.ITemplate[] ): void; - setTpl?( tpl?:Ext.IXTemplate[] ): void; + setTpl?( tpl?:any ): void; /** [Method] Sets the value of tplWriteMode * @param tplWriteMode String */ @@ -5728,15 +6325,14 @@ declare module Ext { /** [Method] Sets the value of width * @param width Number/String */ - setWidth?( width?:any ): any; - setWidth?( width?:number ): void; - setWidth?( width?:string ): void; + setWidth?( width?:any ): void; /** [Method] Sets the value of zIndex * @param zIndex Number */ setZIndex?( zIndex?:number ): void; /** [Method] Shows this component * @param animation Object/Boolean + * @returns Ext.Component */ show?( animation?:any ): Ext.IComponent; /** [Method] Shows this component by another component @@ -5746,6 +6342,7 @@ declare module Ext { showBy?( component?:Ext.IComponent, alignment?:string ): void; /** [Method] Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector * @param selector String The simple selector to test. + * @returns Ext.Container The matching ancestor Container (or undefined if no match was found). */ up?( selector?:string ): Ext.IContainer; /** [Method] Updates the HTML content of the Component */ @@ -5877,111 +6474,209 @@ declare module Ext.lib { disable?(): void; /** [Method] Enables this Component */ enable?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of border */ + /** [Method] Returns the value of border + * @returns Number/String + */ getBorder?(): any; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns any + */ getBottom?(): any; - /** [Method] Returns the value of centered */ + /** [Method] Returns the value of centered + * @returns Boolean + */ getCentered?(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns any + */ getCls?(): any; - /** [Method] Returns the value of contentEl */ + /** [Method] Returns the value of contentEl + * @returns Ext.Element/HTMLElement/String + */ getContentEl?(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ getDisabled?(): boolean; - /** [Method] Returns the value of disabledCls */ + /** [Method] Returns the value of disabledCls + * @returns String + */ getDisabledCls?(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ getDocked?(): string; - /** [Method] Retrieves the top level element representing this component */ + /** [Method] Retrieves the top level element representing this component + * @returns Ext.dom.Element + */ getEl?(): Ext.dom.IElement; - /** [Method] Returns the value of enterAnimation */ + /** [Method] Returns the value of enterAnimation + * @returns String/Mixed + */ getEnterAnimation?(): any; - /** [Method] Returns the value of exitAnimation */ + /** [Method] Returns the value of exitAnimation + * @returns String/Mixed + */ getExitAnimation?(): any; - /** [Method] Returns the value of flex */ + /** [Method] Returns the value of flex + * @returns Number + */ getFlex?(): number; - /** [Method] Returns the value of floatingCls */ + /** [Method] Returns the value of floatingCls + * @returns String + */ getFloatingCls?(): string; - /** [Method] Returns the value of height */ + /** [Method] Returns the value of height + * @returns Number/String + */ getHeight?(): any; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ getHidden?(): boolean; - /** [Method] Returns the value of hiddenCls */ + /** [Method] Returns the value of hiddenCls + * @returns String + */ getHiddenCls?(): string; - /** [Method] Returns the value of hideAnimation */ + /** [Method] Returns the value of hideAnimation + * @returns String/Mixed + */ getHideAnimation?(): any; - /** [Method] Returns the value of html */ + /** [Method] Returns the value of html + * @returns String/Ext.Element/HTMLElement + */ getHtml?(): any; - /** [Method] Returns the value of itemId */ + /** [Method] Returns the value of itemId + * @returns String + */ getItemId?(): string; - /** [Method] Returns the value of left */ + /** [Method] Returns the value of left + * @returns Number/String + */ getLeft?(): any; - /** [Method] Returns the value of margin */ + /** [Method] Returns the value of margin + * @returns Number/String + */ getMargin?(): any; - /** [Method] Returns the value of maxHeight */ + /** [Method] Returns the value of maxHeight + * @returns Number/String + */ getMaxHeight?(): any; - /** [Method] Returns the value of maxWidth */ + /** [Method] Returns the value of maxWidth + * @returns Number/String + */ getMaxWidth?(): any; - /** [Method] Returns the value of minHeight */ + /** [Method] Returns the value of minHeight + * @returns Number/String + */ getMinHeight?(): any; - /** [Method] Returns the value of minWidth */ + /** [Method] Returns the value of minWidth + * @returns Number/String + */ getMinWidth?(): any; - /** [Method] Returns the value of padding */ + /** [Method] Returns the value of padding + * @returns Number/String + */ getPadding?(): any; - /** [Method] Returns the parent of this component if it has one */ + /** [Method] Returns the parent of this component if it has one + * @returns Ext.Component The parent of this component. + */ getParent?(): Ext.IComponent; - /** [Method] Returns the value of plugins */ + /** [Method] Returns the value of plugins + * @returns Object/Array + */ getPlugins?(): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of renderTo */ + /** [Method] Returns the value of renderTo + * @returns Ext.Element + */ getRenderTo?(): Ext.IElement; - /** [Method] Returns the value of right */ + /** [Method] Returns the value of right + * @returns Number/String + */ getRight?(): any; - /** [Method] Returns the value of showAnimation */ + /** [Method] Returns the value of showAnimation + * @returns String/Mixed + */ getShowAnimation?(): any; - /** [Method] Returns the height and width of the Component */ + /** [Method] Returns the height and width of the Component + * @returns Object The current height and width of the Component. + */ getSize?(): any; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns String/Object + */ getStyle?(): any; - /** [Method] Returns the value of styleHtmlCls */ + /** [Method] Returns the value of styleHtmlCls + * @returns String + */ getStyleHtmlCls?(): string; - /** [Method] Returns the value of styleHtmlContent */ + /** [Method] Returns the value of styleHtmlContent + * @returns Boolean + */ getStyleHtmlContent?(): boolean; - /** [Method] Returns the value of top */ + /** [Method] Returns the value of top + * @returns Number/String + */ getTop?(): any; - /** [Method] Returns the value of tpl */ + /** [Method] Returns the value of tpl + * @returns String/String[]/Ext.Template[]/Ext.XTemplate[] + */ getTpl?(): any; - /** [Method] Returns the value of tplWriteMode */ + /** [Method] Returns the value of tplWriteMode + * @returns String + */ getTplWriteMode?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of width */ + /** [Method] Returns the value of width + * @returns Number/String + */ getWidth?(): any; - /** [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] Returns the value of zIndex */ + /** [Method] Returns the value of zIndex + * @returns Number + */ getZIndex?(): number; - /** [Method] Returns true if this component has a parent */ + /** [Method] Returns true if this component has a parent + * @returns Boolean true if this component has a parent. + */ hasParent?(): boolean; /** [Method] Hides this Component * @param animation Object/Boolean + * @returns Ext.Component */ hide?( animation?:any ): Ext.IComponent; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; - /** [Method] Returns true if this Component is currently disabled */ + /** [Method] Returns true if this Component is currently disabled + * @returns Boolean true if currently disabled. + */ isDisabled?(): boolean; - /** [Method] Returns true if this Component is currently hidden */ + /** [Method] Returns true if this Component is currently hidden + * @returns Boolean true if currently hidden. + */ isHidden?(): 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 false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype. + * @returns Boolean true if this component descends from the specified xtype, false otherwise. */ isXType?( xtype?:string, shallow?:boolean ): boolean; /** [Method] Removes the given CSS class es from this Component s rendered element @@ -6006,15 +6701,11 @@ declare module Ext.lib { /** [Method] Sets the value of border * @param border Number/String */ - setBorder?( border?:any ): any; - setBorder?( border?:number ): void; - setBorder?( border?:string ): void; + setBorder?( border?:any ): void; /** [Method] Sets the value of bottom * @param bottom Number/String */ - setBottom?( bottom?:any ): any; - setBottom?( bottom?:number ): void; - setBottom?( bottom?:string ): void; + setBottom?( bottom?:any ): void; /** [Method] Sets the value of centered * @param centered Boolean */ @@ -6022,16 +6713,11 @@ declare module Ext.lib { /** [Method] Sets the value of cls * @param cls String/String[] */ - setCls?( cls?:any ): any; - setCls?( cls?:string ): void; - setCls?( cls?:string[] ): void; + setCls?( cls?:any ): void; /** [Method] Sets the value of contentEl * @param contentEl Ext.Element/HTMLElement/String */ - setContentEl?( contentEl?:any ): any; - setContentEl?( contentEl?:Ext.IElement ): void; - setContentEl?( contentEl?:HTMLElement ): void; - setContentEl?( contentEl?:string ): void; + setContentEl?( contentEl?:any ): void; /** [Method] Sets the value of data * @param data Object */ @@ -6055,13 +6741,11 @@ declare module Ext.lib { /** [Method] Sets the value of enterAnimation * @param enterAnimation String/Mixed */ - setEnterAnimation?( enterAnimation?:any ): any; - setEnterAnimation?( enterAnimation?:string ): void; + setEnterAnimation?( enterAnimation?:any ): void; /** [Method] Sets the value of exitAnimation * @param exitAnimation String/Mixed */ - setExitAnimation?( exitAnimation?:any ): any; - setExitAnimation?( exitAnimation?:string ): void; + setExitAnimation?( exitAnimation?:any ): void; /** [Method] Sets the value of flex * @param flex Number */ @@ -6077,9 +6761,7 @@ declare module Ext.lib { /** [Method] Sets the value of height * @param height Number/String */ - setHeight?( height?:any ): any; - setHeight?( height?:number ): void; - setHeight?( height?:string ): void; + setHeight?( height?:any ): void; /** [Method] Sets the value of hidden * @param hidden Boolean */ @@ -6091,15 +6773,11 @@ declare module Ext.lib { /** [Method] Sets the value of hideAnimation * @param hideAnimation String/Mixed */ - setHideAnimation?( hideAnimation?:any ): any; - setHideAnimation?( hideAnimation?:string ): void; + setHideAnimation?( hideAnimation?:any ): void; /** [Method] Sets the value of html * @param html String/Ext.Element/HTMLElement */ - setHtml?( html?:any ): any; - setHtml?( html?:string ): void; - setHtml?( html?:Ext.IElement ): void; - setHtml?( html?:HTMLElement ): void; + setHtml?( html?:any ): void; /** [Method] Sets the value of itemId * @param itemId String */ @@ -6107,45 +6785,31 @@ declare module Ext.lib { /** [Method] Sets the value of left * @param left Number/String */ - setLeft?( left?:any ): any; - setLeft?( left?:number ): void; - setLeft?( left?:string ): void; + setLeft?( left?:any ): void; /** [Method] Sets the value of margin * @param margin Number/String */ - setMargin?( margin?:any ): any; - setMargin?( margin?:number ): void; - setMargin?( margin?:string ): void; + setMargin?( margin?:any ): void; /** [Method] Sets the value of maxHeight * @param maxHeight Number/String */ - setMaxHeight?( maxHeight?:any ): any; - setMaxHeight?( maxHeight?:number ): void; - setMaxHeight?( maxHeight?:string ): void; + setMaxHeight?( maxHeight?:any ): void; /** [Method] Sets the value of maxWidth * @param maxWidth Number/String */ - setMaxWidth?( maxWidth?:any ): any; - setMaxWidth?( maxWidth?:number ): void; - setMaxWidth?( maxWidth?:string ): void; + setMaxWidth?( maxWidth?:any ): void; /** [Method] Sets the value of minHeight * @param minHeight Number/String */ - setMinHeight?( minHeight?:any ): any; - setMinHeight?( minHeight?:number ): void; - setMinHeight?( minHeight?:string ): void; + setMinHeight?( minHeight?:any ): void; /** [Method] Sets the value of minWidth * @param minWidth Number/String */ - setMinWidth?( minWidth?:any ): any; - setMinWidth?( minWidth?:number ): void; - setMinWidth?( minWidth?:string ): void; + setMinWidth?( minWidth?:any ): void; /** [Method] Sets the value of padding * @param padding Number/String */ - setPadding?( padding?:any ): any; - setPadding?( padding?:number ): void; - setPadding?( padding?:string ): void; + setPadding?( padding?:any ): void; /** [Method] Sets the value of plugins * @param plugins Object/Array */ @@ -6161,16 +6825,13 @@ declare module Ext.lib { /** [Method] Sets the value of right * @param right Number/String */ - setRight?( right?:any ): any; - setRight?( right?:number ): void; - setRight?( right?:string ): void; + setRight?( right?:any ): void; /** [Method] This method has moved to Ext Container */ setScrollable?(): void; /** [Method] Sets the value of showAnimation * @param showAnimation String/Mixed */ - setShowAnimation?( showAnimation?:any ): any; - setShowAnimation?( showAnimation?:string ): void; + setShowAnimation?( showAnimation?:any ): void; /** [Method] Sets the size of the Component * @param width Number The new width for the Component. * @param height Number The new height for the Component. @@ -6191,17 +6852,11 @@ declare module Ext.lib { /** [Method] Sets the value of top * @param top Number/String */ - setTop?( top?:any ): any; - setTop?( top?:number ): void; - setTop?( top?:string ): void; + setTop?( top?:any ): void; /** [Method] Sets the value of tpl * @param tpl String/String[]/Ext.Template[]/Ext.XTemplate[] */ - setTpl?( tpl?:any ): any; - setTpl?( tpl?:string ): void; - setTpl?( tpl?:string[] ): void; - setTpl?( tpl?:Ext.ITemplate[] ): void; - setTpl?( tpl?:Ext.IXTemplate[] ): void; + setTpl?( tpl?:any ): void; /** [Method] Sets the value of tplWriteMode * @param tplWriteMode String */ @@ -6213,15 +6868,14 @@ declare module Ext.lib { /** [Method] Sets the value of width * @param width Number/String */ - setWidth?( width?:any ): any; - setWidth?( width?:number ): void; - setWidth?( width?:string ): void; + setWidth?( width?:any ): void; /** [Method] Sets the value of zIndex * @param zIndex Number */ setZIndex?( zIndex?:number ): void; /** [Method] Shows this component * @param animation Object/Boolean + * @returns Ext.Component */ show?( animation?:any ): Ext.IComponent; /** [Method] Shows this component by another component @@ -6231,6 +6885,7 @@ declare module Ext.lib { showBy?( component?:Ext.IComponent, alignment?:string ): void; /** [Method] Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector * @param selector String The simple selector to test. + * @returns Ext.Container The matching ancestor Container (or undefined if no match was found). */ up?( selector?:string ): Ext.IContainer; /** [Method] Updates the HTML content of the Component */ @@ -6248,47 +6903,54 @@ declare module Ext { export class ComponentManager { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 component Object A configuration object for the Component you wish to create. * @param defaultType Function The constructor to provide the default Component type if the config object does not contain a xtype. (Optional if the config contains an xtype). + * @returns Ext.Component The newly instantiated Component. */ static create( component?:any, defaultType?:any ): Ext.IComponent; /** [Method] */ static destroy(): void; /** [Method] Returns an item by id * @param id String The id of the item. + * @returns Object The item, or undefined if not found. */ static get( id?:string ): any; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Checks if an item type is registered * @param component String The mnemonic string by which the class may be looked up. + * @returns Boolean Whether the type is registered. */ static isRegistered( component?:string ): boolean; /** [Method] Registers an item to be managed * @param component Object The item to register. */ static register( component?: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 component Object The item to unregister. @@ -6302,47 +6964,54 @@ declare module Ext { export class ComponentMgr { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 component Object A configuration object for the Component you wish to create. * @param defaultType Function The constructor to provide the default Component type if the config object does not contain a xtype. (Optional if the config contains an xtype). + * @returns Ext.Component The newly instantiated Component. */ static create( component?:any, defaultType?:any ): Ext.IComponent; /** [Method] */ static destroy(): void; /** [Method] Returns an item by id * @param id String The id of the item. + * @returns Object The item, or undefined if not found. */ static get( id?:string ): any; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Checks if an item type is registered * @param component String The mnemonic string by which the class may be looked up. + * @returns Boolean Whether the type is registered. */ static isRegistered( component?:string ): boolean; /** [Method] Registers an item to be managed * @param component Object The item to register. */ static register( component?: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 component Object The item to unregister. @@ -6357,11 +7026,13 @@ declare module Ext { /** [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 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.IContainer ): Ext.IComponent[]; } @@ -6396,10 +7067,12 @@ declare module Ext { scrollable?: any; /** [Method] Adds one or more Components to this Container * @param newItems Object/Object[]/Ext.Component/Ext.Component[] The new items to add to the Container. + * @returns Ext.Component The last item added to the Container from the newItems array. */ add?( newItems?:any ): Ext.IComponent; /** [Method] Adds an array of Components to this Container * @param items Array The array of items to add to this container. + * @returns Array The array of items after they have been added. */ addAll?( items?:any[] ): any[]; /** [Method] Animates to the supplied activeItem with a specified animation @@ -6409,57 +7082,83 @@ declare module Ext { animateActiveItem?( activeItem?:any, animation?:any ): void; /** [Method] Changes the masked configuration when its setter is called which will convert the value into a proper object instanc * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask + * @returns Object */ applyMasked?( masked?:any ): any; /** [Method] Retrieves the first direct child of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ child?( selector?:string ): Ext.IComponent; /** [Method] */ destroy?(): void; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ down?( selector?:string ): Ext.IComponent; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ getActiveItem?(): any; /** [Method] Returns the Component for a given index in the Container s items * @param index Number The index of the Component to return. + * @returns Ext.Component The item at the specified index, if found. */ getAt?( index?:number ): Ext.IComponent; - /** [Method] Returns the value of autoDestroy */ + /** [Method] Returns the value of autoDestroy + * @returns Boolean + */ getAutoDestroy?(): boolean; /** [Method] Examines this container s items property and gets a direct child component of this container * @param component String/Number This parameter may be any of the following: {String} : representing the itemId or id of the child component. {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?( component?:any ): Ext.IComponent; + /** [Method] Returns the value of control + * @returns Object */ - getComponent?( component?:any ): any; - getComponent?( component?:string ): Ext.IComponent; - getComponent?( component?:number ): Ext.IComponent; - /** [Method] Returns the value of control */ getControl?(): any; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ getDefaults?(): any; /** [Method] Finds a docked item of this container using a reference idor an index of its location in getDockedItems * @param component String/Number The id or index of the component to find. + * @returns Ext.Component/Boolean The docked component, if found. */ getDockedComponent?( component?:any ): any; - getDockedComponent?( component?:string ): Ext.IComponent; - getDockedComponent?( component?:number ): Ext.IComponent; - /** [Method] Returns all the Ext Component docked items in this container */ + /** [Method] Returns all the Ext Component docked items in this container + * @returns Array The docked items of this container. + */ getDockedItems?(): any[]; - /** [Method] Returns the value of hideOnMaskTap */ + /** [Method] Returns the value of hideOnMaskTap + * @returns Boolean + */ getHideOnMaskTap?(): boolean; - /** [Method] Returns all inner items of this container */ + /** [Method] Returns all inner items of this container + * @returns Array The inner items of this container. + */ getInnerItems?(): any[]; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ getItems?(): any; - /** [Method] Returns the value of masked */ + /** [Method] Returns the value of masked + * @returns Boolean/Object/Ext.Mask/Ext.LoadMask + */ getMasked?(): any; - /** [Method] Returns the value of modal */ + /** [Method] Returns the value of modal + * @returns Boolean + */ getModal?(): boolean; - /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class */ + /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class + * @returns Ext.scroll.View The scroll view. + */ getScrollable?(): Ext.scroll.IView; /** [Method] Adds a child Component at the given index * @param index Number The index to insert the Component at. @@ -6472,29 +7171,35 @@ declare module Ext { mask?( mask?:any ): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. + * @returns Array Ext.Component's which matched the selector. */ query?( selector?:string ): any[]; /** [Method] Removes an item from this Container optionally destroying it * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ remove?( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes all items currently in the Container optionally destroying them all * @param destroy Boolean If true, destroys each removed Component. * @param everything Boolean If true, completely remove all items including docked / centered and floating items. + * @returns Ext.Component this */ removeAll?( destroy?:boolean, everything?:boolean ): Ext.IComponent; /** [Method] Removes the Component at the specified index myContainer removeAt 0 removes the first item * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ removeAt?( index?:number ): Ext.IContainer; /** [Method] Removes a docked item from this Container * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ removeDocked?( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes an inner Component at the specified index myContainer removeInnerAt 0 removes the first item of the in * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ removeInnerAt?( index?:number ): Ext.IContainer; /** [Method] Sets the value of activeItem @@ -6575,10 +7280,12 @@ declare module Ext.lib { scrollable?: any; /** [Method] Adds one or more Components to this Container * @param newItems Object/Object[]/Ext.Component/Ext.Component[] The new items to add to the Container. + * @returns Ext.Component The last item added to the Container from the newItems array. */ add?( newItems?:any ): Ext.IComponent; /** [Method] Adds an array of Components to this Container * @param items Array The array of items to add to this container. + * @returns Array The array of items after they have been added. */ addAll?( items?:any[] ): any[]; /** [Method] Animates to the supplied activeItem with a specified animation @@ -6588,57 +7295,83 @@ declare module Ext.lib { animateActiveItem?( activeItem?:any, animation?:any ): void; /** [Method] Changes the masked configuration when its setter is called which will convert the value into a proper object instanc * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask + * @returns Object */ applyMasked?( masked?:any ): any; /** [Method] Retrieves the first direct child of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ child?( selector?:string ): Ext.IComponent; /** [Method] */ destroy?(): void; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ down?( selector?:string ): Ext.IComponent; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ getActiveItem?(): any; /** [Method] Returns the Component for a given index in the Container s items * @param index Number The index of the Component to return. + * @returns Ext.Component The item at the specified index, if found. */ getAt?( index?:number ): Ext.IComponent; - /** [Method] Returns the value of autoDestroy */ + /** [Method] Returns the value of autoDestroy + * @returns Boolean + */ getAutoDestroy?(): boolean; /** [Method] Examines this container s items property and gets a direct child component of this container * @param component String/Number This parameter may be any of the following: {String} : representing the itemId or id of the child component. {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?( component?:any ): Ext.IComponent; + /** [Method] Returns the value of control + * @returns Object */ - getComponent?( component?:any ): any; - getComponent?( component?:string ): Ext.IComponent; - getComponent?( component?:number ): Ext.IComponent; - /** [Method] Returns the value of control */ getControl?(): any; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ getDefaults?(): any; /** [Method] Finds a docked item of this container using a reference idor an index of its location in getDockedItems * @param component String/Number The id or index of the component to find. + * @returns Ext.Component/Boolean The docked component, if found. */ getDockedComponent?( component?:any ): any; - getDockedComponent?( component?:string ): Ext.IComponent; - getDockedComponent?( component?:number ): Ext.IComponent; - /** [Method] Returns all the Ext Component docked items in this container */ + /** [Method] Returns all the Ext Component docked items in this container + * @returns Array The docked items of this container. + */ getDockedItems?(): any[]; - /** [Method] Returns the value of hideOnMaskTap */ + /** [Method] Returns the value of hideOnMaskTap + * @returns Boolean + */ getHideOnMaskTap?(): boolean; - /** [Method] Returns all inner items of this container */ + /** [Method] Returns all inner items of this container + * @returns Array The inner items of this container. + */ getInnerItems?(): any[]; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ getItems?(): any; - /** [Method] Returns the value of masked */ + /** [Method] Returns the value of masked + * @returns Boolean/Object/Ext.Mask/Ext.LoadMask + */ getMasked?(): any; - /** [Method] Returns the value of modal */ + /** [Method] Returns the value of modal + * @returns Boolean + */ getModal?(): boolean; - /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class */ + /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class + * @returns Ext.scroll.View The scroll view. + */ getScrollable?(): Ext.scroll.IView; /** [Method] Adds a child Component at the given index * @param index Number The index to insert the Component at. @@ -6651,29 +7384,35 @@ declare module Ext.lib { mask?( mask?:any ): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. + * @returns Array Ext.Component's which matched the selector. */ query?( selector?:string ): any[]; /** [Method] Removes an item from this Container optionally destroying it * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ remove?( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes all items currently in the Container optionally destroying them all * @param destroy Boolean If true, destroys each removed Component. * @param everything Boolean If true, completely remove all items including docked / centered and floating items. + * @returns Ext.Component this */ removeAll?( destroy?:boolean, everything?:boolean ): Ext.IComponent; /** [Method] Removes the Component at the specified index myContainer removeAt 0 removes the first item * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ removeAt?( index?:number ): Ext.IContainer; /** [Method] Removes a docked item from this Container * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ removeDocked?( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes an inner Component at the specified index myContainer removeInnerAt 0 removes the first item of the in * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ removeInnerAt?( index?:number ): Ext.IContainer; /** [Method] Sets the value of activeItem @@ -6728,7 +7467,9 @@ declare module Ext.data { export interface IArrayStore extends Ext.data.IStore { /** [Config Option] (String/Ext.data.proxy.Proxy/Object) */ proxy?: any; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Object + */ getProxy?(): any; /** [Method] Loads an array of data straight into the Store * @param data Object @@ -6757,23 +7498,41 @@ declare module Ext.data.association { reader?: Ext.data.reader.IReader; /** [Config Option] (String) */ type?: string; - /** [Method] Returns the value of associatedModel */ + /** [Method] Returns the value of associatedModel + * @returns String + */ getAssociatedModel?(): string; - /** [Method] Returns the value of associatedName */ + /** [Method] Returns the value of associatedName + * @returns String + */ getAssociatedName?(): string; - /** [Method] Returns the value of associationKey */ + /** [Method] Returns the value of associationKey + * @returns String + */ getAssociationKey?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns Object + */ getName?(): any; - /** [Method] Returns the value of ownerModel */ + /** [Method] Returns the value of ownerModel + * @returns Ext.data.Model/String + */ getOwnerModel?(): any; - /** [Method] Returns the value of ownerName */ + /** [Method] Returns the value of ownerName + * @returns String + */ getOwnerName?(): string; - /** [Method] Returns the value of primaryKey */ + /** [Method] Returns the value of primaryKey + * @returns String + */ getPrimaryKey?(): string; - /** [Method] Returns the value of reader */ + /** [Method] Returns the value of reader + * @returns Ext.data.reader.Reader + */ getReader?(): Ext.data.reader.IReader; - /** [Method] Returns the value of type */ + /** [Method] Returns the value of type + * @returns String + */ getType?(): string; /** [Method] Sets the value of associatedModel * @param associatedModel String @@ -6794,9 +7553,7 @@ declare module Ext.data.association { /** [Method] Sets the value of ownerModel * @param ownerModel Ext.data.Model/String */ - setOwnerModel?( ownerModel?:any ): any; - setOwnerModel?( ownerModel?:Ext.data.IModel ): void; - setOwnerModel?( ownerModel?:string ): void; + setOwnerModel?( ownerModel?:any ): void; /** [Method] Sets the value of ownerName * @param ownerName String */ @@ -6831,23 +7588,41 @@ declare module Ext.data { reader?: Ext.data.reader.IReader; /** [Config Option] (String) */ type?: string; - /** [Method] Returns the value of associatedModel */ + /** [Method] Returns the value of associatedModel + * @returns String + */ getAssociatedModel?(): string; - /** [Method] Returns the value of associatedName */ + /** [Method] Returns the value of associatedName + * @returns String + */ getAssociatedName?(): string; - /** [Method] Returns the value of associationKey */ + /** [Method] Returns the value of associationKey + * @returns String + */ getAssociationKey?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns Object + */ getName?(): any; - /** [Method] Returns the value of ownerModel */ + /** [Method] Returns the value of ownerModel + * @returns Ext.data.Model/String + */ getOwnerModel?(): any; - /** [Method] Returns the value of ownerName */ + /** [Method] Returns the value of ownerName + * @returns String + */ getOwnerName?(): string; - /** [Method] Returns the value of primaryKey */ + /** [Method] Returns the value of primaryKey + * @returns String + */ getPrimaryKey?(): string; - /** [Method] Returns the value of reader */ + /** [Method] Returns the value of reader + * @returns Ext.data.reader.Reader + */ getReader?(): Ext.data.reader.IReader; - /** [Method] Returns the value of type */ + /** [Method] Returns the value of type + * @returns String + */ getType?(): string; /** [Method] Sets the value of associatedModel * @param associatedModel String @@ -6868,9 +7643,7 @@ declare module Ext.data { /** [Method] Sets the value of ownerModel * @param ownerModel Ext.data.Model/String */ - setOwnerModel?( ownerModel?:any ): any; - setOwnerModel?( ownerModel?:Ext.data.IModel ): void; - setOwnerModel?( ownerModel?:string ): void; + setOwnerModel?( ownerModel?:any ): void; /** [Method] Sets the value of ownerName * @param ownerName String */ @@ -6897,13 +7670,21 @@ declare module Ext.data.association { getterName?: string; /** [Config Option] (String) */ setterName?: string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of getterName */ + /** [Method] Returns the value of getterName + * @returns String + */ getGetterName?(): string; - /** [Method] Returns the value of instanceName */ + /** [Method] Returns the value of instanceName + * @returns Object + */ getInstanceName?(): any; - /** [Method] Returns the value of setterName */ + /** [Method] Returns the value of setterName + * @returns String + */ getSetterName?(): string; /** [Method] Sets the value of foreignKey * @param foreignKey String @@ -6931,13 +7712,21 @@ declare module Ext.data { getterName?: string; /** [Config Option] (String) */ setterName?: string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of getterName */ + /** [Method] Returns the value of getterName + * @returns String + */ getGetterName?(): string; - /** [Method] Returns the value of instanceName */ + /** [Method] Returns the value of instanceName + * @returns Object + */ getInstanceName?(): any; - /** [Method] Returns the value of setterName */ + /** [Method] Returns the value of setterName + * @returns String + */ getSetterName?(): string; /** [Method] Sets the value of foreignKey * @param foreignKey String @@ -6975,17 +7764,29 @@ declare module Ext.data.association { storeConfig?: any; /** [Config Option] (String) */ storeName?: string; - /** [Method] Returns the value of autoLoad */ + /** [Method] Returns the value of autoLoad + * @returns Boolean + */ getAutoLoad?(): boolean; - /** [Method] Returns the value of autoSync */ + /** [Method] Returns the value of autoSync + * @returns Boolean + */ getAutoSync?(): boolean; - /** [Method] Returns the value of filterProperty */ + /** [Method] Returns the value of filterProperty + * @returns String + */ getFilterProperty?(): string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Object + */ getStore?(): any; - /** [Method] Returns the value of storeName */ + /** [Method] Returns the value of storeName + * @returns String + */ getStoreName?(): string; /** [Method] Sets the value of autoLoad * @param autoLoad Boolean @@ -7031,17 +7832,29 @@ declare module Ext.data { storeConfig?: any; /** [Config Option] (String) */ storeName?: string; - /** [Method] Returns the value of autoLoad */ + /** [Method] Returns the value of autoLoad + * @returns Boolean + */ getAutoLoad?(): boolean; - /** [Method] Returns the value of autoSync */ + /** [Method] Returns the value of autoSync + * @returns Boolean + */ getAutoSync?(): boolean; - /** [Method] Returns the value of filterProperty */ + /** [Method] Returns the value of filterProperty + * @returns String + */ getFilterProperty?(): string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Object + */ getStore?(): any; - /** [Method] Returns the value of storeName */ + /** [Method] Returns the value of storeName + * @returns String + */ getStoreName?(): string; /** [Method] Sets the value of autoLoad * @param autoLoad Boolean @@ -7077,13 +7890,21 @@ declare module Ext.data.association { getterName?: string; /** [Config Option] (String) */ setterName?: string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of getterName */ + /** [Method] Returns the value of getterName + * @returns String + */ getGetterName?(): string; - /** [Method] Returns the value of instanceName */ + /** [Method] Returns the value of instanceName + * @returns Object + */ getInstanceName?(): any; - /** [Method] Returns the value of setterName */ + /** [Method] Returns the value of setterName + * @returns String + */ getSetterName?(): string; /** [Method] Sets the value of foreignKey * @param foreignKey String @@ -7111,13 +7932,21 @@ declare module Ext.data { getterName?: string; /** [Config Option] (String) */ setterName?: string; - /** [Method] Returns the value of foreignKey */ + /** [Method] Returns the value of foreignKey + * @returns String + */ getForeignKey?(): string; - /** [Method] Returns the value of getterName */ + /** [Method] Returns the value of getterName + * @returns String + */ getGetterName?(): string; - /** [Method] Returns the value of instanceName */ + /** [Method] Returns the value of instanceName + * @returns Object + */ getInstanceName?(): any; - /** [Method] Returns the value of setterName */ + /** [Method] Returns the value of setterName + * @returns String + */ getSetterName?(): string; /** [Method] Sets the value of foreignKey * @param foreignKey String @@ -7167,16 +7996,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -7188,9 +8015,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -7198,9 +8023,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -7208,33 +8031,44 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of autoStart */ + /** [Method] Returns the value of autoStart + * @returns Boolean + */ getAutoStart?(): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of pauseOnException */ + /** [Method] Returns the value of pauseOnException + * @returns Boolean + */ getPauseOnException?(): boolean; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Ext.data.Proxy + */ getProxy?(): Ext.data.IProxy; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -7244,18 +8078,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -7263,30 +8093,27 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Pauses execution of the batch but does not cancel the current operation */ pause?(): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -7295,16 +8122,14 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -7312,18 +8137,14 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -7339,9 +8160,7 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -7365,25 +8184,21 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.data { @@ -7418,16 +8233,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -7439,9 +8252,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -7449,9 +8260,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -7459,61 +8268,97 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of async */ + /** [Method] Returns the value of async + * @returns Boolean + */ getAsync?(): boolean; - /** [Method] Returns the value of autoAbort */ + /** [Method] Returns the value of autoAbort + * @returns Boolean + */ getAutoAbort?(): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of defaultHeaders */ + /** [Method] Returns the value of defaultHeaders + * @returns Object + */ getDefaultHeaders?(): any; - /** [Method] Returns the value of defaultPostHeader */ + /** [Method] Returns the value of defaultPostHeader + * @returns String + */ getDefaultPostHeader?(): string; - /** [Method] Returns the value of defaultXhrHeader */ + /** [Method] Returns the value of defaultXhrHeader + * @returns String + */ getDefaultXhrHeader?(): string; - /** [Method] Returns the value of disableCaching */ + /** [Method] Returns the value of disableCaching + * @returns Boolean + */ getDisableCaching?(): boolean; - /** [Method] Returns the value of disableCachingParam */ + /** [Method] Returns the value of disableCachingParam + * @returns String + */ getDisableCachingParam?(): string; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ getExtraParams?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns String + */ getMethod?(): string; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ getPassword?(): string; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; - /** [Method] Returns the value of useDefaultHeader */ + /** [Method] Returns the value of useDefaultHeader + * @returns Boolean + */ getUseDefaultHeader?(): boolean; - /** [Method] Returns the value of useDefaultXhrHeader */ + /** [Method] Returns the value of useDefaultXhrHeader + * @returns Boolean + */ getUseDefaultXhrHeader?(): boolean; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ getUsername?(): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Determines whether this object has a request outstanding * @param request Object The request to check. + * @returns Boolean True if there is an outstanding request. */ isLoading?( request?:any ): boolean; /** [Method] Alias for addManagedListener @@ -7523,18 +8368,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -7542,33 +8383,31 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Checks if the response status was successful * @param status Number The status code. * @param xhr Object + * @returns Object An object containing success/status state. */ parseStatus?( status?:number, xhr?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -7577,16 +8416,14 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -7594,20 +8431,17 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?: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 post-processing in a callback because it is passed to callback functions.) + * @returns Object/null The request object. This may be used to cancel the request. */ request?( options?:any ): any; /** [Method] Resumes firing events see suspendEvents @@ -7625,9 +8459,7 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of defaultHeaders * @param defaultHeaders Object */ @@ -7663,6 +8495,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] Sets the value of password @@ -7698,42 +8531,37 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Uploads a form using a hidden iframe * @param form String/HTMLElement/Ext.Element The form to upload. * @param url String The url to post to. * @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 { export interface IDirectStore extends Ext.data.IStore { /** [Config Option] (String/Ext.data.proxy.Proxy/Object) */ proxy?: any; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Object + */ getProxy?(): any; /** [Method] Sets the value of proxy * @param proxy Object @@ -7747,9 +8575,13 @@ declare module Ext.data { field?: string; /** [Config Option] (String) */ message?: string; - /** [Method] Returns the value of field */ + /** [Method] Returns the value of field + * @returns String + */ getField?(): string; - /** [Method] Returns the value of message */ + /** [Method] Returns the value of message + * @returns String + */ getMessage?(): string; /** [Method] Sets the value of field * @param field String @@ -7763,13 +8595,18 @@ declare module Ext.data { } declare module Ext.data { export interface IErrors extends Ext.util.ICollection { - /** [Method] Adds an item to the collection */ + /** [Method] Adds an item to the collection + * @returns Object The item added. + */ add?(): any; /** [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; } } @@ -7797,31 +8634,57 @@ declare module Ext.data { type?: any; /** [Config Option] (Boolean) */ useNull?: boolean; - /** [Method] Returns the value of allowNull */ + /** [Method] Returns the value of allowNull + * @returns Boolean + */ getAllowNull?(): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String + */ getBubbleEvents?(): string; - /** [Method] Returns the value of convert */ + /** [Method] Returns the value of convert + * @returns Function + */ getConvert?(): any; - /** [Method] Returns the value of dateFormat */ + /** [Method] Returns the value of dateFormat + * @returns String + */ getDateFormat?(): string; - /** [Method] Returns the value of decode */ + /** [Method] Returns the value of decode + * @returns Object + */ getDecode?(): any; - /** [Method] Returns the value of defaultValue */ + /** [Method] Returns the value of defaultValue + * @returns Object + */ getDefaultValue?(): any; - /** [Method] Returns the value of encode */ + /** [Method] Returns the value of encode + * @returns Object + */ getEncode?(): any; - /** [Method] Returns the value of mapping */ + /** [Method] Returns the value of mapping + * @returns String/Number + */ getMapping?(): any; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of persist */ + /** [Method] Returns the value of persist + * @returns Boolean + */ getPersist?(): boolean; - /** [Method] Returns the value of sortDir */ + /** [Method] Returns the value of sortDir + * @returns String + */ getSortDir?(): string; - /** [Method] Returns the value of sortType */ + /** [Method] Returns the value of sortType + * @returns Function + */ getSortType?(): any; - /** [Method] Returns the value of type */ + /** [Method] Returns the value of type + * @returns String/Object + */ getType?(): any; /** [Method] Sets the value of allowNull * @param allowNull Boolean @@ -7854,9 +8717,7 @@ declare module Ext.data { /** [Method] Sets the value of mapping * @param mapping String/Number */ - setMapping?( mapping?:any ): any; - setMapping?( mapping?:string ): void; - setMapping?( mapping?:number ): void; + setMapping?( mapping?:any ): void; /** [Method] Sets the value of name * @param name String */ @@ -7885,9 +8746,13 @@ declare module Ext.data.identifier { prefix?: string; /** [Config Option] (Number) */ seed?: number; - /** [Method] Returns the value of prefix */ + /** [Method] Returns the value of prefix + * @returns String + */ getPrefix?(): string; - /** [Method] Returns the value of seed */ + /** [Method] Returns the value of seed + * @returns Number + */ getSeed?(): number; /** [Method] Sets the value of prefix * @param prefix String @@ -7901,7 +8766,9 @@ declare module Ext.data.identifier { } declare module Ext.data.identifier { export interface ISimple extends Ext.IBase { - /** [Method] Returns the value of prefix */ + /** [Method] Returns the value of prefix + * @returns String + */ getPrefix?(): string; /** [Method] Sets the value of prefix * @param prefix String @@ -7919,9 +8786,13 @@ declare module Ext.data.identifier { salt?: any; /** [Property] (Number/Object) */ timestamp?: any; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns Object + */ getId?(): any; - /** [Method] Returns the value of version */ + /** [Method] Returns the value of version + * @returns Number + */ getVersion?(): number; /** [Method] Reconfigures this generator given new config properties * @param config Object @@ -7947,34 +8818,39 @@ declare module Ext.data { static abort( request?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [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. + * @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; } } @@ -7988,34 +8864,39 @@ declare module Ext.util { static abort( request?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [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. + * @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; } } @@ -8023,7 +8904,9 @@ declare module Ext.data { export interface IJsonStore extends Ext.data.IStore { /** [Config Option] (String/Ext.data.proxy.Proxy/Object) */ proxy?: any; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Object + */ getProxy?(): any; /** [Method] Sets the value of proxy * @param proxy Object @@ -8073,16 +8956,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -8094,9 +8975,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -8104,9 +8983,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Begins an edit */ beginEdit?(): void; /** [Method] Cancels all changes made in the current edit operation */ @@ -8119,6 +8996,7 @@ declare module Ext.data { commit?( silent?:boolean ): void; /** [Method] Creates a copy clone of this Model instance * @param id String A new id. If you don't specify this a new id will be generated for you. To generate a phantom instance with a new id use: var rec = record.copy(); // clone the record with a new id + * @returns Ext.data.Model */ copy?( id?:string ): Ext.data.IModel; /** [Method] Destroys this model instance */ @@ -8126,9 +9004,7 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?: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. @@ -8137,6 +9013,7 @@ declare module Ext.data { /** [Method] Destroys the record using the configured proxy * @param options Object/Function Options to pass to the proxy. Config object for Ext.data.Operation. If you pass a function, this will automatically become the callback method. For convenience the config object may also contain success and failure methods in addition to callback - they will all be invoked with the Model and Operation as arguments. * @param scope Object The scope to run your callback method in. This is only used if you passed a function as the first argument. + * @returns Ext.data.Model The Model instance. */ erase?( options?:any, scope?:any ): Ext.data.IModel; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste @@ -8144,64 +9021,104 @@ declare module Ext.data { * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( 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] Returns the value of associations */ + /** [Method] Returns the value of associations + * @returns Object[] + */ getAssociations?(): any[]; - /** [Method] Returns the value of belongsTo */ + /** [Method] Returns the value of belongsTo + * @returns String/Object/String[]/Object[] + */ getBelongsTo?(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Gets a hash of only the fields that have been modified since this Model was created or committed */ + /** [Method] Gets a hash of only the fields that have been modified since this Model was created or committed + * @returns Object + */ getChanges?(): any; - /** [Method] Returns the value of clientIdProperty */ + /** [Method] Returns the value of clientIdProperty + * @returns String + */ getClientIdProperty?(): string; /** [Method] Returns an object containing the data set on this record * @param includeAssociated Boolean true to include the associated data. + * @returns Object The data. */ getData?( includeAssociated?:boolean ): any; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Object[]/String[] + */ getFields?(): any; - /** [Method] Returns the value of hasMany */ + /** [Method] Returns the value of hasMany + * @returns String/Object/String[]/Object[] + */ getHasMany?(): any; - /** [Method] Returns the value of hasOne */ + /** [Method] Returns the value of hasOne + * @returns String/Object/String[]/Object[] + */ getHasOne?(): any; - /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty */ - getId?(): string; - /** [Method] Returns the value of idProperty */ + /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty + * @returns Number/String The id. + */ + getId?(): any; + /** [Method] Returns the value of idProperty + * @returns String + */ getIdProperty?(): string; - /** [Method] Returns the value of identifier */ + /** [Method] Returns the value of identifier + * @returns Object/String + */ getIdentifier?(): any; /** [Method] Returns true if the record has been erased on the server */ getIsErased?(): void; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Object/Ext.data.Proxy + */ getProxy?(): any; - /** [Method] Returns the value of useCache */ + /** [Method] Returns the value of useCache + * @returns Boolean + */ getUseCache?(): boolean; - /** [Method] Returns the value of validations */ + /** [Method] Returns the value of validations + * @returns Object[] + */ getValidations?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, 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] By joining this model to an instance of a class this model will automatically try to call certain template methods o * @param store Ext.data.Store The store to which this model has been added. @@ -8214,18 +9131,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -8233,25 +9146,21 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Usually called by the Ext data Store to which this model instance has been joined * @param silent Boolean true to skip notification of the owning store of the change. */ @@ -8259,6 +9168,7 @@ declare module Ext.data { /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -8267,45 +9177,37 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. - * @param scope Object The scope originally specified for the handler. It must be the same as the scope argument specified in - * the original call to addListener or the listener will not be removed. + * @param scope Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed. * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ resumeEvents?( discardQueuedEvents?:boolean ): void; /** [Method] Saves the model instance using the configured proxy - * @param options Object/Function Options to pass to the proxy. Config object for Ext.data.Operation. If you pass a function, this - * will automatically become the callback method. For convenience the config object may also contain success and failure methods in - * addition to callback - they will all be invoked with the Model and Operation as arguments. + * @param options Object/Function Options to pass to the proxy. Config object for Ext.data.Operation. If you pass a function, this will automatically become the callback method. For convenience the config object may also contain success and failure methods in addition to callback - they will all be invoked with the Model and Operation as arguments. * @param scope Object The scope to run your callback method in. This is only used if you passed a function as the first argument. + * @returns Ext.data.Model The Model instance */ save?( options?:any, scope?:any ): Ext.data.IModel; /** [Method] Sets the given field to the given value marks the instance as dirty @@ -8324,25 +9226,26 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of clientIdProperty * @param clientIdProperty String */ setClientIdProperty?( clientIdProperty?:string ): void; /** [Method] This sets the data directly without converting and applying default values * @param data Object + * @returns Ext.data.Model This Record. */ setConvertedData?( data?:any ): Ext.data.IModel; /** [Method] This method is used to set the data for this Record instance * @param rawData Object + * @returns Ext.data.Model This record. */ setData?( rawData?:any ): Ext.data.IModel; /** [Method] Marks this Record as dirty */ setDirty?(): void; /** [Method] Updates the collection of Fields that all instances of this Model use * @param fields Array + * @returns any */ setFields?( fields?:any[] ): any; /** [Method] Sets the value of hasMany @@ -8356,9 +9259,7 @@ 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 value of idProperty * @param idProperty String */ @@ -8385,7 +9286,9 @@ declare module Ext.data { setValidations?( validations?:any[] ): void; /** [Method] Suspends the firing of all events */ suspendEvents?(): void; - /** [Method] Returns a url suitable string for this model instance */ + /** [Method] Returns a url suitable string for this model instance + * @returns String The url string for this model instance. + */ toUrl?(): string; /** [Method] Alias for removeListener * @param eventName String/String[]/Object The type of event the handler was associated with. @@ -8394,30 +9297,28 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] This un joins this record from an instance of a class * @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 { @@ -8427,20 +9328,25 @@ 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] * @param args Object */ static callParent( args?: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] Asynchronously loads a model instance by id * @param id Number The id of the model to load @@ -8450,6 +9356,7 @@ declare module Ext.data { static load( id?:number, config?:any, scope?: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; } @@ -8496,16 +9403,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -8517,9 +9422,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -8527,9 +9430,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Begins an edit */ beginEdit?(): void; /** [Method] Cancels all changes made in the current edit operation */ @@ -8542,6 +9443,7 @@ declare module Ext.data { commit?( silent?:boolean ): void; /** [Method] Creates a copy clone of this Model instance * @param id String A new id. If you don't specify this a new id will be generated for you. To generate a phantom instance with a new id use: var rec = record.copy(); // clone the record with a new id + * @returns Ext.data.Model */ copy?( id?:string ): Ext.data.IModel; /** [Method] Destroys this model instance */ @@ -8549,9 +9451,7 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?: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. @@ -8560,6 +9460,7 @@ declare module Ext.data { /** [Method] Destroys the record using the configured proxy * @param options Object/Function Options to pass to the proxy. Config object for Ext.data.Operation. If you pass a function, this will automatically become the callback method. For convenience the config object may also contain success and failure methods in addition to callback - they will all be invoked with the Model and Operation as arguments. * @param scope Object The scope to run your callback method in. This is only used if you passed a function as the first argument. + * @returns Ext.data.Model The Model instance. */ erase?( options?:any, scope?:any ): Ext.data.IModel; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste @@ -8567,64 +9468,104 @@ declare module Ext.data { * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( 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] Returns the value of associations */ + /** [Method] Returns the value of associations + * @returns Object[] + */ getAssociations?(): any[]; - /** [Method] Returns the value of belongsTo */ + /** [Method] Returns the value of belongsTo + * @returns String/Object/String[]/Object[] + */ getBelongsTo?(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Gets a hash of only the fields that have been modified since this Model was created or committed */ + /** [Method] Gets a hash of only the fields that have been modified since this Model was created or committed + * @returns Object + */ getChanges?(): any; - /** [Method] Returns the value of clientIdProperty */ + /** [Method] Returns the value of clientIdProperty + * @returns String + */ getClientIdProperty?(): string; /** [Method] Returns an object containing the data set on this record * @param includeAssociated Boolean true to include the associated data. + * @returns Object The data. */ getData?( includeAssociated?:boolean ): any; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Object[]/String[] + */ getFields?(): any; - /** [Method] Returns the value of hasMany */ + /** [Method] Returns the value of hasMany + * @returns String/Object/String[]/Object[] + */ getHasMany?(): any; - /** [Method] Returns the value of hasOne */ + /** [Method] Returns the value of hasOne + * @returns String/Object/String[]/Object[] + */ getHasOne?(): any; - /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty */ - getId?(): string; - /** [Method] Returns the value of idProperty */ + /** [Method] Returns the unique ID allocated to this model instance as defined by idProperty + * @returns Number/String The id. + */ + getId?(): any; + /** [Method] Returns the value of idProperty + * @returns String + */ getIdProperty?(): string; - /** [Method] Returns the value of identifier */ + /** [Method] Returns the value of identifier + * @returns Object/String + */ getIdentifier?(): any; /** [Method] Returns true if the record has been erased on the server */ getIsErased?(): void; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Object/Ext.data.Proxy + */ getProxy?(): any; - /** [Method] Returns the value of useCache */ + /** [Method] Returns the value of useCache + * @returns Boolean + */ getUseCache?(): boolean; - /** [Method] Returns the value of validations */ + /** [Method] Returns the value of validations + * @returns Object[] + */ getValidations?(): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, 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] By joining this model to an instance of a class this model will automatically try to call certain template methods o * @param store Ext.data.Store The store to which this model has been added. @@ -8637,18 +9578,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -8656,25 +9593,21 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Usually called by the Ext data Store to which this model instance has been joined * @param silent Boolean true to skip notification of the owning store of the change. */ @@ -8682,6 +9615,7 @@ declare module Ext.data { /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -8690,16 +9624,14 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -8707,18 +9639,14 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -8726,6 +9654,7 @@ declare module Ext.data { /** [Method] Saves the model instance using the configured proxy * @param options Object/Function Options to pass to the proxy. Config object for Ext.data.Operation. If you pass a function, this will automatically become the callback method. For convenience the config object may also contain success and failure methods in addition to callback - they will all be invoked with the Model and Operation as arguments. * @param scope Object The scope to run your callback method in. This is only used if you passed a function as the first argument. + * @returns Ext.data.Model The Model instance */ save?( options?:any, scope?:any ): Ext.data.IModel; /** [Method] Sets the given field to the given value marks the instance as dirty @@ -8744,25 +9673,26 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of clientIdProperty * @param clientIdProperty String */ setClientIdProperty?( clientIdProperty?:string ): void; /** [Method] This sets the data directly without converting and applying default values * @param data Object + * @returns Ext.data.Model This Record. */ setConvertedData?( data?:any ): Ext.data.IModel; /** [Method] This method is used to set the data for this Record instance * @param rawData Object + * @returns Ext.data.Model This record. */ setData?( rawData?:any ): Ext.data.IModel; /** [Method] Marks this Record as dirty */ setDirty?(): void; /** [Method] Updates the collection of Fields that all instances of this Model use * @param fields Array + * @returns any */ setFields?( fields?:any[] ): any; /** [Method] Sets the value of hasMany @@ -8776,9 +9706,7 @@ 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 value of idProperty * @param idProperty String */ @@ -8805,7 +9733,9 @@ declare module Ext.data { setValidations?( validations?:any[] ): void; /** [Method] Suspends the firing of all events */ suspendEvents?(): void; - /** [Method] Returns a url suitable string for this model instance */ + /** [Method] Returns a url suitable string for this model instance + * @returns String The url string for this model instance. + */ toUrl?(): string; /** [Method] Alias for removeListener * @param eventName String/String[]/Object The type of event the handler was associated with. @@ -8814,30 +9744,28 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] This un joins this record from an instance of a class * @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 { @@ -8847,20 +9775,25 @@ 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] * @param args Object */ static callParent( args?: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] Asynchronously loads a model instance by id * @param id Number The id of the model to load @@ -8870,6 +9803,7 @@ declare module Ext.data { static load( id?:number, config?:any, scope?: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; } @@ -8880,23 +9814,24 @@ declare module Ext.data { export class ModelManager { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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. * @param id Number Unique id of the Model instance (see Ext.data.Model). + * @returns Object */ static create( data?:any, name?:string, id?:number ): any; /** [Method] */ @@ -8908,24 +9843,31 @@ declare module Ext.data { 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 * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Returns the Ext data Model for a given model name * @param id String/Object The id of the model or the model instance. + * @returns Ext.data.Model A model class. */ static getModel( id?:any ): Ext.data.IModel; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [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 @@ -8941,9 +9883,12 @@ declare module Ext.data { /** [Method] Registers a model definition * @param name Object * @param config Object + * @returns Object */ static registerType( name?:any, config?: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] Unregisters an item by removing it from this manager * @param item Object The item to unregister. @@ -8957,23 +9902,24 @@ declare module Ext { export class ModelMgr { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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. * @param id Number Unique id of the Model instance (see Ext.data.Model). + * @returns Object */ static create( data?:any, name?:string, id?:number ): any; /** [Method] */ @@ -8985,24 +9931,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 * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Returns the Ext data Model for a given model name * @param id String/Object The id of the model or the model instance. + * @returns Ext.data.Model A model class. */ static getModel( id?:any ): Ext.data.IModel; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [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 @@ -9018,9 +9971,12 @@ declare module Ext { /** [Method] Registers a model definition * @param name Object * @param config Object + * @returns Object */ static registerType( name?:any, config?: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] Unregisters an item by removing it from this manager * @param item Object The item to unregister. @@ -9034,23 +9990,24 @@ declare module Ext { export class ModelManager { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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. * @param id Number Unique id of the Model instance (see Ext.data.Model). + * @returns Object */ static create( data?:any, name?:string, id?:number ): any; /** [Method] */ @@ -9062,24 +10019,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 * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Returns the Ext data Model for a given model name * @param id String/Object The id of the model or the model instance. + * @returns Ext.data.Model A model class. */ static getModel( id?:any ): Ext.data.IModel; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [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 @@ -9095,9 +10059,12 @@ declare module Ext { /** [Method] Registers a model definition * @param name Object * @param config Object + * @returns Object */ static registerType( name?:any, config?: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] Unregisters an item by removing it from this manager * @param item Object The item to unregister. @@ -9121,10 +10088,9 @@ declare module Ext.data { previousSibling?: any; /** [Method] Insert node s as the last child node of this node * @param node Ext.data.NodeInterface/Ext.data.NodeInterface[] The node or Array of nodes to append. + * @returns Ext.data.NodeInterface The appended node if single append, or null if an array was passed. */ - appendChild?( node?:any ): any; - appendChild?( node?:Ext.data.INodeInterface ): Ext.data.INodeInterface; - appendChild?( node?:Ext.data.INodeInterface[] ): Ext.data.INodeInterface; + appendChild?( node?:any ): Ext.data.INodeInterface; /** [Method] Bubbles up the tree from this node calling the specified function with each node * @param fn Function The function to call. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the current Node. @@ -9145,11 +10111,13 @@ declare module Ext.data { collapse?( 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 newId String A new id, defaults to this Node's id. * @param deep Boolean If passed as true, all child Nodes are recursively copied into the new Node. If omitted or false, the copy will have no child Nodes. + * @returns Ext.data.NodeInterface A copy of this Node. */ copy?( newId?:string, deep?:boolean ): Ext.data.INodeInterface; /** [Method] Destroys the node @@ -9172,79 +10140,113 @@ 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] 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 child Ext.data.NodeInterface + * @returns Number The index of the node or -1 if it was not found. */ indexOf?( child?:Ext.data.INodeInterface ): 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] Insert a node into this node * @param index Number The zero-based index to insert the node at. * @param node Ext.data.Model The node to insert. + * @returns Ext.data.Model The record you just inserted. */ insertChild?( index?:number, node?:Ext.data.IModel ): Ext.data.IModel; /** [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 expanded */ + /** [Method] Returns true if this node is expanded + * @returns Boolean + */ isExpanded?(): boolean; - /** [Method] Returns true if this node is the first child of its parent */ + /** [Method] Returns true if this node is the first child of its parent + * @returns Boolean + */ isFirst?(): boolean; - /** [Method] Returns true if this node is the last child of its parent */ + /** [Method] Returns true if this node is the last child of its parent + * @returns Boolean + */ isLast?(): 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] Sorts this nodes children using the supplied sort function @@ -9255,6 +10257,7 @@ declare module Ext.data { sort?( sortFn?:any, recursive?:boolean, suppressEvent?:boolean ): void; /** [Method] Updates general data of this node like isFirst isLast depth * @param silent Object + * @returns Boolean */ updateInfo?( silent?:any ): boolean; } @@ -9265,13 +10268,16 @@ 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] * @param args Object */ static callParent( args?: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 @@ -9282,10 +10288,13 @@ declare module Ext.data { * @param record Ext.data.Model The Record you want to decorate the prototype of. */ static decorate( record?:Ext.data.IModel ): 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] 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; } @@ -9306,10 +10315,9 @@ declare module Ext.data { previousSibling?: any; /** [Method] Insert node s as the last child node of this node * @param node Ext.data.NodeInterface/Ext.data.NodeInterface[] The node or Array of nodes to append. + * @returns Ext.data.NodeInterface The appended node if single append, or null if an array was passed. */ - appendChild?( node?:any ): any; - appendChild?( node?:Ext.data.INodeInterface ): Ext.data.INodeInterface; - appendChild?( node?:Ext.data.INodeInterface[] ): Ext.data.INodeInterface; + appendChild?( node?:any ): Ext.data.INodeInterface; /** [Method] Bubbles up the tree from this node calling the specified function with each node * @param fn Function The function to call. * @param scope Object The scope (this reference) in which the function is executed. Defaults to the current Node. @@ -9330,11 +10338,13 @@ declare module Ext.data { collapse?( 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 newId String A new id, defaults to this Node's id. * @param deep Boolean If passed as true, all child Nodes are recursively copied into the new Node. If omitted or false, the copy will have no child Nodes. + * @returns Ext.data.NodeInterface A copy of this Node. */ copy?( newId?:string, deep?:boolean ): Ext.data.INodeInterface; /** [Method] Destroys the node @@ -9357,79 +10367,113 @@ 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] 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 child Ext.data.NodeInterface + * @returns Number The index of the node or -1 if it was not found. */ indexOf?( child?:Ext.data.INodeInterface ): 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] Insert a node into this node * @param index Number The zero-based index to insert the node at. * @param node Ext.data.Model The node to insert. + * @returns Ext.data.Model The record you just inserted. */ insertChild?( index?:number, node?:Ext.data.IModel ): Ext.data.IModel; /** [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 expanded */ + /** [Method] Returns true if this node is expanded + * @returns Boolean + */ isExpanded?(): boolean; - /** [Method] Returns true if this node is the first child of its parent */ + /** [Method] Returns true if this node is the first child of its parent + * @returns Boolean + */ isFirst?(): boolean; - /** [Method] Returns true if this node is the last child of its parent */ + /** [Method] Returns true if this node is the last child of its parent + * @returns Boolean + */ isLast?(): 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] Sorts this nodes children using the supplied sort function @@ -9440,6 +10484,7 @@ declare module Ext.data { sort?( sortFn?:any, recursive?:boolean, suppressEvent?:boolean ): void; /** [Method] Updates general data of this node like isFirst isLast depth * @param silent Object + * @returns Boolean */ updateInfo?( silent?:any ): boolean; } @@ -9450,13 +10495,16 @@ 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] * @param args Object */ static callParent( args?: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 @@ -9467,10 +10515,13 @@ declare module Ext.data { * @param record Ext.data.Model The Record you want to decorate the prototype of. */ static decorate( record?:Ext.data.IModel ): 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] 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; } @@ -9489,20 +10540,33 @@ declare module Ext.data { rootVisible?: boolean; /** [Config Option] (Object[]) */ sorters?: any[]; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Object + */ getFilters?(): any; - /** [Method] Returns the value of folderSort */ + /** [Method] Returns the value of folderSort + * @returns Boolean + */ getFolderSort?(): boolean; - /** [Method] Returns the value of node */ + /** [Method] Returns the value of node + * @returns Ext.data.Model + */ getNode?(): Ext.data.IModel; - /** [Method] Returns the value of recursive */ + /** [Method] Returns the value of recursive + * @returns Boolean + */ getRecursive?(): boolean; - /** [Method] Returns the value of rootVisible */ + /** [Method] Returns the value of rootVisible + * @returns Boolean + */ getRootVisible?(): boolean; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Object + */ getSorters?(): any; /** [Method] * @param node Object + * @returns Boolean */ isVisible?( node?:any ): boolean; /** [Method] Sets the value of filters @@ -9569,57 +10633,109 @@ declare module Ext.data { synchronous?: boolean; /** [Config Option] (Boolean) */ withCredentials?: boolean; - /** [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] Returns the value of action */ + /** [Method] Returns the value of action + * @returns String + */ getAction?(): string; - /** [Method] Returns the value of addRecords */ + /** [Method] Returns the value of addRecords + * @returns Boolean + */ getAddRecords?(): boolean; - /** [Method] Returns the value of batch */ + /** [Method] Returns the value of batch + * @returns Ext.data.Batch + */ getBatch?(): Ext.data.IBatch; - /** [Method] Returns the value of callback */ + /** [Method] Returns the value of callback + * @returns Function + */ getCallback?(): any; - /** [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 value of filters */ + /** [Method] Returns the value of filters + * @returns Ext.util.Filter[] + */ getFilters?(): Ext.util.IFilter[]; - /** [Method] Returns the value of grouper */ + /** [Method] Returns the value of grouper + * @returns Ext.util.Grouper + */ getGrouper?(): Ext.util.IGrouper; - /** [Method] Returns the value of limit */ + /** [Method] Returns the value of limit + * @returns Number + */ getLimit?(): number; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns Ext.data.Model + */ getModel?(): Ext.data.IModel; - /** [Method] Returns the value of node */ + /** [Method] Returns the value of node + * @returns Object + */ getNode?(): any; - /** [Method] Returns the value of page */ + /** [Method] Returns the value of page + * @returns Object + */ getPage?(): any; - /** [Method] Returns the value of params */ + /** [Method] Returns the value of params + * @returns Object + */ getParams?(): any; - /** [Method] Returns the value of request */ + /** [Method] Returns the value of request + * @returns Ext.data.Request + */ getRequest?(): Ext.data.IRequest; - /** [Method] Returns the value of response */ + /** [Method] Returns the value of response + * @returns Object + */ getResponse?(): any; - /** [Method] Returns the value of resultSet */ + /** [Method] Returns the value of resultSet + * @returns Ext.data.ResultSet + */ getResultSet?(): Ext.data.IResultSet; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Ext.util.Sorter[] + */ getSorters?(): Ext.util.ISorter[]; - /** [Method] Returns the value of start */ + /** [Method] Returns the value of start + * @returns Number + */ getStart?(): number; - /** [Method] Returns the value of synchronous */ + /** [Method] Returns the value of synchronous + * @returns Boolean + */ getSynchronous?(): boolean; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns Object + */ getUrl?(): any; - /** [Method] Returns the value of withCredentials */ + /** [Method] Returns the value of withCredentials + * @returns Boolean + */ getWithCredentials?(): boolean; - /** [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] Sets the value of action * @param action String @@ -9715,7 +10831,9 @@ declare module Ext.data { * @param withCredentials Boolean */ setWithCredentials?( withCredentials?:boolean ): 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; } } @@ -9737,21 +10855,33 @@ declare module Ext.data.proxy { * @param operation Object * @param callback Object * @param scope Object + * @returns Object */ doRequest?( operation?:any, callback?:any, scope?:any ): any; - /** [Method] Returns the value of headers */ + /** [Method] Returns the value of headers + * @returns Object + */ getHeaders?(): 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; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ getPassword?(): string; - /** [Method] Returns the value of useDefaultXhrHeader */ + /** [Method] Returns the value of useDefaultXhrHeader + * @returns Boolean + */ getUseDefaultXhrHeader?(): boolean; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ getUsername?(): string; - /** [Method] Returns the value of withCredentials */ + /** [Method] Returns the value of withCredentials + * @returns Boolean + */ getWithCredentials?(): boolean; /** [Method] Sets the value of headers * @param headers Object @@ -9793,21 +10923,33 @@ declare module Ext.data { * @param operation Object * @param callback Object * @param scope Object + * @returns Object */ doRequest?( operation?:any, callback?:any, scope?:any ): any; - /** [Method] Returns the value of headers */ + /** [Method] Returns the value of headers + * @returns Object + */ getHeaders?(): 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; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ getPassword?(): string; - /** [Method] Returns the value of useDefaultXhrHeader */ + /** [Method] Returns the value of useDefaultXhrHeader + * @returns Boolean + */ getUseDefaultXhrHeader?(): boolean; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ getUsername?(): string; - /** [Method] Returns the value of withCredentials */ + /** [Method] Returns the value of withCredentials + * @returns Boolean + */ getWithCredentials?(): boolean; /** [Method] Sets the value of headers * @param headers Object @@ -9849,21 +10991,33 @@ declare module Ext.data { * @param operation Object * @param callback Object * @param scope Object + * @returns Object */ doRequest?( operation?:any, callback?:any, scope?:any ): any; - /** [Method] Returns the value of headers */ + /** [Method] Returns the value of headers + * @returns Object + */ getHeaders?(): 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; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ getPassword?(): string; - /** [Method] Returns the value of useDefaultXhrHeader */ + /** [Method] Returns the value of useDefaultXhrHeader + * @returns Boolean + */ getUseDefaultXhrHeader?(): boolean; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ getUsername?(): string; - /** [Method] Returns the value of withCredentials */ + /** [Method] Returns the value of withCredentials + * @returns Boolean + */ getWithCredentials?(): boolean; /** [Method] Sets the value of headers * @param headers Object @@ -9911,7 +11065,9 @@ declare module Ext.data.proxy { paramOrder?: any; /** [Config Option] (Boolean) */ paramsAsHash?: boolean; - /** [Method] Generates a url based on a given Ext data Request object */ + /** [Method] Generates a url based on a given Ext data Request object + * @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 @@ -9919,15 +11075,25 @@ declare module Ext.data.proxy { * @param scope Object */ doRequest?( operation?:any, callback?:any, scope?:any ): void; - /** [Method] Returns the value of api */ + /** [Method] Returns the value of api + * @returns Object + */ getApi?(): any; - /** [Method] Returns the value of directFn */ + /** [Method] Returns the value of directFn + * @returns Function/String + */ getDirectFn?(): any; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ getExtraParams?(): any; - /** [Method] Returns the value of paramOrder */ + /** [Method] Returns the value of paramOrder + * @returns String/String[] + */ getParamOrder?(): any; - /** [Method] Returns the value of paramsAsHash */ + /** [Method] Returns the value of paramsAsHash + * @returns Boolean + */ getParamsAsHash?(): boolean; /** [Method] Sets the value of api * @param api Object @@ -9936,8 +11102,7 @@ declare module Ext.data.proxy { /** [Method] Sets the value of directFn * @param directFn Function/String */ - setDirectFn?( directFn?:any ): any; - setDirectFn?( directFn?:string ): void; + setDirectFn?( directFn?:any ): void; /** [Method] Sets the value of extraParams * @param extraParams Object */ @@ -9945,9 +11110,7 @@ declare module Ext.data.proxy { /** [Method] Sets the value of paramOrder * @param paramOrder String/String[] */ - setParamOrder?( paramOrder?:any ): any; - setParamOrder?( paramOrder?:string ): void; - setParamOrder?( paramOrder?:string[] ): void; + setParamOrder?( paramOrder?:any ): void; /** [Method] Sets the value of paramsAsHash * @param paramsAsHash Boolean */ @@ -9966,7 +11129,9 @@ declare module Ext.data { paramOrder?: any; /** [Config Option] (Boolean) */ paramsAsHash?: boolean; - /** [Method] Generates a url based on a given Ext data Request object */ + /** [Method] Generates a url based on a given Ext data Request object + * @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 @@ -9974,15 +11139,25 @@ declare module Ext.data { * @param scope Object */ doRequest?( operation?:any, callback?:any, scope?:any ): void; - /** [Method] Returns the value of api */ + /** [Method] Returns the value of api + * @returns Object + */ getApi?(): any; - /** [Method] Returns the value of directFn */ + /** [Method] Returns the value of directFn + * @returns Function/String + */ getDirectFn?(): any; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ getExtraParams?(): any; - /** [Method] Returns the value of paramOrder */ + /** [Method] Returns the value of paramOrder + * @returns String/String[] + */ getParamOrder?(): any; - /** [Method] Returns the value of paramsAsHash */ + /** [Method] Returns the value of paramsAsHash + * @returns Boolean + */ getParamsAsHash?(): boolean; /** [Method] Sets the value of api * @param api Object @@ -9991,8 +11166,7 @@ declare module Ext.data { /** [Method] Sets the value of directFn * @param directFn Function/String */ - setDirectFn?( directFn?:any ): any; - setDirectFn?( directFn?:string ): void; + setDirectFn?( directFn?:any ): void; /** [Method] Sets the value of extraParams * @param extraParams Object */ @@ -10000,9 +11174,7 @@ declare module Ext.data { /** [Method] Sets the value of paramOrder * @param paramOrder String/String[] */ - setParamOrder?( paramOrder?:any ): any; - setParamOrder?( paramOrder?:string ): void; - setParamOrder?( paramOrder?:string[] ): void; + setParamOrder?( paramOrder?:any ): void; /** [Method] Sets the value of paramsAsHash * @param paramsAsHash Boolean */ @@ -10021,6 +11193,7 @@ 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] Performs the given destroy operation */ @@ -10029,15 +11202,24 @@ declare module Ext.data.proxy { * @param operation Ext.data.Operation The Operation object to execute. * @param callback Function A callback function to execute when the Operation has been completed. * @param scope Object The scope to execute the callback in. + * @returns Object */ doRequest?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): any; - /** [Method] Returns the value of autoAppendParams */ + /** [Method] Returns the value of autoAppendParams + * @returns Boolean + */ getAutoAppendParams?(): boolean; - /** [Method] Returns the value of callbackKey */ + /** [Method] Returns the value of callbackKey + * @returns String + */ getCallbackKey?(): string; - /** [Method] Returns the value of defaultWriterType */ + /** [Method] Returns the value of defaultWriterType + * @returns String + */ getDefaultWriterType?(): string; - /** [Method] Returns the value of recordParam */ + /** [Method] Returns the value of recordParam + * @returns String + */ getRecordParam?(): string; /** [Method] Sets the value of autoAppendParams * @param autoAppendParams Boolean @@ -10069,6 +11251,7 @@ 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] Performs the given destroy operation */ @@ -10077,15 +11260,24 @@ declare module Ext.data { * @param operation Ext.data.Operation The Operation object to execute. * @param callback Function A callback function to execute when the Operation has been completed. * @param scope Object The scope to execute the callback in. + * @returns Object */ doRequest?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): any; - /** [Method] Returns the value of autoAppendParams */ + /** [Method] Returns the value of autoAppendParams + * @returns Boolean + */ getAutoAppendParams?(): boolean; - /** [Method] Returns the value of callbackKey */ + /** [Method] Returns the value of callbackKey + * @returns String + */ getCallbackKey?(): string; - /** [Method] Returns the value of defaultWriterType */ + /** [Method] Returns the value of defaultWriterType + * @returns String + */ getDefaultWriterType?(): string; - /** [Method] Returns the value of recordParam */ + /** [Method] Returns the value of recordParam + * @returns String + */ getRecordParam?(): string; /** [Method] Sets the value of autoAppendParams * @param autoAppendParams Boolean @@ -10131,7 +11323,9 @@ declare module Ext.data.proxy { * @param scope Object Scope to execute the callback function in */ destroy?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; /** [Method] Reads data from the configured data object * @param operation Ext.data.Operation The read Operation @@ -10169,7 +11363,9 @@ declare module Ext.data { * @param scope Object Scope to execute the callback function in */ destroy?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; /** [Method] Reads data from the configured data object * @param operation Ext.data.Operation The read Operation @@ -10203,6 +11399,7 @@ declare module Ext.data.proxy { writer?: 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] Performs the given create operation @@ -10217,15 +11414,25 @@ declare module Ext.data.proxy { * @param scope Object Scope to execute the callback function in */ destroy?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; - /** [Method] Returns the value of batchActions */ + /** [Method] Returns the value of batchActions + * @returns Boolean + */ getBatchActions?(): boolean; - /** [Method] Returns the value of batchOrder */ + /** [Method] Returns the value of batchOrder + * @returns String + */ getBatchOrder?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns String/Ext.data.Model + */ getModel?(): any; - /** [Method] Returns the value of reader */ + /** [Method] Returns the value of reader + * @returns Object/String/Ext.data.reader.Reader + */ getReader?(): any; - /** [Method] Returns the value of writer */ + /** [Method] Returns the value of writer + * @returns Object/String/Ext.data.writer.Writer + */ getWriter?(): any; /** [Method] Performs the given read operation * @param operation Ext.data.Operation The Operation to perform @@ -10244,9 +11451,7 @@ declare module Ext.data.proxy { /** [Method] Sets the value of model * @param model String/Ext.data.Model */ - setModel?( model?:any ): any; - setModel?( model?:string ): void; - setModel?( model?:Ext.data.IModel ): void; + setModel?( model?:any ): void; /** [Method] Sets the value of reader * @param reader Object/String/Ext.data.reader.Reader */ @@ -10277,6 +11482,7 @@ declare module Ext.data { writer?: 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] Performs the given create operation @@ -10291,15 +11497,25 @@ declare module Ext.data { * @param scope Object Scope to execute the callback function in */ destroy?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; - /** [Method] Returns the value of batchActions */ + /** [Method] Returns the value of batchActions + * @returns Boolean + */ getBatchActions?(): boolean; - /** [Method] Returns the value of batchOrder */ + /** [Method] Returns the value of batchOrder + * @returns String + */ getBatchOrder?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns String/Ext.data.Model + */ getModel?(): any; - /** [Method] Returns the value of reader */ + /** [Method] Returns the value of reader + * @returns Object/String/Ext.data.reader.Reader + */ getReader?(): any; - /** [Method] Returns the value of writer */ + /** [Method] Returns the value of writer + * @returns Object/String/Ext.data.writer.Writer + */ getWriter?(): any; /** [Method] Performs the given read operation * @param operation Ext.data.Operation The Operation to perform @@ -10318,9 +11534,7 @@ declare module Ext.data { /** [Method] Sets the value of model * @param model String/Ext.data.Model */ - setModel?( model?:any ): any; - setModel?( model?:string ): void; - setModel?( model?:Ext.data.IModel ): void; + setModel?( model?:any ): void; /** [Method] Sets the value of reader * @param reader Object/String/Ext.data.reader.Reader */ @@ -10351,6 +11565,7 @@ declare module Ext.data { writer?: 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] Performs the given create operation @@ -10365,15 +11580,25 @@ declare module Ext.data { * @param scope Object Scope to execute the callback function in */ destroy?( operation?:Ext.data.IOperation, callback?:any, scope?:any ): void; - /** [Method] Returns the value of batchActions */ + /** [Method] Returns the value of batchActions + * @returns Boolean + */ getBatchActions?(): boolean; - /** [Method] Returns the value of batchOrder */ + /** [Method] Returns the value of batchOrder + * @returns String + */ getBatchOrder?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns String/Ext.data.Model + */ getModel?(): any; - /** [Method] Returns the value of reader */ + /** [Method] Returns the value of reader + * @returns Object/String/Ext.data.reader.Reader + */ getReader?(): any; - /** [Method] Returns the value of writer */ + /** [Method] Returns the value of writer + * @returns Object/String/Ext.data.writer.Writer + */ getWriter?(): any; /** [Method] Performs the given read operation * @param operation Ext.data.Operation The Operation to perform @@ -10392,9 +11617,7 @@ declare module Ext.data { /** [Method] Sets the value of model * @param model String/Ext.data.Model */ - setModel?( model?:any ): any; - setModel?( model?:string ): void; - setModel?( model?:Ext.data.IModel ): void; + setModel?( model?:any ): void; /** [Method] Sets the value of reader * @param reader Object/String/Ext.data.reader.Reader */ @@ -10419,17 +11642,21 @@ declare module Ext.data.proxy { batchActions?: boolean; /** [Config Option] (String) */ format?: string; - /** [Method] Specialized version of buildUrl that incorporates the appendId and format options into the generated url - * @param request Object + /** [Method] Returns the value of actionMethods + * @returns Object */ - buildUrl?( request?:any ): string; - /** [Method] Returns the value of actionMethods */ getActionMethods?(): any; - /** [Method] Returns the value of appendId */ + /** [Method] Returns the value of appendId + * @returns Boolean + */ getAppendId?(): boolean; - /** [Method] Returns the value of batchActions */ + /** [Method] Returns the value of batchActions + * @returns Boolean + */ getBatchActions?(): boolean; - /** [Method] Returns the value of format */ + /** [Method] Returns the value of format + * @returns String + */ getFormat?(): string; /** [Method] Sets the value of actionMethods * @param actionMethods Object @@ -10457,17 +11684,21 @@ declare module Ext.data { batchActions?: boolean; /** [Config Option] (String) */ format?: string; - /** [Method] Specialized version of buildUrl that incorporates the appendId and format options into the generated url - * @param request Object + /** [Method] Returns the value of actionMethods + * @returns Object */ - buildUrl?( request?:any ): string; - /** [Method] Returns the value of actionMethods */ getActionMethods?(): any; - /** [Method] Returns the value of appendId */ + /** [Method] Returns the value of appendId + * @returns Boolean + */ getAppendId?(): boolean; - /** [Method] Returns the value of batchActions */ + /** [Method] Returns the value of batchActions + * @returns Boolean + */ getBatchActions?(): boolean; - /** [Method] Returns the value of format */ + /** [Method] Returns the value of format + * @returns String + */ getFormat?(): string; /** [Method] Sets the value of actionMethods * @param actionMethods Object @@ -10526,10 +11757,12 @@ declare module Ext.data.proxy { afterRequest?( request?:Ext.data.IRequest, success?:boolean ): void; /** [Method] Creates and returns an Ext data Request object based on the options passed by the Store that this Proxy is attached to * @param operation Ext.data.Operation The Operation object 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 */ @@ -10544,39 +11777,69 @@ 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] Returns the value of api */ + /** [Method] Returns the value of api + * @returns Object + */ getApi?(): any; - /** [Method] Returns the value of cacheString */ + /** [Method] Returns the value of cacheString + * @returns String + */ getCacheString?(): string; - /** [Method] Returns the value of directionParam */ + /** [Method] Returns the value of directionParam + * @returns String + */ getDirectionParam?(): string; - /** [Method] Returns the value of enablePagingParams */ + /** [Method] Returns the value of enablePagingParams + * @returns Boolean + */ getEnablePagingParams?(): boolean; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ getExtraParams?(): any; - /** [Method] Returns the value of filterParam */ + /** [Method] Returns the value of filterParam + * @returns String + */ getFilterParam?(): string; - /** [Method] Returns the value of groupParam */ + /** [Method] Returns the value of groupParam + * @returns String + */ getGroupParam?(): string; - /** [Method] Returns the value of limitParam */ + /** [Method] Returns the value of limitParam + * @returns String + */ getLimitParam?(): string; - /** [Method] Returns the value of noCache */ + /** [Method] Returns the value of noCache + * @returns Boolean + */ getNoCache?(): boolean; - /** [Method] Returns the value of pageParam */ + /** [Method] Returns the value of pageParam + * @returns String + */ getPageParam?(): string; - /** [Method] Returns the value of simpleSortMode */ + /** [Method] Returns the value of simpleSortMode + * @returns Boolean + */ getSimpleSortMode?(): boolean; - /** [Method] Returns the value of sortParam */ + /** [Method] Returns the value of sortParam + * @returns String + */ getSortParam?(): string; - /** [Method] Returns the value of startParam */ + /** [Method] Returns the value of startParam + * @returns String + */ getStartParam?(): string; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; /** [Method] This method handles the processing of the response and is usually overridden by subclasses to do additional processing * @param success Boolean Whether or not this request was successful @@ -10697,10 +11960,12 @@ declare module Ext.data { afterRequest?( request?:Ext.data.IRequest, success?:boolean ): void; /** [Method] Creates and returns an Ext data Request object based on the options passed by the Store that this Proxy is attached to * @param operation Ext.data.Operation The Operation object 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 */ @@ -10715,39 +11980,69 @@ 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] Returns the value of api */ + /** [Method] Returns the value of api + * @returns Object + */ getApi?(): any; - /** [Method] Returns the value of cacheString */ + /** [Method] Returns the value of cacheString + * @returns String + */ getCacheString?(): string; - /** [Method] Returns the value of directionParam */ + /** [Method] Returns the value of directionParam + * @returns String + */ getDirectionParam?(): string; - /** [Method] Returns the value of enablePagingParams */ + /** [Method] Returns the value of enablePagingParams + * @returns Boolean + */ getEnablePagingParams?(): boolean; - /** [Method] Returns the value of extraParams */ + /** [Method] Returns the value of extraParams + * @returns Object + */ getExtraParams?(): any; - /** [Method] Returns the value of filterParam */ + /** [Method] Returns the value of filterParam + * @returns String + */ getFilterParam?(): string; - /** [Method] Returns the value of groupParam */ + /** [Method] Returns the value of groupParam + * @returns String + */ getGroupParam?(): string; - /** [Method] Returns the value of limitParam */ + /** [Method] Returns the value of limitParam + * @returns String + */ getLimitParam?(): string; - /** [Method] Returns the value of noCache */ + /** [Method] Returns the value of noCache + * @returns Boolean + */ getNoCache?(): boolean; - /** [Method] Returns the value of pageParam */ + /** [Method] Returns the value of pageParam + * @returns String + */ getPageParam?(): string; - /** [Method] Returns the value of simpleSortMode */ + /** [Method] Returns the value of simpleSortMode + * @returns Boolean + */ getSimpleSortMode?(): boolean; - /** [Method] Returns the value of sortParam */ + /** [Method] Returns the value of sortParam + * @returns String + */ getSortParam?(): string; - /** [Method] Returns the value of startParam */ + /** [Method] Returns the value of startParam + * @returns String + */ getStartParam?(): string; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; /** [Method] This method handles the processing of the response and is usually overridden by subclasses to do additional processing * @param success Boolean Whether or not this request was successful @@ -10855,21 +12150,34 @@ declare module Ext.data.proxy { * @param scope Object */ destroy?( operation?:any, callback?:any, scope?:any ): void; - /** [Method] Returns the value of columns */ + /** [Method] Returns the value of columns + * @returns String + */ getColumns?(): string; - /** [Method] Returns the value of database */ + /** [Method] Returns the value of database + * @returns String + */ getDatabase?(): string; - /** [Method] Returns the value of defaultDateFormat */ + /** [Method] Returns the value of defaultDateFormat + * @returns String + */ getDefaultDateFormat?(): string; /** [Method] Formats the data for each record before sending it to the server * @param record Object The record that we are writing to the server. + * @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?:any ): any; - /** [Method] Returns the value of table */ + /** [Method] Returns the value of table + * @returns String + */ getTable?(): string; - /** [Method] Returns the value of tableExists */ + /** [Method] Returns the value of tableExists + * @returns Boolean + */ getTableExists?(): boolean; - /** [Method] Returns the value of uniqueIdStrategy */ + /** [Method] Returns the value of uniqueIdStrategy + * @returns Boolean + */ getUniqueIdStrategy?(): boolean; /** [Method] Performs the given read operation * @param operation Object @@ -10931,11 +12239,17 @@ declare module Ext.data.proxy { * @param scope Object */ destroy?( operation?:any, callback?:any, scope?:any ): void; - /** [Method] Returns the value of defaultDateFormat */ + /** [Method] Returns the value of defaultDateFormat + * @returns String + */ getDefaultDateFormat?(): string; - /** [Method] Returns the value of enablePagingParams */ + /** [Method] Returns the value of enablePagingParams + * @returns Boolean + */ getEnablePagingParams?(): boolean; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns String + */ getId?(): string; /** [Method] inherit docs * @param operation Object @@ -10990,11 +12304,17 @@ declare module Ext.data { * @param scope Object */ destroy?( operation?:any, callback?:any, scope?:any ): void; - /** [Method] Returns the value of defaultDateFormat */ + /** [Method] Returns the value of defaultDateFormat + * @returns String + */ getDefaultDateFormat?(): string; - /** [Method] Returns the value of enablePagingParams */ + /** [Method] Returns the value of enablePagingParams + * @returns Boolean + */ getEnablePagingParams?(): boolean; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns String + */ getId?(): string; /** [Method] inherit docs * @param operation Object @@ -11033,9 +12353,13 @@ declare module Ext.data.reader { successProperty?: string; /** [Config Option] (String) */ totalProperty?: string; - /** [Method] Returns the value of successProperty */ + /** [Method] Returns the value of successProperty + * @returns Object + */ getSuccessProperty?(): any; - /** [Method] Returns the value of totalProperty */ + /** [Method] Returns the value of totalProperty + * @returns Object + */ getTotalProperty?(): any; /** [Method] Sets the value of successProperty * @param successProperty Object @@ -11053,9 +12377,13 @@ declare module Ext.data { successProperty?: string; /** [Config Option] (String) */ totalProperty?: string; - /** [Method] Returns the value of successProperty */ + /** [Method] Returns the value of successProperty + * @returns Object + */ getSuccessProperty?(): any; - /** [Method] Returns the value of totalProperty */ + /** [Method] Returns the value of totalProperty + * @returns Object + */ getTotalProperty?(): any; /** [Method] Sets the value of successProperty * @param successProperty Object @@ -11073,13 +12401,18 @@ declare module Ext.data.reader { record?: string; /** [Config Option] (Boolean) */ useSimpleAccessors?: boolean; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] Takes a raw response object as passed to this read and returns the useful data segment of it * @param response Object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; - /** [Method] Returns the value of useSimpleAccessors */ + /** [Method] Returns the value of useSimpleAccessors + * @returns Boolean + */ getUseSimpleAccessors?(): boolean; /** [Method] Sets the value of record * @param record String @@ -11097,13 +12430,18 @@ declare module Ext.data { record?: string; /** [Config Option] (Boolean) */ useSimpleAccessors?: boolean; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] Takes a raw response object as passed to this read and returns the useful data segment of it * @param response Object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; - /** [Method] Returns the value of useSimpleAccessors */ + /** [Method] Returns the value of useSimpleAccessors + * @returns Boolean + */ getUseSimpleAccessors?(): boolean; /** [Method] Sets the value of record * @param record String @@ -11143,16 +12481,14 @@ declare module Ext.data.reader { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -11164,9 +12500,7 @@ declare module Ext.data.reader { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -11174,9 +12508,7 @@ declare module Ext.data.reader { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -11184,47 +12516,69 @@ 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 events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of clientIdProperty */ + /** [Method] Returns the value of clientIdProperty + * @returns String + */ getClientIdProperty?(): string; - /** [Method] Returns the value of idProperty */ + /** [Method] Returns the value of idProperty + * @returns String + */ getIdProperty?(): string; - /** [Method] Returns the value of implicitIncludes */ + /** [Method] Returns the value of implicitIncludes + * @returns Boolean + */ getImplicitIncludes?(): boolean; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of messageProperty */ + /** [Method] Returns the value of messageProperty + * @returns String + */ getMessageProperty?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns Object + */ getModel?(): any; /** [Method] Takes a raw response object as passed to this read and returns the useful data segment of it * @param response Object The response object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; - /** [Method] Returns the value of rootProperty */ + /** [Method] Returns the value of rootProperty + * @returns String + */ getRootProperty?(): string; - /** [Method] Returns the value of successProperty */ + /** [Method] Returns the value of successProperty + * @returns any + */ getSuccessProperty?(): any; - /** [Method] Returns the value of totalProperty */ + /** [Method] Returns the value of totalProperty + * @returns any + */ getTotalProperty?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -11234,18 +12588,14 @@ declare module Ext.data.reader { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -11253,36 +12603,35 @@ declare module Ext.data.reader { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [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 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 object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -11291,16 +12640,14 @@ declare module Ext.data.reader { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -11308,18 +12655,14 @@ declare module Ext.data.reader { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -11327,9 +12670,7 @@ declare module Ext.data.reader { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of clientIdProperty * @param clientIdProperty String */ @@ -11375,25 +12716,21 @@ declare module Ext.data.reader { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.data { @@ -11424,16 +12761,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -11445,9 +12780,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -11455,9 +12788,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -11465,47 +12796,69 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of clientIdProperty */ + /** [Method] Returns the value of clientIdProperty + * @returns String + */ getClientIdProperty?(): string; - /** [Method] Returns the value of idProperty */ + /** [Method] Returns the value of idProperty + * @returns String + */ getIdProperty?(): string; - /** [Method] Returns the value of implicitIncludes */ + /** [Method] Returns the value of implicitIncludes + * @returns Boolean + */ getImplicitIncludes?(): boolean; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of messageProperty */ + /** [Method] Returns the value of messageProperty + * @returns String + */ getMessageProperty?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns Object + */ getModel?(): any; /** [Method] Takes a raw response object as passed to this read and returns the useful data segment of it * @param response Object The response object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; - /** [Method] Returns the value of rootProperty */ + /** [Method] Returns the value of rootProperty + * @returns String + */ getRootProperty?(): string; - /** [Method] Returns the value of successProperty */ + /** [Method] Returns the value of successProperty + * @returns any + */ getSuccessProperty?(): any; - /** [Method] Returns the value of totalProperty */ + /** [Method] Returns the value of totalProperty + * @returns any + */ getTotalProperty?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -11515,18 +12868,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -11534,36 +12883,35 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [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 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 object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -11572,16 +12920,14 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -11589,18 +12935,14 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -11608,9 +12950,7 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of clientIdProperty * @param clientIdProperty String */ @@ -11656,25 +12996,21 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.data { @@ -11705,16 +13041,14 @@ declare module Ext.data { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -11726,9 +13060,7 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -11736,9 +13068,7 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -11746,47 +13076,69 @@ declare module Ext.data { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of clientIdProperty */ + /** [Method] Returns the value of clientIdProperty + * @returns String + */ getClientIdProperty?(): string; - /** [Method] Returns the value of idProperty */ + /** [Method] Returns the value of idProperty + * @returns String + */ getIdProperty?(): string; - /** [Method] Returns the value of implicitIncludes */ + /** [Method] Returns the value of implicitIncludes + * @returns Boolean + */ getImplicitIncludes?(): boolean; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of messageProperty */ + /** [Method] Returns the value of messageProperty + * @returns String + */ getMessageProperty?(): string; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns Object + */ getModel?(): any; /** [Method] Takes a raw response object as passed to this read and returns the useful data segment of it * @param response Object The response object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; - /** [Method] Returns the value of rootProperty */ + /** [Method] Returns the value of rootProperty + * @returns String + */ getRootProperty?(): string; - /** [Method] Returns the value of successProperty */ + /** [Method] Returns the value of successProperty + * @returns any + */ getSuccessProperty?(): any; - /** [Method] Returns the value of totalProperty */ + /** [Method] Returns the value of totalProperty + * @returns any + */ getTotalProperty?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -11796,18 +13148,14 @@ declare module Ext.data { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -11815,36 +13163,35 @@ declare module Ext.data { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [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 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 object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -11853,16 +13200,14 @@ declare module Ext.data { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -11870,18 +13215,14 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -11889,9 +13230,7 @@ declare module Ext.data { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of clientIdProperty * @param clientIdProperty String */ @@ -11937,25 +13276,21 @@ declare module Ext.data { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.data.reader { @@ -11964,16 +13299,21 @@ declare module Ext.data.reader { record?: string; /** [Method] Normalizes the data object * @param data Object The raw data object. + * @returns Object Returns the documentElement property of the data object if present, or the same object if not. */ getData?( data?:any ): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] inherit docs * @param response Object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; /** [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; /** [Method] Sets the value of record @@ -11988,16 +13328,21 @@ declare module Ext.data { record?: string; /** [Method] Normalizes the data object * @param data Object The raw data object. + * @returns Object Returns the documentElement property of the data object if present, or the same object if not. */ getData?( data?:any ): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] inherit docs * @param response Object + * @returns Object The useful data from the response */ getResponseData?( response?:any ): any; /** [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; /** [Method] Sets the value of record @@ -12038,45 +13383,85 @@ declare module Ext.data { withCredentials?: boolean; /** [Config Option] (Object) */ xmlData?: any; - /** [Method] Returns the value of action */ + /** [Method] Returns the value of action + * @returns String + */ getAction?(): string; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Object + */ getArgs?(): any; - /** [Method] Returns the value of callback */ + /** [Method] Returns the value of callback + * @returns Object + */ getCallback?(): any; - /** [Method] Returns the value of callbackKey */ + /** [Method] Returns the value of callbackKey + * @returns String + */ getCallbackKey?(): string; - /** [Method] Returns the value of directFn */ + /** [Method] Returns the value of directFn + * @returns Object + */ getDirectFn?(): any; - /** [Method] Returns the value of disableCaching */ + /** [Method] Returns the value of disableCaching + * @returns Boolean + */ getDisableCaching?(): boolean; - /** [Method] Returns the value of headers */ + /** [Method] Returns the value of headers + * @returns Object + */ getHeaders?(): any; - /** [Method] Returns the value of jsonData */ + /** [Method] Returns the value of jsonData + * @returns Object + */ getJsonData?(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns String + */ getMethod?(): string; - /** [Method] Returns the value of operation */ + /** [Method] Returns the value of operation + * @returns Ext.data.Operation + */ getOperation?(): Ext.data.IOperation; - /** [Method] Returns the value of params */ + /** [Method] Returns the value of params + * @returns Object + */ getParams?(): any; - /** [Method] Returns the value of password */ + /** [Method] Returns the value of password + * @returns String + */ getPassword?(): string; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns Ext.data.proxy.Proxy + */ getProxy?(): Ext.data.proxy.IProxy; - /** [Method] Returns the value of records */ + /** [Method] Returns the value of records + * @returns Object + */ getRecords?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; - /** [Method] Returns the value of username */ + /** [Method] Returns the value of username + * @returns String + */ getUsername?(): string; - /** [Method] Returns the value of withCredentials */ + /** [Method] Returns the value of withCredentials + * @returns Boolean + */ getWithCredentials?(): boolean; - /** [Method] Returns the value of xmlData */ + /** [Method] Returns the value of xmlData + * @returns Object + */ getXmlData?(): any; /** [Method] Sets the value of action * @param action String @@ -12174,17 +13559,29 @@ declare module Ext.data { success?: boolean; /** [Config Option] (Number) */ total?: number; - /** [Method] Returns the value of count */ + /** [Method] Returns the value of count + * @returns Number + */ getCount?(): number; - /** [Method] Returns the value of loaded */ + /** [Method] Returns the value of loaded + * @returns Boolean + */ getLoaded?(): boolean; - /** [Method] Returns the value of message */ + /** [Method] Returns the value of message + * @returns String + */ getMessage?(): string; - /** [Method] Returns the value of records */ + /** [Method] Returns the value of records + * @returns Ext.data.Model[] + */ getRecords?(): Ext.data.IModel[]; - /** [Method] Returns the value of success */ + /** [Method] Returns the value of success + * @returns Boolean + */ getSuccess?(): boolean; - /** [Method] Returns the value of total */ + /** [Method] Returns the value of total + * @returns Number + */ getTotal?(): number; /** [Method] Sets the value of count * @param count Number @@ -12218,58 +13615,69 @@ declare module Ext.data { export class SortTypes { /** [Method] Date sorting * @param value Object The value being converted. + * @returns Number The comparison value. */ static asDate( value?:any ): number; /** [Method] Float sorting * @param value Object The value being converted. + * @returns Number The comparison value. */ static asFloat( value?:any ): number; /** [Method] Integer sorting * @param value Object The value being converted. + * @returns Number The comparison value. */ static asInt( value?:any ): number; /** [Method] Strips all HTML tags to sort on text only * @param value Object The value being converted. + * @returns String The comparison value. */ static asText( value?:any ): string; /** [Method] Case insensitive string * @param value Object The value being converted. + * @returns String The comparison value. */ static asUCString( value?:any ): string; /** [Method] Strips all HTML tags to sort on text only case insensitive * @param value Object The value being converted. + * @returns String The comparison value. */ static asUCText( value?:any ): string; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Default sort that does nothing * @param value Object The value being converted. + * @returns Object The comparison value. */ static none( value?: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; } } @@ -12321,16 +13729,16 @@ declare module Ext.data { currentPage?: number; /** [Method] Adds Model instance to the Store * @param model Ext.data.Model[]/Ext.data.Model... 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 ): any; - add?( model?:Ext.data.IModel[] ): Ext.data.IModel[]; - add?( model:Ext.data.IModel ): Ext.data.IModel[]; + add?( model?:any ): Ext.data.IModel[]; /** [Method] We are using applyData so that we can return nothing and prevent the this data property to be overridden * @param data Object */ applyData?( data?:any ): void; /** [Method] Gets the average value in the store * @param field String The field in each record you want to get the average for. + * @returns Number The average value, if no items exist, 0. */ average?( field?:string ): number; /** [Method] Reverts to a view of the Record cache with no filtering applied @@ -12363,20 +13771,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 @@ -12386,109 +13795,182 @@ 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?: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 + * @returns Ext.data.Model/undefined The first model instance in the store, or undefined. */ - 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; - /** [Method] Convenience function for getting the first model instance in the store */ first?(): any; - /** [Method] Gets the number of all cached records including the ones currently filtered */ + /** [Method] Gets the number of all cached records including the ones currently filtered + * @returns Number The number of all Records in the Store's cache. + */ getAllCount?(): number; /** [Method] Get the Record at the specified index * @param index Number The index of the Record to find. + * @returns Ext.data.Model/undefined The Record at the passed index. Returns undefined if not found. */ getAt?( index?:number ): any; - /** [Method] Returns the value of autoLoad */ + /** [Method] Returns the value of autoLoad + * @returns Boolean/Object + */ getAutoLoad?(): any; - /** [Method] Returns the value of autoSync */ + /** [Method] Returns the value of autoSync + * @returns Boolean + */ getAutoSync?(): boolean; /** [Method] Get the Record with the specified id * @param id String The id of the Record to find. + * @returns Ext.data.Model/undefined The Record with the passed id. Returns undefined if not found. */ getById?( id?:string ): any; - /** [Method] Returns the value of clearOnPageLoad */ + /** [Method] Returns the value of clearOnPageLoad + * @returns Boolean + */ getClearOnPageLoad?(): boolean; - /** [Method] Gets the number of cached records */ + /** [Method] Gets the number of cached records + * @returns Number The number of Records in the Store's cache. + */ getCount?(): number; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object[]/Ext.data.Model[] + */ getData?(): any; - /** [Method] Returns the value of destroyRemovedRecords */ + /** [Method] Returns the value of destroyRemovedRecords + * @returns Boolean + */ getDestroyRemovedRecords?(): boolean; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Object[] + */ getFields?(): any[]; - /** [Method] Returns the value of getGroupString */ + /** [Method] Returns the value of getGroupString + * @returns Function + */ getGetGroupString?(): any; - /** [Method] Returns the value of groupDir */ + /** [Method] Returns the value of groupDir + * @returns String + */ getGroupDir?(): string; - /** [Method] Returns the value of groupField */ + /** [Method] Returns the value of groupField + * @returns String + */ getGroupField?(): string; - /** [Method] Returns the value of grouper */ + /** [Method] Returns the value of grouper + * @returns Object + */ getGrouper?(): any; /** [Method] Returns an array containing the result of applying the grouper to the records in this store * @param groupName String Pass in an optional groupName argument to access a specific group as defined by grouper. + * @returns Object/Object[] The grouped data. */ getGroups?( groupName?:string ): any; - /** [Method] Returns the value of model */ + /** [Method] Returns the value of model + * @returns String + */ getModel?(): string; - /** [Method] Returns the value of modelDefaults */ + /** [Method] Returns the value of modelDefaults + * @returns Object + */ getModelDefaults?(): any; - /** [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 value of pageSize */ + /** [Method] Returns the value of pageSize + * @returns Number + */ getPageSize?(): number; - /** [Method] Returns the value of proxy */ + /** [Method] Returns the value of proxy + * @returns String/Ext.data.proxy.Proxy/Object + */ getProxy?(): any; /** [Method] Returns a range of Records between specified indices * @param startIndex Number The starting index. * @param endIndex Number The ending index (defaults to the last Record in the Store). + * @returns Ext.data.Model[] An array of Records. */ getRange?( startIndex?:number, endIndex?:number ): Ext.data.IModel[]; - /** [Method] Returns the value of remoteFilter */ + /** [Method] Returns the value of remoteFilter + * @returns Boolean + */ getRemoteFilter?(): boolean; - /** [Method] Returns the value of remoteGroup */ + /** [Method] Returns the value of remoteGroup + * @returns Boolean + */ getRemoteGroup?(): boolean; - /** [Method] Returns the value of remoteSort */ + /** [Method] Returns the value of remoteSort + * @returns Boolean + */ getRemoteSort?(): boolean; - /** [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 the value of storeId */ + /** [Method] Returns the value of storeId + * @returns String + */ getStoreId?(): string; - /** [Method] Returns the value of syncRemovedRecords */ + /** [Method] Returns the value of syncRemovedRecords + * @returns Boolean + */ getSyncRemovedRecords?(): boolean; - /** [Method] Returns the value of totalCount */ + /** [Method] Returns the value of totalCount + * @returns Number + */ getTotalCount?(): number; - /** [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] Get the index within the cache of the passed Record * @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 cache 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] 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 cache. + * @returns Object */ insert?( index?:number, records?:Ext.data.IModel[] ): any; - /** [Method] Returns true if the Store is set to autoLoad or is a type which loads upon instantiation */ + /** [Method] Returns true if the Store is set to autoLoad or is a type which loads upon instantiation + * @returns Boolean + */ isAutoLoading?(): boolean; - /** [Method] Returns true if this store is currently filtered */ + /** [Method] Returns true if this store is currently filtered + * @returns Boolean + */ isFiltered?(): boolean; - /** [Method] This method tells you if this store has a grouper defined on it */ + /** [Method] This method tells you if this store has a grouper defined on it + * @returns Boolean true if this store has a grouper defined. + */ isGrouped?(): boolean; - /** [Method] Returns true if the Store has been loaded */ + /** [Method] Returns true if the Store has been loaded + * @returns Boolean true if the Store has been loaded. + */ isLoaded?(): boolean; - /** [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] Returns true if this store is currently sorted */ + /** [Method] Returns true if this store is currently sorted + * @returns Boolean + */ isSorted?(): boolean; - /** [Method] Convenience function for getting the last model instance in the store */ + /** [Method] Convenience function for getting the last model instance in the store + * @returns Ext.data.Model/undefined The last model instance in the store, or undefined. + */ last?(): 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. * @param scope Object Scope for the function. + * @returns Object */ load?( options?:any, scope?:any ): any; /** [Method] Loads an array of data straight into the Store @@ -12504,16 +13986,17 @@ declare module Ext.data { loadPage?( page?:number, options?:any, scope?:any ): void; /** [Method] Adds Model instance to the Store * @param model Ext.data.Model[]/Ext.data.Model... 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. */ - loadRecords?( model?:any ): any; - loadRecords?( model?:Ext.data.IModel[] ): Ext.data.IModel[]; - loadRecords?( model:Ext.data.IModel ): Ext.data.IModel[]; + loadRecords?( model?:any ): Ext.data.IModel[]; /** [Method] Gets the maximum value in the store * @param field String The field in each record. + * @returns Object/undefined The maximum value, if no items exist, undefined. */ max?( field?:string ): any; /** [Method] Gets the minimum value in the store * @param field String The field in each record. + * @returns Object/undefined The minimum value, if no items exist, undefined. */ min?( field?:string ): any; /** [Method] Loads the next page in the current data set @@ -12527,14 +14010,13 @@ declare module Ext.data { /** [Method] Query 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] Removes the given record from the Store firing the removerecords event passing all the instances that are removed * @param records Ext.data.Model/Ext.data.Model[] Model instance or array of instances to remove. */ - remove?( records?:any ): any; - remove?( records?:Ext.data.IModel ): void; - remove?( records?:Ext.data.IModel[] ): void; + remove?( records?:any ): void; /** [Method] Remove all items from the store * @param silent Boolean Prevent the clear event from being fired. */ @@ -12636,14 +14118,15 @@ declare module Ext.data { * @param defaultDirection String The default overall direction to sort the data by. * @param where String This can be either 'prepend' or 'append'. If you leave this undefined it will clear the current sorters. */ - sort?( sorters?:any, defaultDirection?:any, where?:any ): any; - sort?( sorters?:string, defaultDirection?:string, where?:string ): void; - sort?( sorters?:Ext.util.ISorter[], defaultDirection?:string, where?:string ): void; + sort?( sorters?:any, defaultDirection?:string, where?:string ): void; /** [Method] Sums the value of property for each record between start and end and returns the result * @param field String The field in each record. + * @returns Number The sum. */ sum?( field?:string ): number; - /** [Method] Synchronizes the Store with its Proxy */ + /** [Method] Synchronizes the Store with its Proxy + * @returns Object + */ sync?(): any; } } @@ -12654,6 +14137,7 @@ declare module Ext.data { /** [Method] Adds an item to the collection * @param key String 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 item Object The item to add. + * @returns Object The item added. */ static add( key?:string, item?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -12666,6 +14150,7 @@ declare module Ext.data { static addFilter( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Object + * @returns Object */ static addFilters( filters?:any ): any; /** [Method] This method adds a sorter @@ -12680,29 +14165,33 @@ declare module Ext.data { static addSorters( sorters?:any[], defaultDirection?:string ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] 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] Returns true if the collection contains the passed Object as an item * @param item Object The Object to look for in the collection. + * @returns Boolean true if the collection contains the Object as an item. */ static contains( item?: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] */ @@ -12722,106 +14211,141 @@ declare module Ext.data { * @param value Object * @param anyMatch Object * @param caseSensitive Object + * @returns Array */ static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any[]; /** [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 * @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. */ static findBy( fn?:any, scope?:any ): any; /** [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 if the item was not found. */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ static findInsertionIndex( items?:any[], item?:any ): number; - /** [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 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 value of autoFilter */ + /** [Method] Returns the value of autoFilter + * @returns Boolean + */ static getAutoFilter(): boolean; - /** [Method] Returns the value of autoSort */ + /** [Method] Returns the value of autoSort + * @returns Boolean + */ static getAutoSort(): boolean; /** [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] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ static getDefaultSortDirection(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ static getFilterFn(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ static getFilterRoot(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ static getFilters(): any[]; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ 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 start Number The starting index. * @param end Number The ending index. Defaults to the last item. + * @returns Array An array of items. */ static getRange( start?:number, end?:number ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ static getSortFn(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ static getSortRoot(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ static getSorters(): any[]; /** [Method] Returns index within the collection of the passed Object * @param item Object The item to find the index of. + * @returns Number Index of the item. Returns -1 if not found. */ static indexOf( item?: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 instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Inserts an item at the specified index in the collection * @param index Number The index to insert the item at. * @param key String The key to associate with the new item, or the item itself. * @param item Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ static insert( index?:number, key?:string, item?:any ): any; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ static insertFilter( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ static insertFilters( index?:number, filters?:any[] ): any[]; /** [Method] This method adds a sorter at a given index @@ -12830,12 +14354,17 @@ declare module Ext.data { * @param defaultDirection String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'. */ static insertSorter( index?:number, sorter?:any, defaultDirection?:string ): void; - /** [Method] This method inserts all the sorters in the passed array at the given index */ + /** [Method] This method inserts all the sorters in the passed array at the given index + * @returns Ext.util.Collection this + */ static insertSorters(): Ext.util.ICollection; - /** [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] Registers one or more Stores with the StoreManager @@ -12844,22 +14373,27 @@ declare module Ext.data { static register( stores:Ext.data.IStore ): void; /** [Method] Remove an item from the collection * @param item Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( item?:any ): any; /** [Method] Remove all items in the passed array from 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] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] This method removes all the filters in a passed array * @param filters Object + * @returns Ext.util.Collection this */ static removeFilters( filters?:any ): Ext.util.ICollection; /** [Method] This method removes a sorter @@ -12868,11 +14402,13 @@ declare module Ext.data { static removeSorter( sorter?:any ): void; /** [Method] This method removes all the sorters in a passed array * @param sorters Object + * @returns Ext.util.Collection this */ static removeSorters( sorters?:any ): Ext.util.ICollection; /** [Method] Replaces an item in the collection * @param oldKey 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 item Object {Object} item (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( oldKey?:string, item?:any ): any; /** [Method] Sets the value of autoFilter @@ -12906,9 +14442,12 @@ declare module Ext.data { /** [Method] This method will sort an array based on the currently configured sorters * @param sorters Object * @param defaultDirection Object + * @returns Array The array you passed after it is sorted. */ static sort( sorters?:any, defaultDirection?: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] Unregisters one or more Stores with the StoreManager * @param stores String/Object... Any number of Store instances or ID-s. @@ -12923,6 +14462,7 @@ declare module Ext { /** [Method] Adds an item to the collection * @param key String 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 item Object The item to add. + * @returns Object The item added. */ static add( key?:string, item?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -12935,6 +14475,7 @@ declare module Ext { static addFilter( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Object + * @returns Object */ static addFilters( filters?:any ): any; /** [Method] This method adds a sorter @@ -12949,29 +14490,33 @@ declare module Ext { static addSorters( sorters?:any[], defaultDirection?:string ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] 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] Returns true if the collection contains the passed Object as an item * @param item Object The Object to look for in the collection. + * @returns Boolean true if the collection contains the Object as an item. */ static contains( item?: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] */ @@ -12991,106 +14536,141 @@ declare module Ext { * @param value Object * @param anyMatch Object * @param caseSensitive Object + * @returns Array */ static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any[]; /** [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 * @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. */ static findBy( fn?:any, scope?:any ): any; /** [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 if the item was not found. */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ static findInsertionIndex( items?:any[], item?:any ): number; - /** [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 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 value of autoFilter */ + /** [Method] Returns the value of autoFilter + * @returns Boolean + */ static getAutoFilter(): boolean; - /** [Method] Returns the value of autoSort */ + /** [Method] Returns the value of autoSort + * @returns Boolean + */ static getAutoSort(): boolean; /** [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] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ static getDefaultSortDirection(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ static getFilterFn(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ static getFilterRoot(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ static getFilters(): any[]; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ 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 start Number The starting index. * @param end Number The ending index. Defaults to the last item. + * @returns Array An array of items. */ static getRange( start?:number, end?:number ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ static getSortFn(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ static getSortRoot(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ static getSorters(): any[]; /** [Method] Returns index within the collection of the passed Object * @param item Object The item to find the index of. + * @returns Number Index of the item. Returns -1 if not found. */ static indexOf( item?: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 instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Inserts an item at the specified index in the collection * @param index Number The index to insert the item at. * @param key String The key to associate with the new item, or the item itself. * @param item Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ static insert( index?:number, key?:string, item?:any ): any; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ static insertFilter( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ static insertFilters( index?:number, filters?:any[] ): any[]; /** [Method] This method adds a sorter at a given index @@ -13099,12 +14679,17 @@ declare module Ext { * @param defaultDirection String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'. */ static insertSorter( index?:number, sorter?:any, defaultDirection?:string ): void; - /** [Method] This method inserts all the sorters in the passed array at the given index */ + /** [Method] This method inserts all the sorters in the passed array at the given index + * @returns Ext.util.Collection this + */ static insertSorters(): Ext.util.ICollection; - /** [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] Registers one or more Stores with the StoreManager @@ -13113,22 +14698,27 @@ declare module Ext { static register( stores:Ext.data.IStore ): void; /** [Method] Remove an item from the collection * @param item Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( item?:any ): any; /** [Method] Remove all items in the passed array from 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] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] This method removes all the filters in a passed array * @param filters Object + * @returns Ext.util.Collection this */ static removeFilters( filters?:any ): Ext.util.ICollection; /** [Method] This method removes a sorter @@ -13137,11 +14727,13 @@ declare module Ext { static removeSorter( sorter?:any ): void; /** [Method] This method removes all the sorters in a passed array * @param sorters Object + * @returns Ext.util.Collection this */ static removeSorters( sorters?:any ): Ext.util.ICollection; /** [Method] Replaces an item in the collection * @param oldKey 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 item Object {Object} item (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( oldKey?:string, item?:any ): any; /** [Method] Sets the value of autoFilter @@ -13175,9 +14767,12 @@ declare module Ext { /** [Method] This method will sort an array based on the currently configured sorters * @param sorters Object * @param defaultDirection Object + * @returns Array The array you passed after it is sorted. */ static sort( sorters?:any, defaultDirection?: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] Unregisters one or more Stores with the StoreManager * @param stores String/Object... Any number of Store instances or ID-s. @@ -13192,6 +14787,7 @@ declare module Ext.data { /** [Method] Adds an item to the collection * @param key String 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 item Object The item to add. + * @returns Object The item added. */ static add( key?:string, item?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -13204,6 +14800,7 @@ declare module Ext.data { static addFilter( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Object + * @returns Object */ static addFilters( filters?:any ): any; /** [Method] This method adds a sorter @@ -13218,29 +14815,33 @@ declare module Ext.data { static addSorters( sorters?:any[], defaultDirection?:string ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] 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] Returns true if the collection contains the passed Object as an item * @param item Object The Object to look for in the collection. + * @returns Boolean true if the collection contains the Object as an item. */ static contains( item?: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] */ @@ -13260,106 +14861,141 @@ declare module Ext.data { * @param value Object * @param anyMatch Object * @param caseSensitive Object + * @returns Array */ static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any[]; /** [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 * @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. */ static findBy( fn?:any, scope?:any ): any; /** [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 if the item was not found. */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ static findInsertionIndex( items?:any[], item?:any ): number; - /** [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 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 value of autoFilter */ + /** [Method] Returns the value of autoFilter + * @returns Boolean + */ static getAutoFilter(): boolean; - /** [Method] Returns the value of autoSort */ + /** [Method] Returns the value of autoSort + * @returns Boolean + */ static getAutoSort(): boolean; /** [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] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ static getDefaultSortDirection(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ static getFilterFn(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ static getFilterRoot(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ static getFilters(): any[]; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ 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 start Number The starting index. * @param end Number The ending index. Defaults to the last item. + * @returns Array An array of items. */ static getRange( start?:number, end?:number ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ static getSortFn(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ static getSortRoot(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ static getSorters(): any[]; /** [Method] Returns index within the collection of the passed Object * @param item Object The item to find the index of. + * @returns Number Index of the item. Returns -1 if not found. */ static indexOf( item?: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 instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Inserts an item at the specified index in the collection * @param index Number The index to insert the item at. * @param key String The key to associate with the new item, or the item itself. * @param item Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ static insert( index?:number, key?:string, item?:any ): any; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ static insertFilter( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ static insertFilters( index?:number, filters?:any[] ): any[]; /** [Method] This method adds a sorter at a given index @@ -13368,12 +15004,17 @@ declare module Ext.data { * @param defaultDirection String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'. */ static insertSorter( index?:number, sorter?:any, defaultDirection?:string ): void; - /** [Method] This method inserts all the sorters in the passed array at the given index */ + /** [Method] This method inserts all the sorters in the passed array at the given index + * @returns Ext.util.Collection this + */ static insertSorters(): Ext.util.ICollection; - /** [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] Registers one or more Stores with the StoreManager @@ -13382,22 +15023,27 @@ declare module Ext.data { static register( stores:Ext.data.IStore ): void; /** [Method] Remove an item from the collection * @param item Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( item?:any ): any; /** [Method] Remove all items in the passed array from 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] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] This method removes all the filters in a passed array * @param filters Object + * @returns Ext.util.Collection this */ static removeFilters( filters?:any ): Ext.util.ICollection; /** [Method] This method removes a sorter @@ -13406,11 +15052,13 @@ declare module Ext.data { static removeSorter( sorter?:any ): void; /** [Method] This method removes all the sorters in a passed array * @param sorters Object + * @returns Ext.util.Collection this */ static removeSorters( sorters?:any ): Ext.util.ICollection; /** [Method] Replaces an item in the collection * @param oldKey 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 item Object {Object} item (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( oldKey?:string, item?:any ): any; /** [Method] Sets the value of autoFilter @@ -13444,9 +15092,12 @@ declare module Ext.data { /** [Method] This method will sort an array based on the currently configured sorters * @param sorters Object * @param defaultDirection Object + * @returns Array The array you passed after it is sorted. */ static sort( sorters?:any, defaultDirection?: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] Unregisters one or more Stores with the StoreManager * @param stores String/Object... Any number of Store instances or ID-s. @@ -13461,6 +15112,7 @@ declare module Ext { /** [Method] Adds an item to the collection * @param key String 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 item Object The item to add. + * @returns Object The item added. */ static add( key?:string, item?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -13473,6 +15125,7 @@ declare module Ext { static addFilter( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Object + * @returns Object */ static addFilters( filters?:any ): any; /** [Method] This method adds a sorter @@ -13487,29 +15140,33 @@ declare module Ext { static addSorters( sorters?:any[], defaultDirection?:string ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] 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] Returns true if the collection contains the passed Object as an item * @param item Object The Object to look for in the collection. + * @returns Boolean true if the collection contains the Object as an item. */ static contains( item?: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] */ @@ -13529,106 +15186,141 @@ declare module Ext { * @param value Object * @param anyMatch Object * @param caseSensitive Object + * @returns Array */ static filter( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any[]; /** [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 * @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. */ static findBy( fn?:any, scope?:any ): any; /** [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 if the item was not found. */ static findIndexBy( fn?:any, scope?:any, start?:number ): number; /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ static findInsertionIndex( items?:any[], item?:any ): number; - /** [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 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 value of autoFilter */ + /** [Method] Returns the value of autoFilter + * @returns Boolean + */ static getAutoFilter(): boolean; - /** [Method] Returns the value of autoSort */ + /** [Method] Returns the value of autoSort + * @returns Boolean + */ static getAutoSort(): boolean; /** [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] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ static getDefaultSortDirection(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ static getFilterFn(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ static getFilterRoot(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ static getFilters(): any[]; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ 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 start Number The starting index. * @param end Number The ending index. Defaults to the last item. + * @returns Array An array of items. */ static getRange( start?:number, end?:number ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ static getSortFn(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ static getSortRoot(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ static getSorters(): any[]; /** [Method] Returns index within the collection of the passed Object * @param item Object The item to find the index of. + * @returns Number Index of the item. Returns -1 if not found. */ static indexOf( item?: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 instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Inserts an item at the specified index in the collection * @param index Number The index to insert the item at. * @param key String The key to associate with the new item, or the item itself. * @param item Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ static insert( index?:number, key?:string, item?:any ): any; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ static insertFilter( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ static insertFilters( index?:number, filters?:any[] ): any[]; /** [Method] This method adds a sorter at a given index @@ -13637,12 +15329,17 @@ declare module Ext { * @param defaultDirection String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'. */ static insertSorter( index?:number, sorter?:any, defaultDirection?:string ): void; - /** [Method] This method inserts all the sorters in the passed array at the given index */ + /** [Method] This method inserts all the sorters in the passed array at the given index + * @returns Ext.util.Collection this + */ static insertSorters(): Ext.util.ICollection; - /** [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] Registers one or more Stores with the StoreManager @@ -13651,22 +15348,27 @@ declare module Ext { static register( stores:Ext.data.IStore ): void; /** [Method] Remove an item from the collection * @param item Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ static remove( item?:any ): any; /** [Method] Remove all items in the passed array from 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] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ static removeAtKey( key?:string ): any; /** [Method] This method removes all the filters in a passed array * @param filters Object + * @returns Ext.util.Collection this */ static removeFilters( filters?:any ): Ext.util.ICollection; /** [Method] This method removes a sorter @@ -13675,11 +15377,13 @@ declare module Ext { static removeSorter( sorter?:any ): void; /** [Method] This method removes all the sorters in a passed array * @param sorters Object + * @returns Ext.util.Collection this */ static removeSorters( sorters?:any ): Ext.util.ICollection; /** [Method] Replaces an item in the collection * @param oldKey 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 item Object {Object} item (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ static replace( oldKey?:string, item?:any ): any; /** [Method] Sets the value of autoFilter @@ -13713,9 +15417,12 @@ declare module Ext { /** [Method] This method will sort an array based on the currently configured sorters * @param sorters Object * @param defaultDirection Object + * @returns Array The array you passed after it is sorted. */ static sort( sorters?:any, defaultDirection?: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] Unregisters one or more Stores with the StoreManager * @param stores String/Object... Any number of Store instances or ID-s. @@ -13735,26 +15442,39 @@ declare module Ext.data { nodeParam?: string; /** [Config Option] (Ext.data.Model/Ext.data.NodeInterface/Object) */ root?: any; - /** [Method] Returns the value of clearOnLoad */ + /** [Method] Returns the value of clearOnLoad + * @returns Boolean + */ getClearOnLoad?(): boolean; - /** [Method] Returns the value of defaultRootId */ + /** [Method] Returns the value of defaultRootId + * @returns String + */ getDefaultRootId?(): string; - /** [Method] Returns the value of defaultRootProperty */ + /** [Method] Returns the value of defaultRootProperty + * @returns String + */ getDefaultRootProperty?(): string; /** [Method] Returns the record node by id * @param id Object + * @returns Ext.data.NodeInterface */ getNodeById?( id?:any ): Ext.data.INodeInterface; - /** [Method] Returns the value of nodeParam */ + /** [Method] Returns the value of nodeParam + * @returns String + */ getNodeParam?(): string; - /** [Method] Returns the value of root */ + /** [Method] Returns the value of root + * @returns Ext.data.Model/Ext.data.NodeInterface/Object + */ getRoot?(): any; /** [Method] Returns the root node for this tree * @param node Object + * @returns Ext.data.Model */ getRootNode?( node?:any ): 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. + * @returns Object */ load?( options?:any ): any; /** [Method] Called internally when a Proxy has completed a load request @@ -13787,6 +15507,7 @@ declare module Ext.data { setRoot?( root?:any ): void; /** [Method] Sets the root node for this tree * @param node Ext.data.Model + * @returns Ext.data.Model */ setRootNode?( node?:Ext.data.IModel ): Ext.data.IModel; } @@ -13797,30 +15518,34 @@ declare module Ext.data { export class Types { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?: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; } } @@ -13830,64 +15555,75 @@ declare module Ext.data { export class Validations { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [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 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 * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Returns the configured error message for any of the validation types * @param type String The type of validation you want to get the error message for. + * @returns Object */ static getMessage( type?: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 instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [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; } } @@ -13901,13 +15637,21 @@ declare module Ext.data.writer { root?: string; /** [Config Option] (String) */ rootProperty?: string; - /** [Method] Returns the value of allowSingle */ + /** [Method] Returns the value of allowSingle + * @returns Boolean + */ getAllowSingle?(): boolean; - /** [Method] Returns the value of encode */ + /** [Method] Returns the value of encode + * @returns Boolean + */ getEncode?(): boolean; - /** [Method] Returns the value of encodeRequest */ + /** [Method] Returns the value of encodeRequest + * @returns Boolean + */ getEncodeRequest?(): boolean; - /** [Method] Returns the value of rootProperty */ + /** [Method] Returns the value of rootProperty + * @returns String + */ getRootProperty?(): string; /** [Method] Sets the value of allowSingle * @param allowSingle Boolean @@ -13937,13 +15681,21 @@ declare module Ext.data { root?: string; /** [Config Option] (String) */ rootProperty?: string; - /** [Method] Returns the value of allowSingle */ + /** [Method] Returns the value of allowSingle + * @returns Boolean + */ getAllowSingle?(): boolean; - /** [Method] Returns the value of encode */ + /** [Method] Returns the value of encode + * @returns Boolean + */ getEncode?(): boolean; - /** [Method] Returns the value of encodeRequest */ + /** [Method] Returns the value of encodeRequest + * @returns Boolean + */ getEncodeRequest?(): boolean; - /** [Method] Returns the value of rootProperty */ + /** [Method] Returns the value of rootProperty + * @returns String + */ getRootProperty?(): string; /** [Method] Sets the value of allowSingle * @param allowSingle Boolean @@ -13969,13 +15721,18 @@ declare module Ext.data.writer { nameProperty?: string; /** [Config Option] (Boolean) */ writeAllFields?: boolean; - /** [Method] Returns the value of nameProperty */ + /** [Method] Returns the value of nameProperty + * @returns String + */ getNameProperty?(): string; /** [Method] Formats the data for each record before sending it to the server * @param record Object The record that we are writing to the server. + * @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?:any ): any; - /** [Method] Returns the value of writeAllFields */ + /** [Method] Returns the value of writeAllFields + * @returns Boolean + */ getWriteAllFields?(): boolean; /** [Method] Sets the value of nameProperty * @param nameProperty String @@ -13987,6 +15744,7 @@ declare module Ext.data.writer { setWriteAllFields?( writeAllFields?:boolean ): void; /** [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; } @@ -13997,13 +15755,18 @@ declare module Ext.data { nameProperty?: string; /** [Config Option] (Boolean) */ writeAllFields?: boolean; - /** [Method] Returns the value of nameProperty */ + /** [Method] Returns the value of nameProperty + * @returns String + */ getNameProperty?(): string; /** [Method] Formats the data for each record before sending it to the server * @param record Object The record that we are writing to the server. + * @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?:any ): any; - /** [Method] Returns the value of writeAllFields */ + /** [Method] Returns the value of writeAllFields + * @returns Boolean + */ getWriteAllFields?(): boolean; /** [Method] Sets the value of nameProperty * @param nameProperty String @@ -14015,6 +15778,7 @@ declare module Ext.data { setWriteAllFields?( writeAllFields?:boolean ): void; /** [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; } @@ -14025,13 +15789,18 @@ declare module Ext.data { nameProperty?: string; /** [Config Option] (Boolean) */ writeAllFields?: boolean; - /** [Method] Returns the value of nameProperty */ + /** [Method] Returns the value of nameProperty + * @returns String + */ getNameProperty?(): string; /** [Method] Formats the data for each record before sending it to the server * @param record Object The record that we are writing to the server. + * @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?:any ): any; - /** [Method] Returns the value of writeAllFields */ + /** [Method] Returns the value of writeAllFields + * @returns Boolean + */ getWriteAllFields?(): boolean; /** [Method] Sets the value of nameProperty * @param nameProperty String @@ -14043,6 +15812,7 @@ declare module Ext.data { setWriteAllFields?( writeAllFields?:boolean ): void; /** [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; } @@ -14057,13 +15827,21 @@ declare module Ext.data.writer { header?: string; /** [Config Option] (String) */ record?: string; - /** [Method] Returns the value of defaultDocumentRoot */ + /** [Method] Returns the value of defaultDocumentRoot + * @returns String + */ getDefaultDocumentRoot?(): string; - /** [Method] Returns the value of documentRoot */ + /** [Method] Returns the value of documentRoot + * @returns String + */ getDocumentRoot?(): string; - /** [Method] Returns the value of header */ + /** [Method] Returns the value of header + * @returns String + */ getHeader?(): string; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] Sets the value of defaultDocumentRoot * @param defaultDocumentRoot String @@ -14084,6 +15862,7 @@ declare module Ext.data.writer { /** [Method] * @param request Object * @param data Object + * @returns Object */ writeRecords?( request?:any, data?:any ): any; } @@ -14098,13 +15877,21 @@ declare module Ext.data { header?: string; /** [Config Option] (String) */ record?: string; - /** [Method] Returns the value of defaultDocumentRoot */ + /** [Method] Returns the value of defaultDocumentRoot + * @returns String + */ getDefaultDocumentRoot?(): string; - /** [Method] Returns the value of documentRoot */ + /** [Method] Returns the value of documentRoot + * @returns String + */ getDocumentRoot?(): string; - /** [Method] Returns the value of header */ + /** [Method] Returns the value of header + * @returns String + */ getHeader?(): string; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns String + */ getRecord?(): string; /** [Method] Sets the value of defaultDocumentRoot * @param defaultDocumentRoot String @@ -14125,6 +15912,7 @@ declare module Ext.data { /** [Method] * @param request Object * @param data Object + * @returns Object */ writeRecords?( request?:any, data?:any ): any; } @@ -14151,17 +15939,29 @@ declare module Ext.dataview.component { record?: Ext.data.IModel; /** [Config Option] (Number/String) */ width?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of dataMap */ + /** [Method] Returns the value of dataMap + * @returns Object + */ getDataMap?(): any; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of itemCls */ + /** [Method] Returns the value of itemCls + * @returns String + */ getItemCls?(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array + */ getItems?(): any[]; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; /** [Method] Sets the value of baseCls * @param baseCls String @@ -14205,15 +16005,25 @@ declare module Ext.dataview.component { tpl?: any; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of body */ + /** [Method] Returns the value of body + * @returns Object + */ getBody?(): any; - /** [Method] Returns the value of dataMap */ + /** [Method] Returns the value of dataMap + * @returns Object + */ getDataMap?(): any; - /** [Method] Returns the value of disclosure */ + /** [Method] Returns the value of disclosure + * @returns Object + */ getDisclosure?(): any; - /** [Method] Returns the value of header */ + /** [Method] Returns the value of header + * @returns Object + */ getHeader?(): any; /** [Method] Sets the value of baseCls * @param baseCls String @@ -14253,13 +16063,21 @@ declare module Ext.dataview.component { record?: Ext.data.IModel; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of disclosure */ + /** [Method] Returns the value of disclosure + * @returns Object + */ getDisclosure?(): any; - /** [Method] Returns the value of header */ + /** [Method] Returns the value of header + * @returns Object + */ getHeader?(): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -14351,10 +16169,7 @@ declare module Ext.dataview { * @param records Number/Array/Ext.data.Model The record(s) to deselect. Can also be a number to reference by index. * @param suppressEvent Boolean If true the deselect event will not be fired. */ - deselect?( records?:any, suppressEvent?:any ): any; - deselect?( records?:number, suppressEvent?:boolean ): void; - deselect?( records?:any[], suppressEvent?:boolean ): void; - deselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; + deselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Deselects all records * @param supress Object */ @@ -14365,119 +16180,181 @@ declare module Ext.dataview { * @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. */ - doDeselect?( records?:any, suppressEvent?:any ): any; - doDeselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; - doDeselect?( records?:number, suppressEvent?:boolean ): void; + doDeselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Selects a record instance by record instance or index * @param records Ext.data.Model/Number An array of records or an index. * @param keepExisting Boolean * @param suppressEvent Boolean Set to false to not fire a select event. */ - doSelect?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - doSelect?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - doSelect?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; + doSelect?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; /** [Method] Returns the template node the passed child belongs to or null if it doesn t belong to one */ findItemByChild?(): void; /** [Method] Returns the template node by the Ext EventObject or null if it is not found */ findTargetByEvent?(): void; - /** [Method] Returns the value of allowDeselect */ + /** [Method] Returns the value of allowDeselect + * @returns Boolean + */ getAllowDeselect?(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getCount?(): number; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object[] + */ getData?(): any[]; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of deferEmptyText */ + /** [Method] Returns the value of deferEmptyText + * @returns Boolean + */ getDeferEmptyText?(): boolean; - /** [Method] Returns the value of deselectOnContainerClick */ + /** [Method] Returns the value of deselectOnContainerClick + * @returns Boolean + */ getDeselectOnContainerClick?(): boolean; - /** [Method] Returns the value of disableSelection */ + /** [Method] Returns the value of disableSelection + * @returns Boolean + */ getDisableSelection?(): boolean; - /** [Method] Returns the value of emptyText */ + /** [Method] Returns the value of emptyText + * @returns String + */ getEmptyText?(): string; - /** [Method] Returns the value of inline */ + /** [Method] Returns the value of inline + * @returns Boolean/Object + */ getInline?(): any; /** [Method] Returns an item at the specified index * @param index Number Index of the item. + * @returns Ext.dom.Element/Ext.dataview.component.DataItem item Item at the specified index. */ getItemAt?( index?:number ): any; - /** [Method] Returns the value of itemCls */ + /** [Method] Returns the value of itemCls + * @returns String + */ getItemCls?(): string; - /** [Method] Returns the value of itemConfig */ + /** [Method] Returns the value of itemConfig + * @returns Object + */ getItemConfig?(): any; /** [Method] Returns an index for the specified item * @param item Number The item to locate. + * @returns Number Index for the specified item. */ getItemIndex?( item?:number ): number; - /** [Method] Returns the value of itemTpl */ + /** [Method] Returns the value of itemTpl + * @returns String/String[]/Ext.XTemplate + */ getItemTpl?(): any; - /** [Method] Returns the array of previously selected items */ + /** [Method] Returns the array of previously selected items + * @returns Array The previous selection. + */ getLastSelected?(): any[]; - /** [Method] Returns the value of loadingText */ + /** [Method] Returns the value of loadingText + * @returns String + */ getLoadingText?(): string; - /** [Method] Returns the value of maxItemCache */ + /** [Method] Returns the value of maxItemCache + * @returns Number + */ getMaxItemCache?(): number; - /** [Method] Returns the value of mode */ + /** [Method] Returns the value of mode + * @returns String + */ getMode?(): string; /** [Method] Gets a template node */ getNode?(): void; /** [Method] Gets a range nodes */ getNodes?(): void; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; - /** [Method] Returns the value of pressedDelay */ + /** [Method] Returns the value of pressedDelay + * @returns Number + */ getPressedDelay?(): number; /** [Method] Gets an array of the records from an array of nodes */ getRecords?(): void; - /** [Method] Returns the value of scrollToTopOnRefresh */ + /** [Method] Returns the value of scrollToTopOnRefresh + * @returns Boolean + */ getScrollToTopOnRefresh?(): boolean; - /** [Method] Returns the value of scrollable */ + /** [Method] Returns the value of scrollable + * @returns Boolean + */ getScrollable?(): boolean; - /** [Method] Returns the value of selectedCls */ + /** [Method] Returns the value of selectedCls + * @returns String + */ getSelectedCls?(): string; /** [Method] Gets the currently selected nodes */ getSelectedNodes?(): void; /** [Method] Gets an array of the selected records */ getSelectedRecords?(): void; - /** [Method] Returns an array of the currently selected records */ + /** [Method] Returns an array of the currently selected records + * @returns Array An array of selected records. + */ getSelection?(): any[]; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getSelectionCount?(): number; - /** [Method] Returns the selection mode currently used by this Selectable */ + /** [Method] Returns the selection mode currently used by this Selectable + * @returns String The current mode. + */ getSelectionMode?(): string; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.Store/Object + */ getStore?(): any; - /** [Method] Returns the value of triggerCtEvent */ + /** [Method] Returns the value of triggerCtEvent + * @returns String + */ getTriggerCtEvent?(): string; - /** [Method] Returns the value of triggerEvent */ + /** [Method] Returns the value of triggerEvent + * @returns String + */ getTriggerEvent?(): string; - /** [Method] Returns the value of useComponents */ + /** [Method] Returns the value of useComponents + * @returns Boolean + */ getUseComponents?(): boolean; - /** [Method] Returns an array of the current items in the DataView */ + /** [Method] Returns an array of the current items in the DataView + * @returns Ext.dom.Element[]/Ext.dataview.component.DataItem[] Array of Items. + */ getViewItems?(): any; /** [Method] Method called when the Store s Reader throws an exception */ handleException?(): void; - /** [Method] Returns true if there is a selected record */ + /** [Method] Returns true if there is a selected record + * @returns Boolean + */ hasSelection?(): boolean; /** [Method] Finds the index of the passed node */ indexOf?(): void; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; - /** [Method] Returns true if the Selectable is currently locked */ + /** [Method] Returns true if the Selectable is currently locked + * @returns Boolean True if currently locked + */ isLocked?(): 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] Function which can be overridden to provide custom formatting for each Record that is used by this DataView s templat * @param data Object/Object[] The raw data object that was used to create the Record. * @param index 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, index?:number, record?:Ext.data.IModel ): any; /** [Method] Refreshes the view by reloading the data from the store and re rendering the template */ @@ -14489,10 +16366,7 @@ declare module Ext.dataview { * @param keepExisting Boolean If true, the existing selection will be added to (if not, the old selection is replaced). * @param suppressEvent Boolean If true, the select event will not be fired. */ - select?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - select?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:any[], 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 * @param silent Boolean true to suppress all select events. */ @@ -14550,10 +16424,7 @@ declare module Ext.dataview { /** [Method] Sets the value of itemTpl * @param itemTpl String/String[]/Ext.XTemplate */ - setItemTpl?( itemTpl?:any ): any; - setItemTpl?( itemTpl?:string ): void; - setItemTpl?( itemTpl?:string[] ): void; - setItemTpl?( itemTpl?:Ext.IXTemplate ): void; + setItemTpl?( itemTpl?:any ): void; /** [Method] This was an internal function accidentally exposed in 1 x and now deprecated */ setLastFocused?(): void; /** [Method] Sets the value of loadingText @@ -14681,10 +16552,7 @@ declare module Ext { * @param records Number/Array/Ext.data.Model The record(s) to deselect. Can also be a number to reference by index. * @param suppressEvent Boolean If true the deselect event will not be fired. */ - deselect?( records?:any, suppressEvent?:any ): any; - deselect?( records?:number, suppressEvent?:boolean ): void; - deselect?( records?:any[], suppressEvent?:boolean ): void; - deselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; + deselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Deselects all records * @param supress Object */ @@ -14695,119 +16563,181 @@ declare module Ext { * @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. */ - doDeselect?( records?:any, suppressEvent?:any ): any; - doDeselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; - doDeselect?( records?:number, suppressEvent?:boolean ): void; + doDeselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Selects a record instance by record instance or index * @param records Ext.data.Model/Number An array of records or an index. * @param keepExisting Boolean * @param suppressEvent Boolean Set to false to not fire a select event. */ - doSelect?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - doSelect?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - doSelect?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; + doSelect?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; /** [Method] Returns the template node the passed child belongs to or null if it doesn t belong to one */ findItemByChild?(): void; /** [Method] Returns the template node by the Ext EventObject or null if it is not found */ findTargetByEvent?(): void; - /** [Method] Returns the value of allowDeselect */ + /** [Method] Returns the value of allowDeselect + * @returns Boolean + */ getAllowDeselect?(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getCount?(): number; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object[] + */ getData?(): any[]; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of deferEmptyText */ + /** [Method] Returns the value of deferEmptyText + * @returns Boolean + */ getDeferEmptyText?(): boolean; - /** [Method] Returns the value of deselectOnContainerClick */ + /** [Method] Returns the value of deselectOnContainerClick + * @returns Boolean + */ getDeselectOnContainerClick?(): boolean; - /** [Method] Returns the value of disableSelection */ + /** [Method] Returns the value of disableSelection + * @returns Boolean + */ getDisableSelection?(): boolean; - /** [Method] Returns the value of emptyText */ + /** [Method] Returns the value of emptyText + * @returns String + */ getEmptyText?(): string; - /** [Method] Returns the value of inline */ + /** [Method] Returns the value of inline + * @returns Boolean/Object + */ getInline?(): any; /** [Method] Returns an item at the specified index * @param index Number Index of the item. + * @returns Ext.dom.Element/Ext.dataview.component.DataItem item Item at the specified index. */ getItemAt?( index?:number ): any; - /** [Method] Returns the value of itemCls */ + /** [Method] Returns the value of itemCls + * @returns String + */ getItemCls?(): string; - /** [Method] Returns the value of itemConfig */ + /** [Method] Returns the value of itemConfig + * @returns Object + */ getItemConfig?(): any; /** [Method] Returns an index for the specified item * @param item Number The item to locate. + * @returns Number Index for the specified item. */ getItemIndex?( item?:number ): number; - /** [Method] Returns the value of itemTpl */ + /** [Method] Returns the value of itemTpl + * @returns String/String[]/Ext.XTemplate + */ getItemTpl?(): any; - /** [Method] Returns the array of previously selected items */ + /** [Method] Returns the array of previously selected items + * @returns Array The previous selection. + */ getLastSelected?(): any[]; - /** [Method] Returns the value of loadingText */ + /** [Method] Returns the value of loadingText + * @returns String + */ getLoadingText?(): string; - /** [Method] Returns the value of maxItemCache */ + /** [Method] Returns the value of maxItemCache + * @returns Number + */ getMaxItemCache?(): number; - /** [Method] Returns the value of mode */ + /** [Method] Returns the value of mode + * @returns String + */ getMode?(): string; /** [Method] Gets a template node */ getNode?(): void; /** [Method] Gets a range nodes */ getNodes?(): void; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; - /** [Method] Returns the value of pressedDelay */ + /** [Method] Returns the value of pressedDelay + * @returns Number + */ getPressedDelay?(): number; /** [Method] Gets an array of the records from an array of nodes */ getRecords?(): void; - /** [Method] Returns the value of scrollToTopOnRefresh */ + /** [Method] Returns the value of scrollToTopOnRefresh + * @returns Boolean + */ getScrollToTopOnRefresh?(): boolean; - /** [Method] Returns the value of scrollable */ + /** [Method] Returns the value of scrollable + * @returns Boolean + */ getScrollable?(): boolean; - /** [Method] Returns the value of selectedCls */ + /** [Method] Returns the value of selectedCls + * @returns String + */ getSelectedCls?(): string; /** [Method] Gets the currently selected nodes */ getSelectedNodes?(): void; /** [Method] Gets an array of the selected records */ getSelectedRecords?(): void; - /** [Method] Returns an array of the currently selected records */ + /** [Method] Returns an array of the currently selected records + * @returns Array An array of selected records. + */ getSelection?(): any[]; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getSelectionCount?(): number; - /** [Method] Returns the selection mode currently used by this Selectable */ + /** [Method] Returns the selection mode currently used by this Selectable + * @returns String The current mode. + */ getSelectionMode?(): string; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.Store/Object + */ getStore?(): any; - /** [Method] Returns the value of triggerCtEvent */ + /** [Method] Returns the value of triggerCtEvent + * @returns String + */ getTriggerCtEvent?(): string; - /** [Method] Returns the value of triggerEvent */ + /** [Method] Returns the value of triggerEvent + * @returns String + */ getTriggerEvent?(): string; - /** [Method] Returns the value of useComponents */ + /** [Method] Returns the value of useComponents + * @returns Boolean + */ getUseComponents?(): boolean; - /** [Method] Returns an array of the current items in the DataView */ + /** [Method] Returns an array of the current items in the DataView + * @returns Ext.dom.Element[]/Ext.dataview.component.DataItem[] Array of Items. + */ getViewItems?(): any; /** [Method] Method called when the Store s Reader throws an exception */ handleException?(): void; - /** [Method] Returns true if there is a selected record */ + /** [Method] Returns true if there is a selected record + * @returns Boolean + */ hasSelection?(): boolean; /** [Method] Finds the index of the passed node */ indexOf?(): void; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; - /** [Method] Returns true if the Selectable is currently locked */ + /** [Method] Returns true if the Selectable is currently locked + * @returns Boolean True if currently locked + */ isLocked?(): 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] Function which can be overridden to provide custom formatting for each Record that is used by this DataView s templat * @param data Object/Object[] The raw data object that was used to create the Record. * @param index 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, index?:number, record?:Ext.data.IModel ): any; /** [Method] Refreshes the view by reloading the data from the store and re rendering the template */ @@ -14819,10 +16749,7 @@ declare module Ext { * @param keepExisting Boolean If true, the existing selection will be added to (if not, the old selection is replaced). * @param suppressEvent Boolean If true, the select event will not be fired. */ - select?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - select?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:any[], 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 * @param silent Boolean true to suppress all select events. */ @@ -14880,10 +16807,7 @@ declare module Ext { /** [Method] Sets the value of itemTpl * @param itemTpl String/String[]/Ext.XTemplate */ - setItemTpl?( itemTpl?:any ): any; - setItemTpl?( itemTpl?:string ): void; - setItemTpl?( itemTpl?:string[] ): void; - setItemTpl?( itemTpl?:Ext.IXTemplate ): void; + setItemTpl?( itemTpl?:any ): void; /** [Method] This was an internal function accidentally exposed in 1 x and now deprecated */ setLastFocused?(): void; /** [Method] Sets the value of loadingText @@ -14973,15 +16897,25 @@ declare module Ext.dataview { ui?: string; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of letters */ + /** [Method] Returns the value of letters + * @returns Array + */ getLetters?(): any[]; - /** [Method] Returns the value of listPrefix */ + /** [Method] Returns the value of listPrefix + * @returns String + */ getListPrefix?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Returns true when direction is horizontal */ isHorizontal?(): void; @@ -15031,15 +16965,25 @@ declare module Ext { ui?: string; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of letters */ + /** [Method] Returns the value of letters + * @returns Array + */ getLetters?(): any[]; - /** [Method] Returns the value of listPrefix */ + /** [Method] Returns the value of listPrefix + * @returns String + */ getListPrefix?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Returns true when direction is horizontal */ isHorizontal?(): void; @@ -15103,49 +17047,87 @@ declare module Ext.dataview { useSimpleItems?: boolean; /** [Config Option] (Boolean) */ variableHeights?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of disclosureProperty */ + /** [Method] Returns the value of disclosureProperty + * @returns String + */ getDisclosureProperty?(): string; - /** [Method] Returns the value of grouped */ + /** [Method] Returns the value of grouped + * @returns Boolean + */ getGrouped?(): boolean; - /** [Method] Returns the value of icon */ + /** [Method] Returns the value of icon + * @returns Object + */ getIcon?(): any; - /** [Method] Returns the value of indexBar */ + /** [Method] Returns the value of indexBar + * @returns Boolean/Object + */ getIndexBar?(): any; - /** [Method] Returns the value of infinite */ + /** [Method] Returns the value of infinite + * @returns Boolean + */ getInfinite?(): boolean; /** [Method] Returns an item at the specified index * @param index Number Index of the item. + * @returns Ext.dom.Element/Ext.dataview.component.DataItem item Item at the specified index. */ getItemAt?( index?:number ): any; - /** [Method] Returns the value of itemHeight */ + /** [Method] Returns the value of itemHeight + * @returns Number + */ getItemHeight?(): number; /** [Method] Returns an index for the specified item * @param item Number The item to locate. + * @returns Number Index for the specified item. */ getItemIndex?( item?:number ): number; - /** [Method] Returns the value of onItemDisclosure */ + /** [Method] Returns the value of onItemDisclosure + * @returns Boolean/Function/Object + */ getOnItemDisclosure?(): any; - /** [Method] Returns the value of pinHeaders */ + /** [Method] Returns the value of pinHeaders + * @returns Boolean + */ getPinHeaders?(): boolean; - /** [Method] Returns the value of preventSelectionOnDisclose */ + /** [Method] Returns the value of preventSelectionOnDisclose + * @returns Boolean + */ getPreventSelectionOnDisclose?(): boolean; - /** [Method] Returns the value of refreshHeightOnUpdate */ + /** [Method] Returns the value of refreshHeightOnUpdate + * @returns Boolean + */ getRefreshHeightOnUpdate?(): boolean; - /** [Method] Returns all the items that are docked in the scroller in this list */ + /** [Method] Returns all the items that are docked in the scroller in this list + * @returns Array An array of the scrollDock items + */ getScrollDockedItems?(): any[]; - /** [Method] Returns the value of striped */ + /** [Method] Returns the value of striped + * @returns Boolean + */ getStriped?(): boolean; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of useSimpleItems */ + /** [Method] Returns the value of useSimpleItems + * @returns Boolean + */ getUseSimpleItems?(): boolean; - /** [Method] Returns the value of variableHeights */ + /** [Method] Returns the value of variableHeights + * @returns Boolean + */ getVariableHeights?(): boolean; - /** [Method] Returns an array of the current items in the DataView */ + /** [Method] Returns an array of the current items in the DataView + * @returns Ext.dom.Element[]/Ext.dataview.component.DataItem[] Array of Items. + */ getViewItems?(): any; /** [Method] We override DataView s initialize method with an empty function */ initialize?(): void; @@ -15253,49 +17235,87 @@ declare module Ext { useSimpleItems?: boolean; /** [Config Option] (Boolean) */ variableHeights?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of disclosureProperty */ + /** [Method] Returns the value of disclosureProperty + * @returns String + */ getDisclosureProperty?(): string; - /** [Method] Returns the value of grouped */ + /** [Method] Returns the value of grouped + * @returns Boolean + */ getGrouped?(): boolean; - /** [Method] Returns the value of icon */ + /** [Method] Returns the value of icon + * @returns Object + */ getIcon?(): any; - /** [Method] Returns the value of indexBar */ + /** [Method] Returns the value of indexBar + * @returns Boolean/Object + */ getIndexBar?(): any; - /** [Method] Returns the value of infinite */ + /** [Method] Returns the value of infinite + * @returns Boolean + */ getInfinite?(): boolean; /** [Method] Returns an item at the specified index * @param index Number Index of the item. + * @returns Ext.dom.Element/Ext.dataview.component.DataItem item Item at the specified index. */ getItemAt?( index?:number ): any; - /** [Method] Returns the value of itemHeight */ + /** [Method] Returns the value of itemHeight + * @returns Number + */ getItemHeight?(): number; /** [Method] Returns an index for the specified item * @param item Number The item to locate. + * @returns Number Index for the specified item. */ getItemIndex?( item?:number ): number; - /** [Method] Returns the value of onItemDisclosure */ + /** [Method] Returns the value of onItemDisclosure + * @returns Boolean/Function/Object + */ getOnItemDisclosure?(): any; - /** [Method] Returns the value of pinHeaders */ + /** [Method] Returns the value of pinHeaders + * @returns Boolean + */ getPinHeaders?(): boolean; - /** [Method] Returns the value of preventSelectionOnDisclose */ + /** [Method] Returns the value of preventSelectionOnDisclose + * @returns Boolean + */ getPreventSelectionOnDisclose?(): boolean; - /** [Method] Returns the value of refreshHeightOnUpdate */ + /** [Method] Returns the value of refreshHeightOnUpdate + * @returns Boolean + */ getRefreshHeightOnUpdate?(): boolean; - /** [Method] Returns all the items that are docked in the scroller in this list */ + /** [Method] Returns all the items that are docked in the scroller in this list + * @returns Array An array of the scrollDock items + */ getScrollDockedItems?(): any[]; - /** [Method] Returns the value of striped */ + /** [Method] Returns the value of striped + * @returns Boolean + */ getStriped?(): boolean; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of useSimpleItems */ + /** [Method] Returns the value of useSimpleItems + * @returns Boolean + */ getUseSimpleItems?(): boolean; - /** [Method] Returns the value of variableHeights */ + /** [Method] Returns the value of variableHeights + * @returns Boolean + */ getVariableHeights?(): boolean; - /** [Method] Returns an array of the current items in the DataView */ + /** [Method] Returns an array of the current items in the DataView + * @returns Ext.dom.Element[]/Ext.dataview.component.DataItem[] Array of Items. + */ getViewItems?(): any; /** [Method] We override DataView s initialize method with an empty function */ initialize?(): void; @@ -15375,9 +17395,13 @@ declare module Ext.dataview { baseCls?: string; /** [Config Option] (String) */ docked?: string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ getDocked?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -15437,55 +17461,97 @@ declare module Ext.dataview { useToolbar?: boolean; /** [Config Option] (Boolean) */ variableHeights?: boolean; - /** [Method] Returns the value of allowDeselect */ + /** [Method] Returns the value of allowDeselect + * @returns Boolean + */ getAllowDeselect?(): boolean; - /** [Method] Returns the value of backButton */ + /** [Method] Returns the value of backButton + * @returns Object + */ getBackButton?(): any; - /** [Method] Returns the value of backText */ + /** [Method] Returns the value of backText + * @returns String + */ getBackText?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of detailCard */ + /** [Method] Returns the value of detailCard + * @returns Ext.Component + */ getDetailCard?(): Ext.IComponent; - /** [Method] Returns the value of detailContainer */ + /** [Method] Returns the value of detailContainer + * @returns Ext.Container + */ getDetailContainer?(): Ext.IContainer; - /** [Method] Returns the value of displayField */ + /** [Method] Returns the value of displayField + * @returns String + */ getDisplayField?(): string; - /** [Method] Returns the value of emptyText */ + /** [Method] Returns the value of emptyText + * @returns String + */ getEmptyText?(): string; - /** [Method] Returns the value of itemHeight */ + /** [Method] Returns the value of itemHeight + * @returns Number + */ getItemHeight?(): number; /** [Method] Override this method to provide custom template rendering of individual nodes * @param node Ext.data.Record + * @returns String */ getItemTextTpl?( node?:Ext.data.IRecord ): string; - /** [Method] Returns the value of listConfig */ + /** [Method] Returns the value of listConfig + * @returns Object + */ getListConfig?(): any; - /** [Method] Returns the value of loadingText */ + /** [Method] Returns the value of loadingText + * @returns String + */ getLoadingText?(): string; - /** [Method] Returns the value of onItemDisclosure */ + /** [Method] Returns the value of onItemDisclosure + * @returns Boolean/Function + */ getOnItemDisclosure?(): any; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.TreeStore/String + */ getStore?(): any; /** [Method] Returns the subList for a specified node */ getSubList?(): void; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Override this method to provide custom template rendering of titles back buttons when useTitleAsBackText is enabled * @param node Ext.data.Record + * @returns String */ getTitleTextTpl?( node?:Ext.data.IRecord ): string; - /** [Method] Returns the value of toolbar */ + /** [Method] Returns the value of toolbar + * @returns Ext.Toolbar/Object/Boolean + */ getToolbar?(): any; - /** [Method] Returns the value of updateTitleText */ + /** [Method] Returns the value of updateTitleText + * @returns Boolean + */ getUpdateTitleText?(): boolean; - /** [Method] Returns the value of useSimpleItems */ + /** [Method] Returns the value of useSimpleItems + * @returns Boolean + */ getUseSimpleItems?(): boolean; - /** [Method] Returns the value of useTitleAsBackText */ + /** [Method] Returns the value of useTitleAsBackText + * @returns Boolean + */ getUseTitleAsBackText?(): boolean; - /** [Method] Returns the value of useToolbar */ + /** [Method] Returns the value of useToolbar + * @returns Boolean + */ getUseToolbar?(): boolean; - /** [Method] Returns the value of variableHeights */ + /** [Method] Returns the value of variableHeights + * @returns Boolean + */ getVariableHeights?(): boolean; /** [Method] The leaf you want to navigate to * @param node Ext.data.NodeInterface The specified node to navigate to. @@ -15552,14 +17618,11 @@ declare module Ext.dataview { /** [Method] Sets the value of onItemDisclosure * @param onItemDisclosure Boolean/Function */ - setOnItemDisclosure?( onItemDisclosure?:any ): any; - setOnItemDisclosure?( onItemDisclosure?:boolean ): void; + setOnItemDisclosure?( onItemDisclosure?:any ): void; /** [Method] Sets the value of store * @param store Ext.data.TreeStore/String */ - setStore?( store?:any ): any; - setStore?( store?:Ext.data.ITreeStore ): void; - setStore?( store?:string ): void; + setStore?( store?:any ): void; /** [Method] Sets the value of title * @param title String */ @@ -15642,55 +17705,97 @@ declare module Ext { useToolbar?: boolean; /** [Config Option] (Boolean) */ variableHeights?: boolean; - /** [Method] Returns the value of allowDeselect */ + /** [Method] Returns the value of allowDeselect + * @returns Boolean + */ getAllowDeselect?(): boolean; - /** [Method] Returns the value of backButton */ + /** [Method] Returns the value of backButton + * @returns Object + */ getBackButton?(): any; - /** [Method] Returns the value of backText */ + /** [Method] Returns the value of backText + * @returns String + */ getBackText?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of detailCard */ + /** [Method] Returns the value of detailCard + * @returns Ext.Component + */ getDetailCard?(): Ext.IComponent; - /** [Method] Returns the value of detailContainer */ + /** [Method] Returns the value of detailContainer + * @returns Ext.Container + */ getDetailContainer?(): Ext.IContainer; - /** [Method] Returns the value of displayField */ + /** [Method] Returns the value of displayField + * @returns String + */ getDisplayField?(): string; - /** [Method] Returns the value of emptyText */ + /** [Method] Returns the value of emptyText + * @returns String + */ getEmptyText?(): string; - /** [Method] Returns the value of itemHeight */ + /** [Method] Returns the value of itemHeight + * @returns Number + */ getItemHeight?(): number; /** [Method] Override this method to provide custom template rendering of individual nodes * @param node Ext.data.Record + * @returns String */ getItemTextTpl?( node?:Ext.data.IRecord ): string; - /** [Method] Returns the value of listConfig */ + /** [Method] Returns the value of listConfig + * @returns Object + */ getListConfig?(): any; - /** [Method] Returns the value of loadingText */ + /** [Method] Returns the value of loadingText + * @returns String + */ getLoadingText?(): string; - /** [Method] Returns the value of onItemDisclosure */ + /** [Method] Returns the value of onItemDisclosure + * @returns Boolean/Function + */ getOnItemDisclosure?(): any; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.TreeStore/String + */ getStore?(): any; /** [Method] Returns the subList for a specified node */ getSubList?(): void; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Override this method to provide custom template rendering of titles back buttons when useTitleAsBackText is enabled * @param node Ext.data.Record + * @returns String */ getTitleTextTpl?( node?:Ext.data.IRecord ): string; - /** [Method] Returns the value of toolbar */ + /** [Method] Returns the value of toolbar + * @returns Ext.Toolbar/Object/Boolean + */ getToolbar?(): any; - /** [Method] Returns the value of updateTitleText */ + /** [Method] Returns the value of updateTitleText + * @returns Boolean + */ getUpdateTitleText?(): boolean; - /** [Method] Returns the value of useSimpleItems */ + /** [Method] Returns the value of useSimpleItems + * @returns Boolean + */ getUseSimpleItems?(): boolean; - /** [Method] Returns the value of useTitleAsBackText */ + /** [Method] Returns the value of useTitleAsBackText + * @returns Boolean + */ getUseTitleAsBackText?(): boolean; - /** [Method] Returns the value of useToolbar */ + /** [Method] Returns the value of useToolbar + * @returns Boolean + */ getUseToolbar?(): boolean; - /** [Method] Returns the value of variableHeights */ + /** [Method] Returns the value of variableHeights + * @returns Boolean + */ getVariableHeights?(): boolean; /** [Method] The leaf you want to navigate to * @param node Ext.data.NodeInterface The specified node to navigate to. @@ -15757,14 +17862,11 @@ declare module Ext { /** [Method] Sets the value of onItemDisclosure * @param onItemDisclosure Boolean/Function */ - setOnItemDisclosure?( onItemDisclosure?:any ): any; - setOnItemDisclosure?( onItemDisclosure?:boolean ): void; + setOnItemDisclosure?( onItemDisclosure?:any ): void; /** [Method] Sets the value of store * @param store Ext.data.TreeStore/String */ - setStore?( store?:any ): any; - setStore?( store?:Ext.data.ITreeStore ): void; - setStore?( store?:string ): void; + setStore?( store?:any ): void; /** [Method] Sets the value of title * @param title String */ @@ -15807,103 +17909,126 @@ 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] Align the date to unit * @param date Date The date to be aligned. * @param unit String The unit. This unit is compatible with the date interval constants. + * @returns Date The aligned date. */ static align( date?:any, unit?:string ): 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] Calculate how many units are there between two time * @param min Date The first time. * @param max Date The second time. * @param unit String The unit. This unit is compatible with the date interval constants. + * @returns Number The maximum number n of units that min + n * unit <= max. */ static diff( min?:any, max?:any, unit?:string ): number; /** [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. */ static format( date?:any, format?:string ): string; /** [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, defaults to now. + * @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 equivalent to the format specifier W but without a leading zero * @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] 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 @@ -15914,14 +18039,18 @@ 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 The current timestamp. + */ 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/null The parsed Date, or null if an invalid date string. */ static parse( input?:string, format?:string, strict?:boolean ): any; } @@ -15934,103 +18063,126 @@ 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] Align the date to unit * @param date Date The date to be aligned. * @param unit String The unit. This unit is compatible with the date interval constants. + * @returns Date The aligned date. */ static align( date?:any, unit?:string ): 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] Calculate how many units are there between two time * @param min Date The first time. * @param max Date The second time. * @param unit String The unit. This unit is compatible with the date interval constants. + * @returns Number The maximum number n of units that min + n * unit <= max. */ static diff( min?:any, max?:any, unit?:string ): number; /** [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. */ static format( date?:any, format?:string ): string; /** [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, defaults to now. + * @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 equivalent to the format specifier W but without a leading zero * @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] 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 @@ -16041,14 +18193,18 @@ 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 The current timestamp. + */ 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/null The parsed Date, or null if an invalid date string. */ static parse( input?:string, format?:string, strict?:boolean ): any; } @@ -16059,7 +18215,9 @@ declare module Ext { component?: any; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of component * @param component Object @@ -16086,19 +18244,19 @@ declare module Ext.device { export class Camera { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] Allows you to capture a photo * @param options Object The options to use when taking a photo. * @param scope Object The scope in which to call the success and failure functions, if specified. @@ -16112,13 +18270,17 @@ declare module Ext.device { static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?: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; } } @@ -16144,7 +18306,9 @@ declare module Ext.device.camera { * @param options Object */ capture?( options?:any ): void; - /** [Method] Returns the value of samples */ + /** [Method] Returns the value of samples + * @returns Array + */ getSamples?(): any[]; /** [Method] Sets the value of samples * @param samples Array @@ -16166,30 +18330,34 @@ declare module Ext.device { export class Communicator { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?: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; } } @@ -16215,16 +18383,14 @@ declare module Ext.device.connection { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -16236,9 +18402,7 @@ declare module Ext.device.connection { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -16246,9 +18410,7 @@ declare module Ext.device.connection { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -16256,34 +18418,45 @@ declare module Ext.device.connection { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of online */ + /** [Method] Returns the value of online + * @returns Boolean + */ getOnline?(): boolean; - /** [Method] Returns the current connection type */ + /** [Method] Returns the current connection type + * @returns String type + */ getType?(): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; - /** [Method] True if the device is currently online */ + /** [Method] True if the device is currently online + * @returns Boolean online + */ isOnline?(): boolean; /** [Method] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -16292,18 +18465,14 @@ declare module Ext.device.connection { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -16311,28 +18480,25 @@ declare module Ext.device.connection { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -16341,16 +18507,14 @@ declare module Ext.device.connection { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -16358,18 +18522,14 @@ declare module Ext.device.connection { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -16377,9 +18537,7 @@ declare module Ext.device.connection { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -16401,25 +18559,21 @@ declare module Ext.device.connection { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device { @@ -16432,16 +18586,14 @@ declare module Ext.device { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -16453,9 +18605,7 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -16463,24 +18613,22 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 */ static clearListeners(): void; /** [Method] */ @@ -16488,44 +18636,59 @@ declare module Ext.device { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; - /** [Method] Returns the value of online */ + /** [Method] Returns the value of online + * @returns Boolean + */ static getOnline(): boolean; - /** [Method] Returns the current connection type */ + /** [Method] Returns the current connection type + * @returns String type + */ static getType(): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; - /** [Method] True if the device is currently online */ + /** [Method] True if the device is currently online + * @returns Boolean online + */ static isOnline(): boolean; /** [Method] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -16534,18 +18697,14 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -16553,28 +18712,25 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -16583,16 +18739,14 @@ declare module Ext.device { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -16600,18 +18754,14 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -16619,9 +18769,7 @@ declare module Ext.device { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -16634,7 +18782,9 @@ declare module Ext.device { * @param type Object */ static setType( type?: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] Suspends the firing of all events */ static suspendEvents(): void; @@ -16645,32 +18795,32 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device.connection { export interface IPhoneGap extends Ext.device.connection.IAbstract { - /** [Method] Returns the value of online */ + /** [Method] Returns the value of online + * @returns Boolean + */ getOnline?(): boolean; - /** [Method] Returns the current connection type */ + /** [Method] Returns the current connection type + * @returns String type + */ getType?(): string; } } @@ -16680,7 +18830,9 @@ declare module Ext.device.connection { } declare module Ext.device.connection { export interface ISimulator extends Ext.device.connection.IAbstract { - /** [Method] Returns the value of online */ + /** [Method] Returns the value of online + * @returns Boolean + */ getOnline?(): boolean; } } @@ -16694,16 +18846,14 @@ declare module Ext.device.contacts { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -16715,9 +18865,7 @@ declare module Ext.device.contacts { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -16725,9 +18873,7 @@ declare module Ext.device.contacts { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -16735,41 +18881,51 @@ declare module Ext.device.contacts { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; /** [Method] Returns an Array of contact objects * @param config Object + * @returns Object[] An array of contact objects. */ getContacts?( config?:any ): any[]; - /** [Method] Returns the value of includeImages */ + /** [Method] Returns the value of includeImages + * @returns Boolean + */ getIncludeImages?(): boolean; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Returns localized user readable label for a contact field i e * @param config Object + * @returns String user readable string */ getLocalizedLabel?( config?:any ): string; /** [Method] Returns base64 encoded image thumbnail for a contact specified in config id * @param config Object + * @returns String base64 string */ getThumbnail?( config?:any ): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -16779,18 +18935,14 @@ declare module Ext.device.contacts { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -16798,28 +18950,25 @@ declare module Ext.device.contacts { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -16828,16 +18977,14 @@ declare module Ext.device.contacts { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -16845,18 +18992,14 @@ declare module Ext.device.contacts { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -16864,9 +19007,7 @@ declare module Ext.device.contacts { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of includeImages * @param includeImages Boolean */ @@ -16884,25 +19025,21 @@ declare module Ext.device.contacts { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device { @@ -16915,16 +19052,14 @@ declare module Ext.device { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -16936,9 +19071,7 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -16946,24 +19079,22 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 */ static clearListeners(): void; /** [Method] */ @@ -16971,51 +19102,65 @@ declare module Ext.device { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; /** [Method] Returns an Array of contact objects * @param config Object + * @returns Object[] An array of contact objects. */ static getContacts( config?:any ): any[]; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; - /** [Method] Returns the value of includeImages */ + /** [Method] Returns the value of includeImages + * @returns Boolean + */ static getIncludeImages(): boolean; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; /** [Method] Returns localized user readable label for a contact field i e * @param config Object + * @returns String user readable string */ static getLocalizedLabel( config?:any ): string; /** [Method] Returns base64 encoded image thumbnail for a contact specified in config id * @param config Object + * @returns String base64 string */ static getThumbnail( config?:any ): string; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Alias for addManagedListener @@ -17025,18 +19170,14 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -17044,28 +19185,25 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -17074,16 +19212,14 @@ declare module Ext.device { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -17091,18 +19227,14 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -17110,9 +19242,7 @@ declare module Ext.device { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of includeImages * @param includeImages Boolean */ @@ -17121,7 +19251,9 @@ declare module Ext.device { * @param listeners Object */ static setListeners( listeners?: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] Suspends the firing of all events */ static suspendEvents(): void; @@ -17132,39 +19264,38 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device.contacts { export interface ISencha extends Ext.device.contacts.IAbstract { /** [Method] Returns an Array of contact objects * @param config Object + * @returns Object[] An array of contact objects. */ getContacts?( config?:any ): any[]; /** [Method] Returns localized user readable label for a contact field i e * @param config Object + * @returns String user readable string */ getLocalizedLabel?( config?:any ): string; /** [Method] Returns base64 encoded image thumbnail for a contact specified in config id * @param config Object + * @returns String base64 string */ getThumbnail?( config?:any ): string; } @@ -17185,16 +19316,14 @@ declare module Ext.device.device { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -17206,9 +19335,7 @@ declare module Ext.device.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -17216,9 +19343,7 @@ declare module Ext.device.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -17226,27 +19351,32 @@ declare module Ext.device.device { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -17256,18 +19386,14 @@ declare module Ext.device.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -17275,25 +19401,21 @@ declare module Ext.device.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Opens a specified URL * @param url String The URL to open */ @@ -17301,6 +19423,7 @@ declare module Ext.device.device { /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -17309,16 +19432,14 @@ declare module Ext.device.device { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -17326,18 +19447,14 @@ declare module Ext.device.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -17345,9 +19462,7 @@ declare module Ext.device.device { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -17361,25 +19476,21 @@ declare module Ext.device.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device { @@ -17392,16 +19503,14 @@ declare module Ext.device { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -17413,9 +19522,7 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -17423,24 +19530,22 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 */ static clearListeners(): void; /** [Method] */ @@ -17448,37 +19553,46 @@ declare module Ext.device { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Alias for addManagedListener @@ -17488,18 +19602,14 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -17507,25 +19617,21 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Opens a specified URL * @param url String The URL to open */ @@ -17533,6 +19639,7 @@ declare module Ext.device { /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -17541,16 +19648,14 @@ declare module Ext.device { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -17558,18 +19663,14 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -17577,14 +19678,14 @@ declare module Ext.device { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ static setListeners( listeners?: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] Suspends the firing of all events */ static suspendEvents(): void; @@ -17595,25 +19696,21 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device.device { @@ -17644,17 +19741,25 @@ declare module Ext.device.geolocation { timeout?: number; /** [Method] If you are currently watching for the current position this will stop that task */ clearWatch?(): void; - /** [Method] Returns the value of allowHighAccuracy */ + /** [Method] Returns the value of allowHighAccuracy + * @returns Boolean + */ getAllowHighAccuracy?(): boolean; /** [Method] Attempts to get the current position of this device * @param config Object An object which contains the following config options: */ getCurrentPosition?( config?:any ): void; - /** [Method] Returns the value of frequency */ + /** [Method] Returns the value of frequency + * @returns Number + */ getFrequency?(): number; - /** [Method] Returns the value of maximumAge */ + /** [Method] Returns the value of maximumAge + * @returns Number + */ getMaximumAge?(): number; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; /** [Method] Sets the value of allowHighAccuracy * @param allowHighAccuracy Boolean @@ -17684,41 +19789,51 @@ declare module Ext.device { export class Geolocation { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] If you are currently watching for the current position this will stop that task */ static clearWatch(): void; /** [Method] */ static destroy(): void; - /** [Method] Returns the value of allowHighAccuracy */ + /** [Method] Returns the value of allowHighAccuracy + * @returns Boolean + */ static getAllowHighAccuracy(): boolean; /** [Method] Attempts to get the current position of this device * @param config Object An object which contains the following config options: */ static getCurrentPosition( config?:any ): void; - /** [Method] Returns the value of frequency */ + /** [Method] Returns the value of frequency + * @returns Number + */ static getFrequency(): number; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of maximumAge */ + /** [Method] Returns the value of maximumAge + * @returns Number + */ static getMaximumAge(): number; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ static getTimeout(): number; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Sets the value of allowHighAccuracy @@ -17737,7 +19852,9 @@ declare module Ext.device { * @param timeout Number */ static setTimeout( timeout?: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] Watches for the current position and calls the callback when successful depending on the specified frequency * @param config Object An object which contains the following config options: @@ -17789,34 +19906,38 @@ declare module Ext.device { export class Notification { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] A simple way to show a notification * @param config Object An object which contains the following config options: */ static show( 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] Vibrates the device */ static vibrate(): void; @@ -17854,16 +19975,14 @@ declare module Ext.device.orientation { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -17875,9 +19994,7 @@ declare module Ext.device.orientation { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -17885,9 +20002,7 @@ declare module Ext.device.orientation { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -17895,27 +20010,32 @@ declare module Ext.device.orientation { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -17925,18 +20045,14 @@ declare module Ext.device.orientation { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -17944,28 +20060,25 @@ declare module Ext.device.orientation { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -17974,16 +20087,14 @@ declare module Ext.device.orientation { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -17991,18 +20102,14 @@ declare module Ext.device.orientation { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -18010,9 +20117,7 @@ declare module Ext.device.orientation { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -18026,25 +20131,21 @@ declare module Ext.device.orientation { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device.orientation { @@ -18061,16 +20162,14 @@ declare module Ext.device { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -18082,9 +20181,7 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -18092,24 +20189,22 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 */ static clearListeners(): void; /** [Method] */ @@ -18117,37 +20212,46 @@ declare module Ext.device { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Alias for addManagedListener @@ -18157,18 +20261,14 @@ declare module Ext.device { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -18176,28 +20276,25 @@ declare module Ext.device { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -18206,16 +20303,14 @@ declare module Ext.device { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -18223,18 +20318,14 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -18242,14 +20333,14 @@ declare module Ext.device { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ static setListeners( listeners?: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] Suspends the firing of all events */ static suspendEvents(): void; @@ -18260,25 +20351,21 @@ declare module Ext.device { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.device.orientation { @@ -18291,19 +20378,19 @@ declare module Ext.device { export class Purchases { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] Checks if the current user is able to make payments * @param config Object */ @@ -18316,6 +20403,7 @@ declare module Ext.device { static getCompletedPurchases( config?:any ): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Returns a Ext data Store instance of all products available to purchase @@ -18328,9 +20416,12 @@ declare module Ext.device { static getPurchases( config?:any ): void; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?: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; } } @@ -18338,7 +20429,9 @@ declare module Ext.device.purchases { export interface IProduct extends Ext.data.IModel { /** [Config Option] (Object[]/String[]) */ fields?: any; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Array + */ getFields?(): any[]; /** [Method] Will attempt to purchase this product * @param config Object @@ -18358,7 +20451,9 @@ declare module Ext.device.purchases { * @param config Object */ complete?( config?:any ): void; - /** [Method] Returns the value of fields */ + /** [Method] Returns the value of fields + * @returns Array + */ getFields?(): any[]; /** [Method] Sets the value of fields * @param fields Array @@ -18406,34 +20501,38 @@ declare module Ext.device { export class Push { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Registers a push notification * @param config Object The configuration for to pass when registering this push notification service. */ 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; } } @@ -18449,7 +20548,9 @@ declare module Ext.device.sqlite { * @param config Object The object which contains the following config options: */ changeVersion?( config?:any ): void; - /** [Method] Returns the current version of the database */ + /** [Method] Returns the current version of the database + * @returns String The current database version. + */ getVersion?(): string; /** [Method] Works same as transaction but performs a Ext device SQLite SQLTransaction instance with a read only mode * @param config Object @@ -18467,34 +20568,39 @@ declare module Ext.device { export class SQLite { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Returns a Ext device SQLite Database instance * @param config Object The object which contains the following config options: + * @returns Ext.device.SQLite.Database The opened database, null if an error occured. */ static openDatabase( config?:any ): Ext.device.sqlite.IDatabase; - /** [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; } } @@ -18502,26 +20608,36 @@ declare module Ext.device.sqlite { export interface ISencha extends Ext.IBase { /** [Method] Returns a Ext device SQLite Database instance * @param config Object The object which contains the following config options: + * @returns Ext.device.SQLite.Database The opened database, null if an error occured. */ openDatabase?( config?:any ): Ext.device.sqlite.IDatabase; } } declare module Ext.device.sqlite { export interface ISQLResultSet extends Ext.IBase { - /** [Method] Returns the row ID of the last row that the SQL statement inserted into the database if the statement inserted any r */ + /** [Method] Returns the row ID of the last row that the SQL statement inserted into the database if the statement inserted any r + * @returns Number The inserted row ID. + */ getInsertId?(): number; - /** [Method] Returns a Ext device SQLite SQLResultSetRowList instance representing rows returned by the SQL statement */ + /** [Method] Returns a Ext device SQLite SQLResultSetRowList instance representing rows returned by the SQL statement + * @returns Ext.device.SQLite.SQLResultSetRowList The rows. + */ getRows?(): Ext.device.sqlite.ISQLResultSetRowList; - /** [Method] Returns the number of rows that were changed by the SQL statement */ + /** [Method] Returns the number of rows that were changed by the SQL statement + * @returns Number The number of rows affected. + */ getRowsAffected?(): number; } } declare module Ext.device.sqlite { export interface ISQLResultSetRowList extends Ext.IBase { - /** [Method] Returns the number of rows returned by the SQL statement */ + /** [Method] Returns the number of rows returned by the SQL statement + * @returns Number The number of rows. + */ getLength?(): number; /** [Method] Returns a row at specified index returned by the SQL statement * @param index Number The index of a row. This is required. + * @returns Object The row. */ item?( index?:number ): any; } @@ -18540,21 +20656,37 @@ declare module Ext.direct { data?: any; /** [Config Option] (String) */ name?: string; - /** [Method] Returns the value of code */ + /** [Method] Returns the value of code + * @returns Object + */ getCode?(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; - /** [Method] Returns the value of message */ + /** [Method] Returns the value of message + * @returns String + */ getMessage?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of result */ + /** [Method] Returns the value of result + * @returns Object + */ getResult?(): any; - /** [Method] Returns the value of status */ + /** [Method] Returns the value of status + * @returns Boolean + */ getStatus?(): boolean; - /** [Method] Returns the value of transaction */ + /** [Method] Returns the value of transaction + * @returns Object + */ getTransaction?(): any; - /** [Method] Returns the value of xhr */ + /** [Method] Returns the value of xhr + * @returns Object + */ getXhr?(): any; /** [Method] Sets the value of code * @param code Object @@ -18594,11 +20726,17 @@ declare module Ext.direct { export interface IExceptionEvent extends Ext.direct.IRemotingEvent { /** [Config Option] (String) */ name?: string; - /** [Method] Returns the value of error */ + /** [Method] Returns the value of error + * @returns Object + */ getError?(): any; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of status */ + /** [Method] Returns the value of status + * @returns Boolean + */ getStatus?(): boolean; /** [Method] Sets the value of error * @param error Object @@ -18618,6 +20756,7 @@ declare module Ext.direct { export interface IJsonProvider extends Ext.direct.IProvider { /** [Method] Create an event from a response object * @param response Object The XHR response object. + * @returns Ext.direct.Event The event. */ createEvent?( response?:any ): Ext.direct.IEvent; } @@ -18632,16 +20771,14 @@ declare module Ext.direct { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -18653,9 +20790,7 @@ declare module Ext.direct { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -18663,28 +20798,27 @@ declare module Ext.direct { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [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. + * @returns Object */ static addProvider( provider?:any ): any; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 */ static clearListeners(): void; /** [Method] */ @@ -18692,43 +20826,51 @@ declare module Ext.direct { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): 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. + * @returns Object */ static getProvider( id?:any ): any; - static getProvider( id?:string ): any; - static getProvider( id?:Ext.direct.IProvider ): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Alias for addManagedListener @@ -18738,18 +20880,14 @@ declare module Ext.direct { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -18757,33 +20895,30 @@ declare module Ext.direct { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [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 object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -18792,16 +20927,14 @@ declare module Ext.direct { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -18809,24 +20942,19 @@ declare module Ext.direct { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?: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/null The provider, null if not found. */ static removeProvider( provider?:any ): any; - static removeProvider( provider?:string ): any; - static removeProvider( provider?:Ext.direct.IProvider ): any; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -18834,14 +20962,14 @@ declare module Ext.direct { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ static setListeners( listeners?: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] Suspends the firing of all events */ static suspendEvents(): void; @@ -18852,25 +20980,21 @@ declare module Ext.direct { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext { @@ -18883,16 +21007,14 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -18904,9 +21026,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -18914,28 +21034,27 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [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. + * @returns Object */ static addProvider( provider?:any ): any; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 */ static clearListeners(): void; /** [Method] */ @@ -18943,43 +21062,51 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): 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. + * @returns Object */ static getProvider( id?:any ): any; - static getProvider( id?:string ): any; - static getProvider( id?:Ext.direct.IProvider ): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Alias for addManagedListener @@ -18989,18 +21116,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -19008,33 +21131,30 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [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 object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -19043,16 +21163,14 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -19060,24 +21178,19 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?: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/null The provider, null if not found. */ static removeProvider( provider?:any ): any; - static removeProvider( provider?:string ): any; - static removeProvider( provider?:Ext.direct.IProvider ): any; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -19085,14 +21198,14 @@ declare module Ext { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ static setListeners( listeners?: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] Suspends the firing of all events */ static suspendEvents(): void; @@ -19103,25 +21216,21 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.direct { @@ -19136,13 +21245,21 @@ declare module Ext.direct { connect?(): void; /** [Method] Disconnect from the server side and stop the polling process */ disconnect?(): void; - /** [Method] Returns the value of baseParams */ + /** [Method] Returns the value of baseParams + * @returns Object + */ getBaseParams?(): any; - /** [Method] Returns the value of interval */ + /** [Method] Returns the value of interval + * @returns Number + */ getInterval?(): number; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String/Function + */ getUrl?(): any; - /** [Method] Returns whether or not the server side is currently connected */ + /** [Method] Returns whether or not the server side is currently connected + * @returns Boolean + */ isConnected?(): boolean; /** [Method] Sets the value of baseParams * @param baseParams Object @@ -19155,8 +21272,7 @@ declare module Ext.direct { /** [Method] Sets the value of url * @param url String/Function */ - setUrl?( url?:any ): any; - setUrl?( url?:string ): void; + setUrl?( url?:any ): void; } } declare module Ext.direct { @@ -19169,16 +21285,14 @@ declare module Ext.direct { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -19190,9 +21304,7 @@ declare module Ext.direct { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -19200,9 +21312,7 @@ declare module Ext.direct { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] Abstract methods for subclasses to implement */ @@ -19214,32 +21324,41 @@ declare module Ext.direct { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns String + */ getId?(): string; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; - /** [Method] Returns whether or not the server side is currently connected */ + /** [Method] Returns whether or not the server side is currently connected + * @returns Boolean + */ isConnected?(): boolean; /** [Method] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -19248,18 +21367,14 @@ declare module Ext.direct { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -19267,28 +21382,25 @@ declare module Ext.direct { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -19297,16 +21409,14 @@ declare module Ext.direct { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -19314,18 +21424,14 @@ declare module Ext.direct { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -19333,9 +21439,7 @@ declare module Ext.direct { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of id * @param id String */ @@ -19353,36 +21457,38 @@ declare module Ext.direct { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.direct { export interface IRemotingEvent extends Ext.direct.IEvent { /** [Config Option] (String) */ name?: string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of tid */ + /** [Method] Returns the value of tid + * @returns Object + */ getTid?(): any; - /** [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; /** [Method] Sets the value of name * @param name String @@ -19402,17 +21508,28 @@ 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; - /** [Method] Returns the value of formHandler */ + /** [Method] Returns the value of formHandler + * @returns Object + */ getFormHandler?(): any; - /** [Method] Returns the value of len */ + /** [Method] Returns the value of len + * @returns Object + */ getLen?(): any; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns Object + */ getName?(): any; - /** [Method] Returns the value of ordered */ + /** [Method] Returns the value of ordered + * @returns Boolean + */ getOrdered?(): boolean; - /** [Method] Returns the value of params */ + /** [Method] Returns the value of params + * @returns Object + */ getParams?(): any; /** [Method] Sets the value of formHandler * @param formHandler Object @@ -19456,21 +21573,37 @@ declare module Ext.direct { connect?(): void; /** [Method] Abstract methods for subclasses to implement */ disconnect?(): void; - /** [Method] Returns the value of actions */ + /** [Method] Returns the value of actions + * @returns Object + */ getActions?(): any; - /** [Method] Returns the value of enableBuffer */ + /** [Method] Returns the value of enableBuffer + * @returns Number/Boolean + */ getEnableBuffer?(): any; - /** [Method] Returns the value of enableUrlEncode */ + /** [Method] Returns the value of enableUrlEncode + * @returns String + */ getEnableUrlEncode?(): string; - /** [Method] Returns the value of maxRetries */ + /** [Method] Returns the value of maxRetries + * @returns Number + */ getMaxRetries?(): number; - /** [Method] Returns the value of namespace */ + /** [Method] Returns the value of namespace + * @returns String/Object + */ getNamespace?(): any; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; - /** [Method] Returns whether or not the server side is currently connected */ + /** [Method] Returns whether or not the server side is currently connected + * @returns Boolean + */ isConnected?(): boolean; /** [Method] Sets the value of actions * @param actions Object @@ -19479,9 +21612,7 @@ declare module Ext.direct { /** [Method] Sets the value of enableBuffer * @param enableBuffer Number/Boolean */ - setEnableBuffer?( enableBuffer?:any ): any; - setEnableBuffer?( enableBuffer?:number ): void; - setEnableBuffer?( enableBuffer?:boolean ): void; + setEnableBuffer?( enableBuffer?:any ): void; /** [Method] Sets the value of enableUrlEncode * @param enableUrlEncode String */ @@ -19506,23 +21637,41 @@ declare module Ext.direct { } declare module Ext.direct { export interface ITransaction extends Ext.IBase { - /** [Method] Returns the value of action */ + /** [Method] Returns the value of action + * @returns Object + */ getAction?(): any; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Object + */ getArgs?(): any; - /** [Method] Returns the value of callback */ + /** [Method] Returns the value of callback + * @returns Object + */ getCallback?(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ getData?(): any; - /** [Method] Returns the value of form */ + /** [Method] Returns the value of form + * @returns Object + */ getForm?(): any; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns Object + */ getId?(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns Object + */ getMethod?(): any; - /** [Method] Returns the value of provider */ + /** [Method] Returns the value of provider + * @returns Object + */ getProvider?(): any; - /** [Method] Returns the value of retryCount */ + /** [Method] Returns the value of retryCount + * @returns Number + */ getRetryCount?(): number; /** [Method] Sets the value of action * @param action Object @@ -19577,16 +21726,14 @@ declare module Ext.dom { /** [Method] Adds elements to this Composite object * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an Array of DOM elements to add, or another Composite object who's elements should be added. * @param root HTMLElement/String The root element of the query or id of the root. + * @returns Ext.dom.CompositeElementLite This Composite object. */ - add?( els?:any, root?:any ): any; - add?( els?:HTMLElement[], root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:HTMLElement[], root?:string ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:string ): Ext.dom.ICompositeElementLite; + add?( els?:any, root?:any ): Ext.dom.ICompositeElementLite; /** [Method] Adds the given CSS class es to this Element * @param names String The CSS class(es) to add to this element. * @param prefix String Prefix to prepend to each class. * @param suffix String Suffix to append to each class. + * @returns Ext.dom.Element this */ addCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] fixes scope with flyweight @@ -19594,44 +21741,42 @@ declare module Ext.dom { * @param handler Object * @param scope Object * @param opt Object + * @returns Ext.dom.CompositeElementLite this */ addListener?( eventName?:any, handler?:any, scope?:any, opt?:any ): Ext.dom.ICompositeElementLite; /** [Method] Appends the passed element s to this element * @param element HTMLElement/Ext.dom.Element a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendChild?( element?:any ): any; - appendChild?( element?:HTMLElement ): Ext.dom.IElement; - appendChild?( element?:Ext.dom.IElement ): Ext.dom.IElement; + appendChild?( element?:any ): Ext.dom.IElement; /** [Method] Appends this element to the passed element * @param el String/HTMLElement/Ext.dom.Element The new parent element. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendTo?( el?:any ): any; - appendTo?( el?:string ): Ext.dom.IElement; - appendTo?( el?:HTMLElement ): Ext.dom.IElement; - appendTo?( el?:Ext.dom.IElement ): Ext.dom.IElement; + appendTo?( el?:any ): Ext.dom.IElement; /** [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 is true) */ child?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all elements */ clear?(): 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] 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.Element The new child element. */ createChild?( config?:any, insertBefore?:HTMLElement, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Translates an element using CSS 3 in 2D */ @@ -19641,90 +21786,103 @@ 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 is true). */ down?( selector?:string, returnDom?:boolean ): any; /** [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.CompositeElementLite this */ each?( fn?:any, scope?:any ): Ext.dom.ICompositeElementLite; /** [Method] Clears this Composite and adds the elements passed * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an array of DOM elements, or another Composite from which to fill this Composite. + * @returns Ext.dom.CompositeElementLite this */ - fill?( els?:any ): any; - fill?( els?:HTMLElement[] ): Ext.dom.ICompositeElementLite; - fill?( els?:Ext.dom.ICompositeElementLite ): Ext.dom.ICompositeElementLite; + fill?( els?:any ): Ext.dom.ICompositeElementLite; /** [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.CompositeElementLite this */ - filter?( selector?:any ): any; - filter?( selector?:string ): Ext.dom.ICompositeElementLite; + filter?( selector?:any ): Ext.dom.ICompositeElementLite; /** [Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParent?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParent?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element 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/null The matching DOM node (or null if no match was found). */ - findParentNode?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParentNode?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. * @param offsets Array Offset the positioning by [x, y]. + * @returns Array [x, y] */ getAlignToXY?( element?:any, position?:string, offsets?:any[] ): any[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. * @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 Array [x, y] An array containing the element's x and y coordinates. */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): any[]; /** [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 * @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] Gets the bottom Y coordinate of the element element Y position element height */ + /** [Method] Gets the bottom Y coordinate of the element element Y position element height + * @returns Number + */ getBottom?(): 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 are returned instead of page x/y. + * @returns Object An object in the format */ getBox?( contentBox?:boolean, local?:boolean ): any; - /** [Method] Returns the number of elements in this Composite */ + /** [Method] Returns the number of elements in this Composite + * @returns Number + */ getCount?(): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHTML?(): string; /** [Method] Returns the offset height of the element * @param contentHeight Boolean true to get the height minus borders and padding. + * @returns Number The element's height. */ getHeight?( contentHeight?:boolean ): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHtml?(): string; - /** [Method] Gets the left X coordinate */ + /** [Method] Gets the left X coordinate + * @returns Number + */ getLeft?(): 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] Returns the offsets of this element from the passed element * @param element Mixed The element to get the offsets from. + * @returns Array The XY page offsets (e.g. [100, -200]) */ getOffsetsTo?( element?:any ): any[]; /** [Method] Retrieves the height of the element account for the top and bottom margins */ @@ -19733,95 +21891,106 @@ declare module Ext.dom { getOuterWidth?(): void; /** [Method] Gets the width of the padding s for the specified side s * @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] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param asRegion Boolean If true an Ext.util.Region will be returned. + * @returns Object box An object in the format: { x: <Element's X position>, y: <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 the right X coordinate of the element element X position element width */ + /** [Method] Gets the right X coordinate of the element element X position element width + * @returns Number + */ getRight?(): number; /** [Method] Gets the Scroller instance of the first parent that has one */ getScrollParent?(): void; /** [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] Normalizes currentStyle and computedStyle * @param prop String The style property whose value is returned. + * @returns String The current value of the style property for this element. */ getStyle?( prop?:string ): string; - /** [Method] Gets the top Y coordinate */ + /** [Method] Gets the top Y coordinate + * @returns Number + */ getTop?(): number; /** [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 ): any; - /** [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: + */ getViewSize?(): any; /** [Method] Returns the offset width of the element * @param contentWidth Boolean true to get the width minus borders and padding. + * @returns Number The element's width. */ getWidth?( contentWidth?:boolean ): number; /** [Method] Gets the current X position of the element based on page coordinates * @param el Object + * @returns Number The X position of the element */ getX?( el?:any ): number; - /** [Method] Gets the current position of the element based on page coordinates */ + /** [Method] Gets the current position of the element based on page coordinates + * @returns Array The XY position of the element + */ getXY?(): any[]; /** [Method] Gets the current Y position of the element based on page coordinates * @param el Object + * @returns Number The Y position of the element */ getY?( el?:any ): number; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param name String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ hasCls?( name?:string ): boolean; /** [Method] Hides this element */ hide?(): void; /** [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] Inserts this element after the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element to insert after. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertAfter?( el?:any ): any; - insertAfter?( el?:string ): Ext.dom.IElement; - insertAfter?( el?:HTMLElement ): Ext.dom.IElement; - insertAfter?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertAfter?( el?:any ): Ext.dom.IElement; /** [Method] Inserts this element before the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertBefore?( el?:any ): any; - insertBefore?( el?:string ): Ext.dom.IElement; - insertBefore?( el?:HTMLElement ): Ext.dom.IElement; - insertBefore?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertBefore?( el?:any ): Ext.dom.IElement; /** [Method] Inserts an element as the first child of this element * @param element String/HTMLElement/Ext.dom.Element The id or element to insert. + * @returns Ext.dom.Element this */ - insertFirst?( element?:any ): any; - insertFirst?( element?:string ): Ext.dom.IElement; - insertFirst?( element?:HTMLElement ): Ext.dom.IElement; - insertFirst?( element?:Ext.dom.IElement ): Ext.dom.IElement; + insertFirst?( element?:any ): Ext.dom.IElement; /** [Method] Inserts an HTML fragment into this element * @param where String Where to insert the HTML in relation to this element - 'beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'. See Ext.DomHelper.insertHtml for details. * @param html String The HTML fragment * @param returnEl Boolean true to return an Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The inserted node (or nearest related if more than 1 inserted). */ insertHtml?( where?:string, html?:string, returnEl?:boolean ): any; /** [Method] Inserts or creates the passed element or DomHelper config as a sibling of this element * @param el String/HTMLElement/Ext.dom.Element/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.Element. + * @returns Ext.dom.Element The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling?( el?:any, where?:string, returnDom?:boolean ): Ext.dom.IElement; /** [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] Determines if this element is a descendant of the passed in Element */ @@ -19829,14 +21998,17 @@ declare module Ext.dom { /** [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] 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] Puts a mask over this element to disable user interaction */ @@ -19844,30 +22016,33 @@ declare module Ext.dom { /** [Method] Gets the next sibling skipping text nodes * @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/null The next sibling or null. */ next?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @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/null The parent node or null. */ parent?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the previous sibling skipping text nodes * @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/null The previous sibling or null. */ prev?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [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 all listeners for this object */ @@ -19876,197 +22051,188 @@ declare module Ext.dom { * @param names String The CSS class(es) to remove from this element. * @param prefix String Prefix to prepend to each class to be removed. * @param suffix String Suffix to append to each class to be removed. + * @returns Ext.dom.Element this */ removeCls?( names?:string, prefix?:string, suffix?:string ): 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.CompositeElementLite this + */ + removeElement?( el?:any, removeDom?:boolean ): Ext.dom.ICompositeElementLite; + /** [Method] Forces the browser to repaint this element + * @returns Ext.dom.Element this */ - removeElement?( el?:any, removeDom?:any ): any; - removeElement?( el?:string, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:HTMLElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:Ext.IElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:number, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - /** [Method] Forces the browser to repaint this element */ repaint?(): Ext.dom.IElement; /** [Method] Replaces the passed element with this element * @param element String/HTMLElement/Ext.dom.Element The element to replace. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - replace?( element?:any ): any; - replace?( element?:string ): Ext.dom.IElement; - replace?( element?:HTMLElement ): Ext.dom.IElement; - replace?( element?:Ext.dom.IElement ): Ext.dom.IElement; + replace?( element?:any ): Ext.dom.IElement; /** [Method] Replaces a CSS class on the element with another * @param oldName String The CSS class to replace. * @param newName String The replacement CSS class. * @param prefix String Prefix to prepend to each class to be replaced. * @param suffix String Suffix to append to each class to be replaced. + * @returns Ext.dom.Element this */ replaceCls?( oldName?:string, newName?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [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.CompositeElementLite this */ - replaceElement?( el?:any, replacement?:any, domReplace?:any ): any; - replaceElement?( el?:string, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:string, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; + replaceElement?( el?:any, replacement?:any, domReplace?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Replaces this element with the passed element * @param el String/HTMLElement/Ext.dom.Element/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.Element This element. */ replaceWith?( el?:any ): Ext.dom.IElement; /** [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 composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - select?( selector?:any, composite?:any ): any; - select?( selector?:string, composite?:boolean ): Ext.dom.ICompositeElementLite; - select?( selector?:HTMLElement[], composite?:boolean ): Ext.dom.ICompositeElementLite; + select?( selector?:any, composite?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Serializes a DOM form into a url encoded string * @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 attributes Object The object with the attributes. * @param useSet Boolean false to override the default setAttribute to use expandos. + * @returns Ext.dom.Element this */ set?( attributes?:any, useSet?:boolean ): Ext.dom.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom String The bottom CSS property value. + * @returns Ext.dom.Element this */ setBottom?( bottom?:string ): Ext.dom.IElement; /** [Method] Sets the element s box * @param box Object The box to fill, for example: { left: ..., top: ..., width: ..., height: ... } + * @returns Ext.dom.Element this */ setBox?( box?:any ): Ext.dom.IElement; /** [Method] Sets the specified CSS class on this element s DOM node * @param className String/Array The CSS class to set on this element. */ - setCls?( className?:any ): any; - setCls?( className?:string ): void; - setCls?( className?:any[] ): void; + setCls?( className?:any ): void; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHTML?( html?:string ): void; /** [Method] Set the height of this Element * @param height Number/String The new height. + * @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] Sets the innerHTML of this element * @param html String The new HTML. */ setHtml?( html?:string ): void; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left String The left CSS property value. + * @returns Ext.dom.Element this */ setLeft?( left?:string ): Ext.dom.IElement; /** [Method] Set the maximum height of this Element * @param height Number/String The new maximum height. + * @returns Ext.dom.Element this */ - setMaxHeight?( height?:any ): any; - setMaxHeight?( height?:number ): Ext.dom.IElement; - setMaxHeight?( height?:string ): Ext.dom.IElement; + setMaxHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the maximum width of this Element * @param width Number/String The new maximum width. + * @returns Ext.dom.Element this */ - setMaxWidth?( width?:any ): any; - setMaxWidth?( width?:number ): Ext.dom.IElement; - setMaxWidth?( width?:string ): Ext.dom.IElement; + setMaxWidth?( width?:any ): Ext.dom.IElement; /** [Method] Set the minimum height of this Element * @param height Number/String The new minimum height. + * @returns Ext.dom.Element this */ - setMinHeight?( height?:any ): any; - setMinHeight?( height?:number ): Ext.dom.IElement; - setMinHeight?( height?:string ): Ext.dom.IElement; + setMinHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the minimum width of this Element * @param width Number/String The new minimum width. + * @returns Ext.dom.Element this */ - setMinWidth?( width?:any ): any; - setMinWidth?( width?:number ): Ext.dom.IElement; - setMinWidth?( width?:string ): Ext.dom.IElement; + setMinWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right String The right CSS property value. + * @returns Ext.dom.Element this */ setRight?( right?:string ): 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] Sets the element s top position directly using CSS style instead of setY * @param top String The top CSS property value. + * @returns Ext.dom.Element this */ setTop?( top?:string ): Ext.dom.IElement; /** [Method] Sets the element s top and left positions directly using CSS style */ setTopLeft?(): void; /** [Method] Use this to change the visibility mode between VISIBILITY DISPLAY or OFFSETS * @param mode Object + * @returns Ext.dom.Element this */ setVisibilityMode?( mode?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible. + * @returns Ext.Element this */ setVisible?( visible?:boolean ): Ext.IElement; /** [Method] Set the width of this Element * @param width Number/String The new width. + * @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] Sets the X position of the element based on page coordinates * @param x Number The X position of the element + * @returns Ext.dom.Element this */ setX?( x?:number ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates regardless of how the element is positioned * @param pos Number[] Contains X & Y [x, y] values for new position (coordinates are page-based). + * @returns Ext.dom.Element this */ setXY?( pos?:number[] ): Ext.dom.IElement; /** [Method] Sets the Y position of the element based on page coordinates * @param y Number The Y position of the element. + * @returns Ext.dom.Element this */ setY?( y?:number ): Ext.dom.IElement; /** [Method] Shows this element */ show?(): void; /** [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] Translates the passed page coordinates into left top CSS values for this 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] Removes a previously applied mask */ unmask?(): void; /** [Method] Walks up the dom looking for a parent node that matches the passed simple selector e g * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). + * @returns Ext.dom.Element/null The matching DOM node (or null if no match was found). */ - up?( simpleSelector?:any, maxDepth?:any ): any; - up?( simpleSelector?:string, maxDepth?:number ): any; - up?( simpleSelector?:string, maxDepth?:string ): any; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; + up?( simpleSelector?:string, maxDepth?:any ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -20074,6 +22240,7 @@ declare module Ext.dom { /** [Method] Creates and wraps this element with another element * @param config Object DomHelper element config object for the wrapper element or null for an empty div * @param domNode Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The newly created wrapper element. */ wrap?( config?:any, domNode?:boolean ): any; } @@ -20085,16 +22252,14 @@ declare module Ext { /** [Method] Adds elements to this Composite object * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an Array of DOM elements to add, or another Composite object who's elements should be added. * @param root HTMLElement/String The root element of the query or id of the root. + * @returns Ext.dom.CompositeElementLite This Composite object. */ - add?( els?:any, root?:any ): any; - add?( els?:HTMLElement[], root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:HTMLElement[], root?:string ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:string ): Ext.dom.ICompositeElementLite; + add?( els?:any, root?:any ): Ext.dom.ICompositeElementLite; /** [Method] Adds the given CSS class es to this Element * @param names String The CSS class(es) to add to this element. * @param prefix String Prefix to prepend to each class. * @param suffix String Suffix to append to each class. + * @returns Ext.dom.Element this */ addCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] fixes scope with flyweight @@ -20102,44 +22267,42 @@ declare module Ext { * @param handler Object * @param scope Object * @param opt Object + * @returns Ext.dom.CompositeElementLite this */ addListener?( eventName?:any, handler?:any, scope?:any, opt?:any ): Ext.dom.ICompositeElementLite; /** [Method] Appends the passed element s to this element * @param element HTMLElement/Ext.dom.Element a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendChild?( element?:any ): any; - appendChild?( element?:HTMLElement ): Ext.dom.IElement; - appendChild?( element?:Ext.dom.IElement ): Ext.dom.IElement; + appendChild?( element?:any ): Ext.dom.IElement; /** [Method] Appends this element to the passed element * @param el String/HTMLElement/Ext.dom.Element The new parent element. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendTo?( el?:any ): any; - appendTo?( el?:string ): Ext.dom.IElement; - appendTo?( el?:HTMLElement ): Ext.dom.IElement; - appendTo?( el?:Ext.dom.IElement ): Ext.dom.IElement; + appendTo?( el?:any ): Ext.dom.IElement; /** [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 is true) */ child?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all elements */ clear?(): 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] 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.Element The new child element. */ createChild?( config?:any, insertBefore?:HTMLElement, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Translates an element using CSS 3 in 2D */ @@ -20149,90 +22312,103 @@ declare module Ext { /** [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 is true). */ down?( selector?:string, returnDom?:boolean ): any; /** [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.CompositeElementLite this */ each?( fn?:any, scope?:any ): Ext.dom.ICompositeElementLite; /** [Method] Clears this Composite and adds the elements passed * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an array of DOM elements, or another Composite from which to fill this Composite. + * @returns Ext.dom.CompositeElementLite this */ - fill?( els?:any ): any; - fill?( els?:HTMLElement[] ): Ext.dom.ICompositeElementLite; - fill?( els?:Ext.dom.ICompositeElementLite ): Ext.dom.ICompositeElementLite; + fill?( els?:any ): Ext.dom.ICompositeElementLite; /** [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.CompositeElementLite this */ - filter?( selector?:any ): any; - filter?( selector?:string ): Ext.dom.ICompositeElementLite; + filter?( selector?:any ): Ext.dom.ICompositeElementLite; /** [Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParent?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParent?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element 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/null The matching DOM node (or null if no match was found). */ - findParentNode?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParentNode?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. * @param offsets Array Offset the positioning by [x, y]. + * @returns Array [x, y] */ getAlignToXY?( element?:any, position?:string, offsets?:any[] ): any[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. * @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 Array [x, y] An array containing the element's x and y coordinates. */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): any[]; /** [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 * @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] Gets the bottom Y coordinate of the element element Y position element height */ + /** [Method] Gets the bottom Y coordinate of the element element Y position element height + * @returns Number + */ getBottom?(): 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 are returned instead of page x/y. + * @returns Object An object in the format */ getBox?( contentBox?:boolean, local?:boolean ): any; - /** [Method] Returns the number of elements in this Composite */ + /** [Method] Returns the number of elements in this Composite + * @returns Number + */ getCount?(): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHTML?(): string; /** [Method] Returns the offset height of the element * @param contentHeight Boolean true to get the height minus borders and padding. + * @returns Number The element's height. */ getHeight?( contentHeight?:boolean ): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHtml?(): string; - /** [Method] Gets the left X coordinate */ + /** [Method] Gets the left X coordinate + * @returns Number + */ getLeft?(): 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] Returns the offsets of this element from the passed element * @param element Mixed The element to get the offsets from. + * @returns Array The XY page offsets (e.g. [100, -200]) */ getOffsetsTo?( element?:any ): any[]; /** [Method] Retrieves the height of the element account for the top and bottom margins */ @@ -20241,95 +22417,106 @@ declare module Ext { getOuterWidth?(): void; /** [Method] Gets the width of the padding s for the specified side s * @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] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param asRegion Boolean If true an Ext.util.Region will be returned. + * @returns Object box An object in the format: { x: <Element's X position>, y: <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 the right X coordinate of the element element X position element width */ + /** [Method] Gets the right X coordinate of the element element X position element width + * @returns Number + */ getRight?(): number; /** [Method] Gets the Scroller instance of the first parent that has one */ getScrollParent?(): void; /** [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] Normalizes currentStyle and computedStyle * @param prop String The style property whose value is returned. + * @returns String The current value of the style property for this element. */ getStyle?( prop?:string ): string; - /** [Method] Gets the top Y coordinate */ + /** [Method] Gets the top Y coordinate + * @returns Number + */ getTop?(): number; /** [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 ): any; - /** [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: + */ getViewSize?(): any; /** [Method] Returns the offset width of the element * @param contentWidth Boolean true to get the width minus borders and padding. + * @returns Number The element's width. */ getWidth?( contentWidth?:boolean ): number; /** [Method] Gets the current X position of the element based on page coordinates * @param el Object + * @returns Number The X position of the element */ getX?( el?:any ): number; - /** [Method] Gets the current position of the element based on page coordinates */ + /** [Method] Gets the current position of the element based on page coordinates + * @returns Array The XY position of the element + */ getXY?(): any[]; /** [Method] Gets the current Y position of the element based on page coordinates * @param el Object + * @returns Number The Y position of the element */ getY?( el?:any ): number; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param name String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ hasCls?( name?:string ): boolean; /** [Method] Hides this element */ hide?(): void; /** [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] Inserts this element after the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element to insert after. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertAfter?( el?:any ): any; - insertAfter?( el?:string ): Ext.dom.IElement; - insertAfter?( el?:HTMLElement ): Ext.dom.IElement; - insertAfter?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertAfter?( el?:any ): Ext.dom.IElement; /** [Method] Inserts this element before the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertBefore?( el?:any ): any; - insertBefore?( el?:string ): Ext.dom.IElement; - insertBefore?( el?:HTMLElement ): Ext.dom.IElement; - insertBefore?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertBefore?( el?:any ): Ext.dom.IElement; /** [Method] Inserts an element as the first child of this element * @param element String/HTMLElement/Ext.dom.Element The id or element to insert. + * @returns Ext.dom.Element this */ - insertFirst?( element?:any ): any; - insertFirst?( element?:string ): Ext.dom.IElement; - insertFirst?( element?:HTMLElement ): Ext.dom.IElement; - insertFirst?( element?:Ext.dom.IElement ): Ext.dom.IElement; + insertFirst?( element?:any ): Ext.dom.IElement; /** [Method] Inserts an HTML fragment into this element * @param where String Where to insert the HTML in relation to this element - 'beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'. See Ext.DomHelper.insertHtml for details. * @param html String The HTML fragment * @param returnEl Boolean true to return an Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The inserted node (or nearest related if more than 1 inserted). */ insertHtml?( where?:string, html?:string, returnEl?:boolean ): any; /** [Method] Inserts or creates the passed element or DomHelper config as a sibling of this element * @param el String/HTMLElement/Ext.dom.Element/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.Element. + * @returns Ext.dom.Element The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling?( el?:any, where?:string, returnDom?:boolean ): Ext.dom.IElement; /** [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] Determines if this element is a descendant of the passed in Element */ @@ -20337,14 +22524,17 @@ declare module Ext { /** [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] 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] Puts a mask over this element to disable user interaction */ @@ -20352,30 +22542,33 @@ declare module Ext { /** [Method] Gets the next sibling skipping text nodes * @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/null The next sibling or null. */ next?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @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/null The parent node or null. */ parent?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the previous sibling skipping text nodes * @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/null The previous sibling or null. */ prev?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [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 all listeners for this object */ @@ -20384,197 +22577,188 @@ declare module Ext { * @param names String The CSS class(es) to remove from this element. * @param prefix String Prefix to prepend to each class to be removed. * @param suffix String Suffix to append to each class to be removed. + * @returns Ext.dom.Element this */ removeCls?( names?:string, prefix?:string, suffix?:string ): 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.CompositeElementLite this + */ + removeElement?( el?:any, removeDom?:boolean ): Ext.dom.ICompositeElementLite; + /** [Method] Forces the browser to repaint this element + * @returns Ext.dom.Element this */ - removeElement?( el?:any, removeDom?:any ): any; - removeElement?( el?:string, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:HTMLElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:Ext.IElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:number, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - /** [Method] Forces the browser to repaint this element */ repaint?(): Ext.dom.IElement; /** [Method] Replaces the passed element with this element * @param element String/HTMLElement/Ext.dom.Element The element to replace. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - replace?( element?:any ): any; - replace?( element?:string ): Ext.dom.IElement; - replace?( element?:HTMLElement ): Ext.dom.IElement; - replace?( element?:Ext.dom.IElement ): Ext.dom.IElement; + replace?( element?:any ): Ext.dom.IElement; /** [Method] Replaces a CSS class on the element with another * @param oldName String The CSS class to replace. * @param newName String The replacement CSS class. * @param prefix String Prefix to prepend to each class to be replaced. * @param suffix String Suffix to append to each class to be replaced. + * @returns Ext.dom.Element this */ replaceCls?( oldName?:string, newName?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [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.CompositeElementLite this */ - replaceElement?( el?:any, replacement?:any, domReplace?:any ): any; - replaceElement?( el?:string, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:string, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; + replaceElement?( el?:any, replacement?:any, domReplace?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Replaces this element with the passed element * @param el String/HTMLElement/Ext.dom.Element/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.Element This element. */ replaceWith?( el?:any ): Ext.dom.IElement; /** [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 composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - select?( selector?:any, composite?:any ): any; - select?( selector?:string, composite?:boolean ): Ext.dom.ICompositeElementLite; - select?( selector?:HTMLElement[], composite?:boolean ): Ext.dom.ICompositeElementLite; + select?( selector?:any, composite?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Serializes a DOM form into a url encoded string * @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 attributes Object The object with the attributes. * @param useSet Boolean false to override the default setAttribute to use expandos. + * @returns Ext.dom.Element this */ set?( attributes?:any, useSet?:boolean ): Ext.dom.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom String The bottom CSS property value. + * @returns Ext.dom.Element this */ setBottom?( bottom?:string ): Ext.dom.IElement; /** [Method] Sets the element s box * @param box Object The box to fill, for example: { left: ..., top: ..., width: ..., height: ... } + * @returns Ext.dom.Element this */ setBox?( box?:any ): Ext.dom.IElement; /** [Method] Sets the specified CSS class on this element s DOM node * @param className String/Array The CSS class to set on this element. */ - setCls?( className?:any ): any; - setCls?( className?:string ): void; - setCls?( className?:any[] ): void; + setCls?( className?:any ): void; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHTML?( html?:string ): void; /** [Method] Set the height of this Element * @param height Number/String The new height. + * @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] Sets the innerHTML of this element * @param html String The new HTML. */ setHtml?( html?:string ): void; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left String The left CSS property value. + * @returns Ext.dom.Element this */ setLeft?( left?:string ): Ext.dom.IElement; /** [Method] Set the maximum height of this Element * @param height Number/String The new maximum height. + * @returns Ext.dom.Element this */ - setMaxHeight?( height?:any ): any; - setMaxHeight?( height?:number ): Ext.dom.IElement; - setMaxHeight?( height?:string ): Ext.dom.IElement; + setMaxHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the maximum width of this Element * @param width Number/String The new maximum width. + * @returns Ext.dom.Element this */ - setMaxWidth?( width?:any ): any; - setMaxWidth?( width?:number ): Ext.dom.IElement; - setMaxWidth?( width?:string ): Ext.dom.IElement; + setMaxWidth?( width?:any ): Ext.dom.IElement; /** [Method] Set the minimum height of this Element * @param height Number/String The new minimum height. + * @returns Ext.dom.Element this */ - setMinHeight?( height?:any ): any; - setMinHeight?( height?:number ): Ext.dom.IElement; - setMinHeight?( height?:string ): Ext.dom.IElement; + setMinHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the minimum width of this Element * @param width Number/String The new minimum width. + * @returns Ext.dom.Element this */ - setMinWidth?( width?:any ): any; - setMinWidth?( width?:number ): Ext.dom.IElement; - setMinWidth?( width?:string ): Ext.dom.IElement; + setMinWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right String The right CSS property value. + * @returns Ext.dom.Element this */ setRight?( right?:string ): 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] Sets the element s top position directly using CSS style instead of setY * @param top String The top CSS property value. + * @returns Ext.dom.Element this */ setTop?( top?:string ): Ext.dom.IElement; /** [Method] Sets the element s top and left positions directly using CSS style */ setTopLeft?(): void; /** [Method] Use this to change the visibility mode between VISIBILITY DISPLAY or OFFSETS * @param mode Object + * @returns Ext.dom.Element this */ setVisibilityMode?( mode?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible. + * @returns Ext.Element this */ setVisible?( visible?:boolean ): Ext.IElement; /** [Method] Set the width of this Element * @param width Number/String The new width. + * @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] Sets the X position of the element based on page coordinates * @param x Number The X position of the element + * @returns Ext.dom.Element this */ setX?( x?:number ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates regardless of how the element is positioned * @param pos Number[] Contains X & Y [x, y] values for new position (coordinates are page-based). + * @returns Ext.dom.Element this */ setXY?( pos?:number[] ): Ext.dom.IElement; /** [Method] Sets the Y position of the element based on page coordinates * @param y Number The Y position of the element. + * @returns Ext.dom.Element this */ setY?( y?:number ): Ext.dom.IElement; /** [Method] Shows this element */ show?(): void; /** [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] Translates the passed page coordinates into left top CSS values for this 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] Removes a previously applied mask */ unmask?(): void; /** [Method] Walks up the dom looking for a parent node that matches the passed simple selector e g * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). + * @returns Ext.dom.Element/null The matching DOM node (or null if no match was found). */ - up?( simpleSelector?:any, maxDepth?:any ): any; - up?( simpleSelector?:string, maxDepth?:number ): any; - up?( simpleSelector?:string, maxDepth?:string ): any; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; + up?( simpleSelector?:string, maxDepth?:any ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -20582,6 +22766,7 @@ declare module Ext { /** [Method] Creates and wraps this element with another element * @param config Object DomHelper element config object for the wrapper element or null for an empty div * @param domNode Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The newly created wrapper element. */ wrap?( config?:any, domNode?:boolean ): any; } @@ -20593,16 +22778,14 @@ declare module Ext { /** [Method] Adds elements to this Composite object * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an Array of DOM elements to add, or another Composite object who's elements should be added. * @param root HTMLElement/String The root element of the query or id of the root. + * @returns Ext.dom.CompositeElementLite This Composite object. */ - add?( els?:any, root?:any ): any; - add?( els?:HTMLElement[], root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - add?( els?:HTMLElement[], root?:string ): Ext.dom.ICompositeElementLite; - add?( els?:Ext.dom.ICompositeElementLite, root?:string ): Ext.dom.ICompositeElementLite; + add?( els?:any, root?:any ): Ext.dom.ICompositeElementLite; /** [Method] Adds the given CSS class es to this Element * @param names String The CSS class(es) to add to this element. * @param prefix String Prefix to prepend to each class. * @param suffix String Suffix to append to each class. + * @returns Ext.dom.Element this */ addCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] fixes scope with flyweight @@ -20610,44 +22793,42 @@ declare module Ext { * @param handler Object * @param scope Object * @param opt Object + * @returns Ext.dom.CompositeElementLite this */ addListener?( eventName?:any, handler?:any, scope?:any, opt?:any ): Ext.dom.ICompositeElementLite; /** [Method] Appends the passed element s to this element * @param element HTMLElement/Ext.dom.Element a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendChild?( element?:any ): any; - appendChild?( element?:HTMLElement ): Ext.dom.IElement; - appendChild?( element?:Ext.dom.IElement ): Ext.dom.IElement; + appendChild?( element?:any ): Ext.dom.IElement; /** [Method] Appends this element to the passed element * @param el String/HTMLElement/Ext.dom.Element The new parent element. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendTo?( el?:any ): any; - appendTo?( el?:string ): Ext.dom.IElement; - appendTo?( el?:HTMLElement ): Ext.dom.IElement; - appendTo?( el?:Ext.dom.IElement ): Ext.dom.IElement; + appendTo?( el?:any ): Ext.dom.IElement; /** [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 is true) */ child?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all elements */ clear?(): 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] 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.Element The new child element. */ createChild?( config?:any, insertBefore?:HTMLElement, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Translates an element using CSS 3 in 2D */ @@ -20657,90 +22838,103 @@ declare module Ext { /** [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 is true). */ down?( selector?:string, returnDom?:boolean ): any; /** [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.CompositeElementLite this */ each?( fn?:any, scope?:any ): Ext.dom.ICompositeElementLite; /** [Method] Clears this Composite and adds the elements passed * @param els HTMLElement[]/Ext.dom.CompositeElementLite Either an array of DOM elements, or another Composite from which to fill this Composite. + * @returns Ext.dom.CompositeElementLite this */ - fill?( els?:any ): any; - fill?( els?:HTMLElement[] ): Ext.dom.ICompositeElementLite; - fill?( els?:Ext.dom.ICompositeElementLite ): Ext.dom.ICompositeElementLite; + fill?( els?:any ): Ext.dom.ICompositeElementLite; /** [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.CompositeElementLite this */ - filter?( selector?:any ): any; - filter?( selector?:string ): Ext.dom.ICompositeElementLite; + filter?( selector?:any ): Ext.dom.ICompositeElementLite; /** [Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParent?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParent?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element 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/null The matching DOM node (or null if no match was found). */ - findParentNode?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParentNode?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. * @param offsets Array Offset the positioning by [x, y]. + * @returns Array [x, y] */ getAlignToXY?( element?:any, position?:string, offsets?:any[] ): any[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. * @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 Array [x, y] An array containing the element's x and y coordinates. */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): any[]; /** [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 * @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] Gets the bottom Y coordinate of the element element Y position element height */ + /** [Method] Gets the bottom Y coordinate of the element element Y position element height + * @returns Number + */ getBottom?(): 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 are returned instead of page x/y. + * @returns Object An object in the format */ getBox?( contentBox?:boolean, local?:boolean ): any; - /** [Method] Returns the number of elements in this Composite */ + /** [Method] Returns the number of elements in this Composite + * @returns Number + */ getCount?(): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHTML?(): string; /** [Method] Returns the offset height of the element * @param contentHeight Boolean true to get the height minus borders and padding. + * @returns Number The element's height. */ getHeight?( contentHeight?:boolean ): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHtml?(): string; - /** [Method] Gets the left X coordinate */ + /** [Method] Gets the left X coordinate + * @returns Number + */ getLeft?(): 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] Returns the offsets of this element from the passed element * @param element Mixed The element to get the offsets from. + * @returns Array The XY page offsets (e.g. [100, -200]) */ getOffsetsTo?( element?:any ): any[]; /** [Method] Retrieves the height of the element account for the top and bottom margins */ @@ -20749,95 +22943,106 @@ declare module Ext { getOuterWidth?(): void; /** [Method] Gets the width of the padding s for the specified side s * @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] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param asRegion Boolean If true an Ext.util.Region will be returned. + * @returns Object box An object in the format: { x: <Element's X position>, y: <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 the right X coordinate of the element element X position element width */ + /** [Method] Gets the right X coordinate of the element element X position element width + * @returns Number + */ getRight?(): number; /** [Method] Gets the Scroller instance of the first parent that has one */ getScrollParent?(): void; /** [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] Normalizes currentStyle and computedStyle * @param prop String The style property whose value is returned. + * @returns String The current value of the style property for this element. */ getStyle?( prop?:string ): string; - /** [Method] Gets the top Y coordinate */ + /** [Method] Gets the top Y coordinate + * @returns Number + */ getTop?(): number; /** [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 ): any; - /** [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: + */ getViewSize?(): any; /** [Method] Returns the offset width of the element * @param contentWidth Boolean true to get the width minus borders and padding. + * @returns Number The element's width. */ getWidth?( contentWidth?:boolean ): number; /** [Method] Gets the current X position of the element based on page coordinates * @param el Object + * @returns Number The X position of the element */ getX?( el?:any ): number; - /** [Method] Gets the current position of the element based on page coordinates */ + /** [Method] Gets the current position of the element based on page coordinates + * @returns Array The XY position of the element + */ getXY?(): any[]; /** [Method] Gets the current Y position of the element based on page coordinates * @param el Object + * @returns Number The Y position of the element */ getY?( el?:any ): number; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param name String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ hasCls?( name?:string ): boolean; /** [Method] Hides this element */ hide?(): void; /** [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] Inserts this element after the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element to insert after. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertAfter?( el?:any ): any; - insertAfter?( el?:string ): Ext.dom.IElement; - insertAfter?( el?:HTMLElement ): Ext.dom.IElement; - insertAfter?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertAfter?( el?:any ): Ext.dom.IElement; /** [Method] Inserts this element before the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertBefore?( el?:any ): any; - insertBefore?( el?:string ): Ext.dom.IElement; - insertBefore?( el?:HTMLElement ): Ext.dom.IElement; - insertBefore?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertBefore?( el?:any ): Ext.dom.IElement; /** [Method] Inserts an element as the first child of this element * @param element String/HTMLElement/Ext.dom.Element The id or element to insert. + * @returns Ext.dom.Element this */ - insertFirst?( element?:any ): any; - insertFirst?( element?:string ): Ext.dom.IElement; - insertFirst?( element?:HTMLElement ): Ext.dom.IElement; - insertFirst?( element?:Ext.dom.IElement ): Ext.dom.IElement; + insertFirst?( element?:any ): Ext.dom.IElement; /** [Method] Inserts an HTML fragment into this element * @param where String Where to insert the HTML in relation to this element - 'beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'. See Ext.DomHelper.insertHtml for details. * @param html String The HTML fragment * @param returnEl Boolean true to return an Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The inserted node (or nearest related if more than 1 inserted). */ insertHtml?( where?:string, html?:string, returnEl?:boolean ): any; /** [Method] Inserts or creates the passed element or DomHelper config as a sibling of this element * @param el String/HTMLElement/Ext.dom.Element/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.Element. + * @returns Ext.dom.Element The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling?( el?:any, where?:string, returnDom?:boolean ): Ext.dom.IElement; /** [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] Determines if this element is a descendant of the passed in Element */ @@ -20845,14 +23050,17 @@ declare module Ext { /** [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] 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] Puts a mask over this element to disable user interaction */ @@ -20860,30 +23068,33 @@ declare module Ext { /** [Method] Gets the next sibling skipping text nodes * @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/null The next sibling or null. */ next?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @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/null The parent node or null. */ parent?( selector?:string, returnDom?:boolean ): any; - /** [Method] Gets the previous sibling skipping text nodes + /** [Method] Gets the previous sibling skipping text nodes * @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/null The previous sibling or null. */ prev?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [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 all listeners for this object */ @@ -20892,197 +23103,188 @@ declare module Ext { * @param names String The CSS class(es) to remove from this element. * @param prefix String Prefix to prepend to each class to be removed. * @param suffix String Suffix to append to each class to be removed. + * @returns Ext.dom.Element this */ removeCls?( names?:string, prefix?:string, suffix?:string ): 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.CompositeElementLite this + */ + removeElement?( el?:any, removeDom?:boolean ): Ext.dom.ICompositeElementLite; + /** [Method] Forces the browser to repaint this element + * @returns Ext.dom.Element this */ - removeElement?( el?:any, removeDom?:any ): any; - removeElement?( el?:string, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:HTMLElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:Ext.IElement, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - removeElement?( el?:number, removeDom?:boolean ): Ext.dom.ICompositeElementLite; - /** [Method] Forces the browser to repaint this element */ repaint?(): Ext.dom.IElement; /** [Method] Replaces the passed element with this element * @param element String/HTMLElement/Ext.dom.Element The element to replace. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - replace?( element?:any ): any; - replace?( element?:string ): Ext.dom.IElement; - replace?( element?:HTMLElement ): Ext.dom.IElement; - replace?( element?:Ext.dom.IElement ): Ext.dom.IElement; + replace?( element?:any ): Ext.dom.IElement; /** [Method] Replaces a CSS class on the element with another * @param oldName String The CSS class to replace. * @param newName String The replacement CSS class. * @param prefix String Prefix to prepend to each class to be replaced. * @param suffix String Suffix to append to each class to be replaced. + * @returns Ext.dom.Element this */ replaceCls?( oldName?:string, newName?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [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.CompositeElementLite this */ - replaceElement?( el?:any, replacement?:any, domReplace?:any ): any; - replaceElement?( el?:string, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:string, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:string, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:HTMLElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:Ext.IElement, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; - replaceElement?( el?:number, replacement?:Ext.IElement, domReplace?:boolean ): Ext.dom.ICompositeElementLite; + replaceElement?( el?:any, replacement?:any, domReplace?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Replaces this element with the passed element * @param el String/HTMLElement/Ext.dom.Element/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.Element This element. */ replaceWith?( el?:any ): Ext.dom.IElement; /** [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 composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - select?( selector?:any, composite?:any ): any; - select?( selector?:string, composite?:boolean ): Ext.dom.ICompositeElementLite; - select?( selector?:HTMLElement[], composite?:boolean ): Ext.dom.ICompositeElementLite; + select?( selector?:any, composite?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Serializes a DOM form into a url encoded string * @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 attributes Object The object with the attributes. * @param useSet Boolean false to override the default setAttribute to use expandos. + * @returns Ext.dom.Element this */ set?( attributes?:any, useSet?:boolean ): Ext.dom.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom String The bottom CSS property value. + * @returns Ext.dom.Element this */ setBottom?( bottom?:string ): Ext.dom.IElement; /** [Method] Sets the element s box * @param box Object The box to fill, for example: { left: ..., top: ..., width: ..., height: ... } + * @returns Ext.dom.Element this */ setBox?( box?:any ): Ext.dom.IElement; /** [Method] Sets the specified CSS class on this element s DOM node * @param className String/Array The CSS class to set on this element. */ - setCls?( className?:any ): any; - setCls?( className?:string ): void; - setCls?( className?:any[] ): void; + setCls?( className?:any ): void; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHTML?( html?:string ): void; /** [Method] Set the height of this Element * @param height Number/String The new height. + * @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] Sets the innerHTML of this element * @param html String The new HTML. */ setHtml?( html?:string ): void; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left String The left CSS property value. + * @returns Ext.dom.Element this */ setLeft?( left?:string ): Ext.dom.IElement; /** [Method] Set the maximum height of this Element * @param height Number/String The new maximum height. + * @returns Ext.dom.Element this */ - setMaxHeight?( height?:any ): any; - setMaxHeight?( height?:number ): Ext.dom.IElement; - setMaxHeight?( height?:string ): Ext.dom.IElement; + setMaxHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the maximum width of this Element * @param width Number/String The new maximum width. + * @returns Ext.dom.Element this */ - setMaxWidth?( width?:any ): any; - setMaxWidth?( width?:number ): Ext.dom.IElement; - setMaxWidth?( width?:string ): Ext.dom.IElement; + setMaxWidth?( width?:any ): Ext.dom.IElement; /** [Method] Set the minimum height of this Element * @param height Number/String The new minimum height. + * @returns Ext.dom.Element this */ - setMinHeight?( height?:any ): any; - setMinHeight?( height?:number ): Ext.dom.IElement; - setMinHeight?( height?:string ): Ext.dom.IElement; + setMinHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the minimum width of this Element * @param width Number/String The new minimum width. + * @returns Ext.dom.Element this */ - setMinWidth?( width?:any ): any; - setMinWidth?( width?:number ): Ext.dom.IElement; - setMinWidth?( width?:string ): Ext.dom.IElement; + setMinWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right String The right CSS property value. + * @returns Ext.dom.Element this */ setRight?( right?:string ): 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] Sets the element s top position directly using CSS style instead of setY * @param top String The top CSS property value. + * @returns Ext.dom.Element this */ setTop?( top?:string ): Ext.dom.IElement; /** [Method] Sets the element s top and left positions directly using CSS style */ setTopLeft?(): void; /** [Method] Use this to change the visibility mode between VISIBILITY DISPLAY or OFFSETS * @param mode Object + * @returns Ext.dom.Element this */ setVisibilityMode?( mode?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible. + * @returns Ext.Element this */ setVisible?( visible?:boolean ): Ext.IElement; /** [Method] Set the width of this Element * @param width Number/String The new width. + * @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] Sets the X position of the element based on page coordinates * @param x Number The X position of the element + * @returns Ext.dom.Element this */ setX?( x?:number ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates regardless of how the element is positioned * @param pos Number[] Contains X & Y [x, y] values for new position (coordinates are page-based). + * @returns Ext.dom.Element this */ setXY?( pos?:number[] ): Ext.dom.IElement; /** [Method] Sets the Y position of the element based on page coordinates * @param y Number The Y position of the element. + * @returns Ext.dom.Element this */ setY?( y?:number ): Ext.dom.IElement; /** [Method] Shows this element */ show?(): void; /** [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] Translates the passed page coordinates into left top CSS values for this 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] Removes a previously applied mask */ unmask?(): void; /** [Method] Walks up the dom looking for a parent node that matches the passed simple selector e g * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). + * @returns Ext.dom.Element/null The matching DOM node (or null if no match was found). */ - up?( simpleSelector?:any, maxDepth?:any ): any; - up?( simpleSelector?:string, maxDepth?:number ): any; - up?( simpleSelector?:string, maxDepth?:string ): any; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; + up?( simpleSelector?:string, maxDepth?:any ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -21090,6 +23292,7 @@ declare module Ext { /** [Method] Creates and wraps this element with another element * @param config Object DomHelper element config object for the wrapper element or null for an empty div * @param domNode Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The newly created wrapper element. */ wrap?( config?:any, domNode?:boolean ): any; } @@ -21114,20 +23317,19 @@ declare module Ext.dom { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the given CSS class es to this Element * @param names String The CSS class(es) to add to this element. * @param prefix String Prefix to prepend to each class. * @param suffix String Suffix to append to each class. + * @returns Ext.dom.Element this */ addCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Adds the specified events to the list of events which this Observable may fire @@ -21141,9 +23343,7 @@ declare module Ext.dom { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -21151,43 +23351,40 @@ declare module Ext.dom { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends the passed element s to this element * @param element HTMLElement/Ext.dom.Element a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendChild?( element?:any ): any; - appendChild?( element?:HTMLElement ): Ext.dom.IElement; - appendChild?( element?:Ext.dom.IElement ): Ext.dom.IElement; + appendChild?( element?:any ): Ext.dom.IElement; /** [Method] Appends this element to the passed element * @param el String/HTMLElement/Ext.dom.Element The new parent element. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendTo?( el?:any ): any; - appendTo?( el?:string ): Ext.dom.IElement; - appendTo?( el?:HTMLElement ): Ext.dom.IElement; - appendTo?( el?:Ext.dom.IElement ): Ext.dom.IElement; + appendTo?( el?:any ): Ext.dom.IElement; /** [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 is true) */ child?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] Returns true if this element is an ancestor of the passed element * @param element HTMLElement/String The element to check. + * @returns Boolean true if this element is an ancestor of el, else false. */ - contains?( element?:any ): any; - contains?( element?:HTMLElement ): boolean; - contains?( element?:string ): boolean; + contains?( element?: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.Element The new child element. */ createChild?( config?:any, insertBefore?:HTMLElement, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Translates an element using CSS 3 in 2D */ @@ -21197,99 +23394,115 @@ 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 is true). */ down?( selector?:string, returnDom?:boolean ): any; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParent?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParent?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element 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/null The matching DOM node (or null if no match was found). */ - findParentNode?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParentNode?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Gets the first child skipping text nodes * @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/null The first child or null. */ first?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. * @param offsets Array Offset the positioning by [x, y]. + * @returns Array [x, y] */ getAlignToXY?( element?:any, position?:string, offsets?:any[] ): any[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. * @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 Array [x, y] An array containing the element's x and y coordinates. */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): any[]; /** [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 * @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] Gets the bottom Y coordinate of the element element Y position element height */ + /** [Method] Gets the bottom Y coordinate of the element element Y position element height + * @returns Number + */ getBottom?(): 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 are returned instead of page x/y. + * @returns Object An object in the format */ getBox?( contentBox?:boolean, local?:boolean ): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHTML?(): string; /** [Method] Returns the offset height of the element * @param contentHeight Boolean true to get the height minus borders and padding. + * @returns Number The element's height. */ getHeight?( contentHeight?:boolean ): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHtml?(): string; - /** [Method] Gets the left X coordinate */ + /** [Method] Gets the left X coordinate + * @returns Number + */ getLeft?(): number; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [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] Returns the offsets of this element from the passed element * @param element Mixed The element to get the offsets from. + * @returns Array The XY page offsets (e.g. [100, -200]) */ getOffsetsTo?( element?:any ): any[]; /** [Method] Retrieves the height of the element account for the top and bottom margins */ @@ -21298,91 +23511,106 @@ declare module Ext.dom { getOuterWidth?(): void; /** [Method] Gets the width of the padding s for the specified side s * @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] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param asRegion Boolean If true an Ext.util.Region will be returned. + * @returns Object box An object in the format: { x: <Element's X position>, y: <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 the right X coordinate of the element element X position element width */ + /** [Method] Gets the right X coordinate of the element element X position element width + * @returns Number + */ getRight?(): number; /** [Method] Gets the Scroller instance of the first parent that has one */ getScrollParent?(): void; /** [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] Normalizes currentStyle and computedStyle * @param prop String The style property whose value is returned. + * @returns String The current value of the style property for this element. */ getStyle?( prop?:string ): string; - /** [Method] Gets the top Y coordinate */ + /** [Method] Gets the top Y coordinate + * @returns Number + */ getTop?(): number; /** [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 ): any; - /** [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: + */ getViewSize?(): any; /** [Method] Returns the offset width of the element * @param contentWidth Boolean true to get the width minus borders and padding. + * @returns Number The element's width. */ getWidth?( contentWidth?:boolean ): number; /** [Method] Gets the current X position of the element based on page coordinates * @param el Object + * @returns Number The X position of the element */ getX?( el?:any ): number; - /** [Method] Gets the current position of the element based on page coordinates */ + /** [Method] Gets the current position of the element based on page coordinates + * @returns Array The XY position of the element + */ getXY?(): any[]; /** [Method] Gets the current Y position of the element based on page coordinates * @param el Object + * @returns Number The Y position of the element */ getY?( el?:any ): number; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param name String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ hasCls?( name?:string ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Hides this element */ hide?(): void; /** [Method] Inserts this element after the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element to insert after. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertAfter?( el?:any ): any; - insertAfter?( el?:string ): Ext.dom.IElement; - insertAfter?( el?:HTMLElement ): Ext.dom.IElement; - insertAfter?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertAfter?( el?:any ): Ext.dom.IElement; /** [Method] Inserts this element before the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertBefore?( el?:any ): any; - insertBefore?( el?:string ): Ext.dom.IElement; - insertBefore?( el?:HTMLElement ): Ext.dom.IElement; - insertBefore?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertBefore?( el?:any ): Ext.dom.IElement; /** [Method] Inserts an element as the first child of this element * @param element String/HTMLElement/Ext.dom.Element The id or element to insert. + * @returns Ext.dom.Element this */ - insertFirst?( element?:any ): any; - insertFirst?( element?:string ): Ext.dom.IElement; - insertFirst?( element?:HTMLElement ): Ext.dom.IElement; - insertFirst?( element?:Ext.dom.IElement ): Ext.dom.IElement; + insertFirst?( element?:any ): Ext.dom.IElement; /** [Method] Inserts an HTML fragment into this element * @param where String Where to insert the HTML in relation to this element - 'beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'. See Ext.DomHelper.insertHtml for details. * @param html String The HTML fragment * @param returnEl Boolean true to return an Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The inserted node (or nearest related if more than 1 inserted). */ insertHtml?( where?:string, html?:string, returnEl?:boolean ): any; /** [Method] Inserts or creates the passed element or DomHelper config as a sibling of this element * @param el String/HTMLElement/Ext.dom.Element/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.Element. + * @returns Ext.dom.Element The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling?( el?:any, where?:string, returnDom?:boolean ): Ext.dom.IElement; /** [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] Determines if this element is a descendant of the passed in Element */ @@ -21390,15 +23618,18 @@ declare module Ext.dom { /** [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 * @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/null The last child or null. */ last?( selector?:string, returnDom?:boolean ): any; /** [Method] Puts a mask over this element to disable user interaction */ @@ -21410,21 +23641,18 @@ declare module Ext.dom { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Gets the next sibling skipping text nodes * @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/null The next sibling or null. */ next?( selector?:string, returnDom?:boolean ): any; /** [Method] Alias for addListener @@ -21434,50 +23662,49 @@ declare module Ext.dom { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @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/null The parent node or null. */ parent?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the previous sibling skipping text nodes * @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/null The previous sibling or null. */ prev?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [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] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes this element s DOM reference */ @@ -21488,8 +23715,7 @@ declare module Ext.dom { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ removeAllListeners?(): void; /** [Method] Removes a before event handler @@ -21498,12 +23724,12 @@ declare module Ext.dom { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes the given CSS class es from this Element * @param names String The CSS class(es) to remove from this element. * @param prefix String Prefix to prepend to each class to be removed. * @param suffix String Suffix to append to each class to be removed. + * @returns Ext.dom.Element this */ removeCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Removes an event handler @@ -21513,36 +23739,34 @@ declare module Ext.dom { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; - /** [Method] Forces the browser to repaint this element */ + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; + /** [Method] Forces the browser to repaint this element + * @returns Ext.dom.Element this + */ repaint?(): Ext.dom.IElement; /** [Method] Replaces the passed element with this element * @param element String/HTMLElement/Ext.dom.Element The element to replace. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - replace?( element?:any ): any; - replace?( element?:string ): Ext.dom.IElement; - replace?( element?:HTMLElement ): Ext.dom.IElement; - replace?( element?:Ext.dom.IElement ): Ext.dom.IElement; + replace?( element?:any ): Ext.dom.IElement; /** [Method] Replaces a CSS class on the element with another * @param oldName String The CSS class to replace. * @param newName String The replacement CSS class. * @param prefix String Prefix to prepend to each class to be replaced. * @param suffix String Suffix to append to each class to be replaced. + * @returns Ext.dom.Element this */ replaceCls?( oldName?:string, newName?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Replaces this element with the passed element * @param el String/HTMLElement/Ext.dom.Element/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.Element This element. */ replaceWith?( el?:any ): Ext.dom.IElement; /** [Method] Resumes firing events see suspendEvents @@ -21551,49 +23775,49 @@ declare module Ext.dom { resumeEvents?( discardQueuedEvents?:boolean ): void; /** [Method] Serializes a DOM form into a url encoded string * @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 attributes Object The object with the attributes. * @param useSet Boolean false to override the default setAttribute to use expandos. + * @returns Ext.dom.Element this */ set?( attributes?:any, useSet?:boolean ): Ext.dom.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom String The bottom CSS property value. + * @returns Ext.dom.Element this */ setBottom?( bottom?:string ): Ext.dom.IElement; /** [Method] Sets the element s box * @param box Object The box to fill, for example: { left: ..., top: ..., width: ..., height: ... } + * @returns Ext.dom.Element this */ setBox?( box?:any ): Ext.dom.IElement; /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the specified CSS class on this element s DOM node * @param className String/Array The CSS class to set on this element. */ - setCls?( className?:any ): any; - setCls?( className?:string ): void; - setCls?( className?:any[] ): void; + setCls?( className?:any ): void; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHTML?( html?:string ): void; /** [Method] Set the height of this Element * @param height Number/String The new height. + * @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] Sets the innerHTML of this element * @param html String The new HTML. */ setHtml?( html?:string ): void; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left String The left CSS property value. + * @returns Ext.dom.Element this */ setLeft?( left?:string ): Ext.dom.IElement; /** [Method] Sets the value of listeners @@ -21602,76 +23826,76 @@ declare module Ext.dom { setListeners?( listeners?:any ): void; /** [Method] Set the maximum height of this Element * @param height Number/String The new maximum height. + * @returns Ext.dom.Element this */ - setMaxHeight?( height?:any ): any; - setMaxHeight?( height?:number ): Ext.dom.IElement; - setMaxHeight?( height?:string ): Ext.dom.IElement; + setMaxHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the maximum width of this Element * @param width Number/String The new maximum width. + * @returns Ext.dom.Element this */ - setMaxWidth?( width?:any ): any; - setMaxWidth?( width?:number ): Ext.dom.IElement; - setMaxWidth?( width?:string ): Ext.dom.IElement; + setMaxWidth?( width?:any ): Ext.dom.IElement; /** [Method] Set the minimum height of this Element * @param height Number/String The new minimum height. + * @returns Ext.dom.Element this */ - setMinHeight?( height?:any ): any; - setMinHeight?( height?:number ): Ext.dom.IElement; - setMinHeight?( height?:string ): Ext.dom.IElement; + setMinHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the minimum width of this Element * @param width Number/String The new minimum width. + * @returns Ext.dom.Element this */ - setMinWidth?( width?:any ): any; - setMinWidth?( width?:number ): Ext.dom.IElement; - setMinWidth?( width?:string ): Ext.dom.IElement; + setMinWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right String The right CSS property value. + * @returns Ext.dom.Element this */ setRight?( right?:string ): 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] Sets the element s top position directly using CSS style instead of setY * @param top String The top CSS property value. + * @returns Ext.dom.Element this */ setTop?( top?:string ): Ext.dom.IElement; /** [Method] Sets the element s top and left positions directly using CSS style */ setTopLeft?(): void; /** [Method] Use this to change the visibility mode between VISIBILITY DISPLAY or OFFSETS * @param mode Object + * @returns Ext.dom.Element this */ setVisibilityMode?( mode?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible. + * @returns Ext.Element this */ setVisible?( visible?:boolean ): Ext.IElement; /** [Method] Set the width of this Element * @param width Number/String The new width. + * @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] Sets the X position of the element based on page coordinates * @param x Number The X position of the element + * @returns Ext.dom.Element this */ setX?( x?:number ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates regardless of how the element is positioned * @param pos Number[] Contains X & Y [x, y] values for new position (coordinates are page-based). + * @returns Ext.dom.Element this */ setXY?( pos?:number[] ): Ext.dom.IElement; /** [Method] Sets the Y position of the element based on page coordinates * @param y Number The Y position of the element. + * @returns Ext.dom.Element this */ setY?( y?:number ): Ext.dom.IElement; /** [Method] Shows this element */ @@ -21680,15 +23904,15 @@ declare module Ext.dom { suspendEvents?(): void; /** [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] Translates the passed page coordinates into left top CSS values for this 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] Alias for removeListener * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -21696,36 +23920,29 @@ declare module Ext.dom { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a previously applied mask */ unmask?(): void; /** [Method] Walks up the dom looking for a parent node that matches the passed simple selector e g * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). + * @returns Ext.dom.Element/null The matching DOM node (or null if no match was found). */ - up?( simpleSelector?:any, maxDepth?:any ): any; - up?( simpleSelector?:string, maxDepth?:number ): any; - up?( simpleSelector?:string, maxDepth?:string ): any; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; + up?( simpleSelector?:string, maxDepth?:any ): any; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ @@ -21733,6 +23950,7 @@ declare module Ext.dom { /** [Method] Creates and wraps this element with another element * @param config Object DomHelper element config object for the wrapper element or null for an empty div * @param domNode Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The newly created wrapper element. */ wrap?( config?:any, domNode?:boolean ): any; } @@ -21743,6 +23961,7 @@ 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] @@ -21757,71 +23976,81 @@ declare module Ext.dom { /** [Method] Gets the globally shared flyweight Element with the passed node as the active element * @param element 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 The shared Element object (or null if no matching element was found). */ - static fly( element?:any, named?:any ): any; - static fly( element?:string, named?:string ): Ext.dom.IElement; - static fly( element?:HTMLElement, named?:string ): Ext.dom.IElement; + static fly( element?:any, named?:string ): Ext.dom.IElement; /** [Method] Returns the top Element that is located at the passed coordinates * @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 element 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( element?:any ): Ext.dom.IElement; + /** [Method] Retrieves the document height + * @returns Number documentHeight */ - static get( element?:any ): any; - static get( element?:string ): Ext.dom.IElement; - static get( element?:HTMLElement ): Ext.dom.IElement; - static get( element?:Ext.IElement ): Ext.dom.IElement; - /** [Method] Retrieves the document height */ static getDocumentHeight(): number; - /** [Method] Retrieves the document width */ + /** [Method] Retrieves the document width + * @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] 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 containing the unit */ 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] 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 composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. * @param root HTMLElement/String The root element of the query or id of the root + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - static select( selector?:any, composite?:any, root?:any ): any; - static select( selector?:string, composite?:boolean, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - static select( selector?:HTMLElement[], composite?:boolean, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - static select( selector?:string, composite?:boolean, root?:string ): Ext.dom.ICompositeElementLite; - static select( selector?:HTMLElement[], composite?:boolean, root?:string ): Ext.dom.ICompositeElementLite; + static select( selector?:any, composite?:boolean, root?:any ): Ext.dom.ICompositeElementLite; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String The encoded margins * @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?:any ): any; - static unitizeBox( box?:number, units?:string ): string; - static unitizeBox( box?:string, units?:string ): string; + static unitizeBox( box?:any, units?:string ): string; } } declare module Ext { @@ -21844,20 +24073,19 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds the given CSS class es to this Element * @param names String The CSS class(es) to add to this element. * @param prefix String Prefix to prepend to each class. * @param suffix String Suffix to append to each class. + * @returns Ext.dom.Element this */ addCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Adds the specified events to the list of events which this Observable may fire @@ -21871,9 +24099,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -21881,43 +24107,40 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends the passed element s to this element * @param element HTMLElement/Ext.dom.Element a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendChild?( element?:any ): any; - appendChild?( element?:HTMLElement ): Ext.dom.IElement; - appendChild?( element?:Ext.dom.IElement ): Ext.dom.IElement; + appendChild?( element?:any ): Ext.dom.IElement; /** [Method] Appends this element to the passed element * @param el String/HTMLElement/Ext.dom.Element The new parent element. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - appendTo?( el?:any ): any; - appendTo?( el?:string ): Ext.dom.IElement; - appendTo?( el?:HTMLElement ): Ext.dom.IElement; - appendTo?( el?:Ext.dom.IElement ): Ext.dom.IElement; + appendTo?( el?:any ): Ext.dom.IElement; /** [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 is true) */ child?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] Returns true if this element is an ancestor of the passed element * @param element HTMLElement/String The element to check. + * @returns Boolean true if this element is an ancestor of el, else false. */ - contains?( element?:any ): any; - contains?( element?:HTMLElement ): boolean; - contains?( element?:string ): boolean; + contains?( element?: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.Element The new child element. */ createChild?( config?:any, insertBefore?:HTMLElement, returnDom?:boolean ): Ext.dom.IElement; /** [Method] Translates an element using CSS 3 in 2D */ @@ -21927,99 +24150,115 @@ declare module Ext { /** [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 is true). */ down?( selector?:string, returnDom?:boolean ): any; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body) * @param returnEl Boolean true to return a Ext.Element object instead of DOM node. + * @returns HTMLElement/null The matching DOM node (or null if no match was found). */ - findParent?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParent?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParent?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParent?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Looks at parent nodes for a match of the passed simple selector e g * @param simpleSelector String The simple selector to test. * @param maxDepth Number/String/HTMLElement/Ext.Element 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/null The matching DOM node (or null if no match was found). */ - findParentNode?( simpleSelector?:any, maxDepth?:any, returnEl?:any ): any; - findParentNode?( simpleSelector?:string, maxDepth?:number, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:string, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:HTMLElement, returnEl?:boolean ): any; - findParentNode?( simpleSelector?:string, maxDepth?:Ext.IElement, returnEl?:boolean ): any; + findParentNode?( simpleSelector?:string, maxDepth?:any, returnEl?:boolean ): any; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Gets the first child skipping text nodes * @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/null The first child or null. */ first?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the x y coordinates to align this element with another element * @param element Mixed The element to align to. * @param position String The position to align to. * @param offsets Array Offset the positioning by [x, y]. + * @returns Array [x, y] */ getAlignToXY?( element?:any, position?:string, offsets?:any[] ): any[]; /** [Method] Gets the x y coordinates specified by the anchor position on the element * @param anchor String The specified anchor position. * @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 Array [x, y] An array containing the element's x and y coordinates. */ getAnchorXY?( anchor?:string, local?:boolean, size?:any ): any[]; /** [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 * @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] Gets the bottom Y coordinate of the element element Y position element height */ + /** [Method] Gets the bottom Y coordinate of the element element Y position element height + * @returns Number + */ getBottom?(): 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 are returned instead of page x/y. + * @returns Object An object in the format */ getBox?( contentBox?:boolean, local?:boolean ): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHTML?(): string; /** [Method] Returns the offset height of the element * @param contentHeight Boolean true to get the height minus borders and padding. + * @returns Number The element's height. */ getHeight?( contentHeight?:boolean ): number; - /** [Method] Returns the innerHTML of an element */ + /** [Method] Returns the innerHTML of an element + * @returns String + */ getHtml?(): string; - /** [Method] Gets the left X coordinate */ + /** [Method] Gets the left X coordinate + * @returns Number + */ getLeft?(): number; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [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] Returns the offsets of this element from the passed element * @param element Mixed The element to get the offsets from. + * @returns Array The XY page offsets (e.g. [100, -200]) */ getOffsetsTo?( element?:any ): any[]; /** [Method] Retrieves the height of the element account for the top and bottom margins */ @@ -22028,91 +24267,106 @@ declare module Ext { getOuterWidth?(): void; /** [Method] Gets the width of the padding s for the specified side s * @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] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati * @param asRegion Boolean If true an Ext.util.Region will be returned. + * @returns Object box An object in the format: { x: <Element's X position>, y: <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 the right X coordinate of the element element X position element width */ + /** [Method] Gets the right X coordinate of the element element X position element width + * @returns Number + */ getRight?(): number; /** [Method] Gets the Scroller instance of the first parent that has one */ getScrollParent?(): void; /** [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] Normalizes currentStyle and computedStyle * @param prop String The style property whose value is returned. + * @returns String The current value of the style property for this element. */ getStyle?( prop?:string ): string; - /** [Method] Gets the top Y coordinate */ + /** [Method] Gets the top Y coordinate + * @returns Number + */ getTop?(): number; /** [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 ): any; - /** [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: + */ getViewSize?(): any; /** [Method] Returns the offset width of the element * @param contentWidth Boolean true to get the width minus borders and padding. + * @returns Number The element's width. */ getWidth?( contentWidth?:boolean ): number; /** [Method] Gets the current X position of the element based on page coordinates * @param el Object + * @returns Number The X position of the element */ getX?( el?:any ): number; - /** [Method] Gets the current position of the element based on page coordinates */ + /** [Method] Gets the current position of the element based on page coordinates + * @returns Array The XY position of the element + */ getXY?(): any[]; /** [Method] Gets the current Y position of the element based on page coordinates * @param el Object + * @returns Number The Y position of the element */ getY?( el?:any ): number; /** [Method] Checks if the specified CSS class exists on this element s DOM node * @param name String The CSS class to check for. + * @returns Boolean true if the class exists, else false. */ hasCls?( name?:string ): boolean; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Hides this element */ hide?(): void; /** [Method] Inserts this element after the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element to insert after. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertAfter?( el?:any ): any; - insertAfter?( el?:string ): Ext.dom.IElement; - insertAfter?( el?:HTMLElement ): Ext.dom.IElement; - insertAfter?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertAfter?( el?:any ): Ext.dom.IElement; /** [Method] Inserts this element before the passed element in the DOM * @param el String/HTMLElement/Ext.dom.Element The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - insertBefore?( el?:any ): any; - insertBefore?( el?:string ): Ext.dom.IElement; - insertBefore?( el?:HTMLElement ): Ext.dom.IElement; - insertBefore?( el?:Ext.dom.IElement ): Ext.dom.IElement; + insertBefore?( el?:any ): Ext.dom.IElement; /** [Method] Inserts an element as the first child of this element * @param element String/HTMLElement/Ext.dom.Element The id or element to insert. + * @returns Ext.dom.Element this */ - insertFirst?( element?:any ): any; - insertFirst?( element?:string ): Ext.dom.IElement; - insertFirst?( element?:HTMLElement ): Ext.dom.IElement; - insertFirst?( element?:Ext.dom.IElement ): Ext.dom.IElement; + insertFirst?( element?:any ): Ext.dom.IElement; /** [Method] Inserts an HTML fragment into this element * @param where String Where to insert the HTML in relation to this element - 'beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'. See Ext.DomHelper.insertHtml for details. * @param html String The HTML fragment * @param returnEl Boolean true to return an Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The inserted node (or nearest related if more than 1 inserted). */ insertHtml?( where?:string, html?:string, returnEl?:boolean ): any; /** [Method] Inserts or creates the passed element or DomHelper config as a sibling of this element * @param el String/HTMLElement/Ext.dom.Element/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.Element. + * @returns Ext.dom.Element The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling?( el?:any, where?:string, returnDom?:boolean ): Ext.dom.IElement; /** [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] Determines if this element is a descendant of the passed in Element */ @@ -22120,15 +24374,18 @@ declare module Ext { /** [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 * @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/null The last child or null. */ last?( selector?:string, returnDom?:boolean ): any; /** [Method] Puts a mask over this element to disable user interaction */ @@ -22140,21 +24397,18 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Gets the next sibling skipping text nodes * @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/null The next sibling or null. */ next?( selector?:string, returnDom?:boolean ): any; /** [Method] Alias for addListener @@ -22164,50 +24418,49 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Gets the parent node for this element optionally chaining up trying to match a selector * @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/null The parent node or null. */ parent?( selector?:string, returnDom?:boolean ): any; /** [Method] Gets the previous sibling skipping text nodes * @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/null The previous sibling or null. */ prev?( selector?:string, returnDom?:boolean ): any; /** [Method] Removes all listeners for this object */ purgeAllListeners?(): void; /** [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] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes this element s DOM reference */ @@ -22218,8 +24471,7 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ removeAllListeners?(): void; /** [Method] Removes a before event handler @@ -22228,12 +24480,12 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes the given CSS class es from this Element * @param names String The CSS class(es) to remove from this element. * @param prefix String Prefix to prepend to each class to be removed. * @param suffix String Suffix to append to each class to be removed. + * @returns Ext.dom.Element this */ removeCls?( names?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Removes an event handler @@ -22243,36 +24495,34 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; - /** [Method] Forces the browser to repaint this element */ + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; + /** [Method] Forces the browser to repaint this element + * @returns Ext.dom.Element this + */ repaint?(): Ext.dom.IElement; /** [Method] Replaces the passed element with this element * @param element String/HTMLElement/Ext.dom.Element The element to replace. The id of the node, a DOM Node or an existing Element. + * @returns Ext.dom.Element This element. */ - replace?( element?:any ): any; - replace?( element?:string ): Ext.dom.IElement; - replace?( element?:HTMLElement ): Ext.dom.IElement; - replace?( element?:Ext.dom.IElement ): Ext.dom.IElement; + replace?( element?:any ): Ext.dom.IElement; /** [Method] Replaces a CSS class on the element with another * @param oldName String The CSS class to replace. * @param newName String The replacement CSS class. * @param prefix String Prefix to prepend to each class to be replaced. * @param suffix String Suffix to append to each class to be replaced. + * @returns Ext.dom.Element this */ replaceCls?( oldName?:string, newName?:string, prefix?:string, suffix?:string ): Ext.dom.IElement; /** [Method] Replaces this element with the passed element * @param el String/HTMLElement/Ext.dom.Element/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.Element This element. */ replaceWith?( el?:any ): Ext.dom.IElement; /** [Method] Resumes firing events see suspendEvents @@ -22281,49 +24531,49 @@ declare module Ext { resumeEvents?( discardQueuedEvents?:boolean ): void; /** [Method] Serializes a DOM form into a url encoded string * @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 attributes Object The object with the attributes. * @param useSet Boolean false to override the default setAttribute to use expandos. + * @returns Ext.dom.Element this */ set?( attributes?:any, useSet?:boolean ): Ext.dom.IElement; /** [Method] Sets the element s CSS bottom style * @param bottom String The bottom CSS property value. + * @returns Ext.dom.Element this */ setBottom?( bottom?:string ): Ext.dom.IElement; /** [Method] Sets the element s box * @param box Object The box to fill, for example: { left: ..., top: ..., width: ..., height: ... } + * @returns Ext.dom.Element this */ setBox?( box?:any ): Ext.dom.IElement; /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the specified CSS class on this element s DOM node * @param className String/Array The CSS class to set on this element. */ - setCls?( className?:any ): any; - setCls?( className?:string ): void; - setCls?( className?:any[] ): void; + setCls?( className?:any ): void; /** [Method] Sets the innerHTML of this element * @param html String The new HTML. */ setHTML?( html?:string ): void; /** [Method] Set the height of this Element * @param height Number/String The new height. + * @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] Sets the innerHTML of this element * @param html String The new HTML. */ setHtml?( html?:string ): void; /** [Method] Sets the element s left position directly using CSS style instead of setX * @param left String The left CSS property value. + * @returns Ext.dom.Element this */ setLeft?( left?:string ): Ext.dom.IElement; /** [Method] Sets the value of listeners @@ -22332,76 +24582,76 @@ declare module Ext { setListeners?( listeners?:any ): void; /** [Method] Set the maximum height of this Element * @param height Number/String The new maximum height. + * @returns Ext.dom.Element this */ - setMaxHeight?( height?:any ): any; - setMaxHeight?( height?:number ): Ext.dom.IElement; - setMaxHeight?( height?:string ): Ext.dom.IElement; + setMaxHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the maximum width of this Element * @param width Number/String The new maximum width. + * @returns Ext.dom.Element this */ - setMaxWidth?( width?:any ): any; - setMaxWidth?( width?:number ): Ext.dom.IElement; - setMaxWidth?( width?:string ): Ext.dom.IElement; + setMaxWidth?( width?:any ): Ext.dom.IElement; /** [Method] Set the minimum height of this Element * @param height Number/String The new minimum height. + * @returns Ext.dom.Element this */ - setMinHeight?( height?:any ): any; - setMinHeight?( height?:number ): Ext.dom.IElement; - setMinHeight?( height?:string ): Ext.dom.IElement; + setMinHeight?( height?:any ): Ext.dom.IElement; /** [Method] Set the minimum width of this Element * @param width Number/String The new minimum width. + * @returns Ext.dom.Element this */ - setMinWidth?( width?:any ): any; - setMinWidth?( width?:number ): Ext.dom.IElement; - setMinWidth?( width?:string ): Ext.dom.IElement; + setMinWidth?( width?:any ): Ext.dom.IElement; /** [Method] Sets the element s CSS right style * @param right String The right CSS property value. + * @returns Ext.dom.Element this */ setRight?( right?:string ): 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] Sets the element s top position directly using CSS style instead of setY * @param top String The top CSS property value. + * @returns Ext.dom.Element this */ setTop?( top?:string ): Ext.dom.IElement; /** [Method] Sets the element s top and left positions directly using CSS style */ setTopLeft?(): void; /** [Method] Use this to change the visibility mode between VISIBILITY DISPLAY or OFFSETS * @param mode Object + * @returns Ext.dom.Element this */ setVisibilityMode?( mode?:any ): Ext.dom.IElement; /** [Method] Sets the visibility of the element see details * @param visible Boolean Whether the element is visible. + * @returns Ext.Element this */ setVisible?( visible?:boolean ): Ext.IElement; /** [Method] Set the width of this Element * @param width Number/String The new width. + * @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] Sets the X position of the element based on page coordinates * @param x Number The X position of the element + * @returns Ext.dom.Element this */ setX?( x?:number ): Ext.dom.IElement; /** [Method] Sets the position of the element in page coordinates regardless of how the element is positioned * @param pos Number[] Contains X & Y [x, y] values for new position (coordinates are page-based). + * @returns Ext.dom.Element this */ setXY?( pos?:number[] ): Ext.dom.IElement; /** [Method] Sets the Y position of the element based on page coordinates * @param y Number The Y position of the element. + * @returns Ext.dom.Element this */ setY?( y?:number ): Ext.dom.IElement; /** [Method] Shows this element */ @@ -22410,15 +24660,15 @@ declare module Ext { suspendEvents?(): void; /** [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] Translates the passed page coordinates into left top CSS values for this 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] Alias for removeListener * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -22426,40 +24676,37 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a previously applied mask */ unmask?(): void; /** [Method] Walks up the dom looking for a parent node that matches the passed simple selector e g * @param simpleSelector String The simple selector to test * @param maxDepth Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body). + * @returns Ext.dom.Element/null The matching DOM node (or null if no match was found). + */ + up?( simpleSelector?:string, maxDepth?:any ): any; + /** [Method] Sets the innerHTML of this element + * @param html String The new HTML. */ - up?( simpleSelector?:any, maxDepth?:any ): any; - up?( simpleSelector?:string, maxDepth?:number ): any; - up?( simpleSelector?:string, maxDepth?:string ): any; - up?( simpleSelector?:string, maxDepth?:HTMLElement ): any; - up?( simpleSelector?:string, maxDepth?:Ext.IElement ): any; update?( html?:string ): void; /** [Method] Creates and wraps this element with another element * @param config Object DomHelper element config object for the wrapper element or null for an empty div * @param domNode Boolean true to return the raw DOM element instead of Ext.dom.Element. + * @returns HTMLElement/Ext.dom.Element The newly created wrapper element. */ wrap?( config?:any, domNode?:boolean ): any; } @@ -22470,6 +24717,7 @@ 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] @@ -22484,71 +24732,81 @@ declare module Ext { /** [Method] Gets the globally shared flyweight Element with the passed node as the active element * @param element 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 The shared Element object (or null if no matching element was found). */ - static fly( element?:any, named?:any ): any; - static fly( element?:string, named?:string ): Ext.dom.IElement; - static fly( element?:HTMLElement, named?:string ): Ext.dom.IElement; + static fly( element?:any, named?:string ): Ext.dom.IElement; /** [Method] Returns the top Element that is located at the passed coordinates * @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 element 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( element?:any ): Ext.dom.IElement; + /** [Method] Retrieves the document height + * @returns Number documentHeight */ - static get( element?:any ): any; - static get( element?:string ): Ext.dom.IElement; - static get( element?:HTMLElement ): Ext.dom.IElement; - static get( element?:Ext.IElement ): Ext.dom.IElement; - /** [Method] Retrieves the document height */ static getDocumentHeight(): number; - /** [Method] Retrieves the document width */ + /** [Method] Retrieves the document width + * @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] 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 containing the unit */ 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] 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 composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. * @param root HTMLElement/String The root element of the query or id of the root + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - static select( selector?:any, composite?:any, root?:any ): any; - static select( selector?:string, composite?:boolean, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - static select( selector?:HTMLElement[], composite?:boolean, root?:HTMLElement ): Ext.dom.ICompositeElementLite; - static select( selector?:string, composite?:boolean, root?:string ): Ext.dom.ICompositeElementLite; - static select( selector?:HTMLElement[], composite?:boolean, root?:string ): Ext.dom.ICompositeElementLite; + static select( selector?:any, composite?:boolean, root?:any ): Ext.dom.ICompositeElementLite; /** [Method] Parses a number or string representing margin sizes into an object * @param box Number/String The encoded margins * @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?:any ): any; - static unitizeBox( box?:number, units?:string ): string; - static unitizeBox( box?:string, units?:string ): string; + static unitizeBox( box?:any, units?:string ): string; } } declare module Ext.dom { @@ -22556,25 +24814,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 { @@ -22583,75 +24837,65 @@ 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 */ - append?( el?:any, o?:any, returnElement?:any ): any; - append?( el?:string, o?:any, returnElement?:boolean ): any; - append?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - append?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + 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] 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] 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[] ): 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 ): any; - insertAfter?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertAfter?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + 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 ): any; - insertBefore?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertBefore?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + 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 ): any; - insertFirst?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertFirst?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + 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 ): any; - overwrite?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - overwrite?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + overwrite?( el?:any, o?:any, returnElement?:boolean ): any; } } declare module Ext.dom { @@ -22660,75 +24904,65 @@ 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 ): any; - append?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - append?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + 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] 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] 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[] ): 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 ): any; - insertAfter?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertAfter?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + 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 ): any; - insertBefore?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertBefore?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + 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 ): any; - insertFirst?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - insertFirst?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + 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 ): any; - overwrite?( el?:HTMLElement, o?:any, returnElement?:boolean ): any; - overwrite?( el?:Ext.IElement, o?:any, returnElement?:boolean ): any; + overwrite?( el?:any, o?:any, returnElement?:boolean ): any; } } declare module Ext { @@ -22737,52 +24971,52 @@ declare module Ext { export class DomQuery { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [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 */ - static is( el?:any, selector?:any ): any; - static is( el?:string, selector?:string ): boolean; - static is( el?:HTMLElement, selector?:string ): boolean; - static is( el?:any[], selector?:string ): boolean; + static 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. */ - static select( selector?:any, root?:any ): any; - static select( selector?:string, root?:HTMLElement ): HTMLElement[]; - static select( selector?:string, root?:string ): HTMLElement[]; + static 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. + */ + static selectNode( selector?:string, root?:any ): HTMLElement; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class */ - static selectNode( selector?:any, root?:any ): any; - static selectNode( selector?:string, root?:HTMLElement ): HTMLElement; - static selectNode( selector?:string, root?:string ): HTMLElement; - /** [Method] Get the reference to the class from which this object was instantiated */ static statics(): Ext.IClass; } } @@ -22792,52 +25026,52 @@ declare module Ext.core { export class DomQuery { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [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 */ - static is( el?:any, selector?:any ): any; - static is( el?:string, selector?:string ): boolean; - static is( el?:HTMLElement, selector?:string ): boolean; - static is( el?:any[], selector?:string ): boolean; + static 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. */ - static select( selector?:any, root?:any ): any; - static select( selector?:string, root?:HTMLElement ): HTMLElement[]; - static select( selector?:string, root?:string ): HTMLElement[]; + static 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. + */ + static selectNode( selector?:string, root?:any ): HTMLElement; + /** [Method] Get the reference to the class from which this object was instantiated + * @returns Ext.Class */ - static selectNode( selector?:any, root?:any ): any; - static selectNode( selector?:string, root?:HTMLElement ): HTMLElement; - static selectNode( selector?:string, root?:string ): HTMLElement; - /** [Method] Get the reference to the class from which this object was instantiated */ static statics(): Ext.IClass; } } @@ -22852,43 +25086,51 @@ declare module Ext.draw { /** [Method] Register a recursive callback that will be called at every frame * @param callback Object * @param scope Object + * @returns String */ static addFrameCallback( callback?:any, scope?:any ): string; - /** [Method] Cross platform animationTime implementation */ + /** [Method] Cross platform animationTime implementation + * @returns Number + */ static animationTime(): number; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 a registered one time callback * @param id Object */ static cancel( id?:any ): void; /** [Method] Returns true or false whether it contains the given animation or not * @param animation Object The animation to check for. + * @returns Boolean */ static contains( animation?:any ): boolean; /** [Method] */ static destroy(): void; - /** [Method] Returns true or false whether the pool is empty or not */ + /** [Method] Returns true or false whether the pool is empty or not + * @returns Boolean + */ static empty(): boolean; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Removes an animation from the pool @@ -22902,9 +25144,12 @@ declare module Ext.draw { /** [Method] Register an one time callback that will be called at the next frame * @param callback Object * @param scope Object + * @returns String */ static schedule( callback?:any, scope?:any ): 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; /** [Method] Given a frame time it will filter out finished animations from the pool * @param frameTime Number The frame's start time, in milliseconds. @@ -22918,35 +25163,43 @@ declare module Ext.draw { lightnessFactor?: number; /** [Method] Return a new color that is darker than this color * @param factor Number Darker factor (0..1). + * @returns Ext.draw.Color */ createDarker?( factor?:number ): Ext.draw.IColor; /** [Method] Return a new color that is lighter than this color * @param factor Number Lighter factor (0..1). + * @returns Ext.draw.Color */ createLighter?( factor?:number ): Ext.draw.IColor; - /** [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 equivalent HSL components of the color * @param target Array Optional array to receive the values. + * @returns Array */ getHSL?( target?:any[] ): any[]; /** [Method] Parse the string and set current color * @param str String Color in string. + * @returns Object this */ setFromString?( str?:string ): any; /** [Method] Set current color based on the specified HSL values * @param h Number Hue component (0..359) * @param s Number Saturation component (0..1) * @param l Number Lightness component (0..1) + * @returns Object this */ setHSL?( h?:number, s?:number, l?:number ): any; /** [Method] Convert a color to hexadecimal format * @param color String/Array 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. + */ + toHex?( color?:any ): string; + /** [Method] Return the color in the hex format i e + * @returns String */ - toHex?( color?:any ): any; - toHex?( color?:string ): string; - toHex?( color?:any[] ): string; - /** [Method] Return the color in the hex format i e */ toString?(): string; } export class Color { @@ -22956,6 +25209,7 @@ 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] @@ -22967,12 +25221,9 @@ declare module Ext.draw { * @param green Number Green component (0..255) * @param blue Number Blue component (0..255) * @param alpha Number Alpha component (0..1) + * @returns Ext.draw.Color */ - static create( red?:any, green?:any, blue?:any, alpha?:any ): any; - static create( red?:Ext.draw.IColor, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; - static create( red?:string, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; - static create( red?:number[], green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; - static create( red?:number, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; + static create( red?:any, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; /** [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 @@ -22983,24 +25234,28 @@ declare module Ext.draw { * @param green Number Green component (0..255) * @param blue Number Blue component (0..255) * @param alpha Number Alpha component (0..1) + * @returns Ext.draw.Color */ - static fly( red?:any, green?:any, blue?:any, alpha?:any ): any; - static fly( red?:number, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; - static fly( red?:string, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; + static fly( red?:any, green?:number, blue?:number, alpha?:number ): Ext.draw.IColor; /** [Method] Create a new color based on the specified HSL values * @param h Number Hue component (0..359) * @param s Number Saturation component (0..1) * @param l Number Lightness component (0..1) + * @returns Ext.draw.Color */ static fromHSL( h?:number, s?:number, l?:number ): Ext.draw.IColor; /** [Method] Parse the string and create a new color * @param string String Color in string. + * @returns Ext.draw.Color */ static fromString( string?:string ): Ext.draw.IColor; - /** [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] 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; } @@ -23021,23 +25276,38 @@ declare module Ext.draw { viewBox?: boolean; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of autoSize */ + /** [Method] Returns the value of autoSize + * @returns Boolean + */ getAutoSize?(): boolean; - /** [Method] Returns the value of background */ + /** [Method] Returns the value of background + * @returns Object + */ getBackground?(): any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of fitSurface */ + /** [Method] Returns the value of fitSurface + * @returns Boolean + */ getFitSurface?(): boolean; - /** [Method] Returns the value of resizeHandler */ + /** [Method] Returns the value of resizeHandler + * @returns Function + */ getResizeHandler?(): any; - /** [Method] Returns the value of sprites */ + /** [Method] Returns the value of sprites + * @returns Object + */ getSprites?(): any; /** [Method] Get a surface by the given id or create one if it doesn t exist * @param id String + * @returns Ext.draw.Surface */ getSurface?( id?:string ): Ext.draw.ISurface; - /** [Method] Returns the value of viewBox */ + /** [Method] Returns the value of viewBox + * @returns Boolean + */ getViewBox?(): boolean; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -23081,52 +25351,60 @@ declare module Ext.draw { export class Draw { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] Converting radians to degrees * @param radian Number + * @returns Number */ static degrees( radian?:number ): number; /** [Method] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] * @param bbox1 Object * @param bbox2 Object * @param padding Object + * @returns Boolean */ static isBBoxIntersect( bbox1?:any, bbox2?:any, padding?:any ): boolean; /** [Method] Converting degrees to radians * @param degrees Number + * @returns Number */ static rad( degrees?:number ): number; /** [Method] Function that returns its first element * @param a Mixed + * @returns Mixed */ static reflectFn( a?:any ): any; /** [Method] Natural cubic spline interpolation * @param points Array Array of numbers. */ static spline( points?: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; } } @@ -23140,7 +25418,9 @@ declare module Ext.draw.engine { clearTransform?(): void; /** [Method] Destroys the Canvas element and prepares it for Garbage Collection */ destroy?(): void; - /** [Method] Returns the value of highPrecision */ + /** [Method] Returns the value of highPrecision + * @returns Boolean + */ getHighPrecision?(): boolean; /** [Method] Initialize the canvas element */ initElement?(): void; @@ -23160,6 +25440,7 @@ declare module Ext.draw.engine { clearTransform?(): void; /** [Method] Creates a DOM element under the SVG namespace of the given type * @param type Object The type of the SVG DOM element. + * @returns * The created element. */ createSvgNode?( type?:any ): any; /** [Method] Destroys the Canvas element and prepares it for Garbage Collection @@ -23168,7 +25449,9 @@ declare module Ext.draw.engine { * @param band Object */ destroy?( path?:any, matrix?:any, band?:any ): void; - /** [Method] Returns the value of highPrecision */ + /** [Method] Returns the value of highPrecision + * @returns Boolean + */ getHighPrecision?(): boolean; /** [Method] Remove a given sprite from the surface optionally destroying the sprite in the process * @param sprite Object @@ -23177,6 +25460,7 @@ declare module Ext.draw.engine { remove?( sprite?:any, destroySprite?:any ): void; /** [Method] Renders a single sprite into the surface * @param sprite Ext.draw.sprite.Sprite The Sprite to be rendered. + * @returns Boolean returns false to stop the rendering to continue. */ renderSprite?( sprite?:Ext.draw.sprite.ISprite ): boolean; /** [Method] Sets the value of highPrecision @@ -23245,6 +25529,7 @@ declare module Ext.draw.engine { * @param y0 Object * @param x1 Object * @param y1 Object + * @returns Ext.draw.engine.SvgContext.Gradient */ createLinearGradient?( x0?:any, y0?:any, x1?:any, y1?:any ): Ext.draw.engine.svgcontext.IGradient; /** [Method] Returns a CanvasGradient object that represents a radial gradient that paints along the cone given by the circles rep @@ -23254,6 +25539,7 @@ declare module Ext.draw.engine { * @param x1 Object * @param y1 Object * @param r1 Object + * @returns Ext.draw.engine.SvgContext.Gradient */ createRadialGradient?( x0?:any, y0?:any, r0?:any, x1?:any, y1?:any, r1?:any ): Ext.draw.engine.svgcontext.IGradient; /** [Method] Draws the given image onto the canvas @@ -23362,9 +25648,12 @@ declare module Ext.draw.gradient { /** [Method] Generates the gradient for the given context * @param ctx Object The context. * @param bbox Object + * @returns Object */ generateGradient?( ctx?:any, bbox?:any ): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ getId?(): string; } } @@ -23375,6 +25664,7 @@ declare module Ext.draw.gradient { /** [Method] Generates the gradient for the given context * @param ctx Object The context. * @param bbox Object + * @returns Object */ generateGradient?( ctx?:any, bbox?:any ): any; } @@ -23388,11 +25678,16 @@ declare module Ext.draw.gradient { /** [Method] Generates the gradient for the given context * @param ctx Object The context. * @param bbox Object + * @returns Object */ generateGradient?( ctx?:any, bbox?:any ): any; - /** [Method] Returns the value of end */ + /** [Method] Returns the value of end + * @returns Object + */ getEnd?(): any; - /** [Method] Returns the value of start */ + /** [Method] Returns the value of start + * @returns Object + */ getStart?(): any; /** [Method] Sets the value of end * @param end Object @@ -23416,22 +25711,18 @@ declare module Ext.draw { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Add a list of sprites to group * @param sprites Array|Ext.draw.sprite.Sprite */ - addAll?( sprites?:any ): any; - addAll?( sprites?:any[] ): void; - addAll?( sprites?:Ext.draw.sprite.ISprite ): void; + addAll?( sprites?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -23443,9 +25734,7 @@ declare module Ext.draw { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -23453,9 +25742,7 @@ declare module Ext.draw { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Clear the group * @param destroySprite Boolean */ @@ -23471,43 +25758,50 @@ declare module Ext.draw { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Get the sprite with id or index * @param id String|Number + * @returns Ext.draw.sprite.Sprite */ - get?( id?:any ): any; - get?( id?:string ): Ext.draw.sprite.ISprite; - get?( id?:number ): Ext.draw.sprite.ISprite; + get?( id?:any ): Ext.draw.sprite.ISprite; /** [Method] Get the i th sprite of the group * @param index Number + * @returns Ext.draw.sprite.Sprite */ getAt?( index?:number ): Ext.draw.sprite.ISprite; /** [Method] Return the minimal bounding box that contains all the sprites bounding boxes in this group * @param isWithTransform Object */ getBBox?( isWithTransform?:any ): void; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of surface */ + /** [Method] Returns the value of surface + * @returns Object + */ getSurface?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Hide all sprites in the group @@ -23521,18 +25815,14 @@ declare module Ext.draw { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -23540,28 +25830,25 @@ declare module Ext.draw { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Remote sprite from group @@ -23575,16 +25862,14 @@ declare module Ext.draw { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -23592,18 +25877,14 @@ declare module Ext.draw { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -23615,9 +25896,7 @@ declare module Ext.draw { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Set dirty flag for all sprites in the group */ setDirty?(): void; /** [Method] Sets the value of listeners @@ -23641,25 +25920,21 @@ declare module Ext.draw { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.draw { @@ -23675,16 +25950,24 @@ declare module Ext.draw { /** [Method] Get a cached object * @param id String * @param args Mixed... Arguments appended to feeder. + * @returns Object */ get?( id:string, ...args:any[] ): any; - /** [Method] Returns the value of feeder */ + /** [Method] Returns the value of feeder + * @returns Function + */ getFeeder?(): any; - /** [Method] Returns the value of limit */ + /** [Method] Returns the value of limit + * @returns Number + */ getLimit?(): number; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; /** [Method] Sets the value of feeder * @param feeder Function + * @returns Number */ setFeeder?( feeder?:any ): number; /** [Method] Sets the value of limit @@ -23708,46 +25991,75 @@ declare module Ext.draw { * @param yy Object Coefficient from y to y. * @param dx Object Offset of x. * @param dy Object Offset of y. + * @returns Ext.draw.Matrix this */ append?( xx?:any, xy?:any, yx?:any, yy?:any, dx?:any, dy?:any ): Ext.draw.IMatrix; /** [Method] Postpend a matrix onto the current * @param matrix Ext.draw.Matrix + * @returns Ext.draw.Matrix this */ appendMatrix?( matrix?:Ext.draw.IMatrix ): Ext.draw.IMatrix; - /** [Method] Clone this matrix */ + /** [Method] Clone this matrix + * @returns Ext.draw.Matrix + */ clone?(): Ext.draw.IMatrix; /** [Method] Determines if this matrix has the same values as another matrix * @param matrix Ext.draw.Matrix + * @returns Boolean */ equals?( matrix?:Ext.draw.IMatrix ): boolean; - /** [Method] Horizontally flip the matrix */ + /** [Method] Horizontally flip the matrix + * @returns Ext.draw.Matrix this + */ flipX?(): Ext.draw.IMatrix; - /** [Method] Vertically flip the matrix */ + /** [Method] Vertically flip the matrix + * @returns Ext.draw.Matrix this + */ flipY?(): Ext.draw.IMatrix; - /** [Method] Get offset x component of the matrix */ + /** [Method] Get offset x component of the matrix + * @returns Number + */ getDX?(): number; - /** [Method] Get offset y component of the matrix */ + /** [Method] Get offset y component of the matrix + * @returns Number + */ getDY?(): number; - /** [Method] Get the x scale of the matrix */ + /** [Method] Get the x scale of the matrix + * @returns Number + */ getScaleX?(): number; - /** [Method] Get the y scale of the matrix */ + /** [Method] Get the y scale of the matrix + * @returns Number + */ getScaleY?(): number; - /** [Method] Get x to x component of the matrix */ + /** [Method] Get x to x component of the matrix + * @returns Number + */ getXX?(): number; - /** [Method] Get x to y component of the matrix */ + /** [Method] Get x to y component of the matrix + * @returns Number + */ getXY?(): number; - /** [Method] Get y to x component of the matrix */ + /** [Method] Get y to x component of the matrix + * @returns Number + */ getYX?(): number; - /** [Method] Get y to y component of the matrix */ + /** [Method] Get y to y component of the matrix + * @returns Number + */ getYY?(): number; /** [Method] Return a new matrix represents the opposite transformation of the current one * @param target Ext.draw.Matrix A target matrix. If present, it will receive the result of inversion to avoid creating a new object. + * @returns Ext.draw.Matrix */ inverse?( target?:Ext.draw.IMatrix ): Ext.draw.IMatrix; - /** [Method] Determines whether this matrix is an identity matrix no transform */ + /** [Method] Determines whether this matrix is an identity matrix no transform + * @returns Boolean + */ isIdentity?(): boolean; /** [Method] Postpend a matrix onto the current * @param matrix Ext.draw.Matrix + * @returns Ext.draw.Matrix this */ multiply?( matrix?:Ext.draw.IMatrix ): Ext.draw.IMatrix; /** [Method] Prepend a matrix onto the current @@ -23757,29 +26069,31 @@ declare module Ext.draw { * @param yy Object Coefficient from y to y. * @param dx Object Offset of x. * @param dy Object Offset of y. + * @returns Ext.draw.Matrix this */ prepend?( xx?:any, xy?:any, yx?:any, yy?:any, dx?:any, dy?:any ): Ext.draw.IMatrix; /** [Method] Prepend a matrix onto the current * @param matrix Ext.draw.Matrix + * @returns Ext.draw.Matrix this */ prependMatrix?( matrix?:Ext.draw.IMatrix ): Ext.draw.IMatrix; - /** [Method] Reset the matrix to identical */ + /** [Method] Reset the matrix to identical + * @returns Ext.draw.Matrix this + */ reset?(): Ext.draw.IMatrix; /** [Method] Rotate the matrix * @param angle Number Radians to rotate * @param rcx Number|null Center of rotation. * @param rcy Number|null Center of rotation. * @param prepend Boolean If true, this will transformation be prepended to the matrix. + * @returns Ext.draw.Matrix this */ - rotate?( angle?:any, rcx?:any, rcy?:any, prepend?:any ): any; - rotate?( angle?:number, rcx?:number, rcy?:number, prepend?:boolean ): Ext.draw.IMatrix; - rotate?( angle?:number, rcx?:any, rcy?:number, prepend?:boolean ): Ext.draw.IMatrix; - rotate?( angle?:number, rcx?:number, rcy?:any, prepend?:boolean ): Ext.draw.IMatrix; rotate?( angle?:number, rcx?:any, rcy?:any, prepend?:boolean ): Ext.draw.IMatrix; /** [Method] Rotate the matrix by the angle of a vector * @param x Number * @param y Number * @param prepend Boolean If true, this will transformation be prepended to the matrix. + * @returns Ext.draw.Matrix this */ rotateFromVector?( x?:number, y?:number, prepend?:boolean ): Ext.draw.IMatrix; /** [Method] Scale the matrix @@ -23788,6 +26102,7 @@ declare module Ext.draw { * @param scx Number * @param scy Number * @param prepend Boolean If true, this will transformation be prepended to the matrix. + * @returns Ext.draw.Matrix this */ scale?( sx?:number, sy?:number, scx?:number, scy?:number, prepend?:boolean ): Ext.draw.IMatrix; /** [Method] Set the elements of a Matrix @@ -23797,58 +26112,78 @@ declare module Ext.draw { * @param yy Number * @param dx Number * @param dy Number + * @returns Ext.draw.Matrix this */ set?( xx?:number, xy?:number, yx?:number, yy?:number, dx?:number, dy?:number ): Ext.draw.IMatrix; /** [Method] Skew the matrix * @param angle Number + * @returns Ext.draw.Matrix this */ skewX?( angle?:number ): Ext.draw.IMatrix; /** [Method] Skew the matrix * @param angle Number + * @returns Ext.draw.Matrix this */ skewY?( angle?:number ): Ext.draw.IMatrix; - /** [Method] Split matrix into Translate Scale Shear and Rotate */ + /** [Method] Split matrix into Translate Scale Shear and Rotate + * @returns Object + */ split?(): any; - /** [Method] Create an array of elements by horizontal order xx yx dx yx yy dy */ + /** [Method] Create an array of elements by horizontal order xx yx dx yx yy dy + * @returns Array + */ toArray?(): any[]; /** [Method] Apply the matrix to a drawing context * @param ctx Object + * @returns Ext.draw.Matrix this */ toContext?( ctx?:any ): Ext.draw.IMatrix; - /** [Method] Get an array of elements */ + /** [Method] Get an array of elements + * @returns Array + */ toString?(): any[]; - /** [Method] Return a string that can be used as transform attribute in SVG */ + /** [Method] Return a string that can be used as transform attribute in SVG + * @returns String + */ toSvg?(): string; - /** [Method] Create an array of elements by vertical order xx xy yx yy dx dy */ + /** [Method] Create an array of elements by vertical order xx xy yx yy dx dy + * @returns Array|String + */ toVerticalArray?(): any; /** [Method] * @param bbox Object Given as {x: Number, y: Number, width: Number, height: Number}. * @param radius Number * @param target Object Optional target object to recieve the result. Recommanded to use it for better gc. + * @returns Object Object with x, y, width and height. */ transformBBox?( bbox?:any, radius?:number, target?:any ): any; /** [Method] Transform a list for points * @param list Array + * @returns Array list */ transformList?( list?:any[] ): any[]; /** [Method] Transform a point to a new array * @param point Array + * @returns Array */ transformPoint?( point?:any[] ): any[]; /** [Method] Translate the matrix * @param x Number * @param y Number * @param prepend Boolean If true, this will transformation be prepended to the matrix. + * @returns Ext.draw.Matrix this */ translate?( x?:number, y?:number, prepend?:boolean ): Ext.draw.IMatrix; /** [Method] Transform point returning the x component of the result * @param x Number * @param y Number + * @returns Number x component of the result. */ x?( x?:number, y?:number ): number; /** [Method] Transform point returning the y component of the result * @param x Number * @param y Number + * @returns Number y component of the result. */ y?( x?:number, y?:number ): number; } @@ -23859,6 +26194,7 @@ 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] @@ -23867,6 +26203,7 @@ declare module Ext.draw { static callParent( args?:any ): void; /** [Method] Create a matrix from mat * @param mat Mixed + * @returns Ext.draw.Matrix */ static create( mat?:any ): Ext.draw.IMatrix; /** [Method] Return the affine matrix that transform two points x0 y0 and x1 y1 to x0p y0p and x1p y1p @@ -23898,12 +26235,16 @@ declare module Ext.draw { static createPanZoomFromTwoPair( x0?:any, y0?:any, x1?:any, y1?:any, x0p?:any, y0p?:any, x1p?:any, y1p?:any ): void; /** [Method] Create a flyweight to wrap the given array * @param elements Array + * @returns Ext.draw.Matrix */ static fly( elements?:any[] ): Ext.draw.IMatrix; - /** [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] 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; } @@ -23924,16 +26265,14 @@ declare module Ext.draw.modifier { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -23945,9 +26284,7 @@ declare module Ext.draw.modifier { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -23955,9 +26292,7 @@ declare module Ext.draw.modifier { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Remove special easings on the given attributes * @param attrs Object The source attributes. */ @@ -23973,35 +26308,48 @@ declare module Ext.draw.modifier { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of customDuration */ + /** [Method] Returns the value of customDuration + * @returns Object + */ getCustomDuration?(): any; - /** [Method] Returns the value of customEasings */ + /** [Method] Returns the value of customEasings + * @returns Object + */ getCustomEasings?(): any; - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns Function + */ getEasing?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -24011,18 +26359,14 @@ declare module Ext.draw.modifier { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -24030,25 +26374,21 @@ declare module Ext.draw.modifier { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Invoked when changes need to be popped up to the top * @param attributes Object The source attributes. * @param changes Object The changes to be popped up. @@ -24061,11 +26401,13 @@ declare module Ext.draw.modifier { /** [Method] Invoked when changes need to pushed down to the sprite * @param attr Object The source attributes. * @param changes Object The changes to make. This object might be changed unexpectedly inside the method. + * @returns Mixed */ pushDown?( attr?:any, changes?:any ): any; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -24074,16 +26416,14 @@ declare module Ext.draw.modifier { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -24091,18 +26431,14 @@ declare module Ext.draw.modifier { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -24110,9 +26446,7 @@ declare module Ext.draw.modifier { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of customDuration * @param customDuration Object */ @@ -24154,25 +26488,21 @@ declare module Ext.draw.modifier { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.draw.modifier { @@ -24184,11 +26514,16 @@ declare module Ext.draw.modifier { /** [Method] Filter modifier changes if overriding source attributes * @param attr Object The source attributes. * @param changes Object The modifier changes. + * @returns * The filtered changes. */ filterChanges?( attr?:any, changes?:any ): any; - /** [Method] Returns the value of enabled */ + /** [Method] Returns the value of enabled + * @returns Boolean + */ getEnabled?(): boolean; - /** [Method] Returns the value of highlightStyle */ + /** [Method] Returns the value of highlightStyle + * @returns Object + */ getHighlightStyle?(): any; /** [Method] Invoked when changes need to be popped up to the top * @param attributes Object The source attributes. @@ -24202,6 +26537,7 @@ declare module Ext.draw.modifier { /** [Method] Invoked when changes need to pushed down to the sprite * @param attr Object The source attributes. * @param changes Object The changes to make. This object might be changed unexpectedly inside the method. + * @returns Mixed */ pushDown?( attr?:any, changes?:any ): any; /** [Method] Sets the value of enabled @@ -24222,11 +26558,17 @@ declare module Ext.draw.modifier { previous?: Ext.draw.modifier.IModifier; /** [Config Option] (Ext.draw.sprite.Sprite) */ sprite?: Ext.draw.sprite.ISprite; - /** [Method] Returns the value of next */ + /** [Method] Returns the value of next + * @returns Ext.draw.modifier.Modifier + */ getNext?(): Ext.draw.modifier.IModifier; - /** [Method] Returns the value of previous */ + /** [Method] Returns the value of previous + * @returns Ext.draw.modifier.Modifier + */ getPrevious?(): Ext.draw.modifier.IModifier; - /** [Method] Returns the value of sprite */ + /** [Method] Returns the value of sprite + * @returns Ext.draw.sprite.Sprite + */ getSprite?(): Ext.draw.sprite.ISprite; /** [Method] Invoked when changes need to be popped up to the top * @param attributes Object The source attributes. @@ -24240,6 +26582,7 @@ declare module Ext.draw.modifier { /** [Method] Invoked when changes need to pushed down to the sprite * @param attr Object The source attributes. * @param changes Object The changes to make. This object might be changed unexpectedly inside the method. + * @returns Mixed */ pushDown?( attr?:any, changes?:any ): any; /** [Method] Sets the value of next @@ -24270,6 +26613,7 @@ declare module Ext.draw.modifier { /** [Method] Invoked when changes need to pushed down to the sprite * @param attr Object The source attributes. * @param changes Object The changes to make. This object might be changed unexpectedly inside the method. + * @returns Mixed */ pushDown?( attr?:any, changes?:any ): any; } @@ -24316,7 +26660,9 @@ declare module Ext.draw { bezierCurveTo?( cx1?:number, cy1?:number, cx2?:number, cy2?:number, x?:number, y?:number ): void; /** [Method] Clear the path */ clear?(): void; - /** [Method] Clone this path */ + /** [Method] Clone this path + * @returns Ext.draw.Path + */ clone?(): Ext.draw.IPath; /** [Method] Close this path with a straight line */ closePath?(): void; @@ -24341,16 +26687,19 @@ declare module Ext.draw { fromSvgString?( pathString?:any ): void; /** [Method] Get the bounding box of this matrix * @param target Object Optional object to receive the result. + * @returns Object Object with x, y, width and height */ getDimension?( target?:any ): any; /** [Method] Get the bounding box as if the path is transformed by a matrix * @param matrix Ext.draw.Matrix * @param target Object Optional object to receive the result. + * @returns Object An object with x, y, width and height. */ getDimensionWithTransform?( matrix?:Ext.draw.IMatrix, target?:any ): any; /** [Method] Test wether the given point is on or inside the path * @param x Object * @param y Object + * @returns Boolean */ isPointInPath?( x?:any, y?:any ): boolean; /** [Method] A straight line to a position @@ -24377,10 +26726,13 @@ declare module Ext.draw { * @param height Object */ rect?( x?:any, y?:any, width?:any, height?:any ): void; - /** [Method] Return an svg path string for this path */ + /** [Method] Return an svg path string for this path + * @returns String + */ toString?(): string; /** [Method] Convert path to bezier curve stripes * @param target Array The optional array to receive the result. + * @returns Array */ toStripes?( target?:any[] ): any[]; /** [Method] Transform the current path by a matrix @@ -24395,9 +26747,12 @@ declare module Ext.draw { * @param min Number * @param max Number * @param estStep Number + * @returns Object The aggregation information. */ getAggregation?( min?:number, max?:number, estStep?:number ): any; - /** [Method] Returns the value of strategy */ + /** [Method] Returns the value of strategy + * @returns String + */ getStrategy?(): string; /** [Method] Sets the data of the segment tree * @param dataX Object @@ -24419,19 +26774,19 @@ declare module Ext.draw { export class Solver { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 function f x a x3 b x2 c x d and solver for f x y * @param a Object * @param b Object @@ -24447,10 +26802,12 @@ declare module Ext.draw { static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Returns the function f x a x b and solver for f x y @@ -24464,7 +26821,9 @@ declare module Ext.draw { * @param c Object */ static quadraticFunction( a?:any, b?:any, c?: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; } } @@ -24474,30 +26833,34 @@ declare module Ext.draw.sprite { export class AnimationParser { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?: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; } } @@ -24530,18 +26893,29 @@ declare module Ext.draw.sprite { processors?: any; /** [Config Option] (Object) */ updaters?: any; - /** [Method] Returns the value of aliases */ + /** [Method] Returns the value of aliases + * @returns Object + */ getAliases?(): any; - /** [Method] Returns the value of animationProcessors */ + /** [Method] Returns the value of animationProcessors + * @returns Object + */ getAnimationProcessors?(): any; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ getDefaults?(): any; - /** [Method] Returns the value of processors */ + /** [Method] Returns the value of processors + * @returns Object + */ getProcessors?(): any; - /** [Method] Returns the value of updaters */ + /** [Method] Returns the value of updaters + * @returns Object + */ getUpdaters?(): any; /** [Method] Normalizes the changes given via their processors before they are applied as attributes * @param changes Object The changes given. + * @returns Object The normalized values. */ normalize?( changes?:any ): any; /** [Method] Sets the value of aliases @@ -24572,30 +26946,34 @@ declare module Ext.draw.sprite { export class AttributeParser { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?: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; } } @@ -24689,6 +27067,7 @@ declare module Ext.draw.sprite { /** [Method] Render method * @param surface Object * @param ctx Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any ): any; } @@ -24702,24 +27081,31 @@ declare module Ext.draw.sprite { * @param data Object * @param bypassNormalization Boolean 'true' to bypass attribute normalization. * @param avoidCopy Boolean 'true' to avoid copying. + * @returns Object The attributes of the instance. */ createInstance?( config?:any, data?:any, bypassNormalization?:boolean, avoidCopy?:boolean ): any; /** [Method] Removes the sprite and clears all listeners */ destroy?(): void; - /** [Method] Not supported */ + /** [Method] Not supported + * @returns null + */ getBBox?(): any; /** [Method] Returns the bounding box for the instance at the given index * @param index Number The index of the instance. * @param isWithoutTransform Boolean 'true' to not apply sprite transforms to the bounding box. + * @returns Object The bounding box for the instance. */ getBBoxFor?( index?:number, isWithoutTransform?:boolean ): any; - /** [Method] Returns the value of template */ + /** [Method] Returns the value of template + * @returns Object + */ getTemplate?(): any; /** [Method] Render method * @param surface Object * @param ctx Object * @param clipRegion Object * @param region Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any, clipRegion?:any, region?:any ): any; /** [Method] Sets the attributes for the instance at the given index @@ -24741,6 +27127,7 @@ declare module Ext.draw.sprite { /** [Method] Render method * @param surface Object * @param ctx Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any ): any; /** [Method] Update the path @@ -24869,16 +27256,14 @@ declare module Ext.draw.sprite { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -24890,9 +27275,7 @@ declare module Ext.draw.sprite { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -24900,9 +27283,7 @@ declare module Ext.draw.sprite { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] Removes the sprite and clears all listeners */ @@ -24910,19 +27291,19 @@ declare module Ext.draw.sprite { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; /** [Method] Returns the bounding box for the given Sprite as calculated with the Canvas engine @@ -24931,19 +27312,29 @@ declare module Ext.draw.sprite { getBBox?( isWithoutTransform?:boolean ): void; /** [Method] Subclass can rewrite this function to gain better performance * @param isWithoutTransform Boolean + * @returns Array */ getBBoxCenter?( isWithoutTransform?:boolean ): any[]; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of parent */ + /** [Method] Returns the value of parent + * @returns Object + */ getParent?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; - /** [Method] Hide the sprite */ + /** [Method] Hide the sprite + * @returns Ext.draw.sprite.Sprite this + */ hide?(): Ext.draw.sprite.ISprite; /** [Method] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -24952,18 +27343,14 @@ declare module Ext.draw.sprite { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -24971,30 +27358,27 @@ declare module Ext.draw.sprite { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Called before rendering */ preRender?(): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -25003,16 +27387,14 @@ declare module Ext.draw.sprite { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -25020,22 +27402,19 @@ declare module Ext.draw.sprite { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Render method * @param surface Ext.draw.Surface The surface. * @param ctx Object A context object compatible with CanvasRenderingContext2D. * @param region Array The clip region (or called dirty rect) of the current rendering. Not be confused with surface.getRegion(). + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:Ext.draw.ISurface, ctx?:any, region?:any[] ): any; /** [Method] Resumes firing events see suspendEvents @@ -25056,9 +27435,7 @@ declare module Ext.draw.sprite { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -25067,7 +27444,9 @@ declare module Ext.draw.sprite { * @param parent Object */ setParent?( parent?:any ): void; - /** [Method] Show the sprite */ + /** [Method] Show the sprite + * @returns Ext.draw.sprite.Sprite this + */ show?(): Ext.draw.sprite.ISprite; /** [Method] Suspends the firing of all events */ suspendEvents?(): void; @@ -25078,25 +27457,21 @@ declare module Ext.draw.sprite { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Subclass will fill the plain object with x y width height information of the plain bounding box of this sprite * @param plain Object Target object. */ @@ -25135,6 +27510,7 @@ declare module Ext.draw.sprite { /** [Method] Render method * @param surface Object * @param ctx Object + * @returns * returns false to stop rendering in this frame. All the sprite haven't been rendered will have their dirty flag untouched. */ render?( surface?:any, ctx?:any ): any; /** [Method] Subclass will fill the plain object with x y width height information of the plain bounding box of this sprite @@ -25166,21 +27542,33 @@ declare module Ext.draw { /** [Method] * @param sprite Object * @param isWithoutTransform Object + * @returns Object */ getBBox?( sprite?:any, isWithoutTransform?:any ): any; - /** [Method] Returns the value of background */ + /** [Method] Returns the value of background + * @returns Object + */ getBackground?(): any; - /** [Method] Returns true if the surface is dirty */ + /** [Method] Returns true if the surface is dirty + * @returns Boolean 'true' if the surface is dirty + */ getDirty?(): boolean; /** [Method] * @param id String The unique identifier of the group. + * @returns Ext.draw.Group The group. */ getGroup?( id?:string ): Ext.draw.IGroup; - /** [Method] Returns the value of groups */ + /** [Method] Returns the value of groups + * @returns Array + */ getGroups?(): any[]; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Ext.draw.Group + */ getItems?(): Ext.draw.IGroup; - /** [Method] Returns the value of region */ + /** [Method] Returns the value of region + * @returns Array + */ getRegion?(): any[]; /** [Method] Invoked when a sprite is adding to the surface * @param sprite Ext.draw.sprite.Sprite The sprite to be added. @@ -25201,6 +27589,7 @@ declare module Ext.draw { resetTransform?(): void; /** [Method] Round the number to align to the pixels on device * @param num Object The number to align. + * @returns Number The resultant alignment. */ roundPixel?( num?:any ): number; /** [Method] Sets the value of background @@ -25231,23 +27620,29 @@ 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] * @param args Object */ static callParent( args?: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] 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] Stably sort the list of sprites by their zIndex @@ -25262,40 +27657,46 @@ declare module Ext.draw { export class TextMeasurer { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Measure a text with specific font * @param text String * @param font String + * @returns Object An object with width and height properties. */ static measureText( text?:string, font?:string ): any; /** [Method] Measure a single line text with specific font * @param text String * @param font String + * @returns Object An object with width and height properties. */ static measureTextSingleLine( text?:string, font?:string ): 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; } } @@ -25305,30 +27706,34 @@ declare module Ext.draw { export class TimingFunctions { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?: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; } } @@ -25350,6 +27755,7 @@ declare module Ext.env { version?: Ext.IVersion; /** [Method] A hybrid property can be either accessed as a method call for example if Ext browser is IE * @param value String The OS name to check. + * @returns Boolean */ is?( value?:string ): boolean; } @@ -25366,6 +27772,7 @@ declare module Ext.env { version?: Ext.IVersion; /** [Method] A hybrid property can be either accessed as a method call i e if Ext os is Android * @param value String The OS name to check. + * @returns Boolean */ is?( value?:string ): boolean; } @@ -25376,7 +27783,9 @@ declare module Ext.event { } declare module Ext.event { export interface IDispatcher extends Ext.IBase { - /** [Method] Returns the value of publishers */ + /** [Method] Returns the value of publishers + * @returns Object + */ getPublishers?(): any; /** [Method] Sets the value of publishers * @param publishers Object @@ -25394,21 +27803,28 @@ declare module Ext.event { pageY?: number; /** [Property] (HTMLElement) */ target?: HTMLElement; - /** [Method] Gets the x coordinate of the event */ + /** [Method] Gets the x coordinate of the event + * @returns Number + */ getPageX?(): number; - /** [Method] Gets the y coordinate of the event */ + /** [Method] Gets the y coordinate of the event + * @returns Number + */ getPageY?(): number; /** [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/Mixed 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 */ - getTarget?( selector?:any, maxDepth?:any, returnEl?:any ): any; - getTarget?( selector?:string, maxDepth?:number, returnEl?:boolean ): HTMLElement; getTarget?( selector?:string, maxDepth?:any, returnEl?:boolean ): HTMLElement; - /** [Method] Returns the time of the event */ + /** [Method] Returns the time of the event + * @returns Date + */ getTime?(): any; - /** [Method] Gets the X and Y coordinates of the event */ + /** [Method] Gets the X and Y coordinates of the event + * @returns Array + */ getXY?(): any[]; /** [Method] Prevents the browsers default handling of the event */ preventDefault?(): void; @@ -25426,9 +27842,13 @@ declare module Ext.event { rotation?: number; /** [Property] (Number) */ scale?: number; - /** [Method] Stop the event preventDefault and stopPropagation */ + /** [Method] Stop the event preventDefault and stopPropagation + * @returns Ext.event.Event this + */ stopEvent?(): Ext.event.IEvent; - /** [Method] Cancels bubbling of the event */ + /** [Method] Cancels bubbling of the event + * @returns Ext.event.Event this + */ stopPropagation?(): Ext.event.IEvent; } } @@ -25444,9 +27864,13 @@ declare module Ext { rotation?: number; /** [Property] (Number) */ scale?: number; - /** [Method] Stop the event preventDefault and stopPropagation */ + /** [Method] Stop the event preventDefault and stopPropagation + * @returns Ext.event.Event this + */ stopEvent?(): Ext.event.IEvent; - /** [Method] Cancels bubbling of the event */ + /** [Method] Cancels bubbling of the event + * @returns Ext.event.Event this + */ stopPropagation?(): Ext.event.IEvent; } } @@ -25484,9 +27908,13 @@ declare module Ext.event.publisher { } declare module Ext.event.publisher { export interface ITouchGesture extends Ext.event.publisher.IDom { - /** [Method] Returns the value of moveThrottle */ + /** [Method] Returns the value of moveThrottle + * @returns Number + */ getMoveThrottle?(): number; - /** [Method] Returns the value of recognizers */ + /** [Method] Returns the value of recognizers + * @returns Object + */ getRecognizers?(): any; /** [Method] Sets the value of moveThrottle * @param moveThrottle Number @@ -25500,7 +27928,9 @@ declare module Ext.event.publisher { } declare module Ext.event.recognizer { export interface IDoubleTap extends Ext.event.recognizer.ISingleTouch { - /** [Method] Returns the value of maxDuration */ + /** [Method] Returns the value of maxDuration + * @returns Number + */ getMaxDuration?(): number; /** [Method] Sets the value of maxDuration * @param maxDuration Number @@ -25512,7 +27942,9 @@ declare module Ext.event.recognizer { export interface IDrag extends Ext.event.recognizer.ISingleTouch { /** [Config Option] (Number) */ minDistance?: number; - /** [Method] Returns the value of minDistance */ + /** [Method] Returns the value of minDistance + * @returns Number + */ getMinDistance?(): number; /** [Method] Sets the value of minDistance * @param minDistance Number @@ -25526,7 +27958,9 @@ declare module Ext.event.recognizer { } declare module Ext.event.recognizer { export interface ILongPress extends Ext.event.recognizer.ISingleTouch { - /** [Method] Returns the value of minDuration */ + /** [Method] Returns the value of minDuration + * @returns Number + */ getMinDuration?(): number; /** [Method] Sets the value of minDuration * @param minDuration Number @@ -25544,13 +27978,21 @@ declare module Ext.event.recognizer { } declare module Ext.event.recognizer { export interface IRecognizer extends Ext.IBase,Ext.mixin.IIdentifiable { - /** [Method] Returns the value of callbackScope */ + /** [Method] Returns the value of callbackScope + * @returns Object + */ getCallbackScope?(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ getId?(): string; - /** [Method] Returns the value of onFailed */ + /** [Method] Returns the value of onFailed + * @returns Object + */ getOnFailed?(): any; - /** [Method] Returns the value of onRecognized */ + /** [Method] Returns the value of onRecognized + * @returns Object + */ getOnRecognized?(): any; /** [Method] Sets the value of callbackScope * @param callbackScope Object @@ -25576,11 +28018,17 @@ declare module Ext.event.recognizer { } declare module Ext.event.recognizer { export interface ISwipe extends Ext.event.recognizer.ISingleTouch { - /** [Method] Returns the value of maxDuration */ + /** [Method] Returns the value of maxDuration + * @returns Number + */ getMaxDuration?(): number; - /** [Method] Returns the value of maxOffset */ + /** [Method] Returns the value of maxOffset + * @returns Number + */ getMaxOffset?(): number; - /** [Method] Returns the value of minDistance */ + /** [Method] Returns the value of minDistance + * @returns Number + */ getMinDistance?(): number; /** [Method] Sets the value of maxDuration * @param maxDuration Number @@ -25600,7 +28048,9 @@ declare module Ext.event.recognizer { export interface ITap extends Ext.event.recognizer.ISingleTouch { /** [Config Option] (Number) */ moveDistance?: number; - /** [Method] Returns the value of moveDistance */ + /** [Method] Returns the value of moveDistance + * @returns Number + */ getMoveDistance?(): number; /** [Method] Sets the value of moveDistance * @param moveDistance Number @@ -25628,16 +28078,14 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -25649,9 +28097,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -25659,9 +28105,7 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -25669,27 +28113,32 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -25699,18 +28148,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -25718,28 +28163,25 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -25748,16 +28190,14 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -25765,18 +28205,14 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -25784,9 +28220,7 @@ declare module Ext { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -25800,25 +28234,21 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext { @@ -25829,16 +28259,14 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -25850,9 +28278,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -25860,9 +28286,7 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -25870,27 +28294,32 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -25900,18 +28329,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -25919,28 +28344,25 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -25949,16 +28371,14 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -25966,18 +28386,14 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -25985,9 +28401,7 @@ declare module Ext { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -26001,25 +28415,21 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext { @@ -26033,9 +28443,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: */ - 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?:HTMLElement, eventName?:string, handler?:any, scope?:any, options?:any ): void; + static addListener( el?:any, eventName?:string, handler?:any, scope?:any, options?:any ): void; /** [Method] Appends an event handler to an element * @param el String/HTMLElement The html element or id to assign the event handler to. * @param eventName String The name of the event to listen for. @@ -26043,9 +28451,7 @@ declare module Ext { * @param scope Object (this reference) in which the handler function executes. Defaults to the Element. * @param options Object An object containing standard addListener 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?:HTMLElement, eventName?:string, handler?:any, 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 */ static onDocumentReady(): void; /** [Method] Adds a listener to be notified when the browser window is resized and provides resize event buffering 50 millisecond @@ -26057,27 +28463,21 @@ declare module Ext { /** [Method] Removes all event handers from an element * @param el String/HTMLElement 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?:HTMLElement ): void; + static removeAll( el?:any ): void; /** [Method] Removes an event handler from an element * @param el String/HTMLElement 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?:HTMLElement, eventName?:string, fn?:any, scope?:any ): void; + static removeListener( el?:any, eventName?:string, fn?:any, scope?:any ): void; /** [Method] Removes an event handler from an element * @param el String/HTMLElement 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 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. */ - 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?:HTMLElement, eventName?:string, fn?:any, scope?:any ): void; + static un( el?:any, eventName?:string, fn?:any, scope?:any ): void; } } declare module Ext { @@ -26086,34 +28486,39 @@ declare module Ext { export class Feature { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Verifies if a browser feature exists or not on the current device * @param value String The feature name to check. + * @returns Boolean */ static has( value?:string ): boolean; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?: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; } } @@ -26127,29 +28532,49 @@ declare module Ext.field { ui?: string; /** [Config Option] (String) */ value?: string; - /** [Method] Set the checked state of the checkbox to true */ + /** [Method] Set the checked state of the checkbox to true + * @returns Ext.field.Checkbox This checkbox. + */ check?(): Ext.field.ICheckbox; /** [Method] Method called when this Ext field Checkbox has been checked */ doChecked?(): void; /** [Method] Method called when this Ext field Checkbox has been unchecked */ doUnChecked?(): void; - /** [Method] Returns the field checked value */ + /** [Method] Returns the field checked value + * @returns Mixed The field value. + */ getChecked?(): any; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns an array of values from the checkboxes in the group that are checked */ + /** [Method] Returns an array of values from the checkboxes in the group that are checked + * @returns Array + */ getGroupValues?(): 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/String value The value of value or true, if checked. + */ getSubmitValue?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns String + */ getValue?(): string; - /** [Method] Returns the checked state of the checkbox */ + /** [Method] Returns the checked state of the checkbox + * @returns Boolean true if checked, false otherwise. + */ isChecked?(): boolean; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; - /** [Method] Resets the status of all matched checkboxes in the same group to checked */ + /** [Method] Resets the status of all matched checkboxes in the same group to checked + * @returns Ext.field.Checkbox This checkbox. + */ resetGroupValues?(): Ext.field.ICheckbox; /** [Method] Sets the value of component * @param component Object @@ -26157,6 +28582,7 @@ declare module Ext.field { setComponent?( component?:any ): void; /** [Method] Set the status of all matched checkboxes in the same group to checked * @param values Array An array of values. + * @returns Ext.field.Checkbox This checkbox. */ setGroupValues?( values?:any[] ): Ext.field.ICheckbox; /** [Method] Sets the value of ui @@ -26167,7 +28593,9 @@ declare module Ext.field { * @param value String */ setValue?( value?:string ): void; - /** [Method] Set the checked state of the checkbox to false */ + /** [Method] Set the checked state of the checkbox to false + * @returns Ext.field.Checkbox This checkbox. + */ uncheck?(): Ext.field.ICheckbox; } } @@ -26181,29 +28609,49 @@ declare module Ext.form { ui?: string; /** [Config Option] (String) */ value?: string; - /** [Method] Set the checked state of the checkbox to true */ + /** [Method] Set the checked state of the checkbox to true + * @returns Ext.field.Checkbox This checkbox. + */ check?(): Ext.field.ICheckbox; /** [Method] Method called when this Ext field Checkbox has been checked */ doChecked?(): void; /** [Method] Method called when this Ext field Checkbox has been unchecked */ doUnChecked?(): void; - /** [Method] Returns the field checked value */ + /** [Method] Returns the field checked value + * @returns Mixed The field value. + */ getChecked?(): any; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns an array of values from the checkboxes in the group that are checked */ + /** [Method] Returns an array of values from the checkboxes in the group that are checked + * @returns Array + */ getGroupValues?(): 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/String value The value of value or true, if checked. + */ getSubmitValue?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns String + */ getValue?(): string; - /** [Method] Returns the checked state of the checkbox */ + /** [Method] Returns the checked state of the checkbox + * @returns Boolean true if checked, false otherwise. + */ isChecked?(): boolean; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; - /** [Method] Resets the status of all matched checkboxes in the same group to checked */ + /** [Method] Resets the status of all matched checkboxes in the same group to checked + * @returns Ext.field.Checkbox This checkbox. + */ resetGroupValues?(): Ext.field.ICheckbox; /** [Method] Sets the value of component * @param component Object @@ -26211,6 +28659,7 @@ declare module Ext.form { setComponent?( component?:any ): void; /** [Method] Set the status of all matched checkboxes in the same group to checked * @param values Array An array of values. + * @returns Ext.field.Checkbox This checkbox. */ setGroupValues?( values?:any[] ): Ext.field.ICheckbox; /** [Method] Sets the value of ui @@ -26221,7 +28670,9 @@ declare module Ext.form { * @param value String */ setValue?( value?:string ): void; - /** [Method] Set the checked state of the checkbox to false */ + /** [Method] Set the checked state of the checkbox to false + * @returns Ext.field.Checkbox This checkbox. + */ uncheck?(): Ext.field.ICheckbox; } } @@ -26237,23 +28688,34 @@ declare module Ext.field { ui?: string; /** [Config Option] (Object/Date) */ value?: any; - /** [Method] Returns the value of dateFormat */ + /** [Method] Returns the value of dateFormat + * @returns String + */ getDateFormat?(): string; /** [Method] */ getDatePicker?(): void; - /** [Method] Returns the value of destroyPickerOnHide */ + /** [Method] Returns the value of destroyPickerOnHide + * @returns Boolean + */ getDestroyPickerOnHide?(): boolean; /** [Method] Returns the value of the field formatted using the specified format * @param format String The format to be returned. + * @returns String The formatted date. */ getFormattedValue?( format?:string ): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the Date value of this field */ + /** [Method] Returns the Date value of this field + * @returns Date The date selected + */ getValue?(): any; /** [Method] Override this or change event will be fired twice */ onChange?(): void; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of dateFormat * @param dateFormat String @@ -26289,23 +28751,34 @@ declare module Ext.form { ui?: string; /** [Config Option] (Object/Date) */ value?: any; - /** [Method] Returns the value of dateFormat */ + /** [Method] Returns the value of dateFormat + * @returns String + */ getDateFormat?(): string; /** [Method] */ getDatePicker?(): void; - /** [Method] Returns the value of destroyPickerOnHide */ + /** [Method] Returns the value of destroyPickerOnHide + * @returns Boolean + */ getDestroyPickerOnHide?(): boolean; /** [Method] Returns the value of the field formatted using the specified format * @param format String The format to be returned. + * @returns String The formatted date. */ getFormattedValue?( format?:string ): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the Date value of this field */ + /** [Method] Returns the Date value of this field + * @returns Date The date selected + */ getValue?(): any; /** [Method] Override this or change event will be fired twice */ onChange?(): void; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of dateFormat * @param dateFormat String @@ -26335,9 +28808,13 @@ declare module Ext.field { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -26355,9 +28832,13 @@ declare module Ext.form { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -26413,37 +28894,69 @@ declare module Ext.field { labelEl?: Ext.IElement; /** [Property] (Mixed) */ originalValue?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of clearIcon */ + /** [Method] Returns the value of clearIcon + * @returns Boolean + */ getClearIcon?(): boolean; - /** [Method] Returns the value of inputCls */ + /** [Method] Returns the value of inputCls + * @returns String + */ getInputCls?(): string; - /** [Method] Returns the value of inputType */ + /** [Method] Returns the value of inputType + * @returns String + */ getInputType?(): string; - /** [Method] Returns the value of label */ + /** [Method] Returns the value of label + * @returns String + */ getLabel?(): string; - /** [Method] Returns the value of labelAlign */ + /** [Method] Returns the value of labelAlign + * @returns String + */ getLabelAlign?(): string; - /** [Method] Returns the value of labelCls */ + /** [Method] Returns the value of labelCls + * @returns String + */ getLabelCls?(): string; - /** [Method] Returns the value of labelWidth */ + /** [Method] Returns the value of labelWidth + * @returns Number/String + */ getLabelWidth?(): any; - /** [Method] Returns the value of labelWrap */ + /** [Method] Returns the value of labelWrap + * @returns Boolean + */ getLabelWrap?(): boolean; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of required */ + /** [Method] Returns the value of required + * @returns Boolean + */ getRequired?(): boolean; - /** [Method] Returns the value of requiredCls */ + /** [Method] Returns the value of requiredCls + * @returns String + */ getRequiredCls?(): string; - /** [Method] Returns the value of tabIndex */ + /** [Method] Returns the value of tabIndex + * @returns Number + */ getTabIndex?(): number; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [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] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Resets the field s originalValue property so it matches the current value */ resetOriginalValue?(): void; @@ -26478,9 +28991,7 @@ declare module Ext.field { /** [Method] Sets the value of labelWidth * @param labelWidth Number/String */ - setLabelWidth?( labelWidth?:any ): any; - setLabelWidth?( labelWidth?:number ): void; - setLabelWidth?( labelWidth?:string ): void; + setLabelWidth?( labelWidth?:any ): void; /** [Method] Sets the value of labelWrap * @param labelWrap Boolean */ @@ -26551,37 +29062,69 @@ declare module Ext.form { labelEl?: Ext.IElement; /** [Property] (Mixed) */ originalValue?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of clearIcon */ + /** [Method] Returns the value of clearIcon + * @returns Boolean + */ getClearIcon?(): boolean; - /** [Method] Returns the value of inputCls */ + /** [Method] Returns the value of inputCls + * @returns String + */ getInputCls?(): string; - /** [Method] Returns the value of inputType */ + /** [Method] Returns the value of inputType + * @returns String + */ getInputType?(): string; - /** [Method] Returns the value of label */ + /** [Method] Returns the value of label + * @returns String + */ getLabel?(): string; - /** [Method] Returns the value of labelAlign */ + /** [Method] Returns the value of labelAlign + * @returns String + */ getLabelAlign?(): string; - /** [Method] Returns the value of labelCls */ + /** [Method] Returns the value of labelCls + * @returns String + */ getLabelCls?(): string; - /** [Method] Returns the value of labelWidth */ + /** [Method] Returns the value of labelWidth + * @returns Number/String + */ getLabelWidth?(): any; - /** [Method] Returns the value of labelWrap */ + /** [Method] Returns the value of labelWrap + * @returns Boolean + */ getLabelWrap?(): boolean; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of required */ + /** [Method] Returns the value of required + * @returns Boolean + */ getRequired?(): boolean; - /** [Method] Returns the value of requiredCls */ + /** [Method] Returns the value of requiredCls + * @returns String + */ getRequiredCls?(): string; - /** [Method] Returns the value of tabIndex */ + /** [Method] Returns the value of tabIndex + * @returns Number + */ getTabIndex?(): number; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [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] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Resets the field s originalValue property so it matches the current value */ resetOriginalValue?(): void; @@ -26616,9 +29159,7 @@ declare module Ext.form { /** [Method] Sets the value of labelWidth * @param labelWidth Number/String */ - setLabelWidth?( labelWidth?:any ): any; - setLabelWidth?( labelWidth?:number ): void; - setLabelWidth?( labelWidth?:string ): void; + setLabelWidth?( labelWidth?:any ): void; /** [Method] Sets the value of labelWrap * @param labelWrap Boolean */ @@ -26649,7 +29190,9 @@ declare module Ext.field { export interface IFile extends Ext.field.IInput { /** [Config Option] (String) */ type?: string; - /** [Method] Returns the value of type */ + /** [Method] Returns the value of type + * @returns String + */ getType?(): string; /** [Method] Sets the value of type * @param type String @@ -26663,9 +29206,13 @@ declare module Ext.field { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of component * @param component Object @@ -26683,9 +29230,13 @@ declare module Ext.form { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of component * @param component Object @@ -26743,57 +29294,107 @@ declare module Ext.field { value?: any; /** [Property] (Boolean) */ isFocused?: boolean; - /** [Method] Attempts to forcefully blur input focus for the field */ + /** [Method] Attempts to forcefully blur input focus for the field + * @returns Ext.field.Input this + */ blur?(): Ext.field.IInput; - /** [Method] Attempts to set the field as the active input focus */ + /** [Method] Attempts to set the field as the active input focus + * @returns Ext.field.Input this + */ focus?(): Ext.field.IInput; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of autoComplete */ + /** [Method] Returns the value of autoComplete + * @returns Boolean + */ getAutoComplete?(): boolean; - /** [Method] Returns the value of autoCorrect */ + /** [Method] Returns the value of autoCorrect + * @returns Boolean + */ getAutoCorrect?(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the checked value of this field */ + /** [Method] Returns the checked value of this field + * @returns Mixed value The field value + */ getChecked?(): any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ getDisabled?(): boolean; - /** [Method] Returns the value of focusCls */ + /** [Method] Returns the value of focusCls + * @returns String + */ getFocusCls?(): string; - /** [Method] Returns the value of maxLength */ + /** [Method] Returns the value of maxLength + * @returns Number + */ getMaxLength?(): number; - /** [Method] Returns the value of maxRows */ + /** [Method] Returns the value of maxRows + * @returns Number + */ getMaxRows?(): number; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of pattern */ + /** [Method] Returns the value of pattern + * @returns String + */ getPattern?(): string; - /** [Method] Returns the value of placeHolder */ + /** [Method] Returns the value of placeHolder + * @returns String + */ getPlaceHolder?(): string; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; - /** [Method] Returns the value of startValue */ + /** [Method] Returns the value of startValue + * @returns Mixed + */ getStartValue?(): any; - /** [Method] Returns the value of stepValue */ + /** [Method] Returns the value of stepValue + * @returns Number + */ getStepValue?(): number; - /** [Method] Returns the value of tabIndex */ + /** [Method] Returns the value of tabIndex + * @returns Number + */ getTabIndex?(): number; - /** [Method] Returns the value of type */ + /** [Method] Returns the value of type + * @returns String + */ getType?(): string; - /** [Method] Returns the field data value */ + /** [Method] Returns the field data value + * @returns Mixed value The field value. + */ getValue?(): any; - /** [Method] Returns true if the value of this Field has been changed from its original value */ + /** [Method] Returns true if the value of this Field has been changed from its original value + * @returns Boolean + */ isDirty?(): boolean; /** [Method] Resets the current field value to the original value */ reset?(): void; - /** [Method] Attempts to forcefully select all the contents of the input field */ + /** [Method] Attempts to forcefully select all the contents of the input field + * @returns Ext.field.Input this + */ select?(): Ext.field.IInput; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -26894,17 +29495,29 @@ declare module Ext.field { stepValue?: number; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of stepValue */ + /** [Method] Returns the value of stepValue + * @returns Number + */ getStepValue?(): number; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; /** [Method] Sets the value of component * @param component Object @@ -26940,17 +29553,29 @@ declare module Ext.form { stepValue?: number; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of stepValue */ + /** [Method] Returns the value of stepValue + * @returns Number + */ getStepValue?(): number; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; /** [Method] Sets the value of component * @param component Object @@ -26980,9 +29605,13 @@ declare module Ext.field { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27000,9 +29629,13 @@ declare module Ext.form { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27020,15 +29653,25 @@ declare module Ext.field { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the selected value if this radio is part of a group other radio fields with the same name in the same FormP */ + /** [Method] Returns the selected value if this radio is part of a group other radio fields with the same name in the same FormP + * @returns String + */ getGroupValue?(): string; - /** [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/String value The value of value or true, if checked. + */ getSubmitValue?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns String + */ getValue?(): string; /** [Method] Sets the value of component * @param component Object @@ -27036,6 +29679,7 @@ declare module Ext.field { setComponent?( component?:any ): void; /** [Method] Set the matched radio field s status that has the same value as the given string to checked * @param value String The value of the radio field to check. + * @returns Ext.field.Radio The field that is checked. */ setGroupValue?( value?:string ): Ext.field.IRadio; /** [Method] Sets the value of ui @@ -27044,6 +29688,7 @@ declare module Ext.field { setUi?( ui?:string ): void; /** [Method] Sets the value of value * @param value Object + * @returns Ext.field.Radio this */ setValue?( value?:any ): Ext.field.IRadio; } @@ -27054,15 +29699,25 @@ declare module Ext.form { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the selected value if this radio is part of a group other radio fields with the same name in the same FormP */ + /** [Method] Returns the selected value if this radio is part of a group other radio fields with the same name in the same FormP + * @returns String + */ getGroupValue?(): string; - /** [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/String value The value of value or true, if checked. + */ getSubmitValue?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns String + */ getValue?(): string; /** [Method] Sets the value of component * @param component Object @@ -27070,6 +29725,7 @@ declare module Ext.form { setComponent?( component?:any ): void; /** [Method] Set the matched radio field s status that has the same value as the given string to checked * @param value String The value of the radio field to check. + * @returns Ext.field.Radio The field that is checked. */ setGroupValue?( value?:string ): Ext.field.IRadio; /** [Method] Sets the value of ui @@ -27078,6 +29734,7 @@ declare module Ext.form { setUi?( ui?:string ): void; /** [Method] Sets the value of value * @param value Object + * @returns Ext.field.Radio this */ setValue?( value?:any ): Ext.field.IRadio; } @@ -27088,9 +29745,13 @@ declare module Ext.field { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of component * @param component Object @@ -27108,9 +29769,13 @@ declare module Ext.form { component?: any; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of component * @param component Object @@ -27148,37 +29813,65 @@ declare module Ext.field { valueField?: any; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of autoSelect */ + /** [Method] Returns the value of autoSelect + * @returns Boolean + */ getAutoSelect?(): boolean; - /** [Method] Returns the value of defaultPhonePickerConfig */ + /** [Method] Returns the value of defaultPhonePickerConfig + * @returns Object + */ getDefaultPhonePickerConfig?(): any; - /** [Method] Returns the value of defaultTabletPickerConfig */ + /** [Method] Returns the value of defaultTabletPickerConfig + * @returns Object + */ getDefaultTabletPickerConfig?(): any; - /** [Method] Returns the value of displayField */ + /** [Method] Returns the value of displayField + * @returns String/Number + */ getDisplayField?(): any; - /** [Method] Returns the value of hiddenName */ + /** [Method] Returns the value of hiddenName + * @returns String + */ getHiddenName?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of options */ + /** [Method] Returns the value of options + * @returns Array + */ getOptions?(): any[]; - /** [Method] Returns the current selected record instance selected in this field */ + /** [Method] Returns the current selected record instance selected in this field + * @returns Ext.data.Model the record. + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.Store/Object/String + */ getStore?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of usePicker */ + /** [Method] Returns the value of usePicker + * @returns String/Boolean + */ getUsePicker?(): any; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [Method] Returns the value of valueField */ + /** [Method] Returns the value of valueField + * @returns String/Number + */ getValueField?(): any; /** [Method] Called when the internal store s data has changed * @param store Object */ onStoreDataChanged?( store?:any ): void; - /** [Method] Resets the Select field to the value of the first record in the store */ + /** [Method] Resets the Select field to the value of the first record in the store + * @returns Ext.field.Select this + */ reset?(): Ext.field.ISelect; /** [Method] Sets the value of autoSelect * @param autoSelect Boolean @@ -27195,9 +29888,7 @@ declare module Ext.field { /** [Method] Sets the value of displayField * @param displayField String/Number */ - setDisplayField?( displayField?:any ): any; - setDisplayField?( displayField?:string ): void; - setDisplayField?( displayField?:number ): void; + setDisplayField?( displayField?:any ): void; /** [Method] Sets the value of hiddenName * @param hiddenName String */ @@ -27221,19 +29912,16 @@ declare module Ext.field { /** [Method] Sets the value of usePicker * @param usePicker String/Boolean */ - setUsePicker?( usePicker?:any ): any; - setUsePicker?( usePicker?:string ): void; - setUsePicker?( usePicker?:boolean ): void; + setUsePicker?( usePicker?:any ): void; /** [Method] Sets the value of valueField * @param valueField String/Number */ - setValueField?( valueField?:any ): any; - setValueField?( valueField?:string ): void; - setValueField?( valueField?:number ): void; + setValueField?( valueField?:any ): void; /** [Method] Shows the picker for the select field whether that is a Ext picker Picker or a simple list */ showPicker?(): void; /** [Method] Updates the underlying lt options gt list with new values * @param newOptions Array An array of options configurations to insert or append. selectBox.setOptions([ {text: 'First Option', value: 'first'}, {text: 'Second Option', value: 'second'}, {text: 'Third Option', value: 'third'} ]).setValue('third'); Note: option object member names should correspond with defined valueField and displayField values. + * @returns Ext.field.Select this */ updateOptions?( newOptions?:any[] ): Ext.field.ISelect; } @@ -27264,37 +29952,65 @@ declare module Ext.form { valueField?: any; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of autoSelect */ + /** [Method] Returns the value of autoSelect + * @returns Boolean + */ getAutoSelect?(): boolean; - /** [Method] Returns the value of defaultPhonePickerConfig */ + /** [Method] Returns the value of defaultPhonePickerConfig + * @returns Object + */ getDefaultPhonePickerConfig?(): any; - /** [Method] Returns the value of defaultTabletPickerConfig */ + /** [Method] Returns the value of defaultTabletPickerConfig + * @returns Object + */ getDefaultTabletPickerConfig?(): any; - /** [Method] Returns the value of displayField */ + /** [Method] Returns the value of displayField + * @returns String/Number + */ getDisplayField?(): any; - /** [Method] Returns the value of hiddenName */ + /** [Method] Returns the value of hiddenName + * @returns String + */ getHiddenName?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of options */ + /** [Method] Returns the value of options + * @returns Array + */ getOptions?(): any[]; - /** [Method] Returns the current selected record instance selected in this field */ + /** [Method] Returns the current selected record instance selected in this field + * @returns Ext.data.Model the record. + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of store */ + /** [Method] Returns the value of store + * @returns Ext.data.Store/Object/String + */ getStore?(): any; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of usePicker */ + /** [Method] Returns the value of usePicker + * @returns String/Boolean + */ getUsePicker?(): any; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [Method] Returns the value of valueField */ + /** [Method] Returns the value of valueField + * @returns String/Number + */ getValueField?(): any; /** [Method] Called when the internal store s data has changed * @param store Object */ onStoreDataChanged?( store?:any ): void; - /** [Method] Resets the Select field to the value of the first record in the store */ + /** [Method] Resets the Select field to the value of the first record in the store + * @returns Ext.field.Select this + */ reset?(): Ext.field.ISelect; /** [Method] Sets the value of autoSelect * @param autoSelect Boolean @@ -27311,9 +30027,7 @@ declare module Ext.form { /** [Method] Sets the value of displayField * @param displayField String/Number */ - setDisplayField?( displayField?:any ): any; - setDisplayField?( displayField?:string ): void; - setDisplayField?( displayField?:number ): void; + setDisplayField?( displayField?:any ): void; /** [Method] Sets the value of hiddenName * @param hiddenName String */ @@ -27337,19 +30051,16 @@ declare module Ext.form { /** [Method] Sets the value of usePicker * @param usePicker String/Boolean */ - setUsePicker?( usePicker?:any ): any; - setUsePicker?( usePicker?:string ): void; - setUsePicker?( usePicker?:boolean ): void; + setUsePicker?( usePicker?:any ): void; /** [Method] Sets the value of valueField * @param valueField String/Number */ - setValueField?( valueField?:any ): any; - setValueField?( valueField?:string ): void; - setValueField?( valueField?:number ): void; + setValueField?( valueField?:any ): void; /** [Method] Shows the picker for the select field whether that is a Ext picker Picker or a simple list */ showPicker?(): void; /** [Method] Updates the underlying lt options gt list with new values * @param newOptions Array An array of options configurations to insert or append. selectBox.setOptions([ {text: 'First Option', value: 'first'}, {text: 'Second Option', value: 'second'}, {text: 'Third Option', value: 'third'} ]).setValue('third'); Note: option object member names should correspond with defined valueField and displayField values. + * @returns Ext.field.Select this */ updateOptions?( newOptions?:any[] ): Ext.field.ISelect; } @@ -27372,23 +30083,41 @@ declare module Ext.field { value?: any; /** [Config Option] (Number/Number[]) */ values?: any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of increment */ + /** [Method] Returns the value of increment + * @returns Number + */ getIncrement?(): number; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number/Number[] + */ getValue?(): any; - /** [Method] Convenience method */ + /** [Method] Convenience method + * @returns Object + */ getValues?(): any; - /** [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] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of cls * @param cls String @@ -27417,9 +30146,7 @@ declare module Ext.field { /** [Method] Sets the value of value * @param value Number/Number[] */ - setValue?( value?:any ): any; - setValue?( value?:number ): void; - setValue?( value?:number[] ): void; + setValue?( value?:any ): void; /** [Method] Convenience method * @param value Object */ @@ -27444,23 +30171,41 @@ declare module Ext.form { value?: any; /** [Config Option] (Number/Number[]) */ values?: any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of increment */ + /** [Method] Returns the value of increment + * @returns Number + */ getIncrement?(): number; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number/Number[] + */ getValue?(): any; - /** [Method] Convenience method */ + /** [Method] Convenience method + * @returns Object + */ getValues?(): any; - /** [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] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of cls * @param cls String @@ -27489,9 +30234,7 @@ declare module Ext.form { /** [Method] Sets the value of value * @param value Number/Number[] */ - setValue?( value?:any ): any; - setValue?( value?:number ): void; - setValue?( value?:number[] ): void; + setValue?( value?:any ): void; /** [Method] Convenience method * @param value Object */ @@ -27522,25 +30265,45 @@ declare module Ext.field { minValue?: number; /** [Config Option] (Number) */ stepValue?: number; - /** [Method] Returns the value of accelerateOnTapHold */ + /** [Method] Returns the value of accelerateOnTapHold + * @returns Boolean + */ getAccelerateOnTapHold?(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of cycle */ + /** [Method] Returns the value of cycle + * @returns Boolean + */ getCycle?(): boolean; - /** [Method] Returns the value of defaultValue */ + /** [Method] Returns the value of defaultValue + * @returns Number + */ getDefaultValue?(): number; - /** [Method] Returns the value of groupButtons */ + /** [Method] Returns the value of groupButtons + * @returns Boolean + */ getGroupButtons?(): boolean; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of stepValue */ + /** [Method] Returns the value of stepValue + * @returns Number + */ getStepValue?(): number; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of accelerateOnTapHold * @param accelerateOnTapHold Boolean @@ -27608,25 +30371,45 @@ declare module Ext.form { minValue?: number; /** [Config Option] (Number) */ stepValue?: number; - /** [Method] Returns the value of accelerateOnTapHold */ + /** [Method] Returns the value of accelerateOnTapHold + * @returns Boolean + */ getAccelerateOnTapHold?(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of cycle */ + /** [Method] Returns the value of cycle + * @returns Boolean + */ getCycle?(): boolean; - /** [Method] Returns the value of defaultValue */ + /** [Method] Returns the value of defaultValue + * @returns Number + */ getDefaultValue?(): number; - /** [Method] Returns the value of groupButtons */ + /** [Method] Returns the value of groupButtons + * @returns Boolean + */ getGroupButtons?(): boolean; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of stepValue */ + /** [Method] Returns the value of stepValue + * @returns Number + */ getStepValue?(): number; - /** [Method] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Sets the value of accelerateOnTapHold * @param accelerateOnTapHold Boolean @@ -27694,37 +30477,67 @@ declare module Ext.field { ui?: string; /** [Property] (String/Number) */ startValue?: any; - /** [Method] Attempts to forcefully blur input focus for the field */ + /** [Method] Attempts to forcefully blur input focus for the field + * @returns Ext.field.Text This field + */ blur?(): Ext.field.IText; - /** [Method] Attempts to set the field as the active input focus */ + /** [Method] Attempts to set the field as the active input focus + * @returns Ext.field.Text This field + */ focus?(): Ext.field.IText; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of autoComplete */ + /** [Method] Returns the value of autoComplete + * @returns Boolean + */ getAutoComplete?(): boolean; - /** [Method] Returns the value of autoCorrect */ + /** [Method] Returns the value of autoCorrect + * @returns Boolean + */ getAutoCorrect?(): boolean; - /** [Method] Returns the value of clearIcon */ + /** [Method] Returns the value of clearIcon + * @returns Boolean + */ getClearIcon?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxLength */ + /** [Method] Returns the value of maxLength + * @returns Number + */ getMaxLength?(): number; - /** [Method] Returns the value of placeHolder */ + /** [Method] Returns the value of placeHolder + * @returns String + */ getPlaceHolder?(): string; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [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] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Resets the field s originalValue property so it matches the current value */ resetOriginalValue?(): void; - /** [Method] Attempts to forcefully select all the contents of the input field */ + /** [Method] Attempts to forcefully select all the contents of the input field + * @returns Ext.field.Text this + */ select?(): Ext.field.IText; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27792,37 +30605,67 @@ declare module Ext.form { ui?: string; /** [Property] (String/Number) */ startValue?: any; - /** [Method] Attempts to forcefully blur input focus for the field */ + /** [Method] Attempts to forcefully blur input focus for the field + * @returns Ext.field.Text This field + */ blur?(): Ext.field.IText; - /** [Method] Attempts to set the field as the active input focus */ + /** [Method] Attempts to set the field as the active input focus + * @returns Ext.field.Text This field + */ focus?(): Ext.field.IText; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of autoComplete */ + /** [Method] Returns the value of autoComplete + * @returns Boolean + */ getAutoComplete?(): boolean; - /** [Method] Returns the value of autoCorrect */ + /** [Method] Returns the value of autoCorrect + * @returns Boolean + */ getAutoCorrect?(): boolean; - /** [Method] Returns the value of clearIcon */ + /** [Method] Returns the value of clearIcon + * @returns Boolean + */ getClearIcon?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxLength */ + /** [Method] Returns the value of maxLength + * @returns Number + */ getMaxLength?(): number; - /** [Method] Returns the value of placeHolder */ + /** [Method] Returns the value of placeHolder + * @returns String + */ getPlaceHolder?(): string; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Mixed + */ getValue?(): any; - /** [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] Resets the current field value back to the original value on this field when it was created */ + /** [Method] Resets the current field value back to the original value on this field when it was created + * @returns Ext.field.Field this + */ reset?(): Ext.field.IField; /** [Method] Resets the field s originalValue property so it matches the current value */ resetOriginalValue?(): void; - /** [Method] Attempts to forcefully select all the contents of the input field */ + /** [Method] Attempts to forcefully select all the contents of the input field + * @returns Ext.field.Text this + */ select?(): Ext.field.IText; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27876,13 +30719,21 @@ declare module Ext.field { maxRows?: number; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxRows */ + /** [Method] Returns the value of maxRows + * @returns Number + */ getMaxRows?(): number; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27912,13 +30763,21 @@ declare module Ext.form { maxRows?: number; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; - /** [Method] Returns the value of maxRows */ + /** [Method] Returns the value of maxRows + * @returns Number + */ getMaxRows?(): number; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -27956,15 +30815,25 @@ declare module Ext.field { toggleOffLabel?: string; /** [Property] (String) */ toggleOnLabel?: string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of labelAlign */ + /** [Method] Returns the value of labelAlign + * @returns String + */ getLabelAlign?(): string; - /** [Method] Returns the value of maxValueCls */ + /** [Method] Returns the value of maxValueCls + * @returns String + */ getMaxValueCls?(): string; - /** [Method] Returns the value of minValueCls */ + /** [Method] Returns the value of minValueCls + * @returns String + */ getMinValueCls?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number/Number[] + */ getValue?(): any; /** [Method] Sets the value of cls * @param cls String @@ -27984,9 +30853,12 @@ declare module Ext.field { setMinValueCls?( minValueCls?:string ): void; /** [Method] Sets the value of the toggle * @param newValue Number 1 for toggled, 0 for untoggled. + * @returns Object this */ setValue?( newValue?:number ): any; - /** [Method] Toggles the value of this toggle field */ + /** [Method] Toggles the value of this toggle field + * @returns Object this + */ toggle?(): any; } } @@ -28004,15 +30876,25 @@ declare module Ext.form { toggleOffLabel?: string; /** [Property] (String) */ toggleOnLabel?: string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of labelAlign */ + /** [Method] Returns the value of labelAlign + * @returns String + */ getLabelAlign?(): string; - /** [Method] Returns the value of maxValueCls */ + /** [Method] Returns the value of maxValueCls + * @returns String + */ getMaxValueCls?(): string; - /** [Method] Returns the value of minValueCls */ + /** [Method] Returns the value of minValueCls + * @returns String + */ getMinValueCls?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number/Number[] + */ getValue?(): any; /** [Method] Sets the value of cls * @param cls String @@ -28032,9 +30914,12 @@ declare module Ext.form { setMinValueCls?( minValueCls?:string ): void; /** [Method] Sets the value of the toggle * @param newValue Number 1 for toggled, 0 for untoggled. + * @returns Object this */ setValue?( newValue?:number ): any; - /** [Method] Toggles the value of this toggle field */ + /** [Method] Toggles the value of this toggle field + * @returns Object this + */ toggle?(): any; } } @@ -28044,9 +30929,13 @@ declare module Ext.field { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -28064,9 +30953,13 @@ declare module Ext.form { autoCapitalize?: boolean; /** [Config Option] (Object) */ component?: any; - /** [Method] Returns the value of autoCapitalize */ + /** [Method] Returns the value of autoCapitalize + * @returns Boolean + */ getAutoCapitalize?(): boolean; - /** [Method] Returns the value of component */ + /** [Method] Returns the value of component + * @returns Object + */ getComponent?(): any; /** [Method] Sets the value of autoCapitalize * @param autoCapitalize Boolean @@ -28088,9 +30981,12 @@ declare module Ext.form { title?: string; /** [Method] A convenient method to disable all fields in this FieldSet * @param newDisabled Object + * @returns Ext.form.FieldSet This FieldSet */ doSetDisabled?( newDisabled?:any ): Ext.form.IFieldSet; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -28132,46 +31028,73 @@ declare module Ext.form { waitTpl?: any; /** [Method] A convenient method to disable all fields in this form * @param newDisabled Object + * @returns Ext.form.Panel This form. */ doSetDisabled?( newDisabled?:any ): Ext.form.IPanel; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of baseParams */ + /** [Method] Returns the value of baseParams + * @returns Object + */ getBaseParams?(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns String + */ getMethod?(): string; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of scrollable */ + /** [Method] Returns the value of scrollable + * @returns Object + */ getScrollable?(): any; - /** [Method] Returns the value of standardSubmit */ + /** [Method] Returns the value of standardSubmit + * @returns Boolean + */ getStandardSubmit?(): boolean; - /** [Method] Returns the value of submitOnAction */ + /** [Method] Returns the value of submitOnAction + * @returns Object + */ getSubmitOnAction?(): any; - /** [Method] Returns the value of trackResetOnLoad */ + /** [Method] Returns the value of trackResetOnLoad + * @returns Boolean + */ getTrackResetOnLoad?(): boolean; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; /** [Method] Returns an object containing the value of each field in the form keyed to the field s name * @param enabled Boolean true to return only enabled fields. * @param all Boolean true to return all fields even if they don't have a name configured. + * @returns Object Object mapping field name to its value. */ getValues?( enabled?:boolean, all?:boolean ): any; - /** [Method] Hides a previously shown wait mask See showMask */ + /** [Method] Hides a previously shown wait mask See showMask + * @returns Ext.form.Panel this + */ hideMask?(): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ load?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ loadModel?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ loadRecord?( record?:Ext.data.IModel ): Ext.form.IPanel; - /** [Method] Resets all fields in the form back to their original values */ + /** [Method] Resets all fields in the form back to their original values + * @returns Ext.form.Panel This form. + */ reset?(): Ext.form.IPanel; /** [Method] Sets the value of baseCls * @param baseCls String @@ -28187,6 +31110,7 @@ declare module Ext.form { setMethod?( method?:string ): void; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ setRecord?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Sets the value of scrollable @@ -28211,15 +31135,18 @@ declare module Ext.form { setUrl?( url?:string ): void; /** [Method] Sets the values of form fields in bulk * @param values Object field name => value mapping object. + * @returns Ext.form.Panel This form. */ setValues?( values?:any ): Ext.form.IPanel; /** [Method] Shows a generic custom mask over a designated Element * @param cfg String/Object Either a string message or a configuration object supporting the following options: { message : 'Please Wait', cls : 'form-mask' } * @param target Object + * @returns Ext.form.Panel This form */ showMask?( cfg?:any, target?:any ): Ext.form.IPanel; /** [Method] Performs a Ajax based submission of form values if standardSubmit is false or otherwise executes a standard HTML Fo * @param options Object The configuration when submitting this form. + * @returns Ext.data.Connection The request object. */ submit?( options?:any ): Ext.data.IConnection; } @@ -28250,46 +31177,73 @@ declare module Ext.form { waitTpl?: any; /** [Method] A convenient method to disable all fields in this form * @param newDisabled Object + * @returns Ext.form.Panel This form. */ doSetDisabled?( newDisabled?:any ): Ext.form.IPanel; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of baseParams */ + /** [Method] Returns the value of baseParams + * @returns Object + */ getBaseParams?(): any; - /** [Method] Returns the value of method */ + /** [Method] Returns the value of method + * @returns String + */ getMethod?(): string; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ getRecord?(): Ext.data.IModel; - /** [Method] Returns the value of scrollable */ + /** [Method] Returns the value of scrollable + * @returns Object + */ getScrollable?(): any; - /** [Method] Returns the value of standardSubmit */ + /** [Method] Returns the value of standardSubmit + * @returns Boolean + */ getStandardSubmit?(): boolean; - /** [Method] Returns the value of submitOnAction */ + /** [Method] Returns the value of submitOnAction + * @returns Object + */ getSubmitOnAction?(): any; - /** [Method] Returns the value of trackResetOnLoad */ + /** [Method] Returns the value of trackResetOnLoad + * @returns Boolean + */ getTrackResetOnLoad?(): boolean; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; /** [Method] Returns an object containing the value of each field in the form keyed to the field s name * @param enabled Boolean true to return only enabled fields. * @param all Boolean true to return all fields even if they don't have a name configured. + * @returns Object Object mapping field name to its value. */ getValues?( enabled?:boolean, all?:boolean ): any; - /** [Method] Hides a previously shown wait mask See showMask */ + /** [Method] Hides a previously shown wait mask See showMask + * @returns Ext.form.Panel this + */ hideMask?(): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ load?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ loadModel?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ loadRecord?( record?:Ext.data.IModel ): Ext.form.IPanel; - /** [Method] Resets all fields in the form back to their original values */ + /** [Method] Resets all fields in the form back to their original values + * @returns Ext.form.Panel This form. + */ reset?(): Ext.form.IPanel; /** [Method] Sets the value of baseCls * @param baseCls String @@ -28305,6 +31259,7 @@ declare module Ext.form { setMethod?( method?:string ): void; /** [Method] Loads matching fields from a model instance into this form * @param record Ext.data.Model The model instance. + * @returns Ext.form.Panel This form. */ setRecord?( record?:Ext.data.IModel ): Ext.form.IPanel; /** [Method] Sets the value of scrollable @@ -28329,15 +31284,18 @@ declare module Ext.form { setUrl?( url?:string ): void; /** [Method] Sets the values of form fields in bulk * @param values Object field name => value mapping object. + * @returns Ext.form.Panel This form. */ setValues?( values?:any ): Ext.form.IPanel; /** [Method] Shows a generic custom mask over a designated Element * @param cfg String/Object Either a string message or a configuration object supporting the following options: { message : 'Please Wait', cls : 'form-mask' } * @param target Object + * @returns Ext.form.Panel This form */ showMask?( cfg?:any, target?:any ): Ext.form.IPanel; /** [Method] Performs a Ajax based submission of form values if standardSubmit is false or otherwise executes a standard HTML Fo * @param options Object The configuration when submitting this form. + * @returns Ext.data.Connection The request object. */ submit?( options?:any ): Ext.data.IConnection; } @@ -28349,6 +31307,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 @@ -28356,12 +31315,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 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 @@ -28369,6 +31328,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 @@ -28377,36 +31337,37 @@ 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] Create a new function from the provided fn change this to the provided scope optionally overrides arguments for the * @param fn Function The function to delegate. * @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 Function The new function. */ - static createDelegate( fn?:any, scope?:any, args?:any, appendArgs?:any ): any; - static createDelegate( fn?:any, scope?:any, args?:any[], appendArgs?:boolean ): any; - static createDelegate( fn?:any, scope?:any, args?:any[], appendArgs?:number ): any; + static createDelegate( fn?:any, 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 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 milliseconds specified optionally in a specific scope @@ -28415,18 +31376,19 @@ 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 fn Function + * @returns Function flexSetter */ static flexSetter( fn?: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; } @@ -28438,6 +31400,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 @@ -28445,12 +31408,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 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 @@ -28458,6 +31421,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 @@ -28466,36 +31430,37 @@ 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] Create a new function from the provided fn change this to the provided scope optionally overrides arguments for the * @param fn Function The function to delegate. * @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 Function The new function. */ - static createDelegate( fn?:any, scope?:any, args?:any, appendArgs?:any ): any; - static createDelegate( fn?:any, scope?:any, args?:any[], appendArgs?:boolean ): any; - static createDelegate( fn?:any, scope?:any, args?:any[], appendArgs?:number ): any; + static createDelegate( fn?:any, 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 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 milliseconds specified optionally in a specific scope @@ -28504,18 +31469,19 @@ 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 fn Function + * @returns Function flexSetter */ static flexSetter( fn?: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; } @@ -28528,37 +31494,69 @@ declare module Ext.fx.animation { easing?: string; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of delay */ + /** [Method] Returns the value of delay + * @returns Number + */ getDelay?(): number; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of iteration */ + /** [Method] Returns the value of iteration + * @returns Number + */ getIteration?(): number; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of onBeforeEnd */ + /** [Method] Returns the value of onBeforeEnd + * @returns Object + */ getOnBeforeEnd?(): any; - /** [Method] Returns the value of onBeforeStart */ + /** [Method] Returns the value of onBeforeStart + * @returns Object + */ getOnBeforeStart?(): any; - /** [Method] Returns the value of onEnd */ + /** [Method] Returns the value of onEnd + * @returns Object + */ getOnEnd?(): any; - /** [Method] Returns the value of preserveEndState */ + /** [Method] Returns the value of preserveEndState + * @returns Boolean + */ getPreserveEndState?(): boolean; - /** [Method] Returns the value of replacePrevious */ + /** [Method] Returns the value of replacePrevious + * @returns Boolean + */ getReplacePrevious?(): boolean; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; /** [Method] Sets the value of after * @param after Object @@ -28632,13 +31630,21 @@ declare module Ext.fx.animation { before?: any; /** [Config Option] (String) */ direction?: string; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; /** [Method] Sets the value of after * @param after Object @@ -28664,13 +31670,21 @@ declare module Ext.fx.animation { before?: any; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of after * @param after Object @@ -28696,13 +31710,21 @@ declare module Ext.fx.animation { before?: any; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of after * @param after Object @@ -28726,7 +31748,9 @@ declare module Ext.fx.animation { export interface IFadeOut extends Ext.fx.animation.IFade { /** [Config Option] (Object) */ before?: any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; /** [Method] Sets the value of before * @param before Object @@ -28740,13 +31764,21 @@ declare module Ext.fx.animation { direction?: string; /** [Config Option] (String) */ easing?: string; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of half */ + /** [Method] Returns the value of half + * @returns Boolean + */ getHalf?(): boolean; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Object + */ getOut?(): any; /** [Method] Sets the value of direction * @param direction String @@ -28776,11 +31808,17 @@ declare module Ext.fx.animation { before?: any; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; /** [Method] Sets the value of after * @param after Object @@ -28802,11 +31840,17 @@ declare module Ext.fx.animation { before?: any; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of after */ + /** [Method] Returns the value of after + * @returns Object + */ getAfter?(): any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; /** [Method] Sets the value of after * @param after Object @@ -28826,7 +31870,9 @@ declare module Ext.fx.animation { export interface IPopOut extends Ext.fx.animation.IPop { /** [Config Option] (Object) */ before?: any; - /** [Method] Returns the value of before */ + /** [Method] Returns the value of before + * @returns Object + */ getBefore?(): any; /** [Method] Sets the value of before * @param before Object @@ -28844,17 +31890,29 @@ declare module Ext.fx.animation { offset?: number; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of isElementBoxFit */ + /** [Method] Returns the value of isElementBoxFit + * @returns Boolean + */ getIsElementBoxFit?(): boolean; - /** [Method] Returns the value of offset */ + /** [Method] Returns the value of offset + * @returns Number + */ getOffset?(): number; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; - /** [Method] Returns the value of useCssTransform */ + /** [Method] Returns the value of useCssTransform + * @returns Boolean + */ getUseCssTransform?(): boolean; /** [Method] Sets the value of containerBox * @param containerBox String @@ -28900,17 +31958,29 @@ declare module Ext.fx.animation { offset?: number; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of isElementBoxFit */ + /** [Method] Returns the value of isElementBoxFit + * @returns Boolean + */ getIsElementBoxFit?(): boolean; - /** [Method] Returns the value of offset */ + /** [Method] Returns the value of offset + * @returns Number + */ getOffset?(): number; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; - /** [Method] Returns the value of useCssTransform */ + /** [Method] Returns the value of useCssTransform + * @returns Boolean + */ getUseCssTransform?(): boolean; /** [Method] Sets the value of containerBox * @param containerBox String @@ -28958,11 +32028,17 @@ declare module Ext.fx.animation { easing?: string; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; /** [Method] Sets the value of direction * @param direction String @@ -28986,11 +32062,17 @@ declare module Ext.fx.animation { easing?: string; /** [Config Option] (Boolean) */ out?: boolean; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns String + */ getEasing?(): string; - /** [Method] Returns the value of out */ + /** [Method] Returns the value of out + * @returns Boolean + */ getOut?(): boolean; /** [Method] Sets the value of direction * @param direction String @@ -29012,9 +32094,13 @@ declare module Ext.fx.animation { } declare module Ext.fx.easing { export interface IAbstract extends Ext.IBase { - /** [Method] Returns the value of startTime */ + /** [Method] Returns the value of startTime + * @returns Number + */ getStartTime?(): number; - /** [Method] Returns the value of startValue */ + /** [Method] Returns the value of startValue + * @returns Number + */ getStartValue?(): number; /** [Method] Sets the value of startTime * @param startTime Number @@ -29028,11 +32114,17 @@ declare module Ext.fx.easing { } declare module Ext.fx.easing { export interface IBounce extends Ext.fx.easing.IAbstract { - /** [Method] Returns the value of acceleration */ + /** [Method] Returns the value of acceleration + * @returns Number + */ getAcceleration?(): number; - /** [Method] Returns the value of springTension */ + /** [Method] Returns the value of springTension + * @returns Number + */ getSpringTension?(): number; - /** [Method] Returns the value of startVelocity */ + /** [Method] Returns the value of startVelocity + * @returns Number + */ getStartVelocity?(): number; /** [Method] Sets the value of acceleration * @param acceleration Number @@ -29058,17 +32150,29 @@ declare module Ext.fx.easing { momentum?: any; /** [Config Option] (Number) */ startVelocity?: number; - /** [Method] Returns the value of bounce */ + /** [Method] Returns the value of bounce + * @returns Object + */ getBounce?(): any; - /** [Method] Returns the value of maxMomentumValue */ + /** [Method] Returns the value of maxMomentumValue + * @returns Number + */ getMaxMomentumValue?(): number; - /** [Method] Returns the value of minMomentumValue */ + /** [Method] Returns the value of minMomentumValue + * @returns Number + */ getMinMomentumValue?(): number; - /** [Method] Returns the value of minVelocity */ + /** [Method] Returns the value of minVelocity + * @returns Number + */ getMinVelocity?(): number; - /** [Method] Returns the value of momentum */ + /** [Method] Returns the value of momentum + * @returns Object + */ getMomentum?(): any; - /** [Method] Returns the value of startVelocity */ + /** [Method] Returns the value of startVelocity + * @returns Number + */ getStartVelocity?(): number; /** [Method] Sets the value of bounce * @param bounce Object @@ -29098,9 +32202,13 @@ declare module Ext.fx.easing { } declare module Ext.fx.easing { export interface IEaseIn extends Ext.fx.easing.ILinear { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of exponent */ + /** [Method] Returns the value of exponent + * @returns Number + */ getExponent?(): number; /** [Method] Sets the value of duration * @param duration Number @@ -29114,9 +32222,13 @@ declare module Ext.fx.easing { } declare module Ext.fx.easing { export interface IEaseOut extends Ext.fx.easing.ILinear { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of exponent */ + /** [Method] Returns the value of exponent + * @returns Number + */ getExponent?(): number; /** [Method] Sets the value of duration * @param duration Number @@ -29134,9 +32246,13 @@ declare module Ext.fx { } declare module Ext.fx.easing { export interface ILinear extends Ext.fx.easing.IAbstract { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of endValue */ + /** [Method] Returns the value of endValue + * @returns Number + */ getEndValue?(): number; /** [Method] Sets the value of duration * @param duration Number @@ -29150,11 +32266,17 @@ declare module Ext.fx.easing { } declare module Ext.fx.easing { export interface IMomentum extends Ext.fx.easing.IAbstract { - /** [Method] Returns the value of acceleration */ + /** [Method] Returns the value of acceleration + * @returns Number + */ getAcceleration?(): number; - /** [Method] Returns the value of friction */ + /** [Method] Returns the value of friction + * @returns Number + */ getFriction?(): number; - /** [Method] Returns the value of startVelocity */ + /** [Method] Returns the value of startVelocity + * @returns Number + */ getStartVelocity?(): number; /** [Method] Sets the value of acceleration * @param acceleration Number @@ -29174,13 +32296,21 @@ declare module Ext.fx.layout.card { export interface IAbstract extends Ext.IEvented { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Object + */ getDuration?(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of direction * @param direction String @@ -29202,11 +32332,17 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface ICover extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29224,11 +32360,17 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface ICube extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29246,11 +32388,17 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface IFade extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; - /** [Method] Returns the value of reverse */ + /** [Method] Returns the value of reverse + * @returns Object + */ getReverse?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29268,11 +32416,17 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface IFlip extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; /** [Method] Sets the value of duration * @param duration Number @@ -29294,11 +32448,17 @@ declare module Ext.fx.layout { } declare module Ext.fx.layout.card { export interface IPop extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; /** [Method] Sets the value of duration * @param duration Number @@ -29316,9 +32476,13 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface IReveal extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29332,7 +32496,9 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface IScroll extends Ext.fx.layout.card.IAbstract { - /** [Method] Returns the value of duration */ + /** [Method] Returns the value of duration + * @returns Number + */ getDuration?(): number; /** [Method] Sets the value of duration * @param duration Number @@ -29350,9 +32516,13 @@ declare module Ext.fx.layout.card { } declare module Ext.fx.layout.card { export interface ISlide extends Ext.fx.layout.card.IStyle { - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29368,9 +32538,13 @@ declare module Ext.fx.layout.card { export interface IStyle extends Ext.fx.layout.card.IAbstract { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of inAnimation */ + /** [Method] Returns the value of inAnimation + * @returns Object + */ getInAnimation?(): any; - /** [Method] Returns the value of outAnimation */ + /** [Method] Returns the value of outAnimation + * @returns Object + */ getOutAnimation?(): any; /** [Method] Sets the value of inAnimation * @param inAnimation Object @@ -29416,17 +32590,29 @@ declare module Ext { src?: string; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of backgroundCls */ + /** [Method] Returns the value of backgroundCls + * @returns String + */ getBackgroundCls?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of imageCls */ + /** [Method] Returns the value of imageCls + * @returns String + */ getImageCls?(): string; - /** [Method] Returns the value of mode */ + /** [Method] Returns the value of mode + * @returns String + */ getMode?(): string; - /** [Method] Returns the value of src */ + /** [Method] Returns the value of src + * @returns String + */ getSrc?(): string; - /** [Method] Hides this Component */ + /** [Method] Hides this Component + * @returns Ext.Component + */ hide?(): Ext.IComponent; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -29450,7 +32636,9 @@ declare module Ext { * @param src String */ setSrc?( src?:string ): void; - /** [Method] Shows this component */ + /** [Method] Shows this component + * @returns Ext.Component + */ show?(): Ext.IComponent; } } @@ -29462,6 +32650,7 @@ declare module Ext { export interface IItemCollection extends Ext.util.IMixedCollection { /** [Method] MixedCollection has a generic way to fetch keys if you implement getKey * @param item Object + * @returns Object The key for the passed item. */ getKey?( item?:any ): any; } @@ -29491,11 +32680,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] Create a new function from the provided fn change this to the provided scope optionally overrides arguments for the @@ -29503,10 +32694,9 @@ 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 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] Calls function after specified delay or right away when delay 0 * @param callback Function The callback to execute. * @param scope Object The scope to execute in. @@ -29516,10 +32706,12 @@ declare module Ext { export function callback( callback?:any, scope?:any, args?:any[], delay?:number ): void; /** [Method] Old alias to Ext Array clean * @param array Array + * @returns Array results */ export function clean( array?:any[] ): any[]; /** [Method] Clone almost any type of variable including array object 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] Copies a set of named properties from the source object to the destination object @@ -29527,18 +32719,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 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 * @param args Mixed Additional arguments after the name will be passed to the class' constructor. + * @returns Object instance */ export function create( name?:string, args?:any ): any; /** [Method] Convenient shorthand see Ext ClassManager instantiateByAlias * @param alias String * @param args Mixed... Additional arguments after the alias will be passed to the class constructor. + * @returns Object instance */ export function createByAlias( alias:string, ...args:any[] ): any; /** [Method] Creates an interceptor function @@ -29546,6 +32739,7 @@ declare module Ext { * @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. */ export function createInterceptor( origFn?:any, newFn?:any, scope?:any, returnValue?:any ): any; /** [Method] Old name for widget */ @@ -29553,6 +32747,7 @@ declare module Ext { /** [Method] Shorthand for Ext JSON decode * @param json String The JSON string. * @param safe Boolean Whether to return null or throw an exception if the JSON is invalid. + * @returns Object/null The resulting object. */ export function decode( json?:string, safe?:boolean ): any; /** [Method] Calls this function after the number of milliseconds specified optionally in a specific scope @@ -29561,14 +32756,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 * @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 (or override) is created. The execution scope (this) will be the newly created class itself. + * @returns Ext.Base */ export function define( className?:string, data?:any, createdFn?:any ): Ext.IBase; /** [Method] Attempts to destroy any objects passed to it by removing all event listeners removing them from the DOM if applicab @@ -29582,19 +32777,23 @@ 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). + * @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] 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] A global factory method to instantiate a class from a config object @@ -29606,124 +32805,151 @@ declare module Ext { export function factory( config?:any, classReference?:string, instance?:any, aliasNamespace?:any ): void; /** [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 globally shared flyweight Element with the passed node as the active element * @param element 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 The shared Element object (or null if no matching element was found). */ - export function fly( element?:any, named?:any ): any; - export function fly( element?:string, named?:string ): Ext.dom.IElement; - export function fly( element?:HTMLElement, named?:string ): Ext.dom.IElement; + export function fly( element?:any, named?:string ): Ext.dom.IElement; /** [Method] Retrieves Ext dom Element objects * @param element 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( element?:any ): Ext.dom.IElement; + /** [Method] Returns the current document body as an Ext Element + * @returns Ext.Element The document body. */ - export function get( element?:any ): any; - export function get( element?:string ): Ext.dom.IElement; - export function get( element?:HTMLElement ): Ext.dom.IElement; - export function get( element?:Ext.IElement ): Ext.dom.IElement; - /** [Method] Returns the current document body as an Ext Element */ export function getBody(): Ext.IElement; /** [Method] Convenient shorthand see Ext ClassManager getClass */ export function getClass(): void; /** [Method] Convenient shorthand for Ext ClassManager getName * @param object Ext.Class/Object + * @returns String className */ export function getClassName( object?:any ): string; /** [Method] This is shorthand reference to Ext ComponentMgr get * @param id String The component id + * @returns Ext.Component The Component, undefined if not found, or null if a Class was found. */ export function getCmp( id?:string ): Ext.IComponent; /** [Method] Returns the display name for object * @param object Mixed The object who's display name to determine. + * @returns String The determined display name, or "Anonymous" if none found. */ export function getDisplayName( object?:any ): string; - /** [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] Return the dom node for the passed String id dom node or Ext Element * @param el Mixed + * @returns HTMLElement */ export function getDom( el?:any ): HTMLElement; - /** [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] Returns the current orientation of the mobile device */ export function getOrientation(): void; /** [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] 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 Mixed The element to generate an id for. * @param prefix String The id prefix. + * @returns String The generated id. */ export function id( el?:any, prefix?:string ): string; /** [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. + * @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 false otherwise * @param value Object The value to test. + * @returns Boolean */ export function isIterable( value?:any ): boolean; /** [Method] Returns true if the passed value is a String that matches the MS Date JSON encoding format * @param value Object {String} The string to test + * @returns Boolean */ export function isMSDate( 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 @@ -29735,12 +32961,12 @@ 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 comparison 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 */ @@ -29748,14 +32974,14 @@ declare module Ext { /** [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 comparison 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 namespace1 String * @param namespace2 String * @param etc String + * @returns Object The namespace object. If multiple arguments are passed, this will be the last namespace created. */ export function namespace( namespace1?:string, namespace2?:string, etc?:string ): any; /** [Method] Convenient alias for Ext namespace */ @@ -29777,24 +33003,23 @@ declare module Ext { * @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] Registers a new ptype */ export function preg(): void; /** [Method] Shorthand of Ext dom Query select * @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. */ - export function query( selector?:any, root?:any ): any; - export function query( selector?:string, root?:HTMLElement ): HTMLElement[]; - export function query( selector?:string, root?:string ): HTMLElement[]; + export function query( selector?:string, root?:any ): HTMLElement[]; /** [Method] Dispatches a request to a controller action adding to the History stack and updating the page url as necessary */ export function redirect(): void; /** [Method] Registers a new xtype */ @@ -29808,6 +33033,7 @@ declare module Ext { /** [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 @@ -29827,24 +33053,20 @@ 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] 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 composite Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false. + * @returns Ext.dom.CompositeElementLite/Ext.dom.CompositeElement */ - export function select( selector?:any, composite?:any ): any; - export function select( selector?:string, composite?:boolean ): Ext.dom.ICompositeElementLite; - export function select( selector?:HTMLElement[], composite?:boolean ): Ext.dom.ICompositeElementLite; + export function select( selector?:any, composite?:boolean ): Ext.dom.ICompositeElementLite; /** [Method] Ext setup is the entry point to initialize a Sencha Touch application * @param config Object An object with the following config options: */ export function setup( config?:any ): void; /** [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] Synchronous version of require convenient alias of Ext Loader syncRequire @@ -29853,32 +33075,33 @@ 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. * @param end Number a zero-based index that specifies the end of extraction. + * @returns Array */ export function toArray( iterable?:any, start?:number, end?:number ): any[]; /** [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] 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] A convenient alias method for Ext Object fromQueryString */ @@ -29889,10 +33112,12 @@ declare module Ext { * @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 valueFrom( value?:any, defaultValue?:any, allowBlank?:boolean ): any; /** [Method] Convenient shorthand to create a widget by its xtype also see Ext ClassManager instantiateByAlias var button Ext * @param name String + * @returns Object instance */ export function widget( name?:string ): any; } @@ -29903,14 +33128,17 @@ declare module Ext { /** [Method] Decodes parses a JSON string to an object * @param json String The JSON string. * @param safe Boolean Whether to return null or throw an exception if the JSON is invalid. + * @returns Object/null 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; } @@ -29921,7 +33149,9 @@ declare module Ext { baseCls?: string; /** [Config Option] (String) */ html?: string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -29937,16 +33167,14 @@ declare module Ext.layout { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -29958,9 +33186,7 @@ declare module Ext.layout { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -29968,9 +33194,7 @@ declare module Ext.layout { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -29978,27 +33202,32 @@ declare module Ext.layout { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -30008,18 +33237,14 @@ declare module Ext.layout { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -30027,28 +33252,25 @@ declare module Ext.layout { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -30057,16 +33279,14 @@ declare module Ext.layout { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -30074,18 +33294,14 @@ declare module Ext.layout { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -30093,9 +33309,7 @@ declare module Ext.layout { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -30109,25 +33323,21 @@ declare module Ext.layout { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.layout { @@ -30136,11 +33346,17 @@ declare module Ext.layout { align?: string; /** [Config Option] (String) */ pack?: string; - /** [Method] Returns the value of align */ + /** [Method] Returns the value of align + * @returns String + */ getAlign?(): string; - /** [Method] Returns the value of orient */ + /** [Method] Returns the value of orient + * @returns String + */ getOrient?(): string; - /** [Method] Returns the value of pack */ + /** [Method] Returns the value of pack + * @returns String + */ getPack?(): string; /** [Method] * @param item Object @@ -30179,7 +33395,9 @@ declare module Ext.layout { animation?: Ext.fx.layout.ICard; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of animation */ + /** [Method] Returns the value of animation + * @returns Ext.fx.layout.Card + */ getAnimation?(): Ext.fx.layout.ICard; /** [Method] * @param item Object @@ -30206,7 +33424,9 @@ declare module Ext.layout { export interface IFlexBox extends Ext.layout.IBox { /** [Config Option] (String) */ align?: string; - /** [Method] Returns the value of align */ + /** [Method] Returns the value of align + * @returns String + */ getAlign?(): string; /** [Method] * @param item Object @@ -30226,7 +33446,9 @@ declare module Ext.layout { } declare module Ext.layout { export interface IFloat extends Ext.layout.IDefault { - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; /** [Method] * @param item Object @@ -30245,7 +33467,9 @@ declare module Ext.layout { } declare module Ext.layout { export interface IVBox extends Ext.layout.IFlexBox { - /** [Method] Returns the value of orient */ + /** [Method] Returns the value of orient + * @returns String + */ getOrient?(): string; /** [Method] Sets the value of orient * @param orient String @@ -30257,17 +33481,29 @@ declare module Ext.layout.wrapper { export interface IBoxDock extends Ext.IBase { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of bodyElement */ + /** [Method] Returns the value of bodyElement + * @returns Object + */ getBodyElement?(): any; - /** [Method] Returns the value of container */ + /** [Method] Returns the value of container + * @returns Object + */ getContainer?(): any; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of innerWrapper */ + /** [Method] Returns the value of innerWrapper + * @returns Object + */ getInnerWrapper?(): any; - /** [Method] Returns the value of sizeState */ + /** [Method] Returns the value of sizeState + * @returns Boolean + */ getSizeState?(): boolean; /** [Method] Sets the value of bodyElement * @param bodyElement Object @@ -30299,17 +33535,29 @@ declare module Ext.layout.wrapper { export interface IDock extends Ext.IBase { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of bodyElement */ + /** [Method] Returns the value of bodyElement + * @returns Object + */ getBodyElement?(): any; - /** [Method] Returns the value of container */ + /** [Method] Returns the value of container + * @returns Object + */ getContainer?(): any; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of innerWrapper */ + /** [Method] Returns the value of innerWrapper + * @returns Object + */ getInnerWrapper?(): any; - /** [Method] Returns the value of sizeState */ + /** [Method] Returns the value of sizeState + * @returns Boolean + */ getSizeState?(): boolean; /** [Method] Sets the value of bodyElement * @param bodyElement Object @@ -30339,9 +33587,13 @@ declare module Ext.layout.wrapper { } declare module Ext.layout.wrapper { export interface IInner extends Ext.IBase { - /** [Method] Returns the value of container */ + /** [Method] Returns the value of container + * @returns Object + */ getContainer?(): any; - /** [Method] Returns the value of sizeState */ + /** [Method] Returns the value of sizeState + * @returns Object + */ getSizeState?(): any; /** [Method] Sets the value of container * @param container Object @@ -30359,18 +33611,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/Mixed */ 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] Add a new listener to be executed when all required scripts are fully loaded @@ -30385,19 +33641,17 @@ 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 name Object/String The config object to override the default values or name of a single config setting when also passing the second parameter. * @param value Mixed The value for the config setting. + * @returns Ext.Loader this */ static setConfig( name?:any, value?: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 @@ -30406,11 +33660,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 { @@ -30431,11 +33681,17 @@ declare module Ext { * @param store Ext.data.Store The store to bind to this LoadMask */ bindStore?( store?:Ext.data.IStore ): void; - /** [Method] Returns the value of indicator */ + /** [Method] Returns the value of indicator + * @returns Boolean + */ getIndicator?(): boolean; - /** [Method] Returns the value of message */ + /** [Method] Returns the value of message + * @returns String + */ getMessage?(): string; - /** [Method] Returns the value of messageCls */ + /** [Method] Returns the value of messageCls + * @returns String + */ getMessageCls?(): string; /** [Method] Sets the value of indicator * @param indicator Boolean @@ -30464,6 +33720,7 @@ declare module Ext { /** [Method] Logs a message to help with debugging * @param message String Message to log. * @param priority Number Priority of the log message. + * @returns Ext.Logger this */ static log( message?:string, priority?:number ): Ext.ILogger; /** [Method] Convenience method for log with priority verbose */ @@ -30488,15 +33745,25 @@ declare module Ext { maskMapCls?: string; /** [Config Option] (Boolean/Ext.util.Geolocation) */ useCurrentLocation?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of geo */ + /** [Method] Returns the value of geo + * @returns Ext.util.Geolocation + */ getGeo?(): Ext.util.IGeolocation; - /** [Method] Returns the value of map */ + /** [Method] Returns the value of map + * @returns google.maps.Map + */ getMap?(): any; - /** [Method] Returns the state of the Map */ + /** [Method] Returns the state of the Map + * @returns Object mapOptions + */ getState?(): any; - /** [Method] Returns the value of useCurrentLocation */ + /** [Method] Returns the value of useCurrentLocation + * @returns Boolean/Ext.util.Geolocation + */ getUseCurrentLocation?(): any; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -30523,9 +33790,7 @@ declare module Ext { /** [Method] Sets the value of useCurrentLocation * @param useCurrentLocation Boolean/Ext.util.Geolocation */ - setUseCurrentLocation?( useCurrentLocation?:any ): any; - setUseCurrentLocation?( useCurrentLocation?:boolean ): void; - setUseCurrentLocation?( useCurrentLocation?:Ext.util.IGeolocation ): void; + setUseCurrentLocation?( useCurrentLocation?:any ): void; /** [Method] Moves the map center to the designated coordinates hash of the form latitude 37 381592 longitude 122 135672 * @param coordinates Object/google.maps.LatLng Object representing the desired Latitude and longitude upon which to center the map. */ @@ -30538,9 +33803,13 @@ declare module Ext { baseCls?: string; /** [Config Option] (Boolean) */ transparent?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of transparent */ + /** [Method] Returns the value of transparent + * @returns Boolean + */ getTransparent?(): boolean; /** [Method] Sets the value of baseCls * @param baseCls String @@ -30574,31 +33843,55 @@ declare module Ext { volume?: number; /** [Method] Destroys this Component */ destroy?(): void; - /** [Method] Returns the value of autoPause */ + /** [Method] Returns the value of autoPause + * @returns Boolean + */ getAutoPause?(): boolean; - /** [Method] Returns the value of autoResume */ + /** [Method] Returns the value of autoResume + * @returns Boolean + */ getAutoResume?(): boolean; - /** [Method] Returns the current time of the media in seconds */ + /** [Method] Returns the current time of the media in seconds + * @returns Number + */ getCurrentTime?(): number; - /** [Method] Returns the duration of the media in seconds */ + /** [Method] Returns the duration of the media in seconds + * @returns Number + */ getDuration?(): number; - /** [Method] Returns the value of enableControls */ + /** [Method] Returns the value of enableControls + * @returns Boolean + */ getEnableControls?(): boolean; - /** [Method] Returns the value of loop */ + /** [Method] Returns the value of loop + * @returns Boolean + */ getLoop?(): boolean; - /** [Method] Returns the value of media */ + /** [Method] Returns the value of media + * @returns Ext.Element + */ getMedia?(): Ext.IElement; - /** [Method] Returns the value of muted */ + /** [Method] Returns the value of muted + * @returns Boolean + */ getMuted?(): boolean; - /** [Method] Returns the value of preload */ + /** [Method] Returns the value of preload + * @returns Boolean + */ getPreload?(): boolean; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns String + */ getUrl?(): string; - /** [Method] Returns the value of volume */ + /** [Method] Returns the value of volume + * @returns Number + */ getVolume?(): number; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; - /** [Method] Returns if the media is currently playing */ + /** [Method] Returns if the media is currently playing + * @returns Boolean playing true if the media is playing. + */ isPlaying?(): boolean; /** [Method] Pauses media playback */ pause?(): void; @@ -30693,6 +33986,7 @@ declare module Ext { * @param message String The message box body text. * @param fn Function A callback function which is called when the dialog is dismissed by clicking on the configured buttons. * @param scope Object The scope (this reference) in which the callback is executed. Defaults to: the browser window + * @returns Ext.MessageBox this */ alert?( title?:string, message?:string, fn?:any, scope?:any ): Ext.IMessageBox; /** [Method] Displays a confirmation message box with Yes and No buttons comparable to JavaScript s confirm @@ -30700,23 +33994,40 @@ declare module Ext { * @param message String The message box body text. * @param fn Function A callback function which is called when the dialog is dismissed by clicking on the configured buttons. * @param scope Object The scope (this reference) in which the callback is executed. Defaults to: the browser window + * @returns Ext.MessageBox this */ confirm?( title?:string, message?:string, fn?:any, scope?:any ): Ext.IMessageBox; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of buttons */ + /** [Method] Returns the value of buttons + * @returns Array/Object + */ getButtons?(): any; - /** [Method] Returns the value of defaultTextHeight */ + /** [Method] Returns the value of defaultTextHeight + * @returns Number + */ getDefaultTextHeight?(): number; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of prompt */ + /** [Method] Returns the value of prompt + * @returns Object + */ getPrompt?(): any; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of zIndex */ + /** [Method] Returns the value of zIndex + * @returns Number + */ getZIndex?(): number; /** [Method] Sets the value of baseCls * @param baseCls String @@ -30736,6 +34047,7 @@ declare module Ext { setHideAnimation?( hideAnimation?:any ): void; /** [Method] Sets icon * @param iconCls String A CSS class name or empty string to clear the icon. + * @returns Ext.MessageBox this */ setIcon?( iconCls?:string ): Ext.IMessageBox; /** [Method] Sets the value of iconCls @@ -30772,10 +34084,12 @@ declare module Ext { setZIndex?( zIndex?:number ): void; /** [Method] Displays the Ext MessageBox with a specified configuration * @param config Object An object with the following config options: + * @returns Ext.MessageBox this */ show?( config?:any ): Ext.IMessageBox; /** [Method] Sets the value of message * @param message String + * @returns Ext.MessageBox this */ updateText?( message?:string ): Ext.IMessageBox; } @@ -30802,26 +34116,36 @@ declare module Ext.mixin { addFilter?( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Array An array with filters. A filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ addFilters?( filters?:any[] ): any; /** [Method] This method will sort an array based on the currently configured sorters * @param data Array The array you want to have sorted. + * @returns Array The array you passed after it is sorted. */ filter?( data?:any[] ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ getFilterFn?(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ getFilterRoot?(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ getFilters?(): any[]; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ insertFilter?( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ insertFilters?( index?:number, filters?:any[] ): any[]; /** [Method] This method removes all the filters in a passed array @@ -30840,8 +34164,10 @@ declare module Ext.mixin { } declare module Ext.mixin { export interface IIdentifiable extends Ext.IBase { - /** [Method] Retrieves the id of this component */ - getId?(): string; + /** [Method] Retrieves the id of this component + * @returns any id + */ + getId?(): any; } } declare module Ext.mixin { @@ -30860,16 +34186,14 @@ declare module Ext.mixin { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -30881,9 +34205,7 @@ declare module Ext.mixin { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -30891,9 +34213,7 @@ declare module Ext.mixin { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -30901,29 +34221,36 @@ declare module Ext.mixin { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Retrieves the id of this component */ - getId?(): string; - /** [Method] Returns the value of listeners */ + /** [Method] Retrieves the id of this component + * @returns any id + */ + getId?(): any; + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -30933,18 +34260,14 @@ declare module Ext.mixin { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -30952,28 +34275,25 @@ declare module Ext.mixin { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -30982,16 +34302,14 @@ declare module Ext.mixin { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -30999,18 +34317,14 @@ declare module Ext.mixin { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -31018,9 +34332,7 @@ declare module Ext.mixin { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -31034,25 +34346,21 @@ declare module Ext.mixin { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util { @@ -31067,16 +34375,14 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -31088,9 +34394,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -31098,9 +34402,7 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -31108,29 +34410,36 @@ declare module Ext.util { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Retrieves the id of this component */ - getId?(): string; - /** [Method] Returns the value of listeners */ + /** [Method] Retrieves the id of this component + * @returns any id + */ + getId?(): any; + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -31140,18 +34449,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -31159,28 +34464,25 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -31189,16 +34491,14 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -31206,18 +34506,14 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -31225,9 +34521,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -31241,25 +34535,21 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.mixin { @@ -31280,10 +34570,7 @@ declare module Ext.mixin { * @param records Number/Array/Ext.data.Model The record(s) to deselect. Can also be a number to reference by index. * @param suppressEvent Boolean If true the deselect event will not be fired. */ - deselect?( records?:any, suppressEvent?:any ): any; - deselect?( records?:number, suppressEvent?:boolean ): void; - deselect?( records?:any[], suppressEvent?:boolean ): void; - deselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; + deselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Deselects all records * @param supress Object */ @@ -31292,54 +34579,68 @@ declare module Ext.mixin { * @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. */ - doDeselect?( records?:any, suppressEvent?:any ): any; - doDeselect?( records?:Ext.data.IModel, suppressEvent?:boolean ): void; - doDeselect?( records?:number, suppressEvent?:boolean ): void; + doDeselect?( records?:any, suppressEvent?:boolean ): void; /** [Method] Selects a record instance by record instance or index * @param records Ext.data.Model/Number An array of records or an index. * @param keepExisting Boolean * @param suppressEvent Boolean Set to false to not fire a select event. */ - doSelect?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - doSelect?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - doSelect?( records?:number, keepExisting?:boolean, suppressEvent?:boolean ): void; - /** [Method] Returns the value of allowDeselect */ + doSelect?( records?:any, keepExisting?:boolean, suppressEvent?:boolean ): void; + /** [Method] Returns the value of allowDeselect + * @returns Boolean + */ getAllowDeselect?(): boolean; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getCount?(): number; - /** [Method] Returns the value of deselectOnContainerClick */ + /** [Method] Returns the value of deselectOnContainerClick + * @returns Boolean + */ getDeselectOnContainerClick?(): boolean; - /** [Method] Returns the value of disableSelection */ + /** [Method] Returns the value of disableSelection + * @returns Boolean + */ getDisableSelection?(): boolean; - /** [Method] Returns the array of previously selected items */ + /** [Method] Returns the array of previously selected items + * @returns Array The previous selection. + */ getLastSelected?(): any[]; - /** [Method] Returns the value of mode */ + /** [Method] Returns the value of mode + * @returns String + */ getMode?(): string; - /** [Method] Returns an array of the currently selected records */ + /** [Method] Returns an array of the currently selected records + * @returns Array An array of selected records. + */ getSelection?(): any[]; - /** [Method] Returns the number of selections */ + /** [Method] Returns the number of selections + * @returns Number + */ getSelectionCount?(): number; - /** [Method] Returns the selection mode currently used by this Selectable */ + /** [Method] Returns the selection mode currently used by this Selectable + * @returns String The current mode. + */ getSelectionMode?(): string; - /** [Method] Returns true if there is a selected record */ + /** [Method] Returns true if there is a selected record + * @returns Boolean + */ hasSelection?(): boolean; - /** [Method] Returns true if the Selectable is currently locked */ + /** [Method] Returns true if the Selectable is currently locked + * @returns Boolean True if currently locked + */ isLocked?(): 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] Adds the given records to the currently selected set * @param records Ext.data.Model/Array/Number The records to select. * @param keepExisting Boolean If true, the existing selection will be added to (if not, the old selection is replaced). * @param suppressEvent Boolean If true, the select event will not be fired. */ - select?( records?:any, keepExisting?:any, suppressEvent?:any ): any; - select?( records?:Ext.data.IModel, keepExisting?:boolean, suppressEvent?:boolean ): void; - select?( records?:any[], 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 * @param silent Boolean true to suppress all select events. */ @@ -31402,15 +34703,24 @@ declare module Ext.mixin { /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ findInsertionIndex?( items?:any[], item?:any ): number; - /** [Method] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ getDefaultSortDirection?(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ getSortFn?(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ getSortRoot?(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ getSorters?(): any[]; /** [Method] This method adds a sorter at a given index * @param index Number The index at which to insert the sorter. @@ -31446,6 +34756,7 @@ declare module Ext.mixin { setSorters?( sorters?:any[] ): void; /** [Method] This method will sort an array based on the currently configured sorters * @param data Array The array you want to have sorted. + * @returns Array The array you passed after it is sorted. */ sort?( data?:any[] ): any[]; } @@ -31464,6 +34775,7 @@ declare module Ext { export class Msg { /** [Method] Adds one or more Components to this Container * @param newItems Object/Object[]/Ext.Component/Ext.Component[] The new items to add to the Container. + * @returns Ext.Component The last item added to the Container from the newItems array. */ static add( newItems?:any ): Ext.IComponent; /** [Method] Appends an after event handler @@ -31472,10 +34784,10 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds an array of Components to this Container * @param items Array The array of items to add to this container. + * @returns Array The array of items after they have been added. */ static addAll( items?:any[] ): any[]; /** [Method] Appends a before event handler @@ -31484,8 +34796,7 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds a CSS class or classes to this Component s rendered element * @param cls String The CSS class to add. * @param prefix String Optional prefix to add to each class. @@ -31503,9 +34814,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -31513,14 +34822,13 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?: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 message String The message box body text. * @param fn Function A callback function which is called when the dialog is dismissed by clicking on the configured buttons. * @param scope Object The scope (this reference) in which the callback is executed. Defaults to: the browser window + * @returns Ext.MessageBox this */ static alert( title?:string, message?:string, fn?:any, scope?:any ): Ext.IMessageBox; /** [Method] Animates to the supplied activeItem with a specified animation @@ -31530,25 +34838,27 @@ declare module Ext { static animateActiveItem( activeItem?:any, animation?:any ): void; /** [Method] Changes the masked configuration when its setter is called which will convert the value into a proper object instanc * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask + * @returns Object */ static applyMasked( masked?:any ): any; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] Retrieves the first direct child of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ static child( selector?:string ): Ext.IComponent; /** [Method] Removes all listeners for this object */ @@ -31558,6 +34868,7 @@ declare module Ext { * @param message String The message box body text. * @param fn Function A callback function which is called when the dialog is dismissed by clicking on the configured buttons. * @param scope Object The scope (this reference) in which the callback is executed. Defaults to: the browser window + * @returns Ext.MessageBox this */ static confirm( title?:string, message?:string, fn?:any, scope?:any ): Ext.IMessageBox; /** [Method] */ @@ -31566,6 +34877,7 @@ declare module Ext { static disable(): void; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ static down( selector?:string ): Ext.IComponent; /** [Method] Enables this Component */ @@ -31573,195 +34885,342 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ static getActiveItem(): any; /** [Method] Returns the Component for a given index in the Container s items * @param index Number The index of the Component to return. + * @returns Ext.Component The item at the specified index, if found. */ static getAt( index?:number ): Ext.IComponent; - /** [Method] Returns the value of autoDestroy */ + /** [Method] Returns the value of autoDestroy + * @returns Boolean + */ static getAutoDestroy(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ static getBaseCls(): string; - /** [Method] Returns the value of bodyBorder */ + /** [Method] Returns the value of bodyBorder + * @returns Number/Boolean/String + */ static getBodyBorder(): any; - /** [Method] Returns the value of bodyMargin */ + /** [Method] Returns the value of bodyMargin + * @returns Number/Boolean/String + */ static getBodyMargin(): any; - /** [Method] Returns the value of bodyPadding */ + /** [Method] Returns the value of bodyPadding + * @returns Number/Boolean/String + */ static getBodyPadding(): any; - /** [Method] Returns the value of border */ + /** [Method] Returns the value of border + * @returns Number/String + */ static getBorder(): any; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns Number/String + */ static getBottom(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Returns the value of buttons */ + /** [Method] Returns the value of buttons + * @returns Array/Object + */ static getButtons(): any; - /** [Method] Returns the value of centered */ + /** [Method] Returns the value of centered + * @returns Boolean + */ static getCentered(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String/String[] + */ static getCls(): any; /** [Method] Examines this container s items property and gets a direct child component of this container * @param component String/Number This parameter may be any of the following: {String} : representing the itemId or id of the child component. {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). + */ + static getComponent( component?:any ): Ext.IComponent; + /** [Method] Returns the value of contentEl + * @returns Ext.Element/HTMLElement/String */ - static getComponent( component?:any ): any; - static getComponent( component?:string ): Ext.IComponent; - static getComponent( component?:number ): Ext.IComponent; - /** [Method] Returns the value of contentEl */ static getContentEl(): any; - /** [Method] Returns the value of control */ + /** [Method] Returns the value of control + * @returns Object + */ static getControl(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ static getData(): any; - /** [Method] Returns the value of defaultTextHeight */ + /** [Method] Returns the value of defaultTextHeight + * @returns Number + */ static getDefaultTextHeight(): number; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ static getDefaultType(): string; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ static getDefaults(): any; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ static getDisabled(): boolean; - /** [Method] Returns the value of disabledCls */ + /** [Method] Returns the value of disabledCls + * @returns String + */ static getDisabledCls(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ static getDocked(): string; /** [Method] Finds a docked item of this container using a reference idor an index of its location in getDockedItems * @param component String/Number The id or index of the component to find. + * @returns Ext.Component/Boolean The docked component, if found. */ static getDockedComponent( component?:any ): any; - static getDockedComponent( component?:string ): boolean; - static getDockedComponent( component?:number ): boolean; - /** [Method] Returns all the Ext Component docked items in this container */ + /** [Method] Returns all the Ext Component docked items in this container + * @returns Array The docked items of this container. + */ static getDockedItems(): any[]; - /** [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] Returns the value of enter */ + /** [Method] Returns the value of enter + * @returns String + */ static getEnter(): string; - /** [Method] Returns the value of enterAnimation */ + /** [Method] Returns the value of enterAnimation + * @returns String/Mixed + */ static getEnterAnimation(): any; - /** [Method] Returns the value of exit */ + /** [Method] Returns the value of exit + * @returns String + */ static getExit(): string; - /** [Method] Returns the value of exitAnimation */ + /** [Method] Returns the value of exitAnimation + * @returns String/Mixed + */ static getExitAnimation(): any; - /** [Method] Returns the value of flex */ + /** [Method] Returns the value of flex + * @returns Number + */ static getFlex(): number; - /** [Method] Returns the value of floatingCls */ + /** [Method] Returns the value of floatingCls + * @returns String + */ static getFloatingCls(): string; - /** [Method] Returns the value of height */ + /** [Method] Returns the value of height + * @returns Number/String + */ static getHeight(): any; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ static getHidden(): boolean; - /** [Method] Returns the value of hiddenCls */ + /** [Method] Returns the value of hiddenCls + * @returns String + */ static getHiddenCls(): string; - /** [Method] Returns the value of hideAnimation */ + /** [Method] Returns the value of hideAnimation + * @returns Object + */ static getHideAnimation(): any; - /** [Method] Returns the value of hideOnMaskTap */ + /** [Method] Returns the value of hideOnMaskTap + * @returns Boolean + */ static getHideOnMaskTap(): boolean; - /** [Method] Returns the value of html */ + /** [Method] Returns the value of html + * @returns String/Ext.Element/HTMLElement + */ static getHtml(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns all inner items of this container */ + /** [Method] Returns all inner items of this container + * @returns Array The inner items of this container. + */ static getInnerItems(): any[]; - /** [Method] Returns the value of itemId */ + /** [Method] Returns the value of itemId + * @returns String + */ static getItemId(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ static getItems(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ static getLayout(): any; - /** [Method] Returns the value of left */ + /** [Method] Returns the value of left + * @returns Number/String + */ static getLeft(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; - /** [Method] Returns the value of margin */ + /** [Method] Returns the value of margin + * @returns Number/String + */ static getMargin(): any; - /** [Method] Returns the value of masked */ + /** [Method] Returns the value of masked + * @returns Boolean/Object/Ext.Mask/Ext.LoadMask + */ static getMasked(): any; - /** [Method] Returns the value of maxHeight */ + /** [Method] Returns the value of maxHeight + * @returns Number/String + */ static getMaxHeight(): any; - /** [Method] Returns the value of maxWidth */ + /** [Method] Returns the value of maxWidth + * @returns Number/String + */ static getMaxWidth(): any; - /** [Method] Returns the value of minHeight */ + /** [Method] Returns the value of minHeight + * @returns Number/String + */ static getMinHeight(): any; - /** [Method] Returns the value of minWidth */ + /** [Method] Returns the value of minWidth + * @returns Number/String + */ static getMinWidth(): any; - /** [Method] Returns the value of padding */ + /** [Method] Returns the value of padding + * @returns Number/String + */ static getPadding(): any; - /** [Method] Returns the parent of this component if it has one */ + /** [Method] Returns the parent of this component if it has one + * @returns Ext.Component The parent of this component. + */ static getParent(): Ext.IComponent; - /** [Method] Returns the value of plugins */ + /** [Method] Returns the value of plugins + * @returns Object/Array + */ static getPlugins(): any; - /** [Method] Returns the value of prompt */ + /** [Method] Returns the value of prompt + * @returns Object + */ static getPrompt(): any; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ static getRecord(): Ext.data.IModel; - /** [Method] Returns the value of renderTo */ + /** [Method] Returns the value of renderTo + * @returns Ext.Element + */ static getRenderTo(): Ext.IElement; - /** [Method] Returns the value of right */ + /** [Method] Returns the value of right + * @returns Number/String + */ static getRight(): any; - /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class */ + /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class + * @returns Ext.scroll.View The scroll view. + */ static getScrollable(): Ext.scroll.IView; - /** [Method] Returns the value of showAnimation */ + /** [Method] Returns the value of showAnimation + * @returns Object + */ static getShowAnimation(): any; - /** [Method] Returns the height and width of the Component */ + /** [Method] Returns the height and width of the Component + * @returns Object The current height and width of the Component. + */ static getSize(): any; - /** [Method] Returns the value of stretchX */ + /** [Method] Returns the value of stretchX + * @returns Boolean + */ static getStretchX(): boolean; - /** [Method] Returns the value of stretchY */ + /** [Method] Returns the value of stretchY + * @returns Boolean + */ static getStretchY(): boolean; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns String/Object + */ static getStyle(): any; - /** [Method] Returns the value of styleHtmlCls */ + /** [Method] Returns the value of styleHtmlCls + * @returns String + */ static getStyleHtmlCls(): string; - /** [Method] Returns the value of styleHtmlContent */ + /** [Method] Returns the value of styleHtmlContent + * @returns Boolean + */ static getStyleHtmlContent(): boolean; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ static getTitle(): string; - /** [Method] Returns the value of top */ + /** [Method] Returns the value of top + * @returns Number/String + */ static getTop(): any; - /** [Method] Returns the value of tpl */ + /** [Method] Returns the value of tpl + * @returns String/String[]/Ext.Template[]/Ext.XTemplate[] + */ static getTpl(): any; - /** [Method] Returns the value of tplWriteMode */ + /** [Method] Returns the value of tplWriteMode + * @returns String + */ static getTplWriteMode(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ static getUi(): string; - /** [Method] Returns the value of width */ + /** [Method] Returns the value of width + * @returns Number/String + */ static getWidth(): any; - /** [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] Returns the value of zIndex */ + /** [Method] Returns the value of zIndex + * @returns Number + */ static getZIndex(): number; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; - /** [Method] Returns true if this component has a parent */ + /** [Method] Returns true if this component has a parent + * @returns Boolean true if this component has a parent. + */ static hasParent(): boolean; /** [Method] Hides this Component * @param animation Object/Boolean + * @returns Ext.Component */ static hide( animation?:any ): Ext.IComponent; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Allows addition of behavior to the rendering phase */ @@ -31771,13 +35230,18 @@ declare module Ext { * @param item Object The Component to insert. */ static insert( index?:number, item?:any ): void; - /** [Method] Returns true if this Component is currently disabled */ + /** [Method] Returns true if this Component is currently disabled + * @returns Boolean true if currently disabled. + */ static isDisabled(): boolean; - /** [Method] Returns true if this Component is currently hidden */ + /** [Method] Returns true if this Component is currently hidden + * @returns Boolean true if currently hidden. + */ static isHidden(): 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 false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype. + * @returns Boolean true if this component descends from the specified xtype, false otherwise. */ static isXType( xtype?:string, shallow?:boolean ): boolean; /** [Method] Convenience method which calls setMasked with a value of true to show the mask @@ -31791,18 +35255,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -31810,25 +35270,21 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Displays a message box with OK and Cancel buttons prompting the user to enter some text comparable to JavaScript s p * @param title String The title bar text. * @param message String The message box body text. @@ -31837,22 +35293,24 @@ declare module Ext { * @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. * @param prompt Object The configuration for the prompt. See the prompt documentation in Ext.MessageBox for more information. + * @returns Ext.MessageBox this */ - static prompt( title?:any, message?:any, fn?:any, scope?:any, multiLine?:any, value?:any, prompt?:any ): any; - static prompt( title?:string, message?:string, fn?:any, scope?:any, multiLine?:boolean, value?:string, prompt?:any ): Ext.IMessageBox; - static prompt( title?:string, message?:string, fn?:any, scope?:any, multiLine?:number, value?:string, prompt?:any ): Ext.IMessageBox; + static prompt( title?:string, message?:string, fn?:any, scope?:any, multiLine?:any, value?:string, prompt?:any ): Ext.IMessageBox; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. + * @returns Array Ext.Component's which matched the selector. */ static query( selector?:string ): any[]; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes an item from this Container optionally destroying it * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ static remove( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes a before event handler @@ -31861,15 +35319,16 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all items currently in the Container optionally destroying them all * @param destroy Boolean If true, destroys each removed Component. * @param everything Boolean If true, completely remove all items including docked / centered and floating items. + * @returns Ext.Component this */ static removeAll( destroy?:boolean, everything?:boolean ): Ext.IComponent; /** [Method] Removes the Component at the specified index myContainer removeAt 0 removes the first item * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ static removeAt( index?:number ): Ext.IContainer; /** [Method] Removes a before event handler @@ -31878,8 +35337,7 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes the given CSS class es from this Component s rendered element * @param cls String The class(es) to remove. * @param prefix String Optional prefix to prepend before each class. @@ -31889,10 +35347,12 @@ declare module Ext { /** [Method] Removes a docked item from this Container * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ static removeDocked( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes an inner Component at the specified index myContainer removeInnerAt 0 removes the first item of the in * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ static removeInnerAt( index?:number ): Ext.IContainer; /** [Method] Removes an event handler @@ -31902,18 +35362,14 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Replaces specified classes with the newly specified classes * @param oldCls String The class(es) to remove. * @param newCls String The class(es) to add. @@ -31942,42 +35398,27 @@ declare module Ext { /** [Method] Sets the value of bodyBorder * @param bodyBorder Number/Boolean/String */ - static setBodyBorder( bodyBorder?:any ): any; - static setBodyBorder( bodyBorder?:number ): void; - static setBodyBorder( bodyBorder?:boolean ): void; - static setBodyBorder( bodyBorder?:string ): void; + static setBodyBorder( bodyBorder?:any ): void; /** [Method] Sets the value of bodyMargin * @param bodyMargin Number/Boolean/String */ - static setBodyMargin( bodyMargin?:any ): any; - static setBodyMargin( bodyMargin?:number ): void; - static setBodyMargin( bodyMargin?:boolean ): void; - static setBodyMargin( bodyMargin?:string ): void; + static setBodyMargin( bodyMargin?:any ): void; /** [Method] Sets the value of bodyPadding * @param bodyPadding Number/Boolean/String */ - static setBodyPadding( bodyPadding?:any ): any; - static setBodyPadding( bodyPadding?:number ): void; - static setBodyPadding( bodyPadding?:boolean ): void; - static setBodyPadding( bodyPadding?:string ): void; + static setBodyPadding( bodyPadding?:any ): void; /** [Method] Sets the value of border * @param border Number/String */ - static setBorder( border?:any ): any; - static setBorder( border?:number ): void; - static setBorder( border?:string ): void; + static setBorder( border?:any ): void; /** [Method] Sets the value of bottom * @param bottom Number/String */ - static setBottom( bottom?:any ): any; - static setBottom( bottom?:number ): void; - static setBottom( bottom?:string ): void; + static setBottom( bottom?:any ): void; /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of buttons * @param buttons Array/Object */ @@ -31989,16 +35430,11 @@ declare module Ext { /** [Method] Sets the value of cls * @param cls String/String[] */ - static setCls( cls?:any ): any; - static setCls( cls?:string ): void; - static setCls( cls?:string[] ): void; + static setCls( cls?:any ): void; /** [Method] Sets the value of contentEl * @param contentEl Ext.Element/HTMLElement/String */ - static setContentEl( contentEl?:any ): any; - static setContentEl( contentEl?:Ext.IElement ): void; - static setContentEl( contentEl?:HTMLElement ): void; - static setContentEl( contentEl?:string ): void; + static setContentEl( contentEl?:any ): void; /** [Method] Sets the value of control * @param control Object */ @@ -32042,8 +35478,7 @@ declare module Ext { /** [Method] Sets the value of enterAnimation * @param enterAnimation String/Mixed */ - static setEnterAnimation( enterAnimation?:any ): any; - static setEnterAnimation( enterAnimation?:string ): void; + static setEnterAnimation( enterAnimation?:any ): void; /** [Method] Sets the value of exit * @param exit String */ @@ -32051,8 +35486,7 @@ declare module Ext { /** [Method] Sets the value of exitAnimation * @param exitAnimation String/Mixed */ - static setExitAnimation( exitAnimation?:any ): any; - static setExitAnimation( exitAnimation?:string ): void; + static setExitAnimation( exitAnimation?:any ): void; /** [Method] Sets the value of flex * @param flex Number */ @@ -32068,9 +35502,7 @@ declare module Ext { /** [Method] Sets the value of height * @param height Number/String */ - static setHeight( height?:any ): any; - static setHeight( height?:number ): void; - static setHeight( height?:string ): void; + static setHeight( height?:any ): void; /** [Method] Sets the value of hidden * @param hidden Boolean */ @@ -32090,12 +35522,10 @@ declare module Ext { /** [Method] Sets the value of html * @param html String/Ext.Element/HTMLElement */ - static setHtml( html?:any ): any; - static setHtml( html?:string ): void; - static setHtml( html?:Ext.IElement ): void; - static setHtml( html?:HTMLElement ): void; + static setHtml( html?:any ): void; /** [Method] Sets icon * @param iconCls String A CSS class name or empty string to clear the icon. + * @returns Ext.MessageBox this */ static setIcon( iconCls?:string ): Ext.IMessageBox; /** [Method] Sets the value of iconCls @@ -32117,9 +35547,7 @@ declare module Ext { /** [Method] Sets the value of left * @param left Number/String */ - static setLeft( left?:any ): any; - static setLeft( left?:number ): void; - static setLeft( left?:string ): void; + static setLeft( left?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -32127,9 +35555,7 @@ declare module Ext { /** [Method] Sets the value of margin * @param margin Number/String */ - static setMargin( margin?:any ): any; - static setMargin( margin?:number ): void; - static setMargin( margin?:string ): void; + static setMargin( margin?:any ): void; /** [Method] Sets the value of masked * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask */ @@ -32137,15 +35563,11 @@ declare module Ext { /** [Method] Sets the value of maxHeight * @param maxHeight Number/String */ - static setMaxHeight( maxHeight?:any ): any; - static setMaxHeight( maxHeight?:number ): void; - static setMaxHeight( maxHeight?:string ): void; + static setMaxHeight( maxHeight?:any ): void; /** [Method] Sets the value of maxWidth * @param maxWidth Number/String */ - static setMaxWidth( maxWidth?:any ): any; - static setMaxWidth( maxWidth?:number ): void; - static setMaxWidth( maxWidth?:string ): void; + static setMaxWidth( maxWidth?:any ): void; /** [Method] Sets the value of message * @param message String */ @@ -32153,21 +35575,15 @@ declare module Ext { /** [Method] Sets the value of minHeight * @param minHeight Number/String */ - static setMinHeight( minHeight?:any ): any; - static setMinHeight( minHeight?:number ): void; - static setMinHeight( minHeight?:string ): void; + static setMinHeight( minHeight?:any ): void; /** [Method] Sets the value of minWidth * @param minWidth Number/String */ - static setMinWidth( minWidth?:any ): any; - static setMinWidth( minWidth?:number ): void; - static setMinWidth( minWidth?:string ): void; + static setMinWidth( minWidth?:any ): void; /** [Method] Sets the value of padding * @param padding Number/String */ - static setPadding( padding?:any ): any; - static setPadding( padding?:number ): void; - static setPadding( padding?:string ): void; + static setPadding( padding?:any ): void; /** [Method] Sets the value of plugins * @param plugins Object/Array */ @@ -32187,9 +35603,7 @@ declare module Ext { /** [Method] Sets the value of right * @param right Number/String */ - static setRight( right?:any ): any; - static setRight( right?:number ): void; - static setRight( right?:string ): void; + static setRight( right?:any ): void; /** [Method] Sets the value of scrollable * @param scrollable Boolean/String/Object */ @@ -32230,17 +35644,11 @@ declare module Ext { /** [Method] Sets the value of top * @param top Number/String */ - static setTop( top?:any ): any; - static setTop( top?:number ): void; - static setTop( top?:string ): void; + static setTop( top?:any ): void; /** [Method] Sets the value of tpl * @param tpl String/String[]/Ext.Template[]/Ext.XTemplate[] */ - static setTpl( tpl?:any ): any; - static setTpl( tpl?:string ): void; - static setTpl( tpl?:string[] ): void; - static setTpl( tpl?:Ext.ITemplate[] ): void; - static setTpl( tpl?:Ext.IXTemplate[] ): void; + static setTpl( tpl?:any ): void; /** [Method] Sets the value of tplWriteMode * @param tplWriteMode String */ @@ -32252,15 +35660,14 @@ declare module Ext { /** [Method] Sets the value of width * @param width Number/String */ - static setWidth( width?:any ): any; - static setWidth( width?:number ): void; - static setWidth( width?:string ): void; + static setWidth( width?:any ): void; /** [Method] Sets the value of zIndex * @param zIndex Number */ static setZIndex( zIndex?:number ): void; /** [Method] Displays the Ext MessageBox with a specified configuration * @param config Object An object with the following config options: + * @returns Ext.MessageBox this */ static show( config?:any ): Ext.IMessageBox; /** [Method] Shows this component by another component @@ -32268,7 +35675,9 @@ declare module Ext { * @param alignment String The specific alignment. */ static showBy( component?:Ext.IComponent, alignment?: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] Suspends the firing of all events */ static suspendEvents(): void; @@ -32279,29 +35688,26 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Convenience method which calls setMasked with a value of false to hide the mask */ static unmask(): void; /** [Method] Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector * @param selector String The simple selector to test. + * @returns Ext.Container The matching ancestor Container (or undefined if no match was found). */ static up( selector?:string ): Ext.IContainer; /** [Method] Updates the HTML content of the Component */ @@ -32313,6 +35719,7 @@ declare module Ext { static updateStyleHtmlCls( newHtmlCls?:any, oldHtmlCls?:any ): void; /** [Method] Sets the value of message * @param message String + * @returns Ext.MessageBox this */ static updateText( message?:string ): Ext.IMessageBox; } @@ -32327,13 +35734,21 @@ declare module Ext.navigation { cls?: string; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of androidAnimation */ + /** [Method] Returns the value of androidAnimation + * @returns Boolean + */ getAndroidAnimation?(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Sets the value of androidAnimation * @param androidAnimation Boolean @@ -32365,27 +35780,43 @@ declare module Ext.navigation { navigationBar?: any; /** [Config Option] (Boolean) */ useTitleForBackButtonText?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultBackButtonText */ + /** [Method] Returns the value of defaultBackButtonText + * @returns String + */ getDefaultBackButtonText?(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ getItems?(): any; - /** [Method] Returns the value of navigationBar */ + /** [Method] Returns the value of navigationBar + * @returns Boolean/Object + */ getNavigationBar?(): any; - /** [Method] Returns the previous item if one exists */ + /** [Method] Returns the previous item if one exists + * @returns Mixed The previous view + */ getPreviousItem?(): any; - /** [Method] Returns the value of useTitleForBackButtonText */ + /** [Method] Returns the value of useTitleForBackButtonText + * @returns Boolean + */ getUseTitleForBackButtonText?(): boolean; /** [Method] Removes the current active view from the stack and sets the previous view using the default animation of this view * @param count Number The number of views you want to pop. + * @returns Ext.Component The new active item. */ pop?( count?:number ): Ext.IComponent; /** [Method] Pushes a new view into this navigation view using the default animation that this view has * @param view Object The view to push. + * @returns Ext.Component The new item you just pushed. */ push?( view?:any ): Ext.IComponent; - /** [Method] Resets the view by removing all items between the first and last item */ + /** [Method] Resets the view by removing all items between the first and last item + * @returns Ext.Component The view that is now active + */ reset?(): Ext.IComponent; /** [Method] Sets the value of baseCls * @param baseCls String @@ -32421,27 +35852,43 @@ declare module Ext { navigationBar?: any; /** [Config Option] (Boolean) */ useTitleForBackButtonText?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultBackButtonText */ + /** [Method] Returns the value of defaultBackButtonText + * @returns String + */ getDefaultBackButtonText?(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ getItems?(): any; - /** [Method] Returns the value of navigationBar */ + /** [Method] Returns the value of navigationBar + * @returns Boolean/Object + */ getNavigationBar?(): any; - /** [Method] Returns the previous item if one exists */ + /** [Method] Returns the previous item if one exists + * @returns Mixed The previous view + */ getPreviousItem?(): any; - /** [Method] Returns the value of useTitleForBackButtonText */ + /** [Method] Returns the value of useTitleForBackButtonText + * @returns Boolean + */ getUseTitleForBackButtonText?(): boolean; /** [Method] Removes the current active view from the stack and sets the previous view using the default animation of this view * @param count Number The number of views you want to pop. + * @returns Ext.Component The new active item. */ pop?( count?:number ): Ext.IComponent; /** [Method] Pushes a new view into this navigation view using the default animation that this view has * @param view Object The view to push. + * @returns Ext.Component The new item you just pushed. */ push?( view?:any ): Ext.IComponent; - /** [Method] Resets the view by removing all items between the first and last item */ + /** [Method] Resets the view by removing all items between the first and last item + * @returns Ext.Component The view that is now active + */ reset?(): Ext.IComponent; /** [Method] Sets the value of baseCls * @param baseCls String @@ -32473,11 +35920,13 @@ 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] 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] Snaps the passed number between stopping points based upon a passed increment value @@ -32485,6 +35934,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] Formats a number using fixed point notation @@ -32511,6 +35961,7 @@ declare module Ext { /** [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 @@ -32520,30 +35971,36 @@ 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 * @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] Merges any number of objects recursively without referencing them or their children * @param source Object The first object into which to merge the others. * @param objs Object... One or more objects to be merged into the first. + * @returns Object The object that is created as a result of merging all the objects passed in. */ static merge( source:any, ...objs:any[] ): any; /** [Method] Convert a name value pair to an array of objects with support for nested structures useful to construct query stri * @param name String * @param value Object * @param recursive Boolean true to recursively encode any sub-objects. + * @returns Object[] Array of objects with name and value fields. */ 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; } @@ -32554,34 +36011,39 @@ declare module Ext { export class Os { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] A hybrid property can be either accessed as a method call i e if Ext os is Android * @param value String The OS name to check. + * @returns Boolean */ static is( value?:string ): 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; } } @@ -32595,13 +36057,21 @@ declare module Ext { bodyMargin?: any; /** [Config Option] (Number/Boolean/String) */ bodyPadding?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bodyBorder */ + /** [Method] Returns the value of bodyBorder + * @returns Number/Boolean/String + */ getBodyBorder?(): any; - /** [Method] Returns the value of bodyMargin */ + /** [Method] Returns the value of bodyMargin + * @returns Number/Boolean/String + */ getBodyMargin?(): any; - /** [Method] Returns the value of bodyPadding */ + /** [Method] Returns the value of bodyPadding + * @returns Number/Boolean/String + */ getBodyPadding?(): any; /** [Method] Sets the value of baseCls * @param baseCls String @@ -32610,24 +36080,15 @@ declare module Ext { /** [Method] Sets the value of bodyBorder * @param bodyBorder Number/Boolean/String */ - setBodyBorder?( bodyBorder?:any ): any; - setBodyBorder?( bodyBorder?:number ): void; - setBodyBorder?( bodyBorder?:boolean ): void; - setBodyBorder?( bodyBorder?:string ): void; + setBodyBorder?( bodyBorder?:any ): void; /** [Method] Sets the value of bodyMargin * @param bodyMargin Number/Boolean/String */ - setBodyMargin?( bodyMargin?:any ): any; - setBodyMargin?( bodyMargin?:number ): void; - setBodyMargin?( bodyMargin?:boolean ): void; - setBodyMargin?( bodyMargin?:string ): void; + setBodyMargin?( bodyMargin?:any ): void; /** [Method] Sets the value of bodyPadding * @param bodyPadding Number/Boolean/String */ - setBodyPadding?( bodyPadding?:any ): any; - setBodyPadding?( bodyPadding?:number ): void; - setBodyPadding?( bodyPadding?:boolean ): void; - setBodyPadding?( bodyPadding?:string ): void; + setBodyPadding?( bodyPadding?:any ): void; } } declare module Ext.lib { @@ -32640,13 +36101,21 @@ declare module Ext.lib { bodyMargin?: any; /** [Config Option] (Number/Boolean/String) */ bodyPadding?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bodyBorder */ + /** [Method] Returns the value of bodyBorder + * @returns Number/Boolean/String + */ getBodyBorder?(): any; - /** [Method] Returns the value of bodyMargin */ + /** [Method] Returns the value of bodyMargin + * @returns Number/Boolean/String + */ getBodyMargin?(): any; - /** [Method] Returns the value of bodyPadding */ + /** [Method] Returns the value of bodyPadding + * @returns Number/Boolean/String + */ getBodyPadding?(): any; /** [Method] Sets the value of baseCls * @param baseCls String @@ -32655,24 +36124,15 @@ declare module Ext.lib { /** [Method] Sets the value of bodyBorder * @param bodyBorder Number/Boolean/String */ - setBodyBorder?( bodyBorder?:any ): any; - setBodyBorder?( bodyBorder?:number ): void; - setBodyBorder?( bodyBorder?:boolean ): void; - setBodyBorder?( bodyBorder?:string ): void; + setBodyBorder?( bodyBorder?:any ): void; /** [Method] Sets the value of bodyMargin * @param bodyMargin Number/Boolean/String */ - setBodyMargin?( bodyMargin?:any ): any; - setBodyMargin?( bodyMargin?:number ): void; - setBodyMargin?( bodyMargin?:boolean ): void; - setBodyMargin?( bodyMargin?:string ): void; + setBodyMargin?( bodyMargin?:any ): void; /** [Method] Sets the value of bodyPadding * @param bodyPadding Number/Boolean/String */ - setBodyPadding?( bodyPadding?:any ): any; - setBodyPadding?( bodyPadding?:number ): void; - setBodyPadding?( bodyPadding?:boolean ): void; - setBodyPadding?( bodyPadding?:string ): void; + setBodyPadding?( bodyPadding?:any ): void; } } declare module Ext.picker { @@ -32693,23 +36153,38 @@ declare module Ext.picker { yearText?: string; /** [Config Option] (Number) */ yearTo?: number; - /** [Method] Returns the value of dayText */ + /** [Method] Returns the value of dayText + * @returns String + */ getDayText?(): string; - /** [Method] Returns the value of doneButton */ + /** [Method] Returns the value of doneButton + * @returns String/Mixed + */ getDoneButton?(): any; - /** [Method] Returns the value of monthText */ + /** [Method] Returns the value of monthText + * @returns String + */ getMonthText?(): string; - /** [Method] Returns the value of slotOrder */ + /** [Method] Returns the value of slotOrder + * @returns Array + */ getSlotOrder?(): any[]; /** [Method] Returns the values of each of the pickers slots * @param useDom Object + * @returns Object The values of the pickers slots */ getValue?( useDom?:any ): any; - /** [Method] Returns the value of yearFrom */ + /** [Method] Returns the value of yearFrom + * @returns Number + */ getYearFrom?(): number; - /** [Method] Returns the value of yearText */ + /** [Method] Returns the value of yearText + * @returns String + */ getYearText?(): string; - /** [Method] Returns the value of yearTo */ + /** [Method] Returns the value of yearTo + * @returns Number + */ getYearTo?(): number; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -32720,8 +36195,7 @@ declare module Ext.picker { /** [Method] Sets the value of doneButton * @param doneButton String/Mixed */ - setDoneButton?( doneButton?:any ): any; - setDoneButton?( doneButton?:string ): void; + setDoneButton?( doneButton?:any ): void; /** [Method] Sets the value of monthText * @param monthText String */ @@ -32733,6 +36207,7 @@ declare module Ext.picker { /** [Method] Sets the values of the pickers slots * @param value Object * @param animated Object + * @returns Ext.Picker this This picker. */ setValue?( value?:any, animated?:any ): Ext.IPicker; /** [Method] Sets the value of yearFrom @@ -32785,23 +36260,38 @@ declare module Ext { yearText?: string; /** [Config Option] (Number) */ yearTo?: number; - /** [Method] Returns the value of dayText */ + /** [Method] Returns the value of dayText + * @returns String + */ getDayText?(): string; - /** [Method] Returns the value of doneButton */ + /** [Method] Returns the value of doneButton + * @returns String/Mixed + */ getDoneButton?(): any; - /** [Method] Returns the value of monthText */ + /** [Method] Returns the value of monthText + * @returns String + */ getMonthText?(): string; - /** [Method] Returns the value of slotOrder */ + /** [Method] Returns the value of slotOrder + * @returns Array + */ getSlotOrder?(): any[]; /** [Method] Returns the values of each of the pickers slots * @param useDom Object + * @returns Object The values of the pickers slots */ getValue?( useDom?:any ): any; - /** [Method] Returns the value of yearFrom */ + /** [Method] Returns the value of yearFrom + * @returns Number + */ getYearFrom?(): number; - /** [Method] Returns the value of yearText */ + /** [Method] Returns the value of yearText + * @returns String + */ getYearText?(): string; - /** [Method] Returns the value of yearTo */ + /** [Method] Returns the value of yearTo + * @returns Number + */ getYearTo?(): number; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -32812,8 +36302,7 @@ declare module Ext { /** [Method] Sets the value of doneButton * @param doneButton String/Mixed */ - setDoneButton?( doneButton?:any ): any; - setDoneButton?( doneButton?:string ): void; + setDoneButton?( doneButton?:any ): void; /** [Method] Sets the value of monthText * @param monthText String */ @@ -32825,6 +36314,7 @@ declare module Ext { /** [Method] Sets the values of the pickers slots * @param value Object * @param animated Object + * @returns Ext.Picker this This picker. */ setValue?( value?:any, animated?:any ): Ext.IPicker; /** [Method] Sets the value of yearFrom @@ -32889,39 +36379,64 @@ declare module Ext.picker { value?: any; /** [Method] Updates the cancelButton configuration * @param config Object + * @returns Object */ applyCancelButton?( config?:any ): any; /** [Method] Updates the doneButton configuration * @param config Object + * @returns Object */ applyDoneButton?( config?:any ): any; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns Number + */ getBottom?(): number; - /** [Method] Returns the value of cancelButton */ + /** [Method] Returns the value of cancelButton + * @returns String/Mixed + */ getCancelButton?(): any; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ getCard?(): any; - /** [Method] Returns the value of doneButton */ + /** [Method] Returns the value of doneButton + * @returns String/Mixed + */ getDoneButton?(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of slots */ + /** [Method] Returns the value of slots + * @returns Array + */ getSlots?(): any[]; - /** [Method] Returns the value of toolbar */ + /** [Method] Returns the value of toolbar + * @returns Ext.TitleBar/Ext.Toolbar/Object + */ getToolbar?(): any; - /** [Method] Returns the value of toolbarPosition */ + /** [Method] Returns the value of toolbarPosition + * @returns String + */ getToolbarPosition?(): string; - /** [Method] Returns the value of useTitles */ + /** [Method] Returns the value of useTitles + * @returns Boolean + */ getUseTitles?(): boolean; /** [Method] Returns the values of each of the pickers slots * @param useDom Object + * @returns Object The values of the pickers slots */ getValue?( useDom?:any ): any; - /** [Method] Returns the values of each of the pickers slots */ + /** [Method] Returns the values of each of the pickers slots + * @returns Object The values of the pickers slots. + */ getValues?(): any; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -32936,8 +36451,7 @@ declare module Ext.picker { /** [Method] Sets the value of cancelButton * @param cancelButton String/Mixed */ - setCancelButton?( cancelButton?:any ): any; - setCancelButton?( cancelButton?:string ): void; + setCancelButton?( cancelButton?:any ): void; /** [Method] Sets the value of activeItem * @param activeItem Object/String/Number */ @@ -32945,8 +36459,7 @@ declare module Ext.picker { /** [Method] Sets the value of doneButton * @param doneButton String/Mixed */ - setDoneButton?( doneButton?:any ): any; - setDoneButton?( doneButton?:string ): void; + setDoneButton?( doneButton?:any ): void; /** [Method] Sets the value of height * @param height Number */ @@ -32982,9 +36495,12 @@ declare module Ext.picker { /** [Method] Sets the values of the pickers slots * @param values Object The values in a {name:'value'} format. * @param animated Boolean true to animate setting the values. + * @returns Ext.Picker this This picker. */ setValue?( values?:any, animated?:boolean ): Ext.IPicker; - /** [Method] Shows this component */ + /** [Method] Shows this component + * @returns Ext.Component + */ show?(): Ext.IComponent; } } @@ -33018,39 +36534,64 @@ declare module Ext { value?: any; /** [Method] Updates the cancelButton configuration * @param config Object + * @returns Object */ applyCancelButton?( config?:any ): any; /** [Method] Updates the doneButton configuration * @param config Object + * @returns Object */ applyDoneButton?( config?:any ): any; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns Number + */ getBottom?(): number; - /** [Method] Returns the value of cancelButton */ + /** [Method] Returns the value of cancelButton + * @returns String/Mixed + */ getCancelButton?(): any; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ getCard?(): any; - /** [Method] Returns the value of doneButton */ + /** [Method] Returns the value of doneButton + * @returns String/Mixed + */ getDoneButton?(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of slots */ + /** [Method] Returns the value of slots + * @returns Array + */ getSlots?(): any[]; - /** [Method] Returns the value of toolbar */ + /** [Method] Returns the value of toolbar + * @returns Ext.TitleBar/Ext.Toolbar/Object + */ getToolbar?(): any; - /** [Method] Returns the value of toolbarPosition */ + /** [Method] Returns the value of toolbarPosition + * @returns String + */ getToolbarPosition?(): string; - /** [Method] Returns the value of useTitles */ + /** [Method] Returns the value of useTitles + * @returns Boolean + */ getUseTitles?(): boolean; /** [Method] Returns the values of each of the pickers slots * @param useDom Object + * @returns Object The values of the pickers slots */ getValue?( useDom?:any ): any; - /** [Method] Returns the values of each of the pickers slots */ + /** [Method] Returns the values of each of the pickers slots + * @returns Object The values of the pickers slots. + */ getValues?(): any; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -33065,8 +36606,7 @@ declare module Ext { /** [Method] Sets the value of cancelButton * @param cancelButton String/Mixed */ - setCancelButton?( cancelButton?:any ): any; - setCancelButton?( cancelButton?:string ): void; + setCancelButton?( cancelButton?:any ): void; /** [Method] Sets the value of activeItem * @param activeItem Object/String/Number */ @@ -33074,8 +36614,7 @@ declare module Ext { /** [Method] Sets the value of doneButton * @param doneButton String/Mixed */ - setDoneButton?( doneButton?:any ): any; - setDoneButton?( doneButton?:string ): void; + setDoneButton?( doneButton?:any ): void; /** [Method] Sets the value of height * @param height Number */ @@ -33111,9 +36650,12 @@ declare module Ext { /** [Method] Sets the values of the pickers slots * @param values Object The values in a {name:'value'} format. * @param animated Boolean true to animate setting the values. + * @returns Ext.Picker this This picker. */ setValue?( values?:any, animated?:boolean ): Ext.IPicker; - /** [Method] Shows this component */ + /** [Method] Shows this component + * @returns Ext.Component + */ show?(): Ext.IComponent; } } @@ -33135,21 +36677,33 @@ declare module Ext.picker { valueField?: string; /** [Method] Looks at the data configuration and turns it into store * @param data Object + * @returns Object */ applyData?( data?:any ): any; /** [Method] Sets the title for this dataview by creating element * @param title String + * @returns String */ applyTitle?( title?:string ): string; - /** [Method] Returns the value of align */ + /** [Method] Returns the value of align + * @returns String + */ getAlign?(): string; - /** [Method] Returns the value of displayField */ + /** [Method] Returns the value of displayField + * @returns String + */ getDisplayField?(): string; - /** [Method] Returns the value of name */ + /** [Method] Returns the value of name + * @returns String + */ getName?(): string; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; - /** [Method] Returns the value of valueField */ + /** [Method] Returns the value of valueField + * @returns String + */ getValueField?(): string; /** [Method] Sets the value of align * @param align String @@ -33190,11 +36744,17 @@ declare module Ext.plugin { loadMoreText?: string; /** [Config Option] (String) */ noMoreRecordsText?: string; - /** [Method] Returns the value of autoPaging */ + /** [Method] Returns the value of autoPaging + * @returns Boolean + */ getAutoPaging?(): boolean; - /** [Method] Returns the value of loadMoreText */ + /** [Method] Returns the value of loadMoreText + * @returns String + */ getLoadMoreText?(): string; - /** [Method] Returns the value of noMoreRecordsText */ + /** [Method] Returns the value of noMoreRecordsText + * @returns String + */ getNoMoreRecordsText?(): string; /** [Method] Sets the value of autoPaging * @param autoPaging Boolean @@ -33234,29 +36794,53 @@ declare module Ext.plugin { releaseRefreshText?: string; /** [Config Option] (Number) */ snappingAnimationDuration?: number; - /** [Method] Returns the value of autoSnapBack */ + /** [Method] Returns the value of autoSnapBack + * @returns Boolean + */ getAutoSnapBack?(): boolean; - /** [Method] Returns the value of lastUpdatedDateFormat */ + /** [Method] Returns the value of lastUpdatedDateFormat + * @returns String + */ getLastUpdatedDateFormat?(): string; - /** [Method] Returns the value of lastUpdatedText */ + /** [Method] Returns the value of lastUpdatedText + * @returns String + */ getLastUpdatedText?(): string; - /** [Method] Returns the value of list */ + /** [Method] Returns the value of list + * @returns Ext.dataview.List + */ getList?(): Ext.dataview.IList; - /** [Method] Returns the value of loadedText */ + /** [Method] Returns the value of loadedText + * @returns String + */ getLoadedText?(): string; - /** [Method] Returns the value of loadingText */ + /** [Method] Returns the value of loadingText + * @returns String + */ getLoadingText?(): string; - /** [Method] Returns the value of overpullSnapBackDuration */ + /** [Method] Returns the value of overpullSnapBackDuration + * @returns Number + */ getOverpullSnapBackDuration?(): number; - /** [Method] Returns the value of pullRefreshText */ + /** [Method] Returns the value of pullRefreshText + * @returns String + */ getPullRefreshText?(): string; - /** [Method] Returns the value of pullTpl */ + /** [Method] Returns the value of pullTpl + * @returns Ext.XTemplate/String/Array + */ getPullTpl?(): any; - /** [Method] Returns the value of releaseRefreshText */ + /** [Method] Returns the value of releaseRefreshText + * @returns String + */ getReleaseRefreshText?(): string; - /** [Method] Returns the value of snappingAnimationDuration */ + /** [Method] Returns the value of snappingAnimationDuration + * @returns Number + */ getSnappingAnimationDuration?(): number; - /** [Method] Returns the value of translatable */ + /** [Method] Returns the value of translatable + * @returns Boolean + */ getTranslatable?(): boolean; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -33295,10 +36879,7 @@ declare module Ext.plugin { /** [Method] Sets the value of pullTpl * @param pullTpl Ext.XTemplate/String/Array */ - setPullTpl?( pullTpl?:any ): any; - setPullTpl?( pullTpl?:Ext.IXTemplate ): void; - setPullTpl?( pullTpl?:string ): void; - setPullTpl?( pullTpl?:any[] ): void; + setPullTpl?( pullTpl?:any ): void; /** [Method] Sets the value of releaseRefreshText * @param releaseRefreshText String */ @@ -33331,25 +36912,45 @@ declare module Ext.scroll.indicator { hidden?: boolean; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of active */ + /** [Method] Returns the value of active + * @returns Boolean + */ getActive?(): boolean; - /** [Method] Returns the value of axis */ + /** [Method] Returns the value of axis + * @returns String + */ getAxis?(): string; - /** [Method] Returns the value of barCls */ + /** [Method] Returns the value of barCls + * @returns String + */ getBarCls?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ getHidden?(): boolean; - /** [Method] Returns the value of length */ + /** [Method] Returns the value of length + * @returns Object + */ getLength?(): any; - /** [Method] Returns the value of minLength */ + /** [Method] Returns the value of minLength + * @returns Number + */ getMinLength?(): number; - /** [Method] Returns the value of ratio */ + /** [Method] Returns the value of ratio + * @returns Number + */ getRatio?(): number; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Object + */ getValue?(): any; /** [Method] Sets the value of active * @param active Boolean @@ -33397,7 +36998,9 @@ declare module Ext.scroll.indicator { export interface ICssTransform extends Ext.scroll.indicator.IAbstract { /** [Config Option] (String/String[]) */ cls?: any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; /** [Method] Sets the value of cls * @param cls String @@ -33417,7 +37020,9 @@ declare module Ext.scroll.indicator { export interface IRounded extends Ext.scroll.indicator.IAbstract { /** [Config Option] (String/String[]) */ cls?: any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; /** [Method] Sets the value of cls * @param cls String @@ -33429,7 +37034,9 @@ declare module Ext.scroll.indicator { export interface IScrollPosition extends Ext.scroll.indicator.IAbstract { /** [Config Option] (String/String[]) */ cls?: any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; /** [Method] Sets the value of cls * @param cls String @@ -33457,40 +37064,60 @@ declare module Ext.scroll { slotSnapSize?: any; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of directionLock */ + /** [Method] Returns the value of directionLock + * @returns Boolean + */ getDirectionLock?(): boolean; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ getDisabled?(): boolean; - /** [Method] Returns the value of initialOffset */ + /** [Method] Returns the value of initialOffset + * @returns Object/Number + */ getInitialOffset?(): any; - /** [Method] Returns the value of momentumEasing */ + /** [Method] Returns the value of momentumEasing + * @returns Object + */ getMomentumEasing?(): any; - /** [Method] Returns the value of slotSnapEasing */ + /** [Method] Returns the value of slotSnapEasing + * @returns Object + */ getSlotSnapEasing?(): any; - /** [Method] Returns the value of slotSnapSize */ + /** [Method] Returns the value of slotSnapSize + * @returns Number/Object + */ getSlotSnapSize?(): any; - /** [Method] Returns the value of translatable */ + /** [Method] Returns the value of translatable + * @returns Object + */ getTranslatable?(): any; /** [Method] Returns true if a specified axis is enabled * @param axis String The axis to check (x or y). + * @returns Boolean true if the axis is enabled. */ isAxisEnabled?( axis?:string ): boolean; /** [Method] Change the scroll offset by the given amount * @param x Number The offset to scroll by on the x axis. * @param y Number The offset to scroll by on the y axis. * @param animation Boolean/Object Whether or not to animate the scrolling to the new position. + * @returns Ext.scroll.Scroller this */ scrollBy?( x?:number, y?:number, animation?:any ): Ext.scroll.IScroller; /** [Method] Scrolls to the given location * @param x Number The scroll position on the x axis. * @param y Number The scroll position on the y axis. * @param animation Boolean/Object Whether or not to animate the scrolling to the new position. + * @returns Ext.scroll.Scroller this */ scrollTo?( x?:number, y?:number, animation?:any ): Ext.scroll.IScroller; /** [Method] Scrolls to the end of the scrollable view * @param animation Object + * @returns Ext.scroll.Scroller this */ scrollToEnd?( animation?:any ): Ext.scroll.IScroller; /** [Method] Sets the value of direction @@ -33515,6 +37142,7 @@ declare module Ext.scroll { setMomentumEasing?( momentumEasing?:any ): void; /** [Method] Sets the offset of this scroller * @param offset Object The offset to move to. + * @returns Ext.scroll.Scroller this */ setOffset?( offset?:any ): Ext.scroll.IScroller; /** [Method] Sets the value of slotSnapEasing @@ -33529,7 +37157,9 @@ declare module Ext.scroll { * @param translatable Object */ setTranslatable?( translatable?:any ): void; - /** [Method] Updates the boundary information for this scroller */ + /** [Method] Updates the boundary information for this scroller + * @returns Ext.scroll.Scroller this + */ updateBoundary?(): Ext.scroll.IScroller; } } @@ -33539,17 +37169,29 @@ declare module Ext.scroll { indicatorsUi?: string; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of indicators */ + /** [Method] Returns the value of indicators + * @returns Object + */ getIndicators?(): any; - /** [Method] Returns the value of indicatorsHidingDelay */ + /** [Method] Returns the value of indicatorsHidingDelay + * @returns Number + */ getIndicatorsHidingDelay?(): number; - /** [Method] Returns the value of indicatorsUi */ + /** [Method] Returns the value of indicatorsUi + * @returns String + */ getIndicatorsUi?(): string; - /** [Method] Returns the scroller instance in this view */ + /** [Method] Returns the scroller instance in this view + * @returns Ext.scroll.View The scroller + */ getScroller?(): Ext.scroll.IView; /** [Method] Sets the value of cls * @param cls String @@ -33583,17 +37225,29 @@ declare module Ext.util { indicatorsUi?: string; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of indicators */ + /** [Method] Returns the value of indicators + * @returns Object + */ getIndicators?(): any; - /** [Method] Returns the value of indicatorsHidingDelay */ + /** [Method] Returns the value of indicatorsHidingDelay + * @returns Number + */ getIndicatorsHidingDelay?(): number; - /** [Method] Returns the value of indicatorsUi */ + /** [Method] Returns the value of indicatorsUi + * @returns String + */ getIndicatorsUi?(): string; - /** [Method] Returns the scroller instance in this view */ + /** [Method] Returns the scroller instance in this view + * @returns Ext.scroll.View The scroller + */ getScroller?(): Ext.scroll.IView; /** [Method] Sets the value of cls * @param cls String @@ -33641,26 +37295,43 @@ declare module Ext { pressedCls?: string; /** [Method] We override initItems so we can check for the pressed config */ applyItems?(): void; - /** [Method] Returns the value of allowDepress */ + /** [Method] Returns the value of allowDepress + * @returns Boolean + */ getAllowDepress?(): boolean; - /** [Method] Returns the value of allowMultiple */ + /** [Method] Returns the value of allowMultiple + * @returns Boolean + */ getAllowMultiple?(): boolean; - /** [Method] Returns the value of allowToggle */ + /** [Method] Returns the value of allowToggle + * @returns Boolean + */ getAllowToggle?(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; /** [Method] Gets the currently pressed button s */ getPressed?(): void; - /** [Method] Returns the value of pressedButtons */ + /** [Method] Returns the value of pressedButtons + * @returns Array + */ getPressedButtons?(): any[]; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; /** [Method] Returns true if a specified Ext Button is pressed * @param button Ext.Button The button to check if pressed. + * @returns Boolean pressed */ isPressed?( button?:Ext.IButton ): boolean; /** [Method] Sets the value of allowDepress @@ -33692,10 +37363,7 @@ declare module Ext { * @param pressed Boolean If defined, sets the pressed state of the button, otherwise the pressed state is toggled. * @param suppressEvents Boolean true to suppress toggle events during the action. If allowMultiple is true, then setPressed will toggle the button state. */ - setPressed?( button?:any, pressed?:any, suppressEvents?:any ): any; - setPressed?( button?:number, pressed?:boolean, suppressEvents?:boolean ): void; - setPressed?( button?:string, pressed?:boolean, suppressEvents?:boolean ): void; - setPressed?( button?:Ext.IButton, pressed?:boolean, suppressEvents?:boolean ): void; + setPressed?( button?:any, pressed?:boolean, suppressEvents?:boolean ): void; /** [Method] Sets the value of pressedButtons * @param pressedButtons Array */ @@ -33726,19 +37394,33 @@ declare module Ext { stretchX?: boolean; /** [Config Option] (Boolean) */ stretchY?: boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of centered */ + /** [Method] Returns the value of centered + * @returns Boolean + */ getCentered?(): boolean; - /** [Method] Returns the value of enter */ + /** [Method] Returns the value of enter + * @returns String + */ getEnter?(): string; - /** [Method] Returns the value of exit */ + /** [Method] Returns the value of exit + * @returns String + */ getExit?(): string; - /** [Method] Returns the value of modal */ + /** [Method] Returns the value of modal + * @returns Boolean + */ getModal?(): boolean; - /** [Method] Returns the value of stretchX */ + /** [Method] Returns the value of stretchX + * @returns Boolean + */ getStretchX?(): boolean; - /** [Method] Returns the value of stretchY */ + /** [Method] Returns the value of stretchY + * @returns Boolean + */ getStretchY?(): boolean; /** [Method] Sets the value of baseCls * @param baseCls String @@ -33804,33 +37486,57 @@ declare module Ext.slider { values?: any; /** [Method] Sets the increment configuration * @param increment Number + * @returns Number */ applyIncrement?( increment?:number ): number; - /** [Method] Returns the value of allowThumbsOverlapping */ + /** [Method] Returns the value of allowThumbsOverlapping + * @returns Boolean + */ getAllowThumbsOverlapping?(): boolean; - /** [Method] Returns the value of animation */ + /** [Method] Returns the value of animation + * @returns Boolean/Object + */ getAnimation?(): any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of increment */ + /** [Method] Returns the value of increment + * @returns Number + */ getIncrement?(): number; - /** [Method] Returns the value of maxValue */ + /** [Method] Returns the value of maxValue + * @returns Number + */ getMaxValue?(): number; - /** [Method] Returns the value of minValue */ + /** [Method] Returns the value of minValue + * @returns Number + */ getMinValue?(): number; - /** [Method] Returns the value of readOnly */ + /** [Method] Returns the value of readOnly + * @returns Boolean + */ getReadOnly?(): boolean; /** [Method] Returns the Thumb instance bound to this Slider * @param index Number The index of Thumb to return. + * @returns Ext.slider.Thumb The thumb instance */ getThumb?( index?:number ): Ext.slider.IThumb; - /** [Method] Returns the value of thumbConfig */ + /** [Method] Returns the value of thumbConfig + * @returns Object + */ getThumbConfig?(): any; - /** [Method] Returns the Thumb instances bound to this Slider */ + /** [Method] Returns the Thumb instances bound to this Slider + * @returns Ext.slider.Thumb[] The thumb instances + */ getThumbs?(): Ext.slider.IThumb[]; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns Number/Number[] + */ getValue?(): any; - /** [Method] Convenience method */ + /** [Method] Convenience method + * @returns Object + */ getValues?(): any; /** [Method] Sets the value of allowThumbsOverlapping * @param allowThumbsOverlapping Boolean @@ -33867,9 +37573,7 @@ declare module Ext.slider { /** [Method] Sets the value of value * @param value Number/Number[] */ - setValue?( value?:any ): any; - setValue?( value?:number ): void; - setValue?( value?:number[] ): void; + setValue?( value?:any ): void; /** [Method] Convenience method * @param value Object */ @@ -33887,9 +37591,13 @@ declare module Ext.slider { baseCls?: string; /** [Config Option] (Object) */ draggable?: any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of draggable */ + /** [Method] Returns the value of draggable + * @returns Object + */ getDraggable?(): any; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -33911,13 +37619,21 @@ declare module Ext.slider { maxValueCls?: string; /** [Config Option] (String) */ minValueCls?: string; - /** [Method] Sets the increment configuration */ + /** [Method] Sets the increment configuration + * @returns Number + */ applyIncrement?(): number; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of maxValueCls */ + /** [Method] Returns the value of maxValueCls + * @returns String + */ getMaxValueCls?(): string; - /** [Method] Returns the value of minValueCls */ + /** [Method] Returns the value of minValueCls + * @returns String + */ getMinValueCls?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -33944,7 +37660,9 @@ declare module Ext { flex?: number; /** [Config Option] (Number) */ width?: number; - /** [Method] Returns the value of flex */ + /** [Method] Returns the value of flex + * @returns Number + */ getFlex?(): number; /** [Method] Sets the value of flex * @param flex Number @@ -33962,39 +37680,47 @@ declare module Ext { export class String { /** [Method] Capitalize the given string * @param string String + * @returns String */ static capitalize( string?: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] 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 String... First param value to replace token {0}, then next param to replace {1} etc. + * @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 pages * @param value String The string to encode. + * @returns String The encoded text. */ static htmlEncode( value?:string ): 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 (defaults to empty 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 @@ -34007,15 +37733,18 @@ 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 escape + * @returns String The trimmed string */ static trim( 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; } @@ -34040,19 +37769,20 @@ declare module Ext.tab { activeTab?: any; /** [Config Option] (String) */ baseCls?: string; - /** [Method] Returns the value of activeTab */ + /** [Method] Returns the value of activeTab + * @returns Number/String/Ext.Component + */ getActiveTab?(): any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; /** [Method] Sets the value of activeTab * @param activeTab Number/String/Ext.Component */ - setActiveTab?( activeTab?:any ): any; - setActiveTab?( activeTab?:number ): void; - setActiveTab?( activeTab?:string ): void; - setActiveTab?( activeTab?:Ext.IComponent ): void; + setActiveTab?( activeTab?:any ): void; /** [Method] Sets the value of baseCls * @param baseCls String */ @@ -34065,19 +37795,20 @@ declare module Ext { activeTab?: any; /** [Config Option] (String) */ baseCls?: string; - /** [Method] Returns the value of activeTab */ + /** [Method] Returns the value of activeTab + * @returns Number/String/Ext.Component + */ getActiveTab?(): any; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; /** [Method] Sets the value of activeTab * @param activeTab Number/String/Ext.Component */ - setActiveTab?( activeTab?:any ): any; - setActiveTab?( activeTab?:number ): void; - setActiveTab?( activeTab?:string ): void; - setActiveTab?( activeTab?:Ext.IComponent ): void; + setActiveTab?( activeTab?:any ): void; /** [Method] Sets the value of baseCls * @param baseCls String */ @@ -34101,17 +37832,28 @@ declare module Ext.tab { /** [Method] Updates this container with the new active item * @param tabBar Object * @param newTab Object + * @returns Boolean */ doTabChange?( tabBar?:any, newTab?:any ): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of tabBar */ + /** [Method] Returns the value of tabBar + * @returns Object + */ getTabBar?(): any; - /** [Method] Returns the value of tabBarPosition */ + /** [Method] Returns the value of tabBarPosition + * @returns String + */ getTabBarPosition?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -34159,17 +37901,28 @@ declare module Ext { /** [Method] Updates this container with the new active item * @param tabBar Object * @param newTab Object + * @returns Boolean */ doTabChange?( tabBar?:any, newTab?:any ): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object + */ getLayout?(): any; - /** [Method] Returns the value of tabBar */ + /** [Method] Returns the value of tabBar + * @returns Object + */ getTabBar?(): any; - /** [Method] Returns the value of tabBarPosition */ + /** [Method] Returns the value of tabBarPosition + * @returns String + */ getTabBarPosition?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -34212,15 +37965,25 @@ declare module Ext.tab { pressedCls?: string; /** [Config Option] (String) */ title?: string; - /** [Method] Returns the value of active */ + /** [Method] Returns the value of active + * @returns Boolean + */ getActive?(): boolean; - /** [Method] Returns the value of activeCls */ + /** [Method] Returns the value of activeCls + * @returns String + */ getActiveCls?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Sets the value of active * @param active Boolean @@ -34256,15 +38019,25 @@ declare module Ext { pressedCls?: string; /** [Config Option] (String) */ title?: string; - /** [Method] Returns the value of active */ + /** [Method] Returns the value of active + * @returns Boolean + */ getActive?(): boolean; - /** [Method] Returns the value of activeCls */ + /** [Method] Returns the value of activeCls + * @returns String + */ getActiveCls?(): string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of pressedCls */ + /** [Method] Returns the value of pressedCls + * @returns String + */ getPressedCls?(): string; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Sets the value of active * @param active Boolean @@ -34294,30 +38067,34 @@ declare module Ext { export class TaskQueue { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] */ static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?: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; } } @@ -34333,65 +38110,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 ): any; - append?( el?:HTMLElement, values?:any, returnElement?:boolean ): any; - append?( el?:Ext.IElement, values?:any, returnElement?:boolean ): any; + 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 ): any; - insertAfter?( el?:HTMLElement, values?:any, returnElement?:boolean ): any; - insertAfter?( el?:Ext.IElement, values?:any, returnElement?:boolean ): any; + 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 an 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 ): any; - insertBefore?( el?:HTMLElement, values?:any, returnElement?:boolean ): any; - insertBefore?( el?:Ext.IElement, values?:any, returnElement?:boolean ): any; + 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 ): any; - insertFirst?( el?:HTMLElement, values?:any, returnElement?:boolean ): any; - insertFirst?( el?:Ext.IElement, values?:any, returnElement?:boolean ): any; + 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 ): any; - overwrite?( el?:HTMLElement, values?:any, returnElement?:boolean ): any; - overwrite?( el?:Ext.IElement, values?:any, returnElement?:boolean ): any; + 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; } @@ -34402,13 +38175,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] * @param args Object */ static callParent( args?: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 @@ -34418,14 +38194,16 @@ 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] 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; } @@ -34436,9 +38214,13 @@ declare module Ext { baseCls?: string; /** [Config Option] (String) */ title?: string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; /** [Method] Sets the value of baseCls * @param baseCls String @@ -34466,17 +38248,29 @@ declare module Ext { title?: string; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ getItems?(): any; - /** [Method] Returns the value of title */ + /** [Method] Returns the value of title + * @returns String + */ getTitle?(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -34528,17 +38322,29 @@ declare module Ext { titleCls?: boolean; /** [Config Option] (String) */ ui?: string; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ getDefaultType?(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ getDocked?(): string; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object/String + */ getLayout?(): any; - /** [Method] Returns an Ext Title component */ + /** [Method] Returns an Ext Title component + * @returns Ext.Title + */ getTitle?(): Ext.ITitle; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ getUi?(): string; /** [Method] Hides the title if it exists */ hideTitle?(): void; @@ -34565,9 +38371,7 @@ declare module Ext { /** [Method] Use this to update the title configuration * @param title String/Ext.Title You can either pass a String, or a config/instance of Ext.Title. */ - setTitle?( title?:any ): any; - setTitle?( title?:string ): void; - setTitle?( title?:Ext.ITitle ): void; + setTitle?( title?:any ): void; /** [Method] Sets the value of ui * @param ui String */ @@ -34583,6 +38387,7 @@ declare module Ext.util { /** [Method] Adds an item to the collection * @param key String 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?:string, obj?:any ): any; /** [Method] Appends an after event handler @@ -34591,8 +38396,7 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds all elements of an Array or an Object to the collection * @param objs Object/Array An Object containing properties which will be added to the collection, or an Array of values, each of which are added to the collection. Functions references will be added to the collection if allowFunctions has been set to true. */ @@ -34603,8 +38407,7 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -34616,9 +38419,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -34626,27 +38427,30 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all items from the collection */ clear?(): void; /** [Method] Removes all listeners for this object */ clearListeners?(): 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 Optional '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 allowNull Boolean Pass true to allow null, undefined, or empty string values. + * @returns Array The unique values. */ collect?( property?:string, root?:string, allowNull?: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] */ @@ -34664,28 +38468,25 @@ declare module Ext.util { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?: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, it will receive the args o (the object), k (the key) * @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 * @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. */ findBy?( fn?:any, scope?:any ): any; /** [Method] Finds the index of the first matching object in this collection by a specific property value @@ -34694,14 +38495,14 @@ 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, it will receive the args o (the object), k (the key). * @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 and execute a function action at the end if there are no liste @@ -34709,65 +38510,82 @@ declare module Ext.util { * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( 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 value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): 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] MixedCollection has a generic way to fetch keys if you implement getKey * @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 the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Returns a range of items in this collection * @param start Number The starting index. * @param end Number The ending index. + * @returns Array An array of items */ getRange?( start?:number, end?:number ): any[]; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, 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 The 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 The key to associate with the new item, or the item itself. * @param obj Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ insert?( index?:number, key?:string, obj?: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] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -34776,18 +38594,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -34795,32 +38609,30 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [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] Removes a before event handler @@ -34829,18 +38641,20 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Remove all items in the passed array from 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/Boolean The item removed or false if no item was removed. */ removeAt?( index?:number ): any; /** [Method] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ removeAtKey?( key?:string ): any; /** [Method] Removes a before event handler @@ -34849,8 +38663,7 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -34858,21 +38671,18 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [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 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 events see suspendEvents @@ -34882,9 +38692,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -34894,6 +38702,7 @@ declare module Ext.util { * @param root String Optional '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 the firing of all events */ @@ -34905,25 +38714,21 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util { @@ -34947,6 +38752,7 @@ declare module Ext.util { /** [Method] Adds an item to the collection * @param key String 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 item Object The item to add. + * @returns Object The item added. */ add?( key?:string, item?:any ): any; /** [Method] Adds all elements of an Array or an Object to the collection @@ -34959,6 +38765,7 @@ declare module Ext.util { addFilter?( filter?:any ): void; /** [Method] This method adds all the filters in a passed array * @param filters Object + * @returns Object */ addFilters?( filters?:any ): any; /** [Method] This method adds a sorter @@ -34973,14 +38780,18 @@ declare module Ext.util { addSorters?( sorters?:any[], defaultDirection?:string ): void; /** [Method] Removes all items from the collection */ clear?(): 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] Returns true if the collection contains the passed Object as an item * @param item Object The Object to look for in the collection. + * @returns Boolean true if the collection contains the Object as an item. */ contains?( item?: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] */ @@ -35000,98 +38811,131 @@ declare module Ext.util { * @param value Object * @param anyMatch Object * @param caseSensitive Object + * @returns Array */ filter?( property?:any, value?:any, anyMatch?:any, caseSensitive?:any ): any[]; /** [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 * @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. */ findBy?( fn?:any, scope?:any ): any; /** [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 if the item was not found. */ findIndexBy?( fn?:any, scope?:any, start?:number ): number; /** [Method] This method returns the index that a given item would be inserted into a given array based on the current sorters * @param items Array The array that you want to insert the item into. * @param item Mixed The item that you want to insert into the items array. + * @returns Number The index for the given item in the given array based on the current sorters. */ findInsertionIndex?( items?:any[], item?:any ): number; - /** [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 value of autoFilter */ + /** [Method] Returns the value of autoFilter + * @returns Boolean + */ getAutoFilter?(): boolean; - /** [Method] Returns the value of autoSort */ + /** [Method] Returns the value of autoSort + * @returns Boolean + */ getAutoSort?(): boolean; /** [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] Returns the value of defaultSortDirection */ + /** [Method] Returns the value of defaultSortDirection + * @returns String + */ getDefaultSortDirection?(): string; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function sortFn The sort function. + */ getFilterFn?(): any; - /** [Method] Returns the value of filterRoot */ + /** [Method] Returns the value of filterRoot + * @returns String + */ getFilterRoot?(): string; - /** [Method] Returns the value of filters */ + /** [Method] Returns the value of filters + * @returns Array + */ getFilters?(): any[]; /** [Method] MixedCollection has a generic way to fetch keys if you implement getKey * @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 start Number The starting index. * @param end Number The ending index. Defaults to the last item. + * @returns Array An array of items. */ getRange?( start?:number, end?:number ): any[]; - /** [Method] Returns an up to date sort function */ + /** [Method] Returns an up to date sort function + * @returns Function The sort function. + */ getSortFn?(): any; - /** [Method] Returns the value of sortRoot */ + /** [Method] Returns the value of sortRoot + * @returns String + */ getSortRoot?(): string; - /** [Method] Returns the value of sorters */ + /** [Method] Returns the value of sorters + * @returns Array + */ getSorters?(): any[]; /** [Method] Returns index within the collection of the passed Object * @param item Object The item to find the index of. + * @returns Number Index of the item. Returns -1 if not found. */ indexOf?( item?: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 The key to associate with the new item, or the item itself. * @param item Object If the second parameter was a key, the new item. + * @returns Object The item inserted. */ insert?( index?:number, key?:string, item?:any ): any; /** [Method] This method adds a filter at a given index * @param index Number The index at which to insert the filter. * @param filter Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Object */ insertFilter?( index?:number, filter?:any ): any; /** [Method] This method inserts all the filters in the passed array at the given index * @param index Number The index at which to insert the filters. * @param filters Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function. + * @returns Array */ insertFilters?( index?:number, filters?:any[] ): any[]; /** [Method] This method adds a sorter at a given index @@ -35100,28 +38944,37 @@ declare module Ext.util { * @param defaultDirection String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'. */ insertSorter?( index?:number, sorter?:any, defaultDirection?:string ): void; - /** [Method] This method inserts all the sorters in the passed array at the given index */ + /** [Method] This method inserts all the sorters in the passed array at the given index + * @returns Ext.util.Collection this + */ insertSorters?(): Ext.util.ICollection; - /** [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] Remove an item from the collection * @param item Object The item to remove. + * @returns Object The item removed or false if no item was removed. */ remove?( item?:any ): any; /** [Method] Remove all items in the passed array from 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] Removed an item associated with the passed key from the collection * @param key String The key of the item to remove. + * @returns Object/Boolean The item removed or false if no item was removed. */ removeAtKey?( key?:string ): any; /** [Method] This method removes all the filters in a passed array * @param filters Object + * @returns Ext.util.Collection this */ removeFilters?( filters?:any ): Ext.util.ICollection; /** [Method] This method removes a sorter @@ -35130,11 +38983,13 @@ declare module Ext.util { removeSorter?( sorter?:any ): void; /** [Method] This method removes all the sorters in a passed array * @param sorters Object + * @returns Ext.util.Collection this */ removeSorters?( sorters?:any ): Ext.util.ICollection; /** [Method] Replaces an item in the collection * @param oldKey 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 item Object {Object} item (optional) If the first parameter passed was a key, the item to associate with that key. + * @returns Object The new item. */ replace?( oldKey?:string, item?:any ): any; /** [Method] Sets the value of autoFilter @@ -35168,6 +39023,7 @@ declare module Ext.util { /** [Method] This method will sort an array based on the currently configured sorters * @param sorters Object * @param defaultDirection Object + * @returns Array The array you passed after it is sorted. */ sort?( sorters?:any, defaultDirection?:any ): any[]; } @@ -35183,15 +39039,25 @@ declare module Ext.util { * @param newArgs Array Overrides the original args passed when instantiated. */ delay?( delay?:number, newFn?:any, newScope?:any, newArgs?:any[] ): void; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Object + */ getArgs?(): any; - /** [Method] Returns the value of delay */ + /** [Method] Returns the value of delay + * @returns Object + */ getDelay?(): any; - /** [Method] Returns the value of fn */ + /** [Method] Returns the value of fn + * @returns Object + */ getFn?(): any; - /** [Method] Returns the value of interval */ + /** [Method] Returns the value of interval + * @returns Object + */ getInterval?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; /** [Method] Sets the value of args * @param args Object @@ -35227,16 +39093,14 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -35248,9 +39112,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -35258,57 +39120,80 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ destroy?(): void; - /** [Method] Disable the Draggable */ + /** [Method] Disable the Draggable + * @returns Ext.util.Draggable This Draggable instance + */ disable?(): Ext.util.IDraggable; - /** [Method] Enable the Draggable */ + /** [Method] Enable the Draggable + * @returns Ext.util.Draggable This Draggable instance + */ enable?(): Ext.util.IDraggable; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of constraint */ + /** [Method] Returns the value of constraint + * @returns String + */ getConstraint?(): string; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Object + */ getDisabled?(): any; - /** [Method] Returns the value of draggingCls */ + /** [Method] Returns the value of draggingCls + * @returns String + */ getDraggingCls?(): string; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of initialOffset */ + /** [Method] Returns the value of initialOffset + * @returns Object/Number + */ getInitialOffset?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of translatable */ + /** [Method] Returns the value of translatable + * @returns Object + */ getTranslatable?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -35318,18 +39203,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -35337,28 +39218,25 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -35367,16 +39245,14 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -35384,18 +39260,14 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -35403,9 +39275,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of cls * @param cls String */ @@ -35451,25 +39321,21 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util { @@ -35494,16 +39360,14 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -35515,9 +39379,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -35525,9 +39387,7 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] */ @@ -35539,34 +39399,45 @@ declare module Ext.util { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ getBaseCls?(): string; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): 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 Droppable is currently monitoring drag operations of Draggables */ + /** [Method] Method to determine whether this Droppable is currently monitoring drag operations of Draggables + * @returns Boolean the monitoring state of this Droppable + */ isMonitoring?(): boolean; /** [Method] Alias for addManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. @@ -35575,18 +39446,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -35594,28 +39461,25 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -35624,16 +39488,14 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -35641,18 +39503,14 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -35664,9 +39522,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -35680,25 +39536,21 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util { @@ -35721,23 +39573,41 @@ declare module Ext.util { scope?: any; /** [Config Option] (RegExp/Mixed) */ value?: any; - /** [Method] Returns the value of anyMatch */ + /** [Method] Returns the value of anyMatch + * @returns Boolean + */ getAnyMatch?(): boolean; - /** [Method] Returns the value of caseSensitive */ + /** [Method] Returns the value of caseSensitive + * @returns Boolean + */ getCaseSensitive?(): boolean; - /** [Method] Returns the value of exactMatch */ + /** [Method] Returns the value of exactMatch + * @returns Boolean + */ getExactMatch?(): boolean; - /** [Method] Returns the value of filterFn */ + /** [Method] Returns the value of filterFn + * @returns Function + */ getFilterFn?(): any; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns String + */ getId?(): string; - /** [Method] Returns the value of property */ + /** [Method] Returns the value of property + * @returns String + */ getProperty?(): string; - /** [Method] Returns the value of root */ + /** [Method] Returns the value of root + * @returns String + */ getRoot?(): string; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; - /** [Method] Returns the value of value */ + /** [Method] Returns the value of value + * @returns RegExp/Mixed + */ getValue?(): any; /** [Method] Sets the value of anyMatch * @param anyMatch Boolean @@ -35774,8 +39644,7 @@ declare module Ext.util { /** [Method] Sets the value of value * @param value RegExp/Mixed */ - setValue?( value?:any ): any; - setValue?( value?:RegExp ): void; + setValue?( value?:any ): void; } } declare module Ext.util { @@ -35784,25 +39653,24 @@ declare module Ext.util { export class Format { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] Parse a value into a formatted date using the specified format pattern * @param value String/Date The value to format. Strings must conform to the format expected by the JavaScript Date object's parse() method. * @param format String Any valid date format string. + * @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] */ static destroy(): void; @@ -35810,53 +39678,66 @@ declare module Ext.util { * @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 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 str String + * @returns String */ static escapeRegex( str?: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 String... The values to replace token {0}, {1}, etc. + * @returns String The formatted string. */ static format( string:string, ...values:any[] ): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [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 pages * @param value String The string to encode. + * @returns String The encoded text. */ static htmlEncode( value?:string ): string; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [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 char String The character with which to pad the original string. + * @returns String The padded string. */ static leftPad( string?:string, size?:number, char?: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; /** [Method] Utility function that allows you to easily switch a string between two alternating values * @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 escape + * @returns String The trimmed string */ static trim( string?:string ): string; } @@ -35891,15 +39772,25 @@ declare module Ext.util { timestamp?: any; /** [Method] */ destroy?(): void; - /** [Method] Returns the value of allowHighAccuracy */ + /** [Method] Returns the value of allowHighAccuracy + * @returns Boolean + */ getAllowHighAccuracy?(): boolean; - /** [Method] Returns the value of autoUpdate */ + /** [Method] Returns the value of autoUpdate + * @returns Boolean + */ getAutoUpdate?(): boolean; - /** [Method] Returns the value of frequency */ + /** [Method] Returns the value of frequency + * @returns Number + */ getFrequency?(): number; - /** [Method] Returns the value of maximumAge */ + /** [Method] Returns the value of maximumAge + * @returns Number + */ getMaximumAge?(): number; - /** [Method] Returns the value of timeout */ + /** [Method] Returns the value of timeout + * @returns Number + */ getTimeout?(): number; /** [Method] Sets the value of allowHighAccuracy * @param allowHighAccuracy Boolean @@ -35936,11 +39827,17 @@ declare module Ext.util { sortProperty?: string; /** [Config Option] (Function) */ sorterFn?: any; - /** [Method] Returns the value of groupFn */ + /** [Method] Returns the value of groupFn + * @returns Function + */ getGroupFn?(): any; - /** [Method] Returns the value of sortProperty */ + /** [Method] Returns the value of sortProperty + * @returns String + */ getSortProperty?(): string; - /** [Method] Returns the value of sorterFn */ + /** [Method] Returns the value of sorterFn + * @returns Function + */ getSorterFn?(): any; /** [Method] Sets the value of groupFn * @param groupFn Function @@ -35963,6 +39860,7 @@ declare module Ext.util { /** [Method] Add a new item to the hash * @param key String The key of the new item. * @param value Object The value of the new item. + * @returns Object The value of the new item added. */ add?( key?:string, value?:any ): any; /** [Method] Appends an after event handler @@ -35971,16 +39869,14 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -35992,9 +39888,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -36002,23 +39896,26 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [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 */ clearListeners?(): 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] */ @@ -36026,42 +39923,55 @@ declare module Ext.util { /** [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. + * @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 events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( 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] Returns the value of bubbleEvents */ - getBubbleEvents? (): any; - /** [Method] Gets the number of items in the hash */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ + getBubbleEvents?(): any; + /** [Method] Gets the number of items in the hash + * @returns Number The number of items in the hash. + */ getCount?(): number; - /** [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] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): 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 * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -36071,18 +39981,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -36090,32 +39996,30 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [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] Removes a before event handler @@ -36124,18 +40028,17 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Remove an item from the hash * @param key String The key to remove. + * @returns Boolean true if the item was successfully removed. */ removeByKey?( key?:string ): boolean; /** [Method] Removes an event handler @@ -36145,21 +40048,18 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?: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 events see suspendEvents @@ -36169,9 +40069,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -36185,25 +40083,21 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util { @@ -36212,21 +40106,22 @@ declare module Ext.util { export class Inflector { /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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 */ @@ -36237,18 +40132,22 @@ declare module Ext.util { static destroy(): void; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [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 @@ -36258,6 +40157,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 @@ -36267,9 +40167,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; } } @@ -36281,9 +40184,12 @@ declare module Ext.util { export interface ILineSegment extends Ext.IBase { /** [Method] Returns the point where two lines intersect * @param lineSegment Ext.util.LineSegment The line to intersect with. + * @returns Ext.util.Point */ intersects?( lineSegment?:Ext.util.ILineSegment ): Ext.util.IPoint; - /** [Method] Returns string representation of the line */ + /** [Method] Returns string representation of the line + * @returns String For example Point[12,8] Point[0,0] + */ toString?(): string; } } @@ -36302,10 +40208,9 @@ declare module Ext.util { * @param direction String The overall direction to sort the data by. * @param where String * @param doSort Boolean + * @returns Ext.util.Sorter[] */ - sort?( sorters?:any, direction?:any, where?:any, doSort?:any ): any; - sort?( sorters?:string, direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; - sort?( sorters?:Ext.util.ISorter[], direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; + sort?( sorters?:any, direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; /** [Method] Sorts the collection by a single sorter function * @param sorterFn Function The function to sort by. */ @@ -36325,13 +40230,21 @@ declare module Ext.util.paintmonitor { export interface IAbstract extends Ext.IBase { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Array + */ getArgs?(): any[]; - /** [Method] Returns the value of callback */ + /** [Method] Returns the value of callback + * @returns Object + */ getCallback?(): any; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; /** [Method] Sets the value of args * @param args Array @@ -36365,34 +40278,47 @@ declare module Ext.util.paintmonitor { } declare module Ext.util { export interface IPoint extends Ext.IBase { - /** [Method] Copy a new instance of this point */ + /** [Method] Copy a new instance of this point + * @returns Ext.util.Point The new point. + */ clone?(): Ext.util.IPoint; - /** [Method] Clones this Point */ + /** [Method] Clones this Point + * @returns Ext.util.Point The new point. + */ copy?(): Ext.util.IPoint; /** [Method] Copy the x and y values of another point object to this point itself * @param point Ext.util.Point/Object . + * @returns Ext.util.Point This point. */ copyFrom?( point?:any ): Ext.util.IPoint; /** [Method] Compare this point and another point * @param point 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 Returns whether they are equivalent. */ equals?( point?:any ): boolean; /** [Method] Whether the given point is not away from this point within the given threshold amount * @param point Ext.util.Point/Object The point to check with, either an instance of Ext.util.Point or an object with x and y properties. * @param threshold Object/Number Can be either an object with x and y properties or a number. + * @returns Boolean */ isCloseTo?( point?:any, threshold?:any ): boolean; - /** [Method] Returns true if this point is close to another one */ + /** [Method] Returns true if this point is close to another one + * @returns Boolean + */ isWithin?(): boolean; /** [Method] Compare this point with another point when the x and y values of both points are rounded * @param point 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?( point?: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 For example Point[12,8]. + */ toString?(): string; /** [Method] Translate this point by the given amounts * @param x Number Amount to translate in the x-axis. * @param y Number Amount to translate in the y-axis. + * @returns Boolean */ translate?( x?:number, y?:number ): boolean; } @@ -36403,13 +40329,16 @@ 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] * @param args Object */ static callParent( args?: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 @@ -36418,27 +40347,35 @@ declare module Ext.util { static createAlias( alias?:any, origin?:any ): void; /** [Method] Returns a new point from an object that has x and y properties if that object is not an instance of Ext util Point * @param object Object + * @returns Ext.util.Point */ static from( object?:any ): Ext.util.IPoint; /** [Method] Returns a new instance of Ext util Point based on the pageX pageY values of the given event * @param e Event The event. + * @returns Ext.util.Point */ static fromEvent( e?:Event ): Ext.util.IPoint; /** [Method] Returns a new instance of Ext util Point based on the pageX pageY values of the given touch * @param touch Event + * @returns Ext.util.Point */ static fromTouch( touch?:Event ): 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] 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; } } declare module Ext.util { export interface IPositionMap extends Ext.IBase { - /** [Method] Returns the value of minimumHeight */ + /** [Method] Returns the value of minimumHeight + * @returns Number + */ getMinimumHeight?(): number; /** [Method] Sets the value of minimumHeight * @param minimumHeight Number @@ -36453,64 +40390,81 @@ 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] Copy a new instance */ + /** [Method] Copy a new instance + * @returns Ext.util.Region + */ copy?(): 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/Object optional. * @param p Ext.util.Point The point. + * @returns Ext.util.Region */ getOutOfBoundOffset?( axis?:any, p?:Ext.util.IPoint ): Ext.util.IRegion; /** [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 ): any; /** [Method] Check whether the point offset is out of bounds * @param axis String optional * @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 Region. + */ round?(): Ext.util.IRegion; - /** [Method] Dump this to an eye friendly string great for debugging */ + /** [Method] Dump this to an eye friendly string great for debugging + * @returns String For example Region[0,1,3,2]. + */ toString?(): string; /** [Method] Translate this region by the given offset amount * @param offset Object + * @returns Ext.util.Region This Region. */ translateBy?( offset?:any ): Ext.util.IRegion; /** [Method] Returns the smallest region that contains the current AND targetRegion * @param region Ext.util.Region + * @returns Ext.util.Region */ union?( region?:Ext.util.IRegion ): Ext.util.IRegion; } @@ -36521,13 +40475,16 @@ 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] * @param args Object */ static callParent( args?: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 @@ -36536,19 +40493,21 @@ declare module Ext.util { static createAlias( alias?:any, origin?:any ): void; /** [Method] Creates new Region from an object Ext util Region from top 0 right 5 bottom 3 left 1 the above is eq * @param o Object An object with top, right, bottom, and left properties. + * @returns Ext.util.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 The element or its ID. + * @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] 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; } @@ -36557,13 +40516,21 @@ declare module Ext.util.sizemonitor { export interface IAbstract extends Ext.IBase,Ext.mixin.ITemplatable { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of args */ + /** [Method] Returns the value of args + * @returns Array + */ getArgs?(): any[]; - /** [Method] Returns the value of callback */ + /** [Method] Returns the value of callback + * @returns Object + */ getCallback?(): any; - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; - /** [Method] Returns the value of scope */ + /** [Method] Returns the value of scope + * @returns Object + */ getScope?(): any; /** [Method] Sets the value of args * @param args Array @@ -36618,10 +40585,9 @@ declare module Ext.util { * @param direction String The overall direction to sort the data by. * @param where String * @param doSort Boolean + * @returns Ext.util.Sorter[] */ - sort?( sorters?:any, direction?:any, where?:any, doSort?:any ): any; - sort?( sorters?:string, direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; - sort?( sorters?:Ext.util.ISorter[], direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; + sort?( sorters?:any, direction?:string, where?:string, doSort?:boolean ): Ext.util.ISorter[]; } } declare module Ext.util { @@ -36638,17 +40604,29 @@ declare module Ext.util { sorterFn?: any; /** [Config Option] (Function) */ transform?: any; - /** [Method] Returns the value of direction */ + /** [Method] Returns the value of direction + * @returns String + */ getDirection?(): string; - /** [Method] Returns the value of id */ + /** [Method] Returns the value of id + * @returns Mixed + */ getId?(): any; - /** [Method] Returns the value of property */ + /** [Method] Returns the value of property + * @returns String + */ getProperty?(): string; - /** [Method] Returns the value of root */ + /** [Method] Returns the value of root + * @returns String + */ getRoot?(): string; - /** [Method] Returns the value of sorterFn */ + /** [Method] Returns the value of sorterFn + * @returns Function + */ getSorterFn?(): any; - /** [Method] Returns the value of transform */ + /** [Method] Returns the value of transform + * @returns Function + */ getTransform?(): any; /** [Method] Sets the value of direction * @param direction String @@ -36686,16 +40664,14 @@ declare module Ext.util { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Appends a before event handler * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - addBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + addBeforeListener?( eventName?:any, fn?:any, scope?:any, options?: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 or the first event name string if multiple event names are being passed as separate parameters. */ @@ -36707,9 +40683,7 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; addListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - addListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -36717,51 +40691,70 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - addManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - addManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + addManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all listeners for this object */ clearListeners?(): void; /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - enableBubble?( events?:any ): any; - enableBubble?( events?:string ): void; - enableBubble?( events?:string[] ): void; + enableBubble?( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ fireAction?( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ fireEvent?( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of accelerate */ + /** [Method] Returns the value of accelerate + * @returns Boolean + */ getAccelerate?(): boolean; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ getBubbleEvents?(): any; - /** [Method] Returns the value of delay */ + /** [Method] Returns the value of delay + * @returns Number + */ getDelay?(): number; - /** [Method] Returns the value of el */ + /** [Method] Returns the value of el + * @returns Object + */ getEl?(): any; - /** [Method] Returns the value of interval */ + /** [Method] Returns the value of interval + * @returns Number + */ getInterval?(): number; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ getListeners?(): any; - /** [Method] Returns the value of pressCls */ + /** [Method] Returns the value of pressCls + * @returns Object + */ getPressCls?(): any; - /** [Method] Returns the value of preventDefault */ + /** [Method] Returns the value of preventDefault + * @returns Boolean + */ getPreventDefault?(): boolean; - /** [Method] Returns the value of stopDefault */ + /** [Method] Returns the value of stopDefault + * @returns Boolean + */ getStopDefault?(): boolean; - /** [Method] Returns the value of timer */ + /** [Method] Returns the value of timer + * @returns Number + */ getTimer?(): number; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ hasListener?( eventName?:string ): boolean; /** [Method] Alias for addManagedListener @@ -36771,18 +40764,14 @@ declare module Ext.util { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - mon?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - mon?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + mon?( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - mun?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - mun?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - mun?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + mun?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -36790,28 +40779,25 @@ declare module Ext.util { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; on?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - on?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - onBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + onBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ relayEvents?( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes a before event handler @@ -36820,16 +40806,14 @@ declare module Ext.util { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeAfterListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeAfterListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes a before event handler * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - removeBeforeListener?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + removeBeforeListener?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes an event handler * @param eventName String/String[]/Object The type of event the handler was associated with. * @param fn Function/String The handler to remove. This must be a reference to the function passed into the addListener call. @@ -36837,18 +40821,14 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; removeListener?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - removeListener?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): any; - removeManagedListener?( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - removeManagedListener?( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + removeManagedListener?( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Resumes firing events see suspendEvents * @param discardQueuedEvents Boolean Pass as true to discard any queued events. */ @@ -36860,9 +40840,7 @@ declare module Ext.util { /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - setBubbleEvents?( bubbleEvents?:any ): any; - setBubbleEvents?( bubbleEvents?:string ): void; - setBubbleEvents?( bubbleEvents?:string[] ): void; + setBubbleEvents?( bubbleEvents?:any ): void; /** [Method] Sets the value of delay * @param delay Number */ @@ -36904,38 +40882,42 @@ declare module Ext.util { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; un?( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - un?( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unAfter?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unAfter?( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): any; - unBefore?( eventName?:any, fn?:string, scope?:any, options?:any ): void; + unBefore?( eventName?:any, fn?:any, scope?:any, options?:any ): void; } } declare module Ext.util.translatable { export interface IAbstract extends Ext.IEvented { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of easing */ + /** [Method] Returns the value of easing + * @returns Object + */ getEasing?(): any; - /** [Method] Returns the value of easingX */ + /** [Method] Returns the value of easingX + * @returns Object + */ getEasingX?(): any; - /** [Method] Returns the value of easingY */ + /** [Method] Returns the value of easingY + * @returns Object + */ getEasingY?(): any; - /** [Method] Returns the value of useWrapper */ + /** [Method] Returns the value of useWrapper + * @returns Object + */ getUseWrapper?(): any; /** [Method] Sets the value of easing * @param easing Object @@ -36969,7 +40951,9 @@ declare module Ext.util.translatable { } declare module Ext.util.translatable { export interface IDom extends Ext.util.translatable.IAbstract { - /** [Method] Returns the value of element */ + /** [Method] Returns the value of element + * @returns Object + */ getElement?(): any; /** [Method] Sets the value of element * @param element Object @@ -36985,7 +40969,9 @@ declare module Ext.util.translatable { export interface IScrollPosition extends Ext.util.translatable.IDom { /** [Method] */ destroy?(): void; - /** [Method] Returns the value of useWrapper */ + /** [Method] Returns the value of useWrapper + * @returns Boolean + */ getUseWrapper?(): boolean; /** [Method] Sets the value of useWrapper * @param useWrapper Boolean @@ -36995,11 +40981,17 @@ declare module Ext.util.translatable { } declare module Ext.util { export interface ITranslatableGroup extends Ext.util.translatable.IAbstract { - /** [Method] Returns the value of activeIndex */ + /** [Method] Returns the value of activeIndex + * @returns Number + */ getActiveIndex?(): number; - /** [Method] Returns the value of itemLength */ + /** [Method] Returns the value of itemLength + * @returns Object + */ getItemLength?(): any; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array + */ getItems?(): any[]; /** [Method] Sets the value of activeIndex * @param activeIndex Number @@ -37017,7 +41009,9 @@ declare module Ext.util { } declare module Ext.util { export interface ITranslatableList extends Ext.util.translatable.IAbstract { - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array + */ getItems?(): any[]; /** [Method] Sets the value of items * @param items Array @@ -37042,91 +41036,96 @@ declare module Ext { deprecate?( packageName?:string, since?:string, closure?:any, scope?:any ): void; /** [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] Get the version number of the supplied package name will return the last registered version last Ext setVersion c * @param packageName String The package name, for example: 'core', 'touch', 'extjs'. + * @returns Ext.Version The version. */ getVersion?( packageName?:string ): Ext.IVersion; /** [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 ): any; - match?( target?:string ): boolean; - match?( target?:number ): boolean; + match?( target?:any ): boolean; /** [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 + */ + setVersion?( packageName?:string, version?:any ): any; + /** [Method] Returns this format major minor patch build release + * @returns Number[] */ - setVersion?( packageName?:any, version?:any ): any; - setVersion?( packageName?:string, version?:string ): any; - setVersion?( packageName?:string, version?:Ext.IVersion ): any; - /** [Method] Returns this format major minor patch build release */ toArray?(): number[]; /** [Method] * @param value Object + * @returns Number */ toNumber?( value?:any ): number; } @@ -37134,10 +41133,12 @@ declare module Ext { /** [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; } @@ -37148,11 +41149,17 @@ declare module Ext { cls?: any; /** [Config Option] (String) */ posterUrl?: string; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String + */ getCls?(): string; - /** [Method] Returns the value of posterUrl */ + /** [Method] Returns the value of posterUrl + * @returns String + */ getPosterUrl?(): string; - /** [Method] Returns the value of url */ + /** [Method] Returns the value of url + * @returns string + */ getUrl?(): string; /** [Method] Allows addition of behavior to the rendering phase */ initialize?(): void; @@ -37167,9 +41174,7 @@ declare module Ext { /** [Method] Sets the value of url * @param url String/Array */ - setUrl?( url?:any ): any; - setUrl?( url?:string ): void; - setUrl?( url?:any[] ): void; + setUrl?( url?:any ): void; /** [Method] Updates the URL to the poster even if it is rendered * @param newUrl Object */ @@ -37182,7 +41187,9 @@ declare module Ext { } declare module Ext.viewport { export interface IAndroid extends Ext.viewport.IDefault { - /** [Method] Returns the value of autoBlurInput */ + /** [Method] Returns the value of autoBlurInput + * @returns Boolean + */ getAutoBlurInput?(): boolean; /** [Method] Sets the value of autoBlurInput * @param autoBlurInput Boolean @@ -37204,23 +41211,41 @@ declare module Ext.viewport { preventZooming?: boolean; /** [Property] (Boolean) */ isReady?: boolean; - /** [Method] Returns the value of autoMaximize */ + /** [Method] Returns the value of autoMaximize + * @returns Boolean + */ getAutoMaximize?(): boolean; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object/String + */ getLayout?(): any; - /** [Method] Returns the current orientation */ + /** [Method] Returns the current orientation + * @returns String portrait or landscape + */ getOrientation?(): string; - /** [Method] Returns the value of preventPanning */ + /** [Method] Returns the value of preventPanning + * @returns Boolean + */ getPreventPanning?(): boolean; - /** [Method] Returns the value of preventZooming */ + /** [Method] Returns the value of preventZooming + * @returns Boolean + */ getPreventZooming?(): boolean; - /** [Method] Returns the height and width of the Component */ + /** [Method] Returns the height and width of the Component + * @returns Object The current height and width of the Component. + */ getSize?(): any; - /** [Method] Returns the value of useBodyElement */ + /** [Method] Returns the value of useBodyElement + * @returns Boolean + */ getUseBodyElement?(): boolean; - /** [Method] Retrieves the document height */ + /** [Method] Retrieves the document height + * @returns Number height in pixels. + */ getWindowHeight?(): number; - /** [Method] Retrieves the document width */ + /** [Method] Retrieves the document width + * @returns Number width in pixels. + */ getWindowWidth?(): number; /** [Method] Sets the value of autoMaximize * @param autoMaximize Boolean @@ -37254,6 +41279,7 @@ declare module Ext { export class Viewport { /** [Method] Adds one or more Components to this Container * @param newItems Object/Object[]/Ext.Component/Ext.Component[] The new items to add to the Container. + * @returns Ext.Component The last item added to the Container from the newItems array. */ static add( newItems?:any ): Ext.IComponent; /** [Method] Appends an after event handler @@ -37262,10 +41288,10 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds an array of Components to this Container * @param items Array The array of items to add to this container. + * @returns Array The array of items after they have been added. */ static addAll( items?:any[] ): any[]; /** [Method] Appends a before event handler @@ -37274,8 +41300,7 @@ declare module Ext { * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static addBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Adds a CSS class or classes to this Component s rendered element * @param cls String The CSS class to add. * @param prefix String Optional prefix to add to each class. @@ -37293,9 +41318,7 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static addListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static addListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. @@ -37303,9 +41326,7 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static addManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static addManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static addManagedListener( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Animates to the supplied activeItem with a specified animation * @param activeItem Object/Number The item or item index to make active. * @param animation Object/Ext.fx.layout.Card Card animation configuration or instance. @@ -37313,25 +41334,27 @@ declare module Ext { static animateActiveItem( activeItem?:any, animation?:any ): void; /** [Method] Changes the masked configuration when its setter is called which will convert the value into a proper object instanc * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask + * @returns Object */ static applyMasked( masked?:any ): any; /** [Method] Call the original method that was previously overridden with override This method is deprecated as callParent does * @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] Retrieves the first direct child of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ static child( selector?:string ): Ext.IComponent; /** [Method] Removes all listeners for this object */ @@ -37342,6 +41365,7 @@ declare module Ext { static disable(): void; /** [Method] Retrieves the first descendant of this container which matches the passed selector * @param selector String An Ext.ComponentQuery selector. + * @returns Ext.Component */ static down( selector?:string ): Ext.IComponent; /** [Method] Enables this Component */ @@ -37349,185 +41373,322 @@ declare module Ext { /** [Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present * @param events String/String[] The event name to bubble, or an Array of event names. */ - static enableBubble( events?:any ): any; - static enableBubble( events?:string ): void; - static enableBubble( events?:string[] ): void; + static enableBubble( events?:any ): void; /** [Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste * @param eventName String The name of the event to fire. * @param args Array Arguments to pass to handers. * @param fn Function Action. * @param scope Object Scope of fn. + * @returns Object */ static fireAction( eventName?:string, args?:any[], fn?:any, scope?:any ): any; /** [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. */ static fireEvent( eventName:string, ...args:any[] ): boolean; - /** [Method] Returns the value of activeItem */ + /** [Method] Returns the value of activeItem + * @returns Object/String/Number + */ static getActiveItem(): any; /** [Method] Returns the Component for a given index in the Container s items * @param index Number The index of the Component to return. + * @returns Ext.Component The item at the specified index, if found. */ static getAt( index?:number ): Ext.IComponent; - /** [Method] Returns the value of autoDestroy */ + /** [Method] Returns the value of autoDestroy + * @returns Boolean + */ static getAutoDestroy(): boolean; - /** [Method] Returns the value of autoMaximize */ + /** [Method] Returns the value of autoMaximize + * @returns Boolean + */ static getAutoMaximize(): boolean; - /** [Method] Returns the value of baseCls */ + /** [Method] Returns the value of baseCls + * @returns String + */ static getBaseCls(): string; - /** [Method] Returns the value of border */ + /** [Method] Returns the value of border + * @returns Number/String + */ static getBorder(): any; - /** [Method] Returns the value of bottom */ + /** [Method] Returns the value of bottom + * @returns Number/String + */ static getBottom(): any; - /** [Method] Returns the value of bubbleEvents */ + /** [Method] Returns the value of bubbleEvents + * @returns String/String[] + */ static getBubbleEvents(): any; - /** [Method] Returns the value of centered */ + /** [Method] Returns the value of centered + * @returns Boolean + */ static getCentered(): boolean; - /** [Method] Returns the value of cls */ + /** [Method] Returns the value of cls + * @returns String/String[] + */ static getCls(): any; /** [Method] Examines this container s items property and gets a direct child component of this container * @param component String/Number This parameter may be any of the following: {String} : representing the itemId or id of the child component. {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). + */ + static getComponent( component?:any ): Ext.IComponent; + /** [Method] Returns the value of contentEl + * @returns Ext.Element/HTMLElement/String */ - static getComponent( component?:any ): any; - static getComponent( component?:string ): Ext.IComponent; - static getComponent( component?:number ): Ext.IComponent; - /** [Method] Returns the value of contentEl */ static getContentEl(): any; - /** [Method] Returns the value of control */ + /** [Method] Returns the value of control + * @returns Object + */ static getControl(): any; - /** [Method] Returns the value of data */ + /** [Method] Returns the value of data + * @returns Object + */ static getData(): any; - /** [Method] Returns the value of defaultType */ + /** [Method] Returns the value of defaultType + * @returns String + */ static getDefaultType(): string; - /** [Method] Returns the value of defaults */ + /** [Method] Returns the value of defaults + * @returns Object + */ static getDefaults(): any; - /** [Method] Returns the value of disabled */ + /** [Method] Returns the value of disabled + * @returns Boolean + */ static getDisabled(): boolean; - /** [Method] Returns the value of disabledCls */ + /** [Method] Returns the value of disabledCls + * @returns String + */ static getDisabledCls(): string; - /** [Method] Returns the value of docked */ + /** [Method] Returns the value of docked + * @returns String + */ static getDocked(): string; /** [Method] Finds a docked item of this container using a reference idor an index of its location in getDockedItems * @param component String/Number The id or index of the component to find. + * @returns Ext.Component/Boolean The docked component, if found. */ static getDockedComponent( component?:any ): any; - static getDockedComponent( component?:string ): any; - static getDockedComponent( component?:number ): any; - /** [Method] Returns all the Ext Component docked items in this container */ + /** [Method] Returns all the Ext Component docked items in this container + * @returns Array The docked items of this container. + */ static getDockedItems(): any[]; - /** [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] Returns the value of enterAnimation */ + /** [Method] Returns the value of enterAnimation + * @returns String/Mixed + */ static getEnterAnimation(): any; - /** [Method] Returns the value of exitAnimation */ + /** [Method] Returns the value of exitAnimation + * @returns String/Mixed + */ static getExitAnimation(): any; - /** [Method] Returns the value of flex */ + /** [Method] Returns the value of flex + * @returns Number + */ static getFlex(): number; - /** [Method] Returns the value of floatingCls */ + /** [Method] Returns the value of floatingCls + * @returns String + */ static getFloatingCls(): string; - /** [Method] Returns the value of hidden */ + /** [Method] Returns the value of hidden + * @returns Boolean + */ static getHidden(): boolean; - /** [Method] Returns the value of hiddenCls */ + /** [Method] Returns the value of hiddenCls + * @returns String + */ static getHiddenCls(): string; - /** [Method] Returns the value of hideAnimation */ + /** [Method] Returns the value of hideAnimation + * @returns String/Mixed + */ static getHideAnimation(): any; - /** [Method] Returns the value of hideOnMaskTap */ + /** [Method] Returns the value of hideOnMaskTap + * @returns Boolean + */ static getHideOnMaskTap(): boolean; - /** [Method] Returns the value of html */ + /** [Method] Returns the value of html + * @returns String/Ext.Element/HTMLElement + */ static getHtml(): any; - /** [Method] Retrieves the id of this component */ + /** [Method] Retrieves the id of this component + * @returns String id + */ static getId(): string; /** [Method] Returns the initial configuration passed to constructor * @param name String When supplied, value for particular configuration option is returned, otherwise the full config object is returned. + * @returns Object/Mixed */ static getInitialConfig( name?:string ): any; - /** [Method] Returns all inner items of this container */ + /** [Method] Returns all inner items of this container + * @returns Array The inner items of this container. + */ static getInnerItems(): any[]; - /** [Method] Returns the value of itemId */ + /** [Method] Returns the value of itemId + * @returns String + */ static getItemId(): string; - /** [Method] Returns the value of items */ + /** [Method] Returns the value of items + * @returns Array/Object + */ static getItems(): any; - /** [Method] Returns the value of layout */ + /** [Method] Returns the value of layout + * @returns Object/String + */ static getLayout(): any; - /** [Method] Returns the value of left */ + /** [Method] Returns the value of left + * @returns Number/String + */ static getLeft(): any; - /** [Method] Returns the value of listeners */ + /** [Method] Returns the value of listeners + * @returns Object + */ static getListeners(): any; - /** [Method] Returns the value of margin */ + /** [Method] Returns the value of margin + * @returns Number/String + */ static getMargin(): any; - /** [Method] Returns the value of masked */ + /** [Method] Returns the value of masked + * @returns Boolean/Object/Ext.Mask/Ext.LoadMask + */ static getMasked(): any; - /** [Method] Returns the value of maxHeight */ + /** [Method] Returns the value of maxHeight + * @returns Number/String + */ static getMaxHeight(): any; - /** [Method] Returns the value of maxWidth */ + /** [Method] Returns the value of maxWidth + * @returns Number/String + */ static getMaxWidth(): any; - /** [Method] Returns the value of minHeight */ + /** [Method] Returns the value of minHeight + * @returns Number/String + */ static getMinHeight(): any; - /** [Method] Returns the value of minWidth */ + /** [Method] Returns the value of minWidth + * @returns Number/String + */ static getMinWidth(): any; - /** [Method] Returns the value of modal */ + /** [Method] Returns the value of modal + * @returns Boolean + */ static getModal(): boolean; - /** [Method] Returns the current orientation */ + /** [Method] Returns the current orientation + * @returns String portrait or landscape + */ static getOrientation(): string; - /** [Method] Returns the value of padding */ + /** [Method] Returns the value of padding + * @returns Number/String + */ static getPadding(): any; - /** [Method] Returns the parent of this component if it has one */ + /** [Method] Returns the parent of this component if it has one + * @returns Ext.Component The parent of this component. + */ static getParent(): Ext.IComponent; - /** [Method] Returns the value of plugins */ + /** [Method] Returns the value of plugins + * @returns Object/Array + */ static getPlugins(): any; - /** [Method] Returns the value of preventPanning */ + /** [Method] Returns the value of preventPanning + * @returns Boolean + */ static getPreventPanning(): boolean; - /** [Method] Returns the value of preventZooming */ + /** [Method] Returns the value of preventZooming + * @returns Boolean + */ static getPreventZooming(): boolean; - /** [Method] Returns the value of record */ + /** [Method] Returns the value of record + * @returns Ext.data.Model + */ static getRecord(): Ext.data.IModel; - /** [Method] Returns the value of renderTo */ + /** [Method] Returns the value of renderTo + * @returns Ext.Element + */ static getRenderTo(): Ext.IElement; - /** [Method] Returns the value of right */ + /** [Method] Returns the value of right + * @returns Number/String + */ static getRight(): any; - /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class */ + /** [Method] Returns an the scrollable instance for this container which is a Ext scroll View class + * @returns Ext.scroll.View The scroll view. + */ static getScrollable(): Ext.scroll.IView; - /** [Method] Returns the value of showAnimation */ + /** [Method] Returns the value of showAnimation + * @returns String/Mixed + */ static getShowAnimation(): any; - /** [Method] Returns the height and width of the Component */ + /** [Method] Returns the height and width of the Component + * @returns Object The current height and width of the Component. + */ static getSize(): any; - /** [Method] Returns the value of style */ + /** [Method] Returns the value of style + * @returns String/Object + */ static getStyle(): any; - /** [Method] Returns the value of styleHtmlCls */ + /** [Method] Returns the value of styleHtmlCls + * @returns String + */ static getStyleHtmlCls(): string; - /** [Method] Returns the value of styleHtmlContent */ + /** [Method] Returns the value of styleHtmlContent + * @returns Boolean + */ static getStyleHtmlContent(): boolean; - /** [Method] Returns the value of top */ + /** [Method] Returns the value of top + * @returns Number/String + */ static getTop(): any; - /** [Method] Returns the value of tpl */ + /** [Method] Returns the value of tpl + * @returns String/String[]/Ext.Template[]/Ext.XTemplate[] + */ static getTpl(): any; - /** [Method] Returns the value of tplWriteMode */ + /** [Method] Returns the value of tplWriteMode + * @returns String + */ static getTplWriteMode(): string; - /** [Method] Returns the value of ui */ + /** [Method] Returns the value of ui + * @returns String + */ static getUi(): string; - /** [Method] Returns the value of useBodyElement */ + /** [Method] Returns the value of useBodyElement + * @returns Boolean + */ static getUseBodyElement(): boolean; - /** [Method] Retrieves the document height */ + /** [Method] Retrieves the document height + * @returns Number height in pixels. + */ static getWindowHeight(): number; - /** [Method] Retrieves the document width */ + /** [Method] Retrieves the document width + * @returns Number width in pixels. + */ static getWindowWidth(): 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. + */ static getXTypes(): string; - /** [Method] Returns the value of zIndex */ + /** [Method] Returns the value of zIndex + * @returns Number + */ static getZIndex(): number; /** [Method] Checks to see if this object has any listeners for a specified event * @param eventName String The name of the event to check for + * @returns Boolean True if the event is being listened for, else false */ static hasListener( eventName?:string ): boolean; - /** [Method] Returns true if this component has a parent */ + /** [Method] Returns true if this component has a parent + * @returns Boolean true if this component has a parent. + */ static hasParent(): boolean; /** [Method] Hides this Component * @param animation Object/Boolean + * @returns Ext.Component */ static hide( animation?:any ): Ext.IComponent; /** [Method] Initialize configuration for this class * @param instanceConfig Object + * @returns Object mixins The mixin prototypes as key - value pairs */ static initConfig( instanceConfig?:any ): any; /** [Method] Allows addition of behavior to the rendering phase */ @@ -37537,13 +41698,18 @@ declare module Ext { * @param item Object The Component to insert. */ static insert( index?:number, item?:any ): void; - /** [Method] Returns true if this Component is currently disabled */ + /** [Method] Returns true if this Component is currently disabled + * @returns Boolean true if currently disabled. + */ static isDisabled(): boolean; - /** [Method] Returns true if this Component is currently hidden */ + /** [Method] Returns true if this Component is currently hidden + * @returns Boolean true if currently hidden. + */ static isHidden(): 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 false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype. + * @returns Boolean true if this component descends from the specified xtype, false otherwise. */ static isXType( xtype?:string, shallow?:boolean ): boolean; /** [Method] Convenience method which calls setMasked with a value of true to show the mask @@ -37557,18 +41723,14 @@ declare module Ext { * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. * @param options Object If the eventName parameter was an event name, this is the addListener options. */ - static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): any; - static mon( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any, options?:any ): void; - static mon( object?:HTMLElement, eventName?:any, fn?:any, scope?:any, options?:any ): void; + static mon( object?:any, eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeManagedListener * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static mun( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static mun( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static mun( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static mun( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Alias for addListener * @param eventName String/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/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below. @@ -37576,37 +41738,36 @@ declare module Ext { * @param options Object An object containing handler configuration. This object may contain any of the following properties: * @param order String The order of when the listener should be added into the listener queue. Possible values are before, current and after. */ - static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static on( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static on( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for addAfterListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for addBeforeListener * @param eventName String/String[]/Object The name of the event to listen for. * @param fn Function/String The method the event invokes. * @param scope Object The scope for fn. * @param options Object An object containing handler configuration. */ - static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static onBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static onBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Retrieves all descendant components which match the passed selector * @param selector String Selector complying to an Ext.ComponentQuery selector. + * @returns Array Ext.Component's which matched the selector. */ static query( selector?:string ): any[]; /** [Method] Relays selected events from the specified Observable as if the events were fired by this * @param object Object The Observable whose events this object is to relay. * @param events String/Array/Object Array of event names to relay. + * @returns Ext.mixin.Observable this */ static relayEvents( object?:any, events?:any ): Ext.mixin.IObservable; /** [Method] Removes an item from this Container optionally destroying it * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ static remove( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes a before event handler @@ -37615,15 +41776,16 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeAfterListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeAfterListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes all items currently in the Container optionally destroying them all * @param destroy Boolean If true, destroys each removed Component. * @param everything Boolean If true, completely remove all items including docked / centered and floating items. + * @returns Ext.Component this */ static removeAll( destroy?:boolean, everything?:boolean ): Ext.IComponent; /** [Method] Removes the Component at the specified index myContainer removeAt 0 removes the first item * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ static removeAt( index?:number ): Ext.IContainer; /** [Method] Removes a before event handler @@ -37632,8 +41794,7 @@ declare module Ext { * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static removeBeforeListener( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static removeBeforeListener( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Removes the given CSS class es from this Component s rendered element * @param cls String The class(es) to remove. * @param prefix String Optional prefix to prepend before each class. @@ -37643,10 +41804,12 @@ declare module Ext { /** [Method] Removes a docked item from this Container * @param item Object The item to remove. * @param destroy Boolean Calls the Component's destroy method if true. + * @returns Ext.Component this */ static removeDocked( item?:any, destroy?:boolean ): Ext.IComponent; /** [Method] Removes an inner Component at the specified index myContainer removeInnerAt 0 removes the first item of the in * @param index Number The index of the Component to remove. + * @returns Ext.Container this */ static removeInnerAt( index?:number ): Ext.IContainer; /** [Method] Removes an event handler @@ -37656,18 +41819,14 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static removeListener( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static removeListener( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed * @param object Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners. * @param eventName Object/String The event name, or an object containing event name properties. * @param fn Function If the eventName parameter was an event name, this is the handler function. * @param scope Object If the eventName parameter was an event name, this is the scope in which the handler function is executed. */ - static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): any; - static removeManagedListener( object?:Ext.mixin.IObservable, eventName?:any, fn?:any, scope?:any ): void; - static removeManagedListener( object?:HTMLElement, eventName?:any, fn?:any, scope?:any ): void; + static removeManagedListener( object?:any, eventName?:any, fn?:any, scope?:any ): void; /** [Method] Replaces specified classes with the newly specified classes * @param oldCls String The class(es) to remove. * @param newCls String The class(es) to add. @@ -37700,21 +41859,15 @@ declare module Ext { /** [Method] Sets the value of border * @param border Number/String */ - static setBorder( border?:any ): any; - static setBorder( border?:number ): void; - static setBorder( border?:string ): void; + static setBorder( border?:any ): void; /** [Method] Sets the value of bottom * @param bottom Number/String */ - static setBottom( bottom?:any ): any; - static setBottom( bottom?:number ): void; - static setBottom( bottom?:string ): void; + static setBottom( bottom?:any ): void; /** [Method] Sets the value of bubbleEvents * @param bubbleEvents String/String[] */ - static setBubbleEvents( bubbleEvents?:any ): any; - static setBubbleEvents( bubbleEvents?:string ): void; - static setBubbleEvents( bubbleEvents?:string[] ): void; + static setBubbleEvents( bubbleEvents?:any ): void; /** [Method] Sets the value of centered * @param centered Boolean */ @@ -37722,16 +41875,11 @@ declare module Ext { /** [Method] Sets the value of cls * @param cls String/String[] */ - static setCls( cls?:any ): any; - static setCls( cls?:string ): void; - static setCls( cls?:string[] ): void; + static setCls( cls?:any ): void; /** [Method] Sets the value of contentEl * @param contentEl Ext.Element/HTMLElement/String */ - static setContentEl( contentEl?:any ): any; - static setContentEl( contentEl?:Ext.IElement ): void; - static setContentEl( contentEl?:HTMLElement ): void; - static setContentEl( contentEl?:string ): void; + static setContentEl( contentEl?:any ): void; /** [Method] Sets the value of control * @param control Object */ @@ -37767,13 +41915,11 @@ declare module Ext { /** [Method] Sets the value of enterAnimation * @param enterAnimation String/Mixed */ - static setEnterAnimation( enterAnimation?:any ): any; - static setEnterAnimation( enterAnimation?:string ): void; + static setEnterAnimation( enterAnimation?:any ): void; /** [Method] Sets the value of exitAnimation * @param exitAnimation String/Mixed */ - static setExitAnimation( exitAnimation?:any ): any; - static setExitAnimation( exitAnimation?:string ): void; + static setExitAnimation( exitAnimation?:any ): void; /** [Method] Sets the value of flex * @param flex Number */ @@ -37797,8 +41943,7 @@ declare module Ext { /** [Method] Sets the value of hideAnimation * @param hideAnimation String/Mixed */ - static setHideAnimation( hideAnimation?:any ): any; - static setHideAnimation( hideAnimation?:string ): void; + static setHideAnimation( hideAnimation?:any ): void; /** [Method] Sets the value of hideOnMaskTap * @param hideOnMaskTap Boolean */ @@ -37806,10 +41951,7 @@ declare module Ext { /** [Method] Sets the value of html * @param html String/Ext.Element/HTMLElement */ - static setHtml( html?:any ): any; - static setHtml( html?:string ): void; - static setHtml( html?:Ext.IElement ): void; - static setHtml( html?:HTMLElement ): void; + static setHtml( html?:any ): void; /** [Method] Sets the value of itemId * @param itemId String */ @@ -37825,9 +41967,7 @@ declare module Ext { /** [Method] Sets the value of left * @param left Number/String */ - static setLeft( left?:any ): any; - static setLeft( left?:number ): void; - static setLeft( left?:string ): void; + static setLeft( left?:any ): void; /** [Method] Sets the value of listeners * @param listeners Object */ @@ -37835,9 +41975,7 @@ declare module Ext { /** [Method] Sets the value of margin * @param margin Number/String */ - static setMargin( margin?:any ): any; - static setMargin( margin?:number ): void; - static setMargin( margin?:string ): void; + static setMargin( margin?:any ): void; /** [Method] Sets the value of masked * @param masked Boolean/Object/Ext.Mask/Ext.LoadMask */ @@ -37845,27 +41983,19 @@ declare module Ext { /** [Method] Sets the value of maxHeight * @param maxHeight Number/String */ - static setMaxHeight( maxHeight?:any ): any; - static setMaxHeight( maxHeight?:number ): void; - static setMaxHeight( maxHeight?:string ): void; + static setMaxHeight( maxHeight?:any ): void; /** [Method] Sets the value of maxWidth * @param maxWidth Number/String */ - static setMaxWidth( maxWidth?:any ): any; - static setMaxWidth( maxWidth?:number ): void; - static setMaxWidth( maxWidth?:string ): void; + static setMaxWidth( maxWidth?:any ): void; /** [Method] Sets the value of minHeight * @param minHeight Number/String */ - static setMinHeight( minHeight?:any ): any; - static setMinHeight( minHeight?:number ): void; - static setMinHeight( minHeight?:string ): void; + static setMinHeight( minHeight?:any ): void; /** [Method] Sets the value of minWidth * @param minWidth Number/String */ - static setMinWidth( minWidth?:any ): any; - static setMinWidth( minWidth?:number ): void; - static setMinWidth( minWidth?:string ): void; + static setMinWidth( minWidth?:any ): void; /** [Method] Sets the value of modal * @param modal Boolean */ @@ -37873,9 +42003,7 @@ declare module Ext { /** [Method] Sets the value of padding * @param padding Number/String */ - static setPadding( padding?:any ): any; - static setPadding( padding?:number ): void; - static setPadding( padding?:string ): void; + static setPadding( padding?:any ): void; /** [Method] Sets the value of plugins * @param plugins Object/Array */ @@ -37899,9 +42027,7 @@ declare module Ext { /** [Method] Sets the value of right * @param right Number/String */ - static setRight( right?:any ): any; - static setRight( right?:number ): void; - static setRight( right?:string ): void; + static setRight( right?:any ): void; /** [Method] Sets the value of scrollable * @param scrollable Boolean/String/Object */ @@ -37909,8 +42035,7 @@ declare module Ext { /** [Method] Sets the value of showAnimation * @param showAnimation String/Mixed */ - static setShowAnimation( showAnimation?:any ): any; - static setShowAnimation( showAnimation?:string ): void; + static setShowAnimation( showAnimation?:any ): void; /** [Method] Sets the size of the Component * @param width Number The new width for the Component. * @param height Number The new height for the Component. @@ -37931,17 +42056,11 @@ declare module Ext { /** [Method] Sets the value of top * @param top Number/String */ - static setTop( top?:any ): any; - static setTop( top?:number ): void; - static setTop( top?:string ): void; + static setTop( top?:any ): void; /** [Method] Sets the value of tpl * @param tpl String/String[]/Ext.Template[]/Ext.XTemplate[] */ - static setTpl( tpl?:any ): any; - static setTpl( tpl?:string ): void; - static setTpl( tpl?:string[] ): void; - static setTpl( tpl?:Ext.ITemplate[] ): void; - static setTpl( tpl?:Ext.IXTemplate[] ): void; + static setTpl( tpl?:any ): void; /** [Method] Sets the value of tplWriteMode * @param tplWriteMode String */ @@ -37960,6 +42079,7 @@ declare module Ext { static setZIndex( zIndex?:number ): void; /** [Method] Shows this component * @param animation Object/Boolean + * @returns Ext.Component */ static show( animation?:any ): Ext.IComponent; /** [Method] Shows this component by another component @@ -37967,7 +42087,9 @@ declare module Ext { * @param alignment String The specific alignment. */ static showBy( component?:Ext.IComponent, alignment?: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] Suspends the firing of all events */ static suspendEvents(): void; @@ -37978,29 +42100,26 @@ declare module Ext { * @param options Object Extra options object. See addListener for details. * @param order String The order of the listener to remove. Possible values are before, current and after. */ - static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:any ): any; static un( eventName?:any, fn?:any, scope?:any, options?:any, order?:string ): void; - static un( eventName?:any, fn?:string, scope?:any, options?:any, order?:string ): void; /** [Method] Alias for removeAfterListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unAfter( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unAfter( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Alias for removeBeforeListener * @param eventName String/String[]/Object The name of the event the handler was associated with. * @param fn Function/String The handler to remove. * @param scope Object The scope originally specified for fn. * @param options Object Extra options object. */ - static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): any; - static unBefore( eventName?:any, fn?:string, scope?:any, options?:any ): void; + static unBefore( eventName?:any, fn?:any, scope?:any, options?:any ): void; /** [Method] Convenience method which calls setMasked with a value of false to hide the mask */ static unmask(): void; /** [Method] Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector * @param selector String The simple selector to test. + * @returns Ext.Container The matching ancestor Container (or undefined if no match was found). */ static up( selector?:string ): Ext.IContainer; /** [Method] Updates the HTML content of the Component */ @@ -38034,6 +42153,7 @@ declare module Ext { * @param values Object/Array The template values. See apply. * @param out Array The array to which output is pushed. * @param parent Object + * @returns Array The given out array. */ applyOut?( values?:any, out?:any[], parent?:any ): any[]; } @@ -38044,13 +42164,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] * @param args Object */ static callParent( args?: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 @@ -38060,19 +42183,22 @@ 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] 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; }