X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/source/Manager4.html diff --git a/docs/source/Manager4.html b/docs/source/Manager4.html index 2fa6b747..831ae4b2 100644 --- a/docs/source/Manager4.html +++ b/docs/source/Manager4.html @@ -3,8 +3,8 @@ The source code - - + + @@ -15,255 +15,75 @@ -
/**
- * @class Ext.direct.Manager
- * <p><b><u>Overview</u></b></p>
- *
- * <p>Ext.Direct aims to streamline communication between the client and server
- * by providing a single interface that reduces the amount of common code
- * typically required to validate data and handle returned data packets
- * (reading data, error conditions, etc).</p>
- *
- * <p>The Ext.direct namespace includes several classes for a closer integration
- * with the server-side. The Ext.data namespace also includes classes for working
- * with Ext.data.Stores which are backed by data from an Ext.Direct method.</p>
- *
- * <p><b><u>Specification</u></b></p>
- *
- * <p>For additional information consult the
- * <a href="http://sencha.com/products/extjs/extdirect">Ext.Direct Specification</a>.</p>
- *
- * <p><b><u>Providers</u></b></p>
- *
- * <p>Ext.Direct uses a provider architecture, where one or more providers are
- * used to transport data to and from the server. There are several providers
- * that exist in the core at the moment:</p><div class="mdetail-params"><ul>
- *
- * <li>{@link Ext.direct.JsonProvider JsonProvider} for simple JSON operations</li>
- * <li>{@link Ext.direct.PollingProvider PollingProvider} for repeated requests</li>
- * <li>{@link Ext.direct.RemotingProvider RemotingProvider} exposes server side
- * on the client.</li>
- * </ul></div>
- *
- * <p>A provider does not need to be invoked directly, providers are added via
- * {@link Ext.direct.Manager}.{@link Ext.direct.Manager#addProvider addProvider}.</p>
- *
- * <p><b><u>Router</u></b></p>
- *
- * <p>Ext.Direct utilizes a "router" on the server to direct requests from the client
- * to the appropriate server-side method. Because the Ext.Direct API is completely
- * platform-agnostic, you could completely swap out a Java based server solution
- * and replace it with one that uses C# without changing the client side JavaScript
- * at all.</p>
- *
- * <p><b><u>Server side events</u></b></p>
- *
- * <p>Custom events from the server may be handled by the client by adding
- * listeners, for example:</p>
- * <pre><code>
-{"type":"event","name":"message","data":"Successfully polled at: 11:19:30 am"}
-
-// add a handler for a 'message' event sent by the server
-Ext.direct.Manager.on('message', function(e){
-    out.append(String.format('&lt;p>&lt;i>{0}&lt;/i>&lt;/p>', e.data));
-            out.el.scrollTo('t', 100000, true);
-});
- * </code></pre>
+  
/**
+ * @class Ext.state.Manager
+ * This is the global state manager. By default all components that are "state aware" check this class
+ * for state information if you don't pass them a custom state provider. In order for this class
+ * to be useful, it must be initialized with a provider when your application initializes. Example usage:
+ <pre><code>
+// in your initialization function
+init : function(){
+   Ext.state.Manager.setProvider(new Ext.state.CookieProvider());
+   var win = new Window(...);
+   win.restoreState();
+}
+ </code></pre>
+ * This class passes on calls from components to the underlying {@link Ext.state.Provider} so that
+ * there is a common interface that can be used without needing to refer to a specific provider instance
+ * in every component.
  * @singleton
+ * @docauthor Evan Trimboli <evan@sencha.com>
  */
