| interval : NumberHow often to poll the server-side in milliseconds (defaults to 3000 - every
+ 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
+API portion of the Ext.Direct stack.
+ An instance of PollingProvider may be created directly via the new keyword or by simply
+specifying type = 'polling'. For example:
+ var pollA = new Ext.direct.PollingProvider({
+ type:'polling',
+ url: 'php/pollA.php',
+});
+Ext.Direct.addProvider(pollA);
+pollA.disconnect();
+
+Ext.Direct.addProvider(
+ {
+ type:'polling',
+ url: 'php/pollB.php',
+ id: 'pollB-provider'
+ }
+);
+var pollB = Ext.Direct.getProvider('pollB-provider');
Config Options|
| baseParams : Object An object containing properties which are to be sent as parameters
+on every polling request | PollingProvider | | id : StringThe unique id of the provider (defaults to an auto-assigned id).
+You should assign an id if you need to be able to ac... 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:
+ Ext.Direct.addProvider(
+ {
+ type: 'polling',
+ url: 'php/poll.php',
+ id: 'poll-provider'
+ }
+);
+
+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 : ObjectA 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
@@ -89,18 +89,20 @@ Ext.DomObserver = Ext.extend(Object, {
typeAhead: true,
mode: 'local',
triggerAction: 'all'
-}); | Observable | | priority : Number | PollingProvider | | type : StringRequired, 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/FunctionThe 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 |
Public PropertiesPublic Methods|
| addEvents( Object object )
+}); | Observable | | priority : Number | PollingProvider | | type : StringRequired, undefined by default. The type of provider specified
+to Ext.Direct.addProvider to create a
+new Provider. A... 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/FunctionThe url which the PollingProvider should contact with each request. This can also be
+an imported Ext.Direct method wh... 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 |
Public PropertiesPublic Methods|
| addEvents( Object|String o , string Optional. )
:
- voidUsed to define events on this Observable Used to define events on this Observable | 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. | 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:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
@@ -121,8 +123,8 @@ Using the options argument, it is possible to combine different types of listene
A delayed, one-time listener.
myDataView.on('click', this.onClick, this, {
- single: true,
- delay: 100
+single: true,
+delay: 100
});
Attaching multiple handlers in 1 call
@@ -130,48 +132,80 @@ The method also allows for a single argument to be passed which is a config obje
which specify multiple handlers.
myGridPanel.on({
- 'click' : {
- fn: this.onClick,
- scope: this,
- delay: 100
- },
- 'mouseover' : {
- fn: this.onMouseOver,
- scope: this
- },
- 'mouseout' : {
- fn: this.onMouseOut,
- scope: this
- }
+'click' : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+'mouseover' : {
+ fn: this.onMouseOver,
+ scope: this
+},
+'mouseout' : {
+ fn: this.onMouseOut,
+ scope: this
+}
});
Or a shorthand syntax:
myGridPanel.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
+'click' : this.onClick,
+'mouseover' : this.onMouseOver,
+'mouseout' : this.onMouseOut,
+ scope: this
});
Returns: | Observable | | connect()
:
- voidConnect 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
+ 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. | PollingProvider | | disconnect()
:
- voidDisconnect 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. | PollingProvider | | enableBubble( Object events )
+ voidDisconnect from the server-side and stop the polling process. The disconnect
+event will be fired on a successful disc... Disconnect from the server-side and stop the polling process. The disconnect
+event will be fired on a successful disconnect. | PollingProvider | | enableBubble( String/Array events )
:
- voidUsed to enable bubbling of events Used to enable bubbling of events | 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.getBubbleTarget() if present. There is no implementation in the Observable base class.
+ 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: Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
+});
| 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... | 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 | Observable | | isConnected()
+ 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 | Observable | | isConnected()
:
- voidReturns 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.
+ 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. | 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.) | Observable |
Public Events|
| 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: : Ext.direct.PollingProvider
| PollingProvider | | connect :
+ 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: : Ext.direct.PollingProvider
| 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 : Ext.direct.Provider
| 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 : Ext.direct.Provider
| 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 : Ext.direct.Providere : event
| 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 : Ext.direct.Providere : event
| 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 : Ext.direct.Provider
| 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 : Ext.direct.Provider
| 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 )
|
|