Hierarchy
Ext.BaseExt.direct.ProviderExt.direct.AmfRemotingProvider
Inherited mixins
Ext.util.Observable
Requires
Ext.data.amf.Encoder
Ext.data.amf.Packet
Ext.data.amf.RemotingMessage
Ext.data.amf.XmlDecoder
Ext.data.amf.XmlEncoder
Ext.direct.ExceptionEvent
Ext.direct.RemotingMethod
Ext.direct.Transaction
Ext.util.DelayedTask
Ext.util.MixedCollection
Files
AmfRemotingProvider.js

The AmfRemotingProvider\nallows making RPC calls to a Java object on a BlazeDS or ColdFusion using either the AMFX or the AMF protocols.

\n\n\n\n\n

The default protocol is AMFX which works on all browsers. If you choose AMF, a flash plugin might be loaded in certain browsers that do not support posting binary data to the server, e.g. Internet Explorer version 9 or less. To choose AMF, set the binary property to true.

\n\n\n

For AMFX, the server must be configured to expose the desired services via an HTTPEndpoint. For example, the following configuration snippet adds an HTTPEndpoint (AMFX endpoint) to the BlazeDS services-config.xml file:

\n\n\n

<channel-definition id=\"my-http\" class=\"mx.messaging.channels.HTTPChannel\">\n <endpoint url=\"http://{server.name}:{server.port}/{context.root}/messagebroker/http\" class=\"flex.messaging.endpoints.HTTPEndpoint\"/>\n</channel-definition>\n

\n\n\n\n\n

Once the HTTPEndpoint is configured, make sure the service is exposed via the channel by adding the channel (e.g. my-http) to your remoting-services.xml file.\nFor example this allows services to be accessed remotely by both AMF and AMFX:

\n\n\n

<default-channels>\n <channel ref=\"my-amf\"/>\n <channel ref=\"my-http\"/>\n</default-channels>\n

\n\n\n\n\n

In order to make a call, you first need to declare the API to Ext direct. The following example defines local methods to the services provided by the sample Products application provided by Adobe as part of the BlazeDS 4.x binary turnkey distribution's testdrive (Sample 5: Updating Data):

