X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/SequentialIdGenerator.html diff --git a/docs/source/SequentialIdGenerator.html b/docs/source/SequentialIdGenerator.html new file mode 100644 index 00000000..f29dd94d --- /dev/null +++ b/docs/source/SequentialIdGenerator.html @@ -0,0 +1,81 @@ + + + + + The source code + + + + + + + 
/**
+ * @author Don Griffin
+ *
+ * This class is a sequential id generator. A simple use of this class would be like so:
+ *
+ *     Ext.define('MyApp.data.MyModel', {
+ *         extend: 'Ext.data.Model',
+ *         idgen: 'sequential'
+ *     });
+ *     // assign id's of 1, 2, 3, etc.
+ *
+ * An example of a configured generator would be:
+ *
+ *     Ext.define('MyApp.data.MyModel', {
+ *         extend: 'Ext.data.Model',
+ *         idgen: {
+ *             type: 'sequential',
+ *             prefix: 'ID_',
+ *             seed: 1000
+ *         }
+ *     });
+ *     // assign id's of ID_1000, ID_1001, ID_1002, etc.
+ *
+ */
+Ext.define('Ext.data.SequentialIdGenerator', {
+    extend: 'Ext.data.IdGenerator',
+    alias: 'idgen.sequential',
+
+    constructor: function() {
+        var me = this;
+
+        me.callParent(arguments);
+
+        me.parts = [ me.prefix, ''];
+    },
+
+    /**
+     * @cfg {String} prefix
+     * The string to place in front of the sequential number for each generated id. The
+     * default is blank.
+     */
+    prefix: '',
+
+    /**
+     * @cfg {Number} seed
+     * The number at which to start generating sequential id's. The default is 1.
+     */
+    seed: 1,
+
+    /**
+     * Generates and returns the next id.
+     * @return {String} The next id.
+     */
+    generate: function () {
+        var me = this,
+            parts = me.parts;
+
+        parts[1] = me.seed++;
+        return parts.join('');
+    }
+});
+
+ +