Changeset 231

Timestamp:

05/10/07 15:55:13 (6 years ago)

Author:

stefanp

Message:

renamed get/setDataObj to get/setDataObject

renamed submitCaption to submitValue

changed jala.Form.createComponents to use a stripped down label text if no name is provided for a component.

The constructor of a component now throws an error if no argument is provided. jala.Form.create writes that error to the log.

renamed jala.Form.REQUIRED to jala.Form.REQUIRE

Location:

jala/trunk

Files:

• code/Form.js (modified) (26 diffs)
• tests/Form.js (modified) (9 diffs)

jala/trunk/code/Form.js

@@ -75 +75 @@
     * @see #save
     */
-   this.setDataObj = function(newDataObj) {
+   this.setDataObject = function(newDataObj) {
       dataObj = newDataObj;
       return;
@@ -85 +85 @@
     * @returns The data object of this jala.Form instance
     */
-   this.getDataObj = function() {
+   this.getDataObject = function() {
       return dataObj;
    };
@@ -165 +165 @@
 
    // init private fields:
-   var submitCaption, errorMessage = undefined;
-
-   /**
-    * Returns the caption of the submit button.
-    * @returns caption
+   var submitValue, errorMessage = undefined;
+
+   /**
+    * Returns the value (ie. text) of the submit button.
     * @type String
     */
-   this.getSubmitCaption = function() {
-      return submitCaption;
+   this.getSubmitValue = function() {
+      return submitValue;
    };
    
    /**
-    * Sets the caption of the submit button.
-    * @param {String} newCaption
-    */
-   this.setSubmitCaption = function(newCaption) {
-      submitCaption = newCaption;
+    * Sets the value (ie. text) of the submit button.
+    * @param {String} newSubmitValue
+    */
+   this.setSubmitValue = function(newSubmitValue) {
+      submitValue = newSubmitValue;
       return;
    };
@@ -271 +270 @@
       form.setLegend(config.legend);
    }
-   if (config.submitCaption) {
-      form.setSubmitCaption(config.submitCaption);
+   if (config.submitValue) {
+      form.setSubmitValue(config.submitValue);
    }
    if (config.errorMessage) {
@@ -299 +298 @@
       var constr = jala.Form.Component[clazzName];
       if (!constr) {
-         // invalid constructor
+         // invalid constructor:
          var logStr = "jala.Form encountered unknown component type " + element["type"] + " in config of form ";
          logStr += (container.form) ? container.form.name : container.name;
@@ -305 +304 @@
          continue;
       }
-      var component = new constr(element.name);
+      var name = element.name;
+      if (!name && element.label) {
+         name = element.label.toAlphanumeric().toLowerCase();
+      } else if (!name && constr == jala.Form.Component.Fieldset) {
+         var str = "fieldset";
+         while(container.components[str]) {
+            str += "1";
+         }
+         name = str;
+      } else if (!name) {
+         // couldn't find a name for the component:
+         var logStr = "jala.Form encountered component of type " + clazzName.toLowerCase() + " without name or label property in config of form ";
+         logStr += (container.form) ? container.form.name : container.name;
+         app.log(logStr);
+         continue;
+      }
+      var component = new constr(name);
       container.addComponent(component);  // make sure that component.form is set before the loop!
       for (var key in element) {
@@ -322 +337 @@
                component[key] = element[key];
                break;
-            case jala.Form.REQUIRED:
+            case jala.Form.REQUIRE:
                component.require(key, true, msg);
                break;
@@ -405 +420 @@
        name: this.createDomId("submit"),
        "class": "submit",
-       "value": this.getSubmitCaption() || "Submit"}
+       "value": this.getSubmitValue() || "Submit"}
    );
    jala.Form.html.closeTag("div");
@@ -475 +490 @@
  * @param {Object} destObj (optional) object whose values will be changed.
  *       By default the dataObj passed to the constructor or to
- *       setDataObj is used.
+ *       setDataObject is used.
  */
 jala.Form.prototype.save = function(tracker, destObj) {
    tracker = (tracker) ? tracker : this.getTracker();
-   destObj = (destObj) ? destObj : this.getDataObj();
+   destObj = (destObj) ? destObj : this.getDataObject();
    var components = this.listComponents();
    for (var i=0; i<components.length; i++) {
@@ -559 +574 @@
  * Constant used by require function to define that a component
  * should validate only if the user did provide input.
- * Value: "required"
- * @type String
- */
-jala.Form.REQUIRED      = "required";
+ * Value: "require"
+ * @type String
+ */
+jala.Form.REQUIRE       = "require";
 
 /**
@@ -632 +647 @@
  */
 jala.Form.Component = function Component(name) {
+   
+   if (!name) {
+      throw "jala.Form.Component constructed without name.";
+   }
+   
    /**
     * The Form this component belongs to
@@ -881 +901 @@
  */
 jala.Form.Component.Skin.prototype.render = function() {
-   var obj = (this.getHandler()) ? this.getHandler() : this.form.getDataObj();
+   var obj = (this.getHandler()) ? this.getHandler() : this.form.getDataObject();
    obj.renderSkin(this.name, this);
    return;
@@ -905 +925 @@
    /**
     * Sets a requirement for this component.
-    * If function is called without arguments, jala.Form.REQUIRED
+    * If function is called without arguments, jala.Form.REQUIRE
     * is set to true.
     * @param {String} key String defining the type of requirement,
@@ -916 +936 @@
       if (arguments.length == 0) {
          // set default value for arguments
-         key = jala.Form.REQUIRED;
+         key = jala.Form.REQUIRE;
          val = true;
       }
@@ -950 +970 @@
     * Returns a specific message for a config element.
     * @param {String} key The key of the message as defined by
-    *          the constants in jala.Form.* (e.g. "required",
+    *          the constants in jala.Form.* (e.g. "require",
     *          "maxlength", "minlength" ...
     * @param {String} defaultMsg the message to use when no message
@@ -1112 +1132 @@
       if (this.validator) {
          error = this.validator.call(
-            this.form.getDataObj(),
+            this.form.getDataObject(),
             this.name,
             tracker.values[this.name],
@@ -1156 +1176 @@
       return null;
    } else if (this.getter) {
-      return this.getter.call(this.form.getDataObj(), this.name);
+      return this.getter.call(this.form.getDataObject(), this.name);
    } else {
-      return this.form.getDataObj()[this.name];
+      return this.form.getDataObject()[this.name];
    }
 };
@@ -1197 +1217 @@
  */
 jala.Form.Component.Input.prototype.render = function() {
-   var className = (this.getRequirement(jala.Form.REQUIRED) == true) ? "required" : "optional";
+   var className = (this.getRequirement(jala.Form.REQUIRE) == true) ? "require" : "optional";
    if (this.getClassName()) {
       className += " " + this.getClassName();
@@ -1350 +1370 @@
 
 /**
- * Checks user input for maximum length, minimum length and required
+ * Checks user input for maximum length, minimum length and require
  * if the corresponding options have been set using the require method.
  * @param {Object} reqData request data
@@ -1358 +1378 @@
  */
 jala.Form.Component.Input.prototype.checkLength = function(reqData) {
-   var required  = this.getRequirement(jala.Form.REQUIRED);
+   var require   = this.getRequirement(jala.Form.REQUIRE);
    var minLength = this.getRequirement(jala.Form.MINLENGTH);
    var maxLength = this.getRequirement(jala.Form.MAXLENGTH);
    
-   if (required && (reqData[this.name] == null || reqData[this.name].trim() == "")) {
-      return this.getMessage(jala.Form.REQUIRED, "Please enter text into this field.");
+   if (require && (reqData[this.name] == null || reqData[this.name].trim() == "")) {
+      return this.getMessage(jala.Form.REQUIRE, "Please enter text into this field.");
    } else if (maxLength && reqData[this.name].length > maxLength) {
       return this.getMessage(jala.Form.MAXLENGTH, "Input for this field is too long ({0} characters). Please enter no more than {1} characters.",
@@ -1371 +1391 @@
       // but don't throw an error if the element is optional and empty
       if (reqData[this.name].length < minLength &&
-          (required || (!required && reqData[this.name].length > 0))) {
+          (require || (!require && reqData[this.name].length > 0))) {
          return this.getMessage(jala.Form.MINLENGTH, "Input for this field is too short ({0} characters). Please enter at least {1} characters.",
                reqData[this.name].length, minLength);
@@ -1774 +1794 @@
          return options;
       } else if (options instanceof Function) {
-         return options.call(this.form.getDataObj(), this.name);
+         return options.call(this.form.getDataObject(), this.name);
       }
    }
@@ -1789 +1809 @@
 jala.Form.Component.Select.prototype.checkOptions = function(reqData) {
    // if field is required, an empty option is not allowed:
-   var found = (!this.getRequirement(jala.Form.REQUIRED) && !reqData[this.name]);
+   var found = (!this.getRequirement(jala.Form.REQUIRE) && !reqData[this.name]);
    if (!found) {
       if (this.getRequirement(jala.Form.CHECKOPTIONS) === false) {
@@ -1986 +2006 @@
 
 /**
- * Validates a file upload by making sure it's there (if REQUIRED is set),
+ * Validates a file upload by making sure it's there (if REQUIRE is set),
  * checking the file size, the content type and by trying to construct an image.
  * @param {Object} reqData request data
@@ -1997 +2017 @@
    if (reqData[this.name].contentLength == 0) {
       // no upload
-      if (this.getRequirement(jala.Form.REQUIRED) == true) {
-         return this.getMessage(jala.Form.REQUIRED, "File upload is required.");
+      if (this.getRequirement(jala.Form.REQUIRE) == true) {
+         return this.getMessage(jala.Form.REQUIRE, "File upload is required.");
       } else {
          // no further checks necessary, exit here
@@ -2050 +2070 @@
 
 /**
- * Validates an image upload by making sure it's there (if REQUIRED is set),
+ * Validates an image upload by making sure it's there (if REQUIRE is set),
  * checking the file size, the content type and by trying to construct an image.
  * If the file is an image, width and height limitations set by require are

jala/trunk/tests/Form.js

@@ -70 +70 @@
    assertEqual(list[++idx].name, "div");
    assertAttribute(list[idx].attributes, "id", "test_alias_row");
-   assertAttribute(list[idx].attributes, "class", "row required");
+   assertAttribute(list[idx].attributes, "class", "row require");
 
    assertEqual(list[++idx].name, "label");
@@ -96 +96 @@
    assertEqual(list[++idx].name, "div");
    assertAttribute(list[idx].attributes, "id", "test_desc_row");
-   assertAttribute(list[idx].attributes, "class", "row required");
+   assertAttribute(list[idx].attributes, "class", "row require");
 
    assertEqual(list[++idx].name, "label");
@@ -117 +117 @@
    assertEqual(list[++idx].name, "div");
    assertAttribute(list[idx].attributes, "id", "test_pushdate_row");
-   assertAttribute(list[idx].attributes, "class", "row required");
+   assertAttribute(list[idx].attributes, "class", "row require");
 
    assertEqual(list[++idx].name, "label");
@@ -242 +242 @@
    assertAttribute(list[idx].attributes, "class", "submit");
    assertAttribute(list[idx].attributes, "name", "test_submit");
-   assertAttribute(list[idx].attributes, "value", "Submit");
+   assertAttribute(list[idx].attributes, "value", "Save");
    assertAttribute(list[idx].attributes, "type", "submit");
    
@@ -308 +308 @@
  */
 var testFormSave = function() {
-   var dataObj = form.getDataObj();
+   var dataObj = form.getDataObject();
 
    var reqData = getRequestData();
@@ -400 +400 @@
    return   {
    name:             "test",
-   submit:           "Save",
+   submitValue:      "Save",
    components:[
       {
@@ -408 +408 @@
          minlength:  4,
          maxlength:  10,
-         required:   true,
+         require:    true,
          messages:   {
-            required: "Alias is required.",
+            require:   "Alias is required.",
             maxlength: "Alias is too long.",
             minlength: "Alias is too short."
@@ -420 +420 @@
          rows:       3,
          cols:       30,
-         required:   true,
+         require:    true,
          getter:     function(name) {
             return this.getProperty(name);
@@ -432 +432 @@
          type:       "date",
          dateFormat: "d.M.yyyy H:m",
-         required:   true
+         require:    true
       },
       {