\n\n\n

    Ext.direct.Manager.addProvider({\n        \"url\":\"/samples/messagebroker/http\", // URL for the HTTPEndpoint\n        \"type\":\"amfremoting\",\n        \"endpoint\": \"my-http\", // the name of the HTTPEndpoint channel as defined in the server's services-config.xml\n        \"actions\":{\n        \"product\":[{ // name of the destination as defined in remoting-config.xml on the server\n            \"name\":\"getProducts\", // method name of the method to call\n            \"len\":0 // number of parameters\n        },{\n            \"name\":\"add\",\n            \"len\":1\n        },{\n            \"name\":\"bad\",\n            \"len\":0\n        }]\n        }\n    });\n\n

\n\n\n

You can now call the service as follows:

\n\n\n\n\n

product.getProducts((function(provider, response) {\n    // do something with the response\n    console.log(\"Got \" + response.data.length + \" objects\");\n});\n

\n\n\n

Note that in case server methods require parameters of a specific class (e.g. flex.samples.product.Product), you should make sure the passed parameter has a field called $flexType set to the class name (in this case flex.Samples.product.Product). This is similar to the remote class alias definition in ActionScript.

\n\n

The following example shows how to define a binary AMF-based call:

\n\n\n

    Ext.direct.Manager.addProvider({\n        \"url\":\"/samples/messagebroker/amf\", // URL for the AMFEndpoint\n        \"type\":\"amfremoting\",\n        \"endpoint\": \"my-amf\", // the name of the AMFEndpoint channel as defined in the server's services-config.xml\n        \"binary\": true, // chooses AMF encoding\n        \"actions\":{\n        \"product\":[{ // name of the destination as defined in remoting-config.xml on the server\n            \"name\":\"getProducts\", // method name of the method to call\n            \"len\":0 // number of parameters\n        },{\n            \"name\":\"add\",\n            \"len\":1\n        },{\n            \"name\":\"bad\",\n            \"len\":0\n        }]\n        }\n    });\n\n

\n\n\n

Calling the server is done the same way as for the AMFX-based definition.

\n\n

Defined By

Config options

Ext.direct.AmfRemotingProvider
view source

actions : Object

Object literal defining the server side actions and methods. ...

Object literal defining the server side actions and methods. For example, if\nthe Provider is configured with:

\n\n

\"actions\":{ // each property within the 'actions' object represents a server side Class \n    \"TestAction\":[ // array of methods within each server side Class to be   \n    {              // stubbed out on client\n        \"name\":\"doEcho\", \n        \"len\":1            \n    },{\n        \"name\":\"multiply\",// name of method\n        \"len\":2           // The number of parameters that will be used to create an\n                          // array of data to send to the server side function.\n                          // Ensure the server sends back a Number, not a String. \n    },{\n        \"name\":\"doForm\",\n        \"formHandler\":true, // direct the client to use specialized form handling method \n        \"len\":1\n    }]\n}\n

\n\n\n

Note that a Store is not required, a server method can be called at any time.\nIn the following example a client side handler is used to call the\nserver side method \"multiply\" in the server-side \"TestAction\" Class:

\n\n\n

TestAction.multiply(\n    2, 4, // pass two arguments to server, so specify len=2\n    // callback function after the server is called\n    // result: the result returned by the server\n    //      e: Ext.direct.RemotingEvent object\n    function(result, e) {\n        var t = e.getTransaction();\n        var action = t.action; // server side Class called\n        var method = t.method; // server side method called\n        if(e.status) {\n            var answer = Ext.encode(result); // 8\n    \n        } else {\n            var msg = e.message; // failure message\n        }\n    }\n);\n

\n\n\n

In the example above, the server side \"multiply\" function will be passed two\narguments (2 and 4). The \"multiply\" method should return the value 8 which will be\navailable as the result in the example above.

Ext.direct.AmfRemotingProvider
view source

binary : String

If true, use AMF binary encoding instead of AMFX XML-based encoding. ...

If true, use AMF binary encoding instead of AMFX XML-based encoding. Note that on some browsers, this will load a flash plugin to handle binary communication with the server. Important: If using binary encoding with older browsers, see notes in BinaryXhr regarding packaging the Flash plugin for use in older browsers.

Defaults to: false

Ext.direct.AmfRemotingProvider
view source

enableUrlEncode : String

Specify which param will hold the arguments for the method. ...

Specify which param will hold the arguments for the method.\nDefaults to 'data'.

Ext.direct.AmfRemotingProvider
view source

endpoint : String

Requred. ...

Requred. This is the channel id defined in services-config.xml on the server (e.g. my-amf or my-http).

Ext.direct.Provider
view source

id : String

The unique id of the provider (defaults to an auto-assigned id). ...

The unique id of the provider (defaults to an auto-assigned id).\nYou should assign an id if you need to be able to access the provider later and you do\nnot have an object reference available, for example:

\n\n

 Ext.direct.Manager.addProvider({\n     type: 'polling',\n     url:  'php/poll.php',\n     id:   'poll-provider'\n });\n var p = Ext.direct.Manager.getProvider('poll-provider');\np.disconnect();\n

Ext.util.Observable
view source

listeners : Object

A config object containing one or more event handlers to be added to this object during initialization. ...

A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.

\n\n

DOM events from Ext JS Components

\n\n

While some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:

\n\n

new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n

Ext.direct.AmfRemotingProvider
view source

maxRetries : Number

Number of times to re-attempt delivery on failure of a call. ...

Number of times to re-attempt delivery on failure of a call.

Defaults to: 1

Ext.direct.AmfRemotingProvider
view source

namespace : String/Object

Namespace for the Remoting Provider (defaults to the browser global scope of window). ...

Namespace for the Remoting Provider (defaults to the browser global scope of window).\nExplicitly specify the namespace Object, or specify a String to have a\nnamespace created implicitly.

Ext.direct.Provider
view source

relayedEvents : String[]

List of Provider events that should be relayed by Ext.direct.Manager. ...

List of Provider events that should be relayed by Ext.direct.Manager.\n'data' event is always relayed.

Ext.direct.AmfRemotingProvider
view source

timeout : Number

The timeout to use for each request.

Ext.direct.AmfRemotingProvider
view source

url : String

Required. ...

Required. The URL to connect to the Flex remoting server (LCDS, BlazeDS, etc).\nThis should include the /messagebroker/amf suffix as defined in the services-config.xml and remoting-config.xml files.

Properties

Defined By

Instance Properties

Ext.Base
view source

$className : Stringprivate

...

Defaults to: 'Ext.Base'

Ext.Base
view source

configMap : Objectprivate

...

Defaults to: {}

Ext.util.Observable
view source

eventsSuspended : Numberprivate

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

Ext.util.Observable
view source

hasListeners : Objectreadonly

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set\ndirectly on the instance, or on its class or a super class (via observe) or\non the MVC EventBus. The values of this object are truthy\n(a non-zero number) and falsy (0 or undefined). They do not represent an exact count\nof listeners. The value for an event is truthy if the event must be fired and is\nfalsy if there is no need to fire the event.

\n\n

The intended use of this property is to avoid the expense of fireEvent calls when\nthere are no listeners. This can be particularly helpful when one would otherwise\nhave to call fireEvent hundreds or thousands of times. It is used like this:

\n\n

 if (this.hasListeners.foo) {\n     this.fireEvent('foo', this, arg1);\n }\n

Ext.Base
view source

initConfigList : Arrayprivate

...

Defaults to: []

Ext.Base
view source

initConfigMap : Objectprivate

...

Defaults to: {}

Ext.Base
view source

isInstance : Booleanprivate

...

Defaults to: true

Ext.util.Observable
view source

isObservable : Boolean

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

Ext.direct.Provider
view source

isProvider : Booleanprivate

...

Defaults to: true

Ext.Base
view source

self : Ext.Classprotected

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n

Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n

Defined By

Static Properties

Ext.Base
view source

$onExtended : Arrayprivatestatic

...

Defaults to: []

Methods

Defined By

Instance Methods

Ext.direct.AmfRemotingProvider
view source

newExt.direct.AmfRemotingProvider( config ) : Ext.direct.AmfRemotingProvider

...

Parameters

config : Object
\n

Returns

Ext.direct.AmfRemotingProvider
\n

Ext.util.Observable
view source

addEvents( eventNames )

Adds the specified events to the list of events which this Observable may fire. ...

Adds the specified events to the list of events which this Observable may fire.

Parameters

eventNames : Object/String...
Either an object with event names as properties with\na value of true. For example:
\n\n
```
this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
```
\n\n
Or any number of event names as separate parameters. For example:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n

Ext.util.Observable
view source

addListener( eventName, [fn], [scope], [options] ) : Object

Appends an event handler to this object. ...

Appends an event handler to this object. For example:

\n\n

myGridPanel.on(\"mouseover\", this.onMouseOver, this);\n

\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n

myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n

\n\n

One can also specify options for each event handler separately:

\n\n

myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n

\n\n

Names of methods in a specified scope may also be used. Note that\nscope MUST be specified to use this option:

\n\n

myGridPanel.on({\n    cellClick: {fn: 'onCellClick', scope: this, single: true},\n    mouseover: {fn: 'onMouseOver', scope: panel}\n});\n

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n
- destroyable : Boolean (optional)
  When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.
  \n\n
  Defaults to: false
- priority : Number (optional)
  An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

Returns

Object

Only when the destroyable option is specified.

\n\n\n\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n\n\n\n

this.btnListeners =  = myButton.on({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

Ext.util.Observable
view source

addManagedListener( item, ename, [fn], [scope], [options] ) : Object

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestr...

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
options : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

Returns

Object

Only when the destroyable option is specified.

\n\n\n\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n\n\n\n

this.btnListeners =  = myButton.mon({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

Ext.Base
view source

callOverridden( args ) : Objectdeprecatedprotected

Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

This method has been deprecated

as of 4.1. Use callParent instead.

\n\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)
\n

Returns

Object
Returns the result of calling the overridden method
\n

Ext.Base
view source

callParent( args ) : Objectprotected

Call the \"parent\" method of the current method. ...

Call the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).

\n\n

 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n

\n\n

This can be used with an override as follows:

\n\n

 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n

\n\n

This also works with static methods.

\n\n

 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n

\n\n

Lastly, it also works with overridden static methods.

\n\n

 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n

\n\n

To override a method and replace it and also call the superclass method, use\ncallSuper. This is often done to patch a method to fix a bug.

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
\n

Returns

Object
Returns the result of calling the parent method
\n

Ext.Base
view source

callSuper( args ) : Objectprotected

This method is used by an override to call the superclass method but bypass any\noverridden method. ...

This method is used by an override to call the superclass method but bypass any\noverridden method. This is often done to \"patch\" a method that contains a bug\nbut for whatever reason cannot be fixed directly.

\n\n

Consider:

\n\n

 Ext.define('Ext.some.Class', {\n     method: function () {\n         console.log('Good');\n     }\n });\n\n Ext.define('Ext.some.DerivedClass', {\n     method: function () {\n         console.log('Bad');\n\n         // ... logic but with a bug ...\n\n         this.callParent();\n     }\n });\n

\n\n

To patch the bug in DerivedClass.method, the typical solution is to create an\noverride:

\n\n

 Ext.define('App.paches.DerivedClass', {\n     override: 'Ext.some.DerivedClass',\n\n     method: function () {\n         console.log('Fixed');\n\n         // ... logic but with bug fixed ...\n\n         this.callSuper();\n     }\n });\n

\n\n

The patch method cannot use callParent to call the superclass method since\nthat would call the overridden method containing the bug. In other words, the\nabove patch would only produce \"Fixed\" then \"Good\" in the console log, whereas,\nusing callParent would produce \"Fixed\" then \"Bad\" then \"Good\".

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callSuper(arguments)
\n

Returns

Object
Returns the result of calling the superclass method
\n

Ext.util.Observable
view source

captureArgs( o, fn, scope )private

...

Parameters

o : Object
\n
fn : Object
\n
scope : Object
\n

Ext.util.Observable
view source

clearListeners( )

Removes all listeners for this object including the managed listeners ...

Removes all listeners for this object including the managed listeners

Ext.util.Observable
view source

clearManagedListeners( )

Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

Ext.direct.AmfRemotingProvider
view source

combineAndSend( )private

Combine any buffered requests and send them off ...

Combine any buffered requests and send them off

Ext.Base
view source

configClass( )private

...

Ext.direct.AmfRemotingProvider
view source

configureFormRequest( action, method, form, [callback], [scope] )private

Configure a form submission request ...

Configure a form submission request

Parameters

action : String
The action being executed
\n
method : Object
The method being executed
\n
form : HTMLElement
The form being submitted
\n
callback : Function (optional)
A callback to run after the form submits
\n
scope : Object (optional)
A scope to execute the callback in
\n

Ext.direct.AmfRemotingProvider
view source

configureRequest( action, method )private

Configure a direct request ...

Configure a direct request

Parameters

action : String
The action being executed
\n
method : Object
The method being executed
\n

Ext.direct.AmfRemotingProvider
view source

connect( )template

inherit docs\n\nAbstract method for subclasses to implement. ...

inherit docs

\n\n

Abstract method for subclasses to implement.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Overrides: Ext.direct.Provider.connect

Ext.util.Observable
view source

continueFireEvent( eventName, args, bubbles )private

Continue to fire event. ...

Continue to fire event.

Parameters

eventName : String
\n
args : Array
\n
bubbles : Boolean
\n

Ext.direct.AmfRemotingProvider
view source

createEvent( response ) : Ext.direct.Event

Create an event from an AMFX response object ...

Create an event from an AMFX response object

Parameters

response : Object
The AMFX response object
\n

Returns

Ext.direct.Event
The event
\n

Ext.direct.AmfRemotingProvider
view source

createEvents( response ) : Ext.direct.Event[]private

Creates a set of events based on the XHR response ...

Creates a set of events based on the XHR response

Parameters

response : Object
The XHR response
\n

Returns

Ext.direct.Event[]
An array of Ext.direct.Event
\n

Ext.direct.AmfRemotingProvider
view source

createHandler( action, method ) : Functionprivate

Create a handler function for a direct call. ...

Create a handler function for a direct call.

Parameters

action : String
The action the call is for
\n
method : Object
The details of the method
\n

Returns

Function
A JS function that will kick off the call
\n

Ext.util.Observable
view source

createRelayer( newName, [beginEnd] ) : Functionprivate

Creates an event handling function which refires the event from this object as the passed event name. ...

Creates an event handling function which refires the event from this object as the passed event name.

Parameters

newName : String
The name under which to refire the passed parameters.
\n
beginEnd : Array (optional)
The caller can specify on which indices to slice.
\n

Returns

Function
\n

Ext.Base
view source

destroy( )private

...

Overrides: Ext.state.Stateful.destroy, Ext.util.ElementContainer.destroy, Ext.AbstractComponent.destroy, Ext.AbstractPlugin.destroy

Ext.direct.AmfRemotingProvider
view source

disconnect( )template

inherit docs\n\nAbstract method for subclasses to implement. ...

inherit docs

\n\n

Abstract method for subclasses to implement.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Overrides: Ext.direct.Provider.disconnect

Ext.util.Observable
view source

enableBubble( eventNames )

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. There is no implementation in the Observable base class.

\n\n

This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.

\n\n

Example:

\n\n

Ext.define('Ext.overrides.form.field.Base', {\n    override: 'Ext.form.field.Base',\n\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent: function () {\n        this.callParent();\n        this.enableBubble('change');\n    }\n});\n\nvar myForm = Ext.create('Ext.form.Panel', {\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n

Parameters

eventNames : String/String[]
The event name to bubble, or an Array of event names.
\n

Ext.util.Observable
view source

fireEvent( eventName, args ) : Boolean

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addListener).

\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.

Parameters

eventName : String
The name of the event to fire.
\n
args : Object...
Variable number of parameters are passed to handlers.
\n

Returns

Boolean
returns false if any of the handlers return false otherwise it returns true.
\n

Ext.util.Observable
view source

fireEventArgs( eventName, args ) : Boolean

Fires the specified event with the passed parameter list. ...

Fires the specified event with the passed parameter list.

\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.

Parameters

eventName : String
The name of the event to fire.
\n
args : Object[]
An array of parameters which are passed to handlers.
\n

Returns

Boolean
returns false if any of the handlers return false otherwise it returns true.
\n

Ext.util.Observable
view source

getBubbleParent( ) : Ext.util.Observableprivate

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

Returns

Ext.util.Observable
The bubble parent. null is returned if no bubble target exists
\n

Ext.direct.AmfRemotingProvider
view source

getCallData( transaction ) : Objectprivate

Gets the Flex remoting message info for a transaction ...

Gets the Flex remoting message info for a transaction

Parameters

transaction : Ext.direct.Transaction
The transaction
\n

Returns

Object
The Flex remoting message structure ready to encode in an AMFX RemoteMessage
\n

Ext.Base
view source

getConfig( name )private

...

Parameters

name : Object
\n

Ext.Base
view source

getInitialConfig( [name] ) : Object/Mixed

Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

Parameters

name : String (optional)
Name of the config option to return.
\n

Returns

Object/Mixed
The full config object or a single config value\nwhen name parameter specified.
\n

Ext.direct.AmfRemotingProvider
view source

getTransaction( options ) : Ext.direct.Transactionprivate

Get transaction from XHR options ...

Get transaction from XHR options

Parameters

options : Object
The options sent to the Ajax request
\n

Returns

Ext.direct.Transaction
The transaction, null if not found
\n

Ext.Base
view source

hasConfig( config )private

...

Parameters

config : Object
\n

Ext.util.Observable
view source

hasListener( eventName ) : Boolean

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer\nindicates whether the event needs firing or not.

Parameters

eventName : String
The name of the event to check for
\n

Returns

Boolean
true if the event is being listened for or bubbles, else false
\n

Ext.direct.AmfRemotingProvider
view source

initAPI( )private

Initialize the API ...

Initialize the API

Ext.Base
view source

initConfig( config ) : Ext.Basechainableprotected

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n

Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n

Parameters

config : Object
\n

Returns

Ext.Base
this
\n

Ext.direct.AmfRemotingProvider
view source

isConnected( )template

inherit docs\n\nReturns whether or not the server-side is currently connected. ...

inherit docs

\n\n

Returns whether or not the server-side is currently connected.\nAbstract method for subclasses to implement.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Overrides: Ext.direct.Provider.isConnected

Ext.util.Observable
view source

mon( item, ename, [fn], [scope], [options] ) : Object

Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

\n\n

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
options : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

Returns

Object

Only when the destroyable option is specified.

\n\n\n\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n\n\n\n

this.btnListeners =  = myButton.mon({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

Ext.util.Observable
view source

mun( item, ename, [fn], [scope] )

Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

Ext.util.Observable
view source

on( eventName, [fn], [scope], [options] ) : Object

Shorthand for addListener. ...

Shorthand for addListener.

\n\n

Appends an event handler to this object. For example:

\n\n

myGridPanel.on(\"mouseover\", this.onMouseOver, this);\n

\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n

myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n

\n\n

One can also specify options for each event handler separately:

\n\n

myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n

\n\n

Names of methods in a specified scope may also be used. Note that\nscope MUST be specified to use this option:

\n\n

myGridPanel.on({\n    cellClick: {fn: 'onCellClick', scope: this, single: true},\n    mouseover: {fn: 'onMouseOver', scope: panel}\n});\n

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n
- destroyable : Boolean (optional)
  When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.
  \n\n
  Defaults to: false
- priority : Number (optional)
  An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

Returns

Object

Only when the destroyable option is specified.

\n\n\n\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n\n\n\n

this.btnListeners =  = myButton.on({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

Ext.Base
view source

onConfigUpdate( names, callback, scope )private

...

Parameters

names : Object
\n
callback : Object
\n
scope : Object
\n

Ext.direct.AmfRemotingProvider
view source

onData( options, success, response )private

React to the ajax request being completed ...

React to the ajax request being completed

Parameters

options : Object
\n
success : Object
\n
response : Object
\n

Ext.util.Observable
view source

prepareClass( T )private

Prepares a given class for observable instances. ...

Prepares a given class for observable instances. This method is called when a\nclass derives from this class or uses this class as a mixin.

Parameters

T : Function
The class constructor to prepare.
\n

Ext.direct.AmfRemotingProvider
view source

queueTransaction( transaction )private

Add a new transaction to the queue ...

Add a new transaction to the queue

Parameters

transaction : Ext.direct.Transaction
The transaction
\n

Ext.util.Observable
view source

relayEvents( origin, events, [prefix] ) : Object

Relays selected events from the specified Observable as if the events were fired by this. ...

Relays selected events from the specified Observable as if the events were fired by this.

\n\n

For example if you are extending Grid, you might decide to forward some events from store.\nSo you can do this inside your initComponent:

\n\n

this.relayEvents(this.getStore(), ['load']);\n

\n\n

The grid instance will then have an observable 'load' event which will be passed the\nparameters of the store's load event and any function fired with the grid's load event\nwould have access to the grid using the this keyword.

Parameters

origin : Object
The Observable whose events this object is to relay.
\n
events : String[]
Array of event names to relay.
\n
prefix : String (optional)
A common prefix to prepend to the event names. For example:
\n\n
```
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
\n

Returns

Object
A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:
\n\n
```
this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Can be undone by calling
\n\n
```
Ext.destroy(this.storeRelayers);\n
```
\n\n
or
\n\n
```
this.store.relayers.destroy();\n
```
\n

Ext.util.Observable
view source

removeListener( eventName, fn, [scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

Ext.util.Observable
view source

removeManagedListener( item, ename, [fn], [scope] )

Removes listeners that were added by the mon method. ...

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

Ext.util.Observable
view source

removeManagedListenerItem( isClear, managedListener )private

Remove a single managed listener item ...

Remove a single managed listener item

Parameters

isClear : Boolean
True if this is being called during a clear
\n
managedListener : Object
The managed listener item\nSee removeManagedListener for other args
\n

Ext.util.Observable
view source

resumeEvent( eventName )

Resumes firing of the named event(s). ...

Resumes firing of the named event(s).

\n\n

After calling this method to resume events, the events will fire when requested to fire.

\n\n

Note that if the suspendEvent method is called multiple times for a certain event,\nthis converse method will have to be called the same number of times for it to resume firing.

Parameters

eventName : String...
Multiple event names to resume.
\n

Ext.util.Observable
view source

resumeEvents( )

Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

\n\n

If events were suspended using the queueSuspended parameter, then all events fired\nduring event suspension will be sent to any listeners now.

Ext.direct.AmfRemotingProvider
view source

runCallback( transaction, event )private

Run any callbacks related to the transaction. ...

Run any callbacks related to the transaction.

Parameters

transaction : Ext.direct.Transaction
The transaction
\n
event : Ext.direct.Event
The event
\n

Ext.direct.AmfRemotingProvider
view source

sendFormRequest( transaction )private

Sends a form request ...

Sends a form request

Parameters

transaction : Ext.direct.Transaction
The transaction to send
\n

Ext.direct.AmfRemotingProvider
view source

sendRequest( data )private

Sends a request to the server ...

Sends a request to the server

Parameters

data : Object/Array
The data to send
\n

Ext.Base
view source

setConfig( config, applyIfNotSet ) : Ext.Basechainableprivate

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

Returns

Ext.Base
this
\n

Ext.Base
view source

statics( ) : Ext.Classprotected

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n

Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n

Returns

Ext.Class
\n

Ext.util.Observable
view source

suspendEvent( eventName )

Suspends firing of the named event(s). ...

Suspends firing of the named event(s).

\n\n

After calling this method to suspend events, the events will no longer fire when requested to fire.

\n\n

Note that if this is called multiple times for a certain event, the converse method\nresumeEvent will have to be called the same number of times for it to resume firing.

Parameters

eventName : String...
Multiple event names to suspend.
\n

Ext.util.Observable
view source

suspendEvents( queueSuspended )

Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n

Ext.util.Observable
view source

un( eventName, fn, [scope] )

Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

Defined By

Static Methods

Ext.Base
view source

addConfig( config )privatestatic

...

Parameters

config : Object
\n

Ext.Base
view source

addInheritableStatics( members )chainableprivatestatic

...

Parameters

members : Object
\n

Ext.Base
view source

addMember( name, member )chainableprivatestatic

...

Parameters

name : Object
\n
member : Object
\n

Ext.Base
view source

addMembers( members )chainablestatic

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n

Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n

Parameters

members : Object
\n

Ext.Base
view source

addStatics( members ) : Ext.Basechainablestatic

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n

Parameters

members : Object
\n

Returns

Ext.Base
this
\n

Ext.Base
view source

addXtype( xtype )chainableprivatestatic

...

Parameters

xtype : Object
\n

Ext.Base
view source

borrow( fromClass, members ) : Ext.Basechainableprivatestatic

Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n

Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n

Parameters

fromClass : Ext.Base
The class to borrow members from
\n
members : Array/String
The names of the members to borrow
\n

Returns

Ext.Base
this
\n

Ext.Base
view source

create( ) : Objectstatic

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n

\n\n

All parameters are passed to the constructor of the class.

Returns

Object
the created instance.
\n

Ext.Base
view source

createAlias( alias, origin )static

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n

Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n

Parameters

alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n
origin : String/Object
The original method name
\n

Ext.Base
view source

extend( config )privatestatic

...

Parameters

config : Object
\n

Ext.Base
view source

getName( ) : Stringstatic

Get the current class' name in string format. ...

Get the current class' name in string format.

\n\n

Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n

Returns

String
className
\n

Ext.Base
view source

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

Ext.Base
view source

mixin( name, mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

Ext.Base
view source

onExtended( fn, scope )chainableprivatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

Ext.Base
view source

override( members ) : Ext.Basechainabledeprecatedstatic

Override members of this class. ...

Override members of this class. Overridden methods can be invoked via\ncallParent.

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

\n\n

As of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:

\n\n

Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n

\n\n

The above accomplishes the same result but can be managed by the Ext.Loader\nwhich can properly order the override and its target class and the build process\ncan determine whether the override is needed based on the required state of the\ntarget class (My.Cat).

This method has been deprecated since 4.1.0

Use Ext.define instead

\n\n

Parameters

members : Object
The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.
\n

Returns

Ext.Base
this class
\n

Ext.Base
view source

triggerExtended( )privatestatic

...

Defined By

Events

Ext.direct.AmfRemotingProvider
view source

beforecall( provider, transaction, meta, eOpts )

Fires immediately before the client-side sends off the RPC call. ...

Fires immediately before the client-side sends off the RPC call.\nBy returning false from an event handler you can prevent the call from\nexecuting.

Parameters

provider : Ext.direct.AmfRemotingProvider
\n
transaction : Ext.direct.Transaction
\n
meta : Object
The meta data
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.direct.AmfRemotingProvider
view source

call( provider, transaction, meta, eOpts )

Fires immediately after the request to the server-side is sent. ...

Fires immediately after the request to the server-side is sent. This does\nNOT fire after the response has come back from the call.

Parameters

provider : Ext.direct.AmfRemotingProvider
\n
transaction : Ext.direct.Transaction
\n
meta : Object
The meta data
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.direct.Provider
view source

connect( provider, eOpts )

Fires when the Provider connects to the server-side ...

Fires when the Provider connects to the server-side

Parameters

provider : Ext.direct.Provider
The Provider.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.direct.Provider
view source

data( provider, e, eOpts )

Fires when the Provider receives data from the server-side ...

Fires when the Provider receives data from the server-side

Parameters

provider : Ext.direct.Provider
The Provider.
\n
e : Ext.direct.Event
The Ext.direct.Event type that occurred.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.direct.Provider
view source

disconnect( provider, eOpts )

Fires when the Provider disconnects from the server-side ...

Fires when the Provider disconnects from the server-side

Parameters

provider : Ext.direct.Provider
The Provider.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.direct.Provider
view source

exception( eOpts )

Fires when the Provider receives an exception from the server-side ...

Fires when the Provider receives an exception from the server-side

Parameters

eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n