Hierarchy
Ext.util.ObservableExt.direct.ProviderExt.direct.JsonProviderExt.direct.PollingProvider
Files
PollingProvider.js

Provides for repetitive polling of the server at distinct intervals.\nThe initial request for data originates from the client, and then is responded to by the\nserver.

\n\n\n\n\n

All configurations for the PollingProvider should be generated by the server-side\nAPI portion of the Ext.Direct stack.

\n\n\n\n\n

An instance of PollingProvider may be created directly via the new keyword or by simply\nspecifying type = 'polling'. For example:

\n\n\n

var pollA = new Ext.direct.PollingProvider({\n    type:'polling',\n    url: 'php/pollA.php',\n});\nExt.Direct.addProvider(pollA);\npollA.disconnect();\n\nExt.Direct.addProvider(\n    {\n        type:'polling',\n        url: 'php/pollB.php',\n        id: 'pollB-provider'\n    }\n);\nvar pollB = Ext.Direct.getProvider('pollB-provider');\n

\n\n

Defined By

Config options

Ext.direct.PollingProvider
view source

baseParams : Object

An object containing properties which are to be sent as parameters\non every polling request

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.addProvider(\n    {\n        type: 'polling',\n        url:  'php/poll.php',\n        id:   'poll-provider'\n    }\n);\n     \nvar p = Ext.Direct.getProvider('poll-provider');\np.disconnect();\n

\n\n

Ext.direct.PollingProvider
view source

interval : Number

How often to poll the server-side in milliseconds (defaults to 3000 - every\n3 seconds). ...

How often to poll the server-side in milliseconds (defaults to 3000 - every\n3 seconds).

Defaults to: 3000

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

Ext.direct.PollingProvider
view source

priority : Number

override default priority\n\nPriority of the request. ...

override default priority

\n\n

Priority of the request. Lower is higher priority, 0 means \"duplex\" (always on).\nAll Providers default to 1 except for PollingProvider which defaults to 3.

Defaults to: 3

Overrides: Ext.direct.Provider.priority

Ext.direct.Provider
view source

type : String

Required, undefined by default. ...

Required, undefined by default. The type of provider specified\nto Ext.Direct.addProvider to create a\nnew Provider. Acceptable values by default are:

polling : PollingProvider
remoting : RemotingProvider

Ext.direct.PollingProvider
view source

url : String/Function

The url which the PollingProvider should contact with each request. ...

The url which the PollingProvider should contact with each request. This can also be\nan imported Ext.Direct method which will accept the baseParams as its only argument.

Defined By

Methods

Ext.direct.PollingProvider
view source

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

private ...

private

Parameters

config : Object
\n

Returns

Ext.direct.PollingProvider
\n

Overrides: Ext.direct.Provider.constructor

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

connect( )

Connect to the server-side and begin the polling process. ...

Connect to the server-side and begin the polling process. To handle each\nresponse subscribe to the data event.

Overrides: Ext.direct.Provider.connect

Ext.direct.PollingProvider
view source

disconnect( )

Disconnect from the server-side and stop the polling process. ...

Disconnect from the server-side and stop the polling process. The disconnect\nevent will be fired on a successful disconnect.

Overrides: Ext.direct.Provider.disconnect

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

getEvents( xhr )private

...

Parameters

xhr : 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.direct.PollingProvider
view source

isConnected( )

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

inherited

\n\n

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

Overrides: Ext.direct.Provider.isConnected

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

onData( opt, success, xhr )private

private ...

private

Parameters

opt : Object
\n
success : Object
\n
xhr : Object
\n

Ext.direct.JsonProvider
view source

parseResponse( xhr )private

...

Parameters

xhr : 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.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