X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..92c2b89db26be16707f4a805d3303ab2531006e1:/docs/output/Ext.direct.PollingProvider.html diff --git a/docs/output/Ext.direct.PollingProvider.html b/docs/output/Ext.direct.PollingProvider.html index 900b544b..94c7de5b 100644 --- a/docs/output/Ext.direct.PollingProvider.html +++ b/docs/output/Ext.direct.PollingProvider.html @@ -1,4 +1,4 @@ -
Observable Provider JsonProvider PollingProvider
Package: | Ext.direct |
Defined In: | PollingProvider.js |
Class: | PollingProvider |
Extends: | JsonProvider |
Provides for repetitive polling of the server at distinct intervals. +
Observable Provider JsonProvider PollingProvider
Package: | Ext.direct |
Defined In: | PollingProvider.js |
Class: | PollingProvider |
Extends: | JsonProvider |
Provides for repetitive polling of the server at distinct intervals. The initial request for data originates from the client, and then is responded to by the server.
All configurations for the PollingProvider should be generated by the server-side @@ -20,7 +20,7 @@ Ext.Direct.addProvider( } ); var pollB = Ext.Direct.getProvider('pollB-provider');
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:
@@ -89,7 +89,7 @@ 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
+}); | 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
@@ -98,9 +98,11 @@ 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
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 object )
+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. )
:
- voidUsed to define events on this Observable Used to define events on this Observable Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ 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 ] )
:
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
@@ -159,16 +161,48 @@ response subscribe to the data event. Paramet
:
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( Object events )
+event will be fired on a successful disconnect.Parameters:
| PollingProvider | |
enableBubble( String/Array events )
:
- voidUsed to enable bubbling of events Used to enable bubbling of events Parameters:
| Observable | |
fireEvent( String eventName , Object... args )
+ 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 +implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to +access the required target more quickly. +Example:
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()
+ 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:
| 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.
@@ -196,13 +230,13 @@ after the 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 :
+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 :
+ 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 :
+ 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 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 )
|