Files
Ext-more.js
Ext.js

Ext core utilities and functions.

Defined By

Properties

Ext
view source

BLANK_IMAGE_URL : String

URL to a 1x1 transparent gif image used by Ext to create inline icons with CSS background images. ...

URL to a 1x1 transparent gif image used by Ext to create inline icons with CSS background images.\nIn older versions of IE, this defaults to \"http://extjs.com/s.gif\" and you should change this to a URL on your server.\nFor other browsers it uses an inline data URL.

Ext
view source

SSL_SECURE_URL : String

URL to a blank file used by Ext when in secure mode for iframe src and onReady src to prevent\nthe IE insecure content...

URL to a blank file used by Ext when in secure mode for iframe src and onReady src to prevent\nthe IE insecure content warning ('about:blank', except for IE in secure mode, which is 'javascript:\"\"').

Ext
view source

USE_NATIVE_JSON : Boolean

Indicates whether to use native browser parsing for JSON methods. ...

Indicates whether to use native browser parsing for JSON methods.\nThis option is ignored if the browser does not support native JSON methods.\nNote: Native JSON methods will not work with objects that have functions.\nAlso, property names must be quoted, otherwise the data will not parse. (Defaults to false)

Defaults to: false

Ext
view source

emptyFn : Function

A reusable empty function

Ext
view source

enableForcedBoxModel : Boolean

HIGHLY EXPERIMENTAL\nTrue to force css based border-box model override and turning off javascript based adjustments. ...

HIGHLY EXPERIMENTAL\nTrue to force css based border-box model override and turning off javascript based adjustments. This is a\nruntime configuration and must be set before onReady.

Defaults to: false

Ext
view source

enableFx : Boolean

True if the Ext.Fx Class is available

Ext
view source

enableGarbageCollector : Boolean

True to automatically uncache orphaned Ext.Elements periodically (defaults to true) ...

True to automatically uncache orphaned Ext.Elements periodically (defaults to true)

Defaults to: true

Ext
view source

enableListenerCollection : Boolean

True to automatically purge event listeners during garbageCollection (defaults to false). ...

True to automatically purge event listeners during garbageCollection (defaults to false).

Defaults to: false

Ext
view source

enableNestedListenerRemoval : Boolean

EXPERIMENTAL - True to cascade listener removal to child elements when an element is removed. ...

EXPERIMENTAL - True to cascade listener removal to child elements when an element is removed.\nCurrently not optimized for performance.

Defaults to: false

Ext
view source

isAir : Boolean

True if the detected platform is Adobe Air.

Ext
view source

isBorderBox : Boolean

True if the detected browser is Internet Explorer running in non-strict mode.

Ext
view source

isChrome : Boolean

True if the detected browser is Chrome.

Ext
view source

isGecko : Boolean

