Hierarchy
Ext.util.ObservableExt.Direct
Files
Direct.js

Overview

\n\n\n\n\n

Ext.Direct aims to streamline communication between the client and server\nby providing a single interface that reduces the amount of common code\ntypically required to validate data and handle returned data packets\n(reading data, error conditions, etc).

\n\n\n\n\n

The Ext.direct namespace includes several classes for a closer integration\nwith the server-side. The Ext.data namespace also includes classes for working\nwith Ext.data.Stores which are backed by data from an Ext.Direct method.

\n\n\n\n\n

Specification

\n\n\n\n\n

For additional information consult the\nExt.Direct Specification.

\n\n\n\n\n

Providers

\n\n\n\n\n

Ext.Direct uses a provider architecture, where one or more providers are\nused to transport data to and from the server. There are several providers\nthat exist in the core at the moment:

\n\n\n

JsonProvider for simple JSON operations
PollingProvider for repeated requests
RemotingProvider exposes server side\non the client.

\n\n\n\n\n

A provider does not need to be invoked directly, providers are added via\nExt.Direct.add.

\n\n\n\n\n

Router

\n\n\n\n\n

Ext.Direct utilizes a \"router\" on the server to direct requests from the client\nto the appropriate server-side method. Because the Ext.Direct API is completely\nplatform-agnostic, you could completely swap out a Java based server solution\nand replace it with one that uses C# without changing the client side JavaScript\nat all.

\n\n\n\n\n

Server side events

\n\n\n\n\n

Custom events from the server may be handled by the client by adding\nlisteners, for example:

\n\n\n

