| Config Options | Defined By | |
|---|---|---|
| baseParams : Object An object containing properties which are to be sent as parameters
-on every polling request | PollingProvider | |
| id : String The unique id of the provider (defaults to an auto-assigned id).
+on every polling request | PollingProvider | |
| id : String The unique id of the provider (defaults to an auto-assigned id).
You should assign an id if you need to be able to a... The unique id of the provider (defaults to an auto-assigned id).
You should assign an id if you need to be able to access the provider later and you do
not have an object reference available, for example:
@@ -34,7 +34,7 @@ not have an object reference available, for example:
var p = Ext.Direct.getProvider('poll-provider');
p.disconnect(); | Provider | |
| interval : Number How often to poll the server-side in milliseconds (defaults to 3000 - every
-3 seconds). | PollingProvider | |
| listeners : Object A config object containing one or more event handlers to be added to this
+3 seconds). | PollingProvider | |
| listeners : Object A config object containing one or more event handlers to be added to this
object during initialization. This should ... A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once. @@ -89,21 +89,21 @@ Ext.DomObserver = Ext.extend(Object, { typeAhead: true, mode: 'local', triggerAction: 'all' -}); | Observable | |
| priority : Number Priority of the request (defaults to 3). See Ext.direct.Provider.priority. | PollingProvider | |
| type : String Required, undefined by default. The type of provider specified
-to Ext.Direct.addProvider to create a
+}); | Observable | |
| priority : Number Priority of the request (defaults to 3). See Ext.direct.Provider.priority. | PollingProvider | |
| type : String Required, undefined by default. The type of provider specified
+to Ext.Direct.addProvider to create a
new Provider.... Required, undefined by default. The type of provider specified
to Ext.Direct.addProvider to create a
new Provider. Acceptable values by default are:
| Provider | |
| url : String/Function The url which the PollingProvider should contact with each request. This can also be
+ | Provider | |
| url : String/Function The url which the PollingProvider should contact with each request. This can also be
an imported Ext.Direct method w... The url which the PollingProvider should contact with each request. This can also be
-an imported Ext.Direct method which will accept the baseParams as its only argument. | PollingProvider | |
| Property | Defined By | |
|---|---|---|
| connect : Object Abstract methods for subclasses to implement. | Provider | |
| disconnect : Object Abstract methods for subclasses to implement. | Provider | |
| Method | Defined By | |
|---|---|---|
addEvents( Object|String o, string Optional. )
- :
+an imported Ext.Direct method which will accept the baseParams as its only argument. | PollingProvider | |
| Property | Defined By | |
|---|---|---|
| connect : Object Abstract methods for subclasses to implement. | Provider | |
| disconnect : Object Abstract methods for subclasses to implement. | Provider | |
| Method | Defined By | |
|---|---|---|
addEvents( Object|String o, string Optional. )
+ :
voidAdds 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:
| Observable | |
addListener( String eventName, Function handler, [Object scope], [Object options] )
- :
+Usage:
| Observable | |
addListener( String eventName, Function handler, [Object scope], [Object options] )
+ :
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
| connect()
- :
- void Connect to the server-side and begin the polling process. To handle each
+}); Returns:
| Observable | |
| connect()
+ :
+ void Connect to the server-side and begin the polling process. To handle each
response subscribe to the data event. Connect to the server-side and begin the polling process. To handle each
-response subscribe to the data event. Parameters:
| PollingProvider | |
| disconnect()
- :
- void Disconnect from the server-side and stop the polling process. The disconnect
+response subscribe to the data event. Parameters:
| PollingProvider | |
| disconnect()
+ :
+ void Disconnect from the server-side and stop the polling process. The disconnect
event will be fired on a successful dis... Disconnect from the server-side and stop the polling process. The disconnect
-event will be fired on a successful disconnect. Parameters:
| PollingProvider | |
enableBubble( String/Array events )
- :
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+event will be fired on a successful disconnect. Parameters:
| PollingProvider | |
enableBubble( String/Array events )
+ :
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present... Enables events fired by this Observable to bubble up an owner hierarchy by calling
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default @@ -195,49 +195,49 @@ access the required target more quickly. myForm.header.setStyle('color', 'red'); } } -});Parameters:
| Observable | |
fireEvent( String eventName, Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+}); Parameters:
| Observable | |
fireEvent( String eventName, Object... args )
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) -by calling enableBubble. Parameters:
| Observable | |
hasListener( String eventName )
- :
- BooleanChecks 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:
| Observable | |
| isConnected()
- :
- void Returns whether or not the server-side is currently connected.
+by calling enableBubble. Parameters:
| Observable | |
hasListener( String eventName )
+ :
+ BooleanChecks 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:
| Observable | |
| isConnected()
+ :
+ void Returns whether or not the server-side is currently connected.
Abstract method for subclasses to implement. Returns whether or not the server-side is currently connected.
-Abstract method for subclasses to implement. Parameters:
| Provider | |
on( String eventName, Function handler, [Object scope], [Object options] )
- :
+Abstract method for subclasses to implement.Parameters:
| Provider | |
on( String eventName, Function handler, [Object scope], [Object options] )
+ :
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
| purgeListeners()
- :
- void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o, Array events )
- :
- voidRelays 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:
| Observable | |
removeListener( String eventName, Function handler, [Object scope] )
- :
- voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
| resumeEvents()
- :
- void Resume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
| Observable | |
| purgeListeners()
+ :
+ void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o, Array events )
+ :
+ voidRelays 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:
| Observable | |
removeListener( String eventName, Function handler, [Object scope] )
+ :
+ voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
| resumeEvents()
+ :
+ void Resume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
suspendEvents( Boolean queueSuspended )
- :
+events fired during event suspension will be sent to any listeners now.Parameters:
| Observable | |
suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
un( String eventName, Function handler, [Object scope] )
- :
- voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
| Event | Defined By | |
|---|---|---|
beforepoll :
- ( Ext.direct.PollingProvider )
- Fired immediately before a poll takes place, an event handler can return false
+after the resumeEvents call instead of discarding all suspended events; Returns:
| Observable | |
un( String eventName, Function handler, [Object scope] )
+ :
+ voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
| Event | Defined By | |
|---|---|---|
beforepoll :
+ ( Ext.direct.PollingProvider )
+ Fired immediately before a poll takes place, an event handler can return false
in order to cancel the poll. Fired immediately before a poll takes place, an event handler can return false
-in order to cancel the poll. Listeners will be called with the following arguments:
| PollingProvider | |
connect :
- ( Ext.direct.Provider provider )
- Fires when the Provider connects to the server-side Fires when the Provider connects to the server-side Listeners will be called with the following arguments:
| Provider | |
data :
- ( Ext.direct.Provider provider, event e )
- Fires when the Provider receives data from the server-side Fires when the Provider receives data from the server-side Listeners will be called with the following arguments:
| Provider | |
disconnect :
- ( Ext.direct.Provider provider )
- Fires when the Provider disconnects from the server-side Fires when the Provider disconnects from the server-side Listeners will be called with the following arguments:
| Provider | |
| exception :
- ()
- Fires when the Provider receives an exception from the server-side Fires when the Provider receives an exception from the server-side Listeners will be called with the following arguments:
| Provider | |
poll :
- ( Ext.direct.PollingProvider )
+in order to cancel the poll.Listeners will be called with the following arguments:
| PollingProvider | |
connect :
+ ( Ext.direct.Provider provider )
+ Fires when the Provider connects to the server-side Fires when the Provider connects to the server-side Listeners will be called with the following arguments:
| Provider | |
data :
+ ( Ext.direct.Provider provider, event e )
+ Fires when the Provider receives data from the server-side Fires when the Provider receives data from the server-side Listeners will be called with the following arguments:
| Provider | |
disconnect :
+ ( Ext.direct.Provider provider )
+ Fires when the Provider disconnects from the server-side Fires when the Provider disconnects from the server-side Listeners will be called with the following arguments:
| Provider | |
| exception :
+ ()
+ Fires when the Provider receives an exception from the server-side Fires when the Provider receives an exception from the server-side Listeners will be called with the following arguments:
| Provider | |
poll :
+ ( Ext.direct.PollingProvider )
This event has not yet been implemented. This event has not yet been implemented. Listeners will be called with the following arguments:
| PollingProvider | |