-
-Ext.define('Ext.direct.Manager', {
-    
-    /* Begin Definitions */
+Ext.define('Ext.state.Manager', {
     singleton: true,
-   
-    mixins: {
-        observable: 'Ext.util.Observable'
-    },
-    
-    requires: ['Ext.util.MixedCollection'],
-    
-    statics: {
-        exceptions: {
-            TRANSPORT: 'xhr',
-            PARSE: 'parse',
-            LOGIN: 'login',
-            SERVER: 'exception'
-        }
+    requires: ['Ext.state.Provider'],
+    constructor: function() {
+        this.provider = Ext.create('Ext.state.Provider');
     },
     
-    /* End Definitions */
-   
-    constructor: function(){
-        var me = this;
-       
-        me.addEvents(
-            /**
-             * @event event
-             * Fires after an event.
-             * @param {event} e The Ext.direct.Event type that occurred.
-             * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
-             */
-            'event',
-            /**
-             * @event exception
-             * Fires after an event exception.
-             * @param {event} e The Ext.direct.Event type that occurred.
-             */
-            'exception'
-        );
-        me.transactions = Ext.create('Ext.util.MixedCollection');
-        me.providers = Ext.create('Ext.util.MixedCollection');
-        
-        me.mixins.observable.constructor.call(me);
-    },
-    
-    /**
-     * Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods.
-     * If the provider is not already connected, it will auto-connect.
-     * <pre><code>
-var pollProv = new Ext.direct.PollingProvider({
-    url: 'php/poll2.php'
-});
-
-Ext.direct.Manager.addProvider({
-    "type":"remoting",       // create a {@link Ext.direct.RemotingProvider}
-    "url":"php\/router.php", // url to connect to the Ext.Direct server-side router.
-    "actions":{              // each property within the actions object represents a Class
-        "TestAction":[       // array of methods within each server side Class
-        {
-            "name":"doEcho", // name of method
-            "len":1
-        },{
-            "name":"multiply",
-            "len":1
-        },{
-            "name":"doForm",
-            "formHandler":true, // handle form on server with Ext.Direct.Transaction
-            "len":1
-        }]
-    },
-    "namespace":"myApplication",// namespace to create the Remoting Provider in
-},{
-    type: 'polling', // create a {@link Ext.direct.PollingProvider}
-    url:  'php/poll.php'
-}, pollProv); // reference to previously created instance
-     * </code></pre>
-     * @param {Object/Array} provider Accepts either an Array of Provider descriptions (an instance
-     * or config object for a Provider) or any number of Provider descriptions as arguments.  Each
-     * Provider description instructs Ext.Direct how to create client-side stub methods.
-     */
-    addProvider : function(provider){
-        var me = this,
-            args = arguments,
-            i = 0,
-            len;
-            
-        if (args.length > 1) {
-            for (len = args.length; i < len; ++i) {
-                me.addProvider(args[i]);
-            }
-            return;
-        }
-
-        // if provider has not already been instantiated
-        if (!provider.isProvider) {
-            provider = Ext.create('direct.' + provider.type + 'provider', provider);
-        }
-        me.providers.add(provider);
-        provider.on('data', me.onProviderData, me);
-
-
-        if (!provider.isConnected()) {
-            provider.connect();
-        }
-
-        return provider;
-    },
     
-    /**
-     * Retrieve a {@link Ext.direct.Provider provider} by the
-     * <b><tt>{@link Ext.direct.Provider#id id}</tt></b> specified when the provider is
-     * {@link #addProvider added}.
-     * @param {String/Ext.data.Provider} id The id of the provider, or the provider instance.
+    /**
+     * Configures the default state provider for your application
+     * @param {Ext.state.Provider} stateProvider The state provider to set
      */
-    getProvider : function(id){
-        return id.isProvider ? id : this.providers.get(id);
+    setProvider : function(stateProvider){
+        this.provider = stateProvider;
     },
-    
-    /**
-     * Removes the provider.
-     * @param {String/Ext.direct.Provider} provider The provider instance or the id of the provider.
-     * @return {Ext.direct.Provider} The provider, null if not found.
+
+    /**
+     * Returns the current value for a key
+     * @param {String} name The key name
+     * @param {Object} defaultValue The default value to return if the key lookup does not match
+     * @return {Object} The state data
      */
-    removeProvider : function(provider){
-        var me = this,
-            providers = me.providers,
-            provider = provider.isProvider ? provider : providers.get(provider);
-            
-        if (provider) {
-            provider.un('data', me.onProviderData, me);
-            providers.remove(provider);
-            return provider;
-        }
-        return null;
+    get : function(key, defaultValue){
+        return this.provider.get(key, defaultValue);
     },
-    
-    /**
-     * Add a transaction to the manager.
-     * @private
-     * @param {Ext.direct.Transaction} transaction The transaction to add
-     * @return {Ext.direct.Transaction} transaction
+
+    /**
+     * Sets the value for a key
+     * @param {String} name The key name
+     * @param {Object} value The state data
      */
-    addTransaction: function(transaction){
-        this.transactions.add(transaction);
-        return transaction;
+     set : function(key, value){
+        this.provider.set(key, value);
     },
 
-    /**
-     * Remove a transaction from the manager.
-     * @private
-     * @param {String/Ext.direct.Transaction} transaction The transaction/id of transaction to remove
-     * @return {Ext.direct.Transaction} transaction
+    /**
+     * Clears a value from the state
+     * @param {String} name The key name
      */
-    removeTransaction: function(transaction){
-        transaction = this.getTransaction(transaction);
-        this.transactions.remove(transaction);
-        return transaction;
+    clear : function(key){
+        this.provider.clear(key);
     },
 
-    /**
-     * Gets a transaction
-     * @private
-     * @param {String/Ext.direct.Transaction} transaction The transaction/id of transaction to get
-     * @return {Ext.direct.Transaction}
+    /**
+     * Gets the currently configured state provider
+     * @return {Ext.state.Provider} The state provider
      */
-    getTransaction: function(transaction){
-        return transaction.isTransaction ? transaction : this.transactions.get(transaction);
-    },
-    
-    onProviderData : function(provider, event){
-        var me = this,
-            i = 0,
-            len;
-            
-        if (Ext.isArray(event)) {
-            for (len = event.length; i < len; ++i) {
-                me.onProviderData(provider, event[i]);
-            }
-            return;
-        }
-        if (event.name && event.name != 'event' && event.name != 'exception') {
-            me.fireEvent(event.name, event);
-        } else if (event.type == 'exception') {
-            me.fireEvent('exception', event);
-        }
-        me.fireEvent('event', event, provider);
+    getProvider : function(){
+        return this.provider;
     }
-}, function(){
-    // Backwards compatibility
-    Ext.Direct = Ext.direct.Manager;
-});
-
+});