{\"type\":\"event\",\"name\":\"message\",\"data\":\"Successfully polled at: 11:19:30 am\"}\n\n// add a handler for a 'message' event sent by the server\nExt.Direct.on('message', function(e){\n    out.append(String.format('<p><i>{0}</i></p>', e.data));\n            out.el.scrollTo('t', 100000, true);\n});\n

\n\n

Defined By

Config options

Ext.util.Observable
view source

listeners : Object

(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. ...

(optional)

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

\n\n

DOM events from ExtJs Components

\n\n\n

While some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n

is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a Component's HTMLElement, listeners must be added to the Element after the Component\nhas been rendered. A plugin can simplify this step:

\n\n

// Plugin is configured with a listeners config object.\n// The Component is appended to the argument list of all handler functions.\nExt.DomObserver = Ext.extend(Object, {\n    constructor: function(config) {\n        this.listeners = config.listeners ? config.listeners : config;\n    },\n\n    // Component passes itself into plugin's init method\n    init: function(c) {\n        var p, l = this.listeners;\n        for (p in l) {\n            if (Ext.isFunction(l[p])) {\n                l[p] = this.createHandler(l[p], c);\n            } else {\n                l[p].fn = this.createHandler(l[p].fn, c);\n            }\n        }\n\n        // Add the listeners to the Element immediately following the render call\n        c.render = c.render.createSequence(function() {\n            var e = c.getEl();\n            if (e) {\n                e.on(l);\n            }\n        });\n    },\n\n    createHandler: function(fn, c) {\n        return function(e) {\n            fn.call(this, e, c);\n        };\n    }\n});\n\nvar combo = new Ext.form.ComboBox({\n\n    // Collapse combo when its element is clicked on\n    plugins: [ new Ext.DomObserver({\n        click: function(evt, comp) {\n            comp.collapse();\n        }\n    })],\n    store: myStore,\n    typeAhead: true,\n    mode: 'local',\n    triggerAction: 'all'\n});\n

\n\n\n

Defined By

Properties

Ext.Direct
view source

eventTypes : Object

Each event type implements a getData() method. ...

Each event type implements a getData() method. The default event types are:

\n\n

event : Ext.Direct.Event
exception : Ext.Direct.ExceptionEvent
rpc : Ext.Direct.RemotingEvent

\n\n

Ext.Direct
view source

exceptions : Object

Four types of possible exceptions which can occur:\n\n\nExt.Direct.exceptions.TRANSPORT : 'xhr'\nExt.Direct.exceptions.PA...

Four types of possible exceptions which can occur:

\n\n

Ext.Direct.exceptions.TRANSPORT : 'xhr'
Ext.Direct.exceptions.PARSE : 'parse'
Ext.Direct.exceptions.LOGIN : 'login'
Ext.Direct.exceptions.SERVER : 'exception'

\n\n

Defaults to: {TRANSPORT: 'xhr', PARSE: 'parse', LOGIN: 'login', SERVER: 'exception'}

Defined By

Methods

Ext.Direct
view source

newExt.Direct( ) : Ext.Direct

private ...

private

Returns

Ext.Direct
\n

Ext.util.Observable
view source

addEvents( o, Optional )

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

o : Object|String
Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.
\n
Optional : string
. Event name if multiple event names are being passed as separate parameters.\nUsage:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n\n

Ext.util.Observable
view source

addListener( eventName, handler, [scope], [options] )

Appends an event handler to this object. ...

Appends an event handler to this object.

Parameters

eventName : String
The name of the event to listen for.
\n
handler : Function
The method the event invokes.
\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
\n
options : Object (optional)
An object containing handler configuration.\nproperties. This may contain any of the following properties:
- scope : Object
  The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
- target : Observable
  Only call the handler if the event was fired on the target Observable, not\nif the event was bubbled up from a child Observable.
\n\n
\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
```
myDataView.on('click', this.onClick, this, {\nsingle: true,\ndelay: 100\n});
```
\n
\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n
\n
```
myGridPanel.on({\n'click' : {\n    fn: this.onClick,\n    scope: this,\n    delay: 100\n},\n'mouseover' : {\n    fn: this.onMouseOver,\n    scope: this\n},\n'mouseout' : {\n    fn: this.onMouseOut,\n    scope: this\n}\n});
```
\n
\nOr a shorthand syntax:
\n
```
myGridPanel.on({\n'click' : this.onClick,\n'mouseover' : this.onMouseOver,\n'mouseout' : this.onMouseOut,\n scope: this\n});
```
\n\n

Ext.Direct
view source

addProvider( provider )

Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods. ...

Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods.\nIf the provider is not already connected, it will auto-connect.

\n\n

var pollProv = new Ext.direct.PollingProvider({\n    url: 'php/poll2.php'\n});\n\nExt.Direct.addProvider(\n    {\n        \"type\":\"remoting\",       // create a Ext.direct.RemotingProvider\n        \"url\":\"php\\/router.php\", // url to connect to the Ext.Direct server-side router.\n        \"actions\":{              // each property within the actions object represents a Class\n            \"TestAction\":[       // array of methods within each server side Class\n            {\n                \"name\":\"doEcho\", // name of method\n                \"len\":1\n            },{\n                \"name\":\"multiply\",\n                \"len\":1\n            },{\n                \"name\":\"doForm\",\n                \"formHandler\":true, // handle form on server with Ext.Direct.Transaction\n                \"len\":1\n            }]\n        },\n        \"namespace\":\"myApplication\",// namespace to create the Remoting Provider in\n    },{\n        type: 'polling', // create a Ext.direct.PollingProvider\n        url:  'php/poll.php'\n    },\n    pollProv // reference to previously created instance\n);\n

\n\n

Parameters

provider : Object/Array
Accepts either an Array of Provider descriptions (an instance\nor config object for a Provider) or any number of Provider descriptions as arguments. Each\nProvider description instructs Ext.Direct how to create client-side stub methods.
\n

Ext.Direct
view source

addTransaction( t )private

...

Parameters

t : Object
\n

Ext.Direct
view source

createEvent( response, extraProps )private

...

Parameters

response : Object
\n
extraProps : Object
\n

Ext.util.Observable
view source

enableBubble( events )

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

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

\n\n\n

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

\n\n\n

Example:

\n\n\n

Ext.override(Ext.form.Field, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\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

\n\n

Parameters

events : String/Array
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). ...

Fires the specified event with the passed parameters (minus the event name).

\n\n\n

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

\n\n

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.Direct
view source

getProvider( id )

Retrieve a provider by the\nid specified when the provider is\nadded. ...

Retrieve a provider by the\nid specified when the provider is\nadded.

Parameters

id : String
Unique identifier assigned to the provider when calling addProvider
\n

Ext.Direct
view source

getTransaction( tid )private

...

Parameters

tid : Object
\n

Ext.util.Observable
view source

hasListener( eventName ) : Boolean

Checks to see if this object has any listeners for a specified event ...

Checks to see if this object has any listeners for a specified event

Parameters

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

Returns

Boolean
True if the event is being listened for, else false
\n

Ext.util.Observable
view source

on( eventName, handler, [scope], [options] )

Appends an event handler to this object (shorthand for addListener.) ...

Appends an event handler to this object (shorthand for addListener.)

Parameters

eventName : String
The type of event to listen for
\n
handler : Function
The method the event invokes
\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
\n
options : Object (optional)
An object containing handler configuration.
\n

Ext.Direct
view source

onProviderData( provider, e )private

...

Parameters

provider : Object
\n
e : Object
\n

Ext.util.Observable
view source

purgeListeners( )

Removes all listeners for this object ...

Removes all listeners for this object

Ext.util.Observable
view source

relayEvents( o, events )

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.

Parameters

o : Object
The Observable whose events this object is to relay.
\n
events : Array
Array of event names to relay.
\n

Ext.util.Observable
view source

removeListener( eventName, handler, [scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
\n
scope : Object (optional)
The scope originally specified for the handler.
\n

Ext.Direct
view source

removeProvider( id )private

...

Parameters

id : Object
\n

Ext.Direct
view source

removeTransaction( t )private

...

Parameters

t : Object
\n

Ext.util.Observable
view source

resumeEvents( )

Resume firing events. ...

Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.

Ext.util.Observable
view source

suspendEvents( queueSuspended )

Suspend the firing of all events. ...

Suspend 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, handler, [scope] )

Removes an event handler (shorthand for removeListener.) ...

Removes an event handler (shorthand for removeListener.)

Parameters

eventName : String
The type of event the handler was associated with.
\n
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
\n
scope : Object (optional)
The scope originally specified for the handler.
\n

Defined By

Events

Ext.Direct
view source

event( e, provider )

Fires after an event. ...

Fires after an event.

Parameters

e : event
The Ext.Direct.Event type that occurred.
\n
provider : Ext.direct.Provider
The Provider.
\n

Ext.Direct
view source

exception( e )

Fires after an event exception. ...

Fires after an event exception.

Parameters

e : event
The Ext.Direct.Event type that occurred.
\n