True if the detected browser uses the Gecko layout engine (e.g. ...

True if the detected browser uses the Gecko layout engine (e.g. Mozilla, Firefox).

Ext
view source

isGecko2 : Boolean

True if the detected browser uses a pre-Gecko 1.9 layout engine (e.g. ...

True if the detected browser uses a pre-Gecko 1.9 layout engine (e.g. Firefox 2.x).

Ext
view source

isGecko3 : Boolean

True if the detected browser uses a Gecko 1.9+ layout engine (e.g. ...

True if the detected browser uses a Gecko 1.9+ layout engine (e.g. Firefox 3.x).

Ext
view source

isIE : Boolean

True if the detected browser is Internet Explorer.

Ext
view source

isIE10 : Boolean

True if the detected browser is Internet Explorer 10.x

Ext
view source

isIE10p : Boolean

True if the detected browser is Internet Explorer 10.x or higher

Ext
view source

isIE6 : Boolean

True if the detected browser is Internet Explorer 6.x.

Ext
view source

isIE7 : Boolean

True if the detected browser is Internet Explorer 7.x.

Ext
view source

isIE8 : Boolean

True if the detected browser is Internet Explorer 8.x.

Ext
view source

isIE9 : Boolean

True if the detected browser is Internet Explorer 9.x.

Ext
view source

isIE9m : Boolean

True if the detected browser is Internet Explorer 9.x or lower

Ext
view source

isLinux : Boolean

True if the detected platform is Linux.

Ext
view source

isMac : Boolean

True if the detected platform is Mac OS.

Ext
view source

isOpera : Boolean

True if the detected browser is Opera.

Ext
view source

isReady : Boolean

True when the document is fully initialized and ready for action ...

True when the document is fully initialized and ready for action

Defaults to: false

Ext
view source

isSafari : Boolean

True if the detected browser is Safari.

Ext
view source

isSafari2 : Boolean

True if the detected browser is Safari 2.x.

Ext
view source

isSafari3 : Boolean

True if the detected browser is Safari 3.x.

Ext
view source

isSafari4 : Boolean

True if the detected browser is Safari 4.x.

Ext
view source

isSecure : Boolean

True if the page is running over SSL

Ext
view source

isStrict : Boolean

True if the browser is in strict (standards-compliant) mode, as opposed to quirks mode

Ext
view source

isWebKit : Boolean

True if the detected browser uses WebKit.

Ext
view source

isWindows : Boolean

True if the detected platform is Windows.

Ext
view source

useShims : Boolean

By default, Ext intelligently decides whether floating elements should be shimmed. ...

By default, Ext intelligently decides whether floating elements should be shimmed. If you are using flash,\nyou may want to set this to true.

Ext
view source

ux : Object

Namespace alloted for extensions to the framework.

Ext
view source

version : String

The version of the framework ...

The version of the framework

Defaults to: '3.4.1.1'

Ext
view source

versionDetail : Objectprivate

...

Defaults to: {major: 3, minor: 4, patch: 1.1}

Defined By

Methods

Ext
view source

addBehaviors( obj )

Applies event listeners to elements by selectors when the document is ready. ...

Applies event listeners to elements by selectors when the document is ready.\nThe event name is specified with an @ suffix.

\n\n

Ext.addBehaviors({\n    // add a listener for click on all anchors in element with id foo\n    '#foo a@click' : function(e, t){\n        // do something\n    },\n\n    // add the same listener to multiple selectors (separated by comma BEFORE the @)\n    '#foo a, #bar span.some-class@mouseover' : function(){\n        // do something\n    }\n});\n

\n\n

Parameters

obj : Object
The list of behaviors to apply
\n

Ext
view source

apply( obj, config, defaults ) : Object

Copies all the properties of config to obj. ...

Copies all the properties of config to obj. apply

Parameters

obj : Object
The receiver of the properties
\n
config : Object
The source of the properties
\n
defaults : Object
A different object that will also be applied for default values
\n

Returns

Object
returns obj
\n

Ext
view source

applyIf( obj, config ) : Object

Copies all the properties of config to obj if they don't already exist. ...

Copies all the properties of config to obj if they don't already exist.

Parameters

obj : Object
The receiver of the properties
\n
config : Object
The source of the properties
\n

Returns

Object
returns obj
\n

Ext
view source

clean( arr ) : Array

Creates a copy of the passed Array with falsy values removed. ...

Creates a copy of the passed Array with falsy values removed.

Parameters

arr : Array/NodeList
The Array from which to remove falsy values.
\n

Returns

Array
The new, compressed Array.
\n

Ext
view source

copyTo( dest, source, names ) : Object

Copies a set of named properties fom the source object to the destination object. ...

Copies a set of named properties fom the source object to the destination object.

\n\n

example:\n

ImageComponent = Ext.extend(Ext.BoxComponent, {\n    initComponent: function() {\n        this.autoEl = { tag: 'img' };\n        MyComponent.superclass.initComponent.apply(this, arguments);\n        this.initialBox = Ext.copyTo({}, this.initialConfig, 'x,y,width,height');\n    }\n});\n

\n\n

Parameters

dest : Object
The destination object.
\n
source : Object
The source object.
\n
names : Array/String
Either an Array of property names, or a comma-delimited list\nof property names to copy.
\n

Returns

Object
The modified object.
\n

Ext
view source

create( config, defaultType ) : Ext.Component

Shorthand for Ext.ComponentMgr.create\nCreates a new Component from the specified config object using the\nconfig objec...

Shorthand for Ext.ComponentMgr.create\nCreates a new Component from the specified config object using the\nconfig object's xtype to determine the class to instantiate.

Parameters

config : Object
A configuration object for the Component you wish to create.
\n
defaultType : Constructor
The constructor to provide the default Component type if\nthe config object does not contain a xtype. (Optional if the config contains a xtype).
\n

Returns

Ext.Component
The newly instantiated Component.
\n

Ext
view source

createDelegate( fn, [scope], [args], [appendArgs] ) : Function

Shorthand for Ext.util.Functions.createDelegate ...

Shorthand for Ext.util.Functions.createDelegate

Parameters

fn : Function
The function to delegate.
\n
scope : Object (optional)
The scope (this reference) in which the function is executed.\nIf omitted, defaults to the browser window.
\n
args : Array (optional)
Overrides arguments for the call. (Defaults to the arguments passed by the caller)
\n
appendArgs : Boolean/Number (optional)
if True args are appended to call args instead of overriding,\nif a number the args are inserted at the specified position
\n

Returns

Function
The new function
\n

Ext
view source

createInterceptor( origFn, newFn, [scope] ) : Function

Shorthand for Ext.util.Functions.createInterceptor ...

Shorthand for Ext.util.Functions.createInterceptor

Parameters

origFn : Function
The original function.
\n
newFn : Function
The function to call before the original
\n
scope : Object (optional)
The scope (this reference) in which the passed function is executed.\nIf omitted, defaults to the scope in which the original function is called or the browser window.
\n

Returns

Function
The new function
\n

Ext
view source

createSequence( origFn, newFn, [scope] ) : Function

Shorthand for Ext.util.Functions.createSequence ...

Shorthand for Ext.util.Functions.createSequence

Parameters

origFn : Function
The original function.
\n
newFn : Function
The function to sequence
\n
scope : Object (optional)
The scope (this reference) in which the passed function is executed.\nIf omitted, defaults to the scope in which the original function is called or the browser window.
\n

Returns

Function
The new function
\n

Ext
view source

decode( json, [safe] ) : Object

Shorthand for Ext.util.JSON.decode ...

Shorthand for Ext.util.JSON.decode

Parameters

json : String
The JSON string
\n
safe : Boolean (optional)
Whether to return null or throw an exception if the JSON is invalid.
\n

Returns

Object
The resulting object
\n

Ext
view source

defer( fn, millis, [scope], [args], [appendArgs] ) : Number

Shorthand for Ext.util.Functions.defer ...

Shorthand for Ext.util.Functions.defer

Parameters

fn : Function
The function to defer.
\n
millis : Number
The number of milliseconds for the setTimeout call (if less than or equal to 0 the function is executed immediately)
\n
scope : Object (optional)
The scope (this reference) in which the function is executed.\nIf omitted, defaults to the browser window.
\n
args : Array (optional)
Overrides arguments for the call. (Defaults to the arguments passed by the caller)
\n
appendArgs : Boolean/Number (optional)
if True args are appended to call args instead of overriding,\nif a number the args are inserted at the specified position
\n

Returns

Number
The timeout id that can be used with clearTimeout
\n

Ext
view source

define( className, data, createdFn ) : Ext.Base

Defines a class or override. ...

Defines a class or override. A basic class is defined like this:

\n\n

 Ext.define('My.awesome.Class', {\n     someProperty: 'something',\n\n     someMethod: function(s) {\n         alert(s + this.someProperty);\n     }\n\n     ...\n });\n\n var obj = new My.awesome.Class();\n\n obj.someMethod('Say '); // alerts 'Say something'\n

\n\n

To create an anonymous class, pass null for the className:

\n\n

 Ext.define(null, {\n     constructor: function () {\n         // ...\n     }\n });\n

\n\n

In some cases, it is helpful to create a nested scope to contain some private\nproperties. The best way to do this is to pass a function instead of an object\nas the second parameter. This function will be called to produce the class\nbody:

\n\n

 Ext.define('MyApp.foo.Bar', function () {\n     var id = 0;\n\n     return {\n         nextId: function () {\n             return ++id;\n         }\n     };\n });\n

\n\n

When using this form of Ext.define, the function is passed a reference to its\nclass. This can be used as an efficient way to access any static properties you\nmay have:

\n\n

 Ext.define('MyApp.foo.Bar', function (Bar) {\n     return {\n         statics: {\n             staticMethod: function () {\n                 // ...\n             }\n         },\n\n         method: function () {\n             return Bar.staticMethod();\n         }\n     };\n });\n

\n\n

To define an override, include the override property. The content of an\noverride is aggregated with the specified class in order to extend or modify\nthat class. This can be as simple as setting default property values or it can\nextend and/or replace methods. This can also extend the statics of the class.

\n\n

One use for an override is to break a large class into manageable pieces.

\n\n

 // File: /src/app/Panel.js\n\n Ext.define('My.app.Panel', {\n     extend: 'Ext.panel.Panel',\n\n     constructor: function (config) {\n         this.callParent(arguments); // calls Ext.panel.Panel's constructor\n         //...\n     },\n\n     statics: {\n         method: function () {\n             return 'abc';\n         }\n     }\n });\n\n // File: /src/app/PanelPart2.js\n Ext.define('My.app.PanelPart2', {\n     override: 'My.app.Panel',\n\n     constructor: function (config) {\n         this.callParent(arguments); // calls My.app.Panel's constructor\n         //...\n     }\n });\n

\n\n

Another use of overrides is to provide optional parts of classes that can be\nindependently required. In this case, the class may even be unaware of the\noverride altogether.

\n\n

 Ext.define('My.ux.CoolTip', {\n     override: 'Ext.tip.ToolTip',\n\n     constructor: function (config) {\n         this.callParent(arguments); // calls Ext.tip.ToolTip's constructor\n         //...\n     }\n });\n

\n\n

Overrides can also contain statics:

\n\n

 Ext.define('My.app.BarMod', {\n     override: 'Ext.foo.Bar',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x * 2]); // call Ext.foo.Bar.method\n         }\n     }\n });\n

Parameters

className : String
The class name to create in string dot-namespaced format, for example:\n'My.very.awesome.Class', 'FeedViewer.plugin.CoolPager'\nIt is highly recommended to follow this simple convention:\n - The root and the class name are 'CamelCased'\n - Everything else is lower-cased\nPass null to create an anonymous class.
\n
data : Object
The key - value pairs of properties to apply to this class. Property names can be of any valid\nstrings, except those in the reserved listed below:\n - mixins\n - statics\n - config\n - alias\n - self\n - singleton\n - alternateClassName\n - override
\n
createdFn : Function
Optional callback to execute after the class is created, the execution scope of which\n(this) will be the newly created class itself.
\n

Returns

Ext.Base
\n

Ext
view source

destroy( args )

Attempts to destroy any objects passed to it by removing all event listeners, removing them from the\nDOM (if applicab...

Attempts to destroy any objects passed to it by removing all event listeners, removing them from the\nDOM (if applicable) and calling their destroy functions (if available). This method is primarily\nintended for arguments of type Ext.Element and Ext.Component, but any subclass of\nExt.util.Observable can be passed in. Any number of elements and/or components can be\npassed into this function in a single call as separate arguments.

Parameters

args : Mixed...
An Ext.Element, Ext.Component, or an Array of either of these to destroy
\n

Ext
view source

destroyMembers( o, arg1, etc )

Attempts to destroy and then remove a set of named properties of the passed object. ...

Attempts to destroy and then remove a set of named properties of the passed object.

Parameters

o : Object
The object (most likely a Component) who's properties you wish to destroy.
\n
arg1 : Mixed
The name of the property to destroy and remove from the object.
\n
etc : Mixed
... More property names to destroy and remove.
\n

Ext
view source

each( array, fn, scope ) : Object

Iterates an array calling the supplied function. ...

Iterates an array calling the supplied function.

Parameters

array : Array/NodeList/Mixed
The array to be iterated. If this\nargument is not really an array, the supplied function is called once.
\n
fn : Function
The function to be called with each item. If the\nsupplied function returns false, iteration stops and this method returns\nthe current index. This function is called with\nthe following arguments:
\n\n
- item : Mixed\n
  The item at the current index\nin the passed array
- index : Number\n
  The current index within the array
- allItems : Array\n
  The array passed as the first\nargument to Ext.each.
\n\n
scope : Object
The scope (this reference) in which the specified function is executed.\nDefaults to the item at the current index\nwithin the passed array.
\n

Returns

Object
See description for the fn parameter.
\n

Ext
view source

encode( o ) : String

Shorthand for Ext.util.JSON.encode ...

Shorthand for Ext.util.JSON.encode

Parameters

o : Mixed
The variable to encode
\n

Returns

String
The JSON string
\n

Ext
view source

escapeRe( str ) : String

Escapes the passed string for use in a regular expression ...

Escapes the passed string for use in a regular expression

Parameters

str : String
\n

Returns

String
\n

Ext
view source

extend( superclass, overrides ) : Function

Extends one class to create a subclass and optionally overrides members with the passed literal. ...

Extends one class to create a subclass and optionally overrides members with the passed literal. This method\nalso adds the function \"override()\" to the subclass that can be used to override members of the class.

\n\n\n

For example, to create a subclass of Ext GridPanel:

\n\n

MyGridPanel = Ext.extend(Ext.grid.GridPanel, {\n    constructor: function(config) {\n\n//      Create configuration for this Grid.\n        var store = new Ext.data.Store({...});\n        var colModel = new Ext.grid.ColumnModel({...});\n\n//      Create a new config object containing our computed properties\n//      *plus* whatever was in the config parameter.\n        config = Ext.apply({\n            store: store,\n            colModel: colModel\n        }, config);\n\n        MyGridPanel.superclass.constructor.call(this, config);\n\n//      Your postprocessing here\n    },\n\n    yourMethod: function() {\n        // etc.\n    }\n});\n

\n\n\n\n\n

This function also supports a 3-argument call in which the subclass's constructor is\npassed as an argument. In this form, the parameters are as follows:

\n\n\n

subclass : Function
The subclass constructor.
superclass : Function
The constructor of class being extended
overrides : Object
A literal with members which are copied into the subclass's\nprototype, and are therefore shared among all instances of the new class.

\n\n

Parameters

superclass : Function
The constructor of class being extended.
\n
overrides : Object
A literal with members which are copied into the subclass's\nprototype, and are therefore shared between all instances of the new class.
\n\n\n
This may contain a special member named constructor. This is used\nto define the constructor of the new class, and is returned. If this property is\nnot specified, a constructor is generated and returned which just calls the\nsuperclass's constructor passing on its parameters.
\n\n\n
It is essential that you call the superclass constructor in any provided constructor. See example code.
\n\n

Returns

Function
The subclass constructor from the overrides parameter, or a generated one if not provided.
\n

Ext
view source

flatten( arr ) : Array

Recursively flattens into 1-d Array. ...

Recursively flattens into 1-d Array. Injects Arrays inline.

Parameters

arr : Array
The array to flatten
\n

Returns

Array
The new, flattened array.
\n

Ext
view source

fly( el, [named] ) : Element

Gets the globally shared flyweight Element, with the passed node as the active element. ...

Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code. Shorthand of Ext.Element.fly

\n\n\n

Use this to make one-time references to DOM elements which are not going to be accessed again either by\napplication code, or by Ext's classes. If accessing an element which will be processed regularly, then get\nwill be more appropriate to take advantage of the caching provided by the Ext.Element class.

\n\n

Parameters

el : String/HTMLElement
The dom node or id
\n
named : String (optional)
Allows for creation of named reusable flyweights to prevent conflicts\n(e.g. internally Ext uses \"_global\")
\n

Returns

Element
The shared Element object (or null if no matching element was found)
\n

Ext
view source

get( el ) : Element

Retrieves Ext.Element objects. ...

Retrieves Ext.Element objects.

\n\n

This method does not retrieve Components. This method\nretrieves Ext.Element objects which encapsulate DOM elements. To retrieve a Component by\nits ID, use Ext.ComponentMgr.get.

\n\n\n

Uses simple caching to consistently return the same object. Automatically fixes if an\nobject was recreated with the same id via AJAX or DOM.

\n\n\n

Shorthand of Ext.Element.get

Parameters

el : Mixed
The id of the node, a DOM Node or an existing Element.
\n

Returns

Element
The Element object (or null if no matching element was found)
\n

Ext
view source

getBody( ) : Object

Returns the current document body as an Ext.Element. ...

Returns the current document body as an Ext.Element.

Returns

Object
Ext.Element The document body
\n

Ext
view source

getCmp( id ) : Object

This is shorthand reference to Ext.ComponentMgr.get. ...

This is shorthand reference to Ext.ComponentMgr.get.\nLooks up an existing Component by id

Parameters

id : String
The component id
\n

Returns

Object
Ext.Component The Component, undefined if not found, or null if a\nClass was found.
\n

Ext
view source

getDoc( ) : Object

Returns the current HTML document object as an Ext.Element. ...

Returns the current HTML document object as an Ext.Element.

Returns

Object
Ext.Element The document
\n

Ext
view source

getDom( el ) : Object

Return the dom node for the passed String (id), dom node, or Ext.Element. ...

Return the dom node for the passed String (id), dom node, or Ext.Element.\nOptional 'strict' flag is needed for IE since it can return 'name' and\n'id' elements by using getElementById.\nHere are some examples:

\n\n

// gets dom node based on id\nvar elDom = Ext.getDom('elId');\n// gets dom node based on the dom node\nvar elDom1 = Ext.getDom(elDom);\n\n// If we don't know if we are working with an\n// Ext.Element or a dom node use Ext.getDom\nfunction(el){\n    var dom = Ext.getDom(el);\n    // do something with the dom node\n}\n

\n\n\n

Note: the dom node to be found actually needs to exist (be rendered, etc)\nwhen this method is called to be successful.

Parameters

el : Mixed
\n

Returns

Object
HTMLElement
\n

Ext
view source

getHead( ) : Object

Returns the current document body as an Ext.Element. ...

Returns the current document body as an Ext.Element.

Returns

Object
Ext.Element The document body
\n

Ext
view source

getScrollBarWidth( [force] ) : Number

Utility method for getting the width of the browser scrollbar. ...

Utility method for getting the width of the browser scrollbar. This can differ depending on\noperating system settings, such as the theme or font size.

Parameters

force : Boolean (optional)
true to force a recalculation of the value.
\n

Returns

Number
The width of the scrollbar.
\n

Ext
view source

handleError( e )

Framework-wide error-handler. ...

Framework-wide error-handler. Developers can override this method to provide\ncustom exception-handling. Framework errors will often extend from the base\nExt.Error class.

Parameters

e : Object/Error
The thrown exception object.
\n

Ext
view source

id( [el], [prefix] ) : String

Generates unique ids. ...

Generates unique ids. If the element already has an id, it is unchanged

Parameters

el : Mixed (optional)
The element to generate an id for
\n
prefix : String (optional)
Id prefix (defaults \"ext-gen\")
\n

Returns

String
The generated Id.
\n

Ext
view source

invoke( arr, methodName, args ) : Array

Invokes a method on each item in an Array. ...

Invokes a method on each item in an Array.

\n\n

// Example:\nExt.invoke(Ext.query(\"p\"), \"getAttribute\", \"id\");\n// [el1.getAttribute(\"id\"), el2.getAttribute(\"id\"), ..., elN.getAttribute(\"id\")]\n

\n\n

Parameters

arr : Array|NodeList
The Array of items to invoke the method on.
\n
methodName : String
The method name to invoke.
\n
args : ...*
Arguments to send into the method invocation.
\n

Returns

Array
The results of invoking the method on each item in the array.
\n

Ext
view source

isArray( value ) : Boolean

Returns true if the passed value is a JavaScript array, otherwise false. ...

Returns true if the passed value is a JavaScript array, otherwise false.

Parameters

value : Mixed
The value to test
\n

Returns

Boolean
\n

Ext
view source

isBoolean( value ) : Boolean

Returns true if the passed value is a boolean. ...

Returns true if the passed value is a boolean.

Parameters

value : Mixed
The value to test
\n

Returns

Boolean
\n

Ext
view source

isDate( object ) : Boolean

Returns true if the passed object is a JavaScript date object, otherwise false. ...

Returns true if the passed object is a JavaScript date object, otherwise false.

Parameters

object : Object
The object to test
\n

Returns

Boolean
\n

Ext
view source

isDefined( value ) : Boolean

Returns true if the passed value is not undefined. ...

Returns true if the passed value is not undefined.

Parameters

value : Mixed
The value to test
\n

Returns

Boolean
\n

Ext
view source

isElement( value ) : Boolean

Returns true if the passed value is an HTMLElement ...

Returns true if the passed value is an HTMLElement

Parameters

value : Mixed
The value to test
\n

Returns

Boolean
\n

Ext
view source

isEmpty( value, [allowBlank] ) : Boolean

Returns true if the passed value is empty. ...

Returns true if the passed value is empty.

\n\n\n

The value is deemed to be empty if it is

null
undefined
an empty array
a zero length string (Unless the allowBlank parameter is true)

\n\n

Parameters

value : Mixed
The value to test
\n
allowBlank : Boolean (optional)
true to allow empty strings (defaults to false)
\n

Returns

Boolean
\n

Ext
view source

isFunction( value ) : Boolean

Returns true if the passed value is a JavaScript Function, otherwise false. ...

Returns true if the passed value is a JavaScript Function, otherwise false.

Parameters

value : Mixed
The value to test
\n

Returns

Boolean
\n

Ext
view source

isNumber( value ) : Boolean

Returns true if the passed value is a number. ...

Returns true if the passed value is a number. Returns false for non-finite numbers.

Parameters

value : Mixed
The value to test
\n

Returns

Boolean
\n

Ext
view source

isObject( value ) : Boolean

Returns true if the passed value is a JavaScript Object, otherwise false. ...

Returns true if the passed value is a JavaScript Object, otherwise false.

Parameters

value : Mixed
The value to test
\n

Returns

Boolean
\n

Ext
view source

isPrimitive( value ) : Boolean

Returns true if the passed value is a JavaScript 'primitive', a string, number or boolean. ...

Returns true if the passed value is a JavaScript 'primitive', a string, number or boolean.

Parameters

value : Mixed
The value to test
\n

Returns

Boolean
\n

Ext
view source

isString( value ) : Boolean

Returns true if the passed value is a string. ...

Returns true if the passed value is a string.

Parameters

value : Mixed
The value to test
\n

Returns

Boolean
\n

Ext
view source

iterate( object, fn, scope )

Iterates either the elements in an array, or each of the properties in an object. ...

Iterates either the elements in an array, or each of the properties in an object.\nNote: If you are only iterating arrays, it is better to call each.

Parameters

object : Object/Array
The object or array to be iterated
\n
fn : Function
The function to be called for each iteration.\nThe iteration will stop if the supplied function returns false, or\nall array elements / object properties have been covered. The signature\nvaries depending on the type of object being interated:
\n\n
- Arrays : (Object item, Number index, Array allItems)\n
  \nWhen iterating an array, the supplied function is called with each item.
- Objects : (String key, Object value, Object)\n
  \nWhen iterating an object, the supplied function is called with each key-value pair in\nthe object, and the iterated object
\n\n
scope : Object
The scope (this reference) in which the specified function is executed. Defaults to\nthe object being iterated.
\n

Ext
view source

max( arr, [comp] )

Returns the maximum value in the Array ...

Returns the maximum value in the Array

Parameters

arr : Array|NodeList
The Array from which to select the maximum value.
\n
comp : Function (optional)
a function to perform the comparision which determines maximization.
\n\n
```
              If omitted the \">\" operator will be used. Note: gt = 1; eq = 0; lt = -1\n
```
\n\n
@return {Object} The maximum value in the Array.
\n

Ext
view source

mean( arr ) : Number

Calculates the mean of the Array ...

Calculates the mean of the Array

Parameters

arr : Array
The Array to calculate the mean value of.
\n

Returns

Number
The mean.
\n

Ext
view source

min( arr, [comp] )

Returns the minimum value in the Array. ...

Returns the minimum value in the Array.

Parameters

arr : Array|NodeList
The Array from which to select the minimum value.
\n
comp : Function (optional)
a function to perform the comparision which determines minimization.
\n\n
```
              If omitted the \"<\" operator will be used. Note: gt = 1; eq = 0; lt = -1\n
```
\n\n
@return {Object} The minimum value in the Array.
\n

Ext
view source

namespace( namespace1, namespace2, etc ) : Object

Creates namespaces to be used for scoping variables and classes so that they are not global. ...

Creates namespaces to be used for scoping variables and classes so that they are not global.\nSpecifying the last node of a namespace implicitly creates all other nodes. Usage:

\n\n

Ext.namespace('Company', 'Company.data');\nExt.namespace('Company.data'); // equivalent and preferable to above syntax\nCompany.Widget = function() { ... }\nCompany.data.CustomStore = function(config) { ... }\n

\n\n

Parameters

namespace1 : String
\n
namespace2 : String
\n
etc : String
\n

Returns

Object
The namespace object. (If multiple arguments are passed, this will be the last namespace created)
\n

Ext
view source

ns( namespace1, namespace2, etc ) : Object

Creates namespaces to be used for scoping variables and classes so that they are not global. ...

Creates namespaces to be used for scoping variables and classes so that they are not global.\nSpecifying the last node of a namespace implicitly creates all other nodes. Usage:

\n\n

Ext.namespace('Company', 'Company.data');\nExt.namespace('Company.data'); // equivalent and preferable to above syntax\nCompany.Widget = function() { ... }\nCompany.data.CustomStore = function(config) { ... }\n

\n\n

Parameters

namespace1 : String
\n
namespace2 : String
\n
etc : String
\n

Returns

Object
The namespace object. (If multiple arguments are passed, this will be the last namespace created)
\n

Ext
view source

num( value, defaultValue ) : Number

Utility method for validating that a value is numeric, returning the specified default value if it is not. ...

Utility method for validating that a value is numeric, returning the specified default value if it is not.

Parameters

value : Mixed
Should be a number, but any type will be handled appropriately
\n
defaultValue : Number
The value to return if the original value is non-numeric
\n

Returns

Number
Value, if numeric, else defaultValue
\n

Ext
view source

onReady( fn, [scope], [options] )

Adds a listener to be notified when the document is ready (before onload and before images are loaded). ...

Adds a listener to be notified when the document is ready (before onload and before images are loaded). Shorthand of Ext.EventManager.onDocumentReady.

Parameters

fn : Function
The method the event invokes.
\n
scope : Object (optional)
The scope (this reference) in which the handler function executes. Defaults to the browser window.
\n
options : boolean (optional)
Options object as passed to Ext.Element.addListener. It is recommended that the options\n{single: true} be used so that the handler is removed on first invocation.
\n

Ext
view source

override( target, overrides )

Overrides members of the specified target with the given values. ...

Overrides members of the specified target with the given values.

\n\n

If the target is a function, it is assumed to be a constructor and the contents\nof overrides are applied to its prototype using Ext.apply.

\n\n

If the target is an instance of a class created using define,\nthe overrides are applied to only that instance. In this case, methods are\nspecially processed to allow them to use Ext.Base.callParent.

\n\n

 var panel = new Ext.Panel({ ... });\n\n Ext.override(panel, {\n     initComponent: function () {\n         // extra processing...\n\n         this.callParent();\n     }\n });\n

\n\n

If the target is none of these, the overrides are applied to the target\nusing Ext.apply.

\n\n

Please refer to Ext.define for further details.

Parameters

target : Object
The target to override.
\n
overrides : Object
The properties to add or replace on target.
\n

Ext
view source

partition( arr, [truth] )

Partitions the set into two sets: a true set and a false set. ...

Partitions the set into two sets: a true set and a false set.\nExample:\nExample2:

\n\n

// Example 1:\nExt.partition([true, false, true, true, false]); // [[true, true, true], [false, false]]\n\n// Example 2:\nExt.partition(\n    Ext.query(\"p\"),\n    function(val){\n        return val.className == \"class1\"\n    }\n);\n// true are those paragraph elements with a className of \"class1\",\n// false set are those that do not have that className.\n

\n\n

Parameters

arr : Array|NodeList
The array to partition
\n
truth : Function (optional)
a function to determine truth. If this is omitted the element
\n\n
```
              itself must be able to be evaluated for its truthfulness.\n
```
\n\n
@return {Array} [true,false]
\n

Ext
view source

pluck( arr, prop ) : Array

Plucks the value of a property from each item in the Array\n\n// Example:\nExt.pluck(Ext.query(\"p\"), \"className\"); // [e...

Plucks the value of a property from each item in the Array

\n\n

// Example:\nExt.pluck(Ext.query(\"p\"), \"className\"); // [el1.className, el2.className, ..., elN.className]\n

\n\n

Parameters

arr : Array|NodeList
The Array of items to pluck the value from.
\n
prop : String
The property name to pluck from each element.
\n

Returns

Array
The value from each item in the Array.
\n

Ext
view source

preg( ptype, cls )

Shorthand for Ext.ComponentMgr.registerPlugin ...

Shorthand for Ext.ComponentMgr.registerPlugin

Parameters

ptype : String
The mnemonic string by which the Plugin class\nmay be looked up.
\n
cls : Constructor
The new Plugin class.
\n

Ext
view source

query( path, [root] ) : Array

Selects an array of DOM nodes by CSS/XPath selector. ...

Selects an array of DOM nodes by CSS/XPath selector. Shorthand of Ext.DomQuery.select

Parameters

path : String
The selector/xpath query
\n
root : Node (optional)
The start of the query (defaults to document).
\n

Returns

Array
\n

Ext
view source

reg( xtype, cls )

Shorthand for Ext.ComponentMgr.registerType ...

Shorthand for Ext.ComponentMgr.registerType

Parameters

xtype : String
The mnemonic string by which the Component class\nmay be looked up.
\n
cls : Constructor
The new Component class.
\n

Ext
view source

removeNode( node )

Removes this element from the document, removes all DOM event listeners, and deletes the cache reference. ...

Removes this element from the document, removes all DOM event listeners, and deletes the cache reference.\nAll DOM event listeners are removed from this element. If enableNestedListenerRemoval is\ntrue, then DOM event listeners are also removed from all child nodes. The body node\nwill be ignored if passed in.

\n\n

Parameters

node : HTMLElement
The node to remove
\n

Ext
view source

select( selector, [root] ) : CompositeElementLite/CompositeElement

Selects elements based on the passed CSS selector to enable Element methods\nto be applied to many related elements in...

Selects elements based on the passed CSS selector to enable Element methods\nto be applied to many related elements in one statement through the returned CompositeElement or\nCompositeElementLite object.

Parameters

selector : String/Array
The CSS selector or an array of elements
\n
root : HTMLElement/String (optional)
The root element of the query or id of the root
\n

Returns

CompositeElementLite/CompositeElement
\n

Ext
view source

sum( arr ) : Number

Calculates the sum of the Array ...

Calculates the sum of the Array

Parameters

arr : Array
The Array to calculate the sum value of.
\n

Returns

Number
The sum.
\n

Ext
view source

toArray( the ) : Object

Converts any iterable (numeric indices and a length property) into a true array\nDon't use this on strings. ...

Converts any iterable (numeric indices and a length property) into a true array\nDon't use this on strings. IE doesn't support \"abc\"[0] which this implementation depends on.\nFor strings, use this instead: \"abc\".match(/./g) => [a,b,c];

Parameters

the : Iterable
iterable object to be turned into a true Array.
\n

Returns

Object
(Array) array
\n

Ext
view source

type( object ) : String

Returns the type of object that is passed in. ...

Returns the type of object that is passed in. If the object passed in is null or undefined it\nreturn false otherwise it returns one of the following values:

string: If the object passed is a string
number: If the object passed is a number
boolean: If the object passed is a boolean value
date: If the object passed is a Date object
function: If the object passed is a function reference
object: If the object passed is an object
array: If the object passed is an array
regexp: If the object passed is a regular expression
element: If the object passed is a DOM Element
nodelist: If the object passed is a DOM NodeList
textnode: If the object passed is a DOM text node and contains something other than whitespace
whitespace: If the object passed is a DOM text node and contains only whitespace

Parameters

object : Mixed
\n

Returns

String
\n

Ext
view source

unique( arr ) : Array

Creates a copy of the passed Array, filtered to contain only unique values. ...

Creates a copy of the passed Array, filtered to contain only unique values.

Parameters

arr : Array
The Array to filter
\n

Returns

Array
The new Array containing unique values.
\n

Ext
view source

urlAppend( url, s ) : Object

Appends content to the query string of a URL, handling logic for whether to place\na question mark or ampersand. ...

Appends content to the query string of a URL, handling logic for whether to place\na question mark or ampersand.

Parameters

url : String
The URL to append to.
\n
s : String
The content to append to the URL.
\n

Returns

Object
(String) The resulting URL
\n

Ext
view source

urlDecode( string, [overwrite] ) : Object

Takes an encoded URL and and converts it to an object. ...

Takes an encoded URL and and converts it to an object. Example:

\n\n

Ext.urlDecode(\"foo=1&bar=2\"); // returns {foo: \"1\", bar: \"2\"}\nExt.urlDecode(\"foo=1&bar=2&bar=3&bar=4\", false); // returns {foo: \"1\", bar: [\"2\", \"3\", \"4\"]}\n

\n\n

Parameters

string : String
\n
overwrite : Boolean (optional)
Items of the same name will overwrite previous values instead of creating an an array (Defaults to false).
\n

Returns

Object
A literal with members
\n

Ext
view source

urlEncode( o, [pre] ) : String

Takes an object and converts it to an encoded URL. ...

Takes an object and converts it to an encoded URL. e.g. Ext.urlEncode({foo: 1, bar: 2}); would return \"foo=1&bar=2\". Optionally, property values can be arrays, instead of keys and the resulting string that's returned will contain a name/value pair for each array value.

Parameters

o : Object
\n
pre : String (optional)
A prefix to add to the url encoded string
\n

Returns

String
\n

Ext
view source

value( value, defaultValue, [allowBlank] ) : Mixed

Utility method for returning a default value if the passed value is empty. ...

Utility method for returning a default value if the passed value is empty.

\n\n\n

The value is deemed to be empty if it is

null
undefined
an empty array
a zero length string (Unless the allowBlank parameter is true)

\n\n

Parameters

value : Mixed
The value to test
\n
defaultValue : Mixed
The value to return if the original value is empty
\n
allowBlank : Boolean (optional)
true to allow zero length strings to qualify as non-empty (defaults to false)
\n

Returns

Mixed
value, if non-empty, else defaultValue
\n

Ext
view source

zip( arr, [zipper] ) : Array

Zips N sets together. ...

Zips N sets together.

\n\n\n

// Example 1:\nExt.zip([1,2,3],[4,5,6]); // [[1,4],[2,5],[3,6]]\n// Example 2:\nExt.zip(\n    [ \"+\", \"-\", \"+\"],\n    [  12,  10,  22],\n    [  43,  15,  96],\n    function(a, b, c){\n        return \"$\" + a + \"\" + b + \".\" + c\n    }\n); // [\"$+12.43\", \"$-10.15\", \"$+22.96\"]\n

\n\n

Parameters

arr : Arrays|NodeLists
This argument may be repeated. Array(s) to contribute values.
\n
zipper : Function (optional)
The last item in the argument list. This will drive how the items are zipped together.
\n

Returns

Array
The zipped set.
\n