Changeset 12954

Timestamp:

03/06/08 20:09:10 (10 months ago)

Author:

peller

Message:

Add CurrencyTextBox? constraints docs. Refs #6075 !strict

Files:

• dijit/trunk/form/CurrencyTextBox.js (modified) (1 diff)
• dijit/trunk/form/NumberTextBox.js (modified) (2 diffs)
• dijit/trunk/form/_DateTimeTextBox.js (modified) (1 diff)
• dojo/trunk/currency.js (modified) (2 diffs)
• dojo/trunk/number.js (modified) (2 diffs)

dijit/trunk/form/CurrencyTextBox.js

@@ -14 +14 @@
                 //              A validating currency textbox
                 //
+                // constraints: dijit.form._DateTimeTextBox.__Constraints 
+                //
                 // currency: String
-                //              the ISO4217 currency code, a three letter sequence like "USD"
-                //              See http://en.wikipedia.org/wiki/ISO_4217
+                //              the [ISO4217](http://en.wikipedia.org/wiki/ISO_4217) currency code, a three letter sequence like "USD"
                 currency: "",
+
+                /*=====
+                constraints: {},
+                ======*/
 
                 regExpGen: dojo.currency.regexp,
                 _formatter: dojo.currency.format,
+/*=====
+                parse: function(value, constraints){
+                        //      summary: parses the value as a Currency, according to constraints
+                        //      value: String
+                        //
+                        //      constraints: dojo.currency.__ParseOptions
+                },
+=====*/
                 parse: dojo.currency.parse,
 

dijit/trunk/form/NumberTextBox.js

@@ -36 +36 @@
 
                 format: function(/*Number*/ value, /*dojo.number.__FormatOptions*/ constraints){
+                        //      summary: formats the value as a Number, according to constraints
+
                         if(typeof value == "string") { return value; }
                         if(isNaN(value)){ return ""; }
@@ -47 +49 @@
                 /*=====
                 parse: function(value, constraints){
+                        //      summary: parses the value as a Number, according to constraints
                         //      value: String
                         //

dijit/trunk/form/_DateTimeTextBox.js

@@ -28 +28 @@
                 compare: dojo.date.compare,
                 format: function(/*Date*/ value, /*dojo.date.locale.__FormatOptions*/ constraints){
+                        //      summary: formats the value as a Date, according to constraints
                         if(!value){ return ''; }
                         return dojo.date.locale.format(value, constraints);
                 },
                 parse: function(/*String*/ value, /*dojo.date.locale.__FormatOptions*/ constraints){
+                        //      summary: parses the value as a Date, according to constraints
                         return dojo.date.locale.parse(value, constraints) || undefined; /* can't return null to getValue since that's special */
                 },

dojo/trunk/currency.js

@@ -33 +33 @@
 }
 
-dojo.currency.format = function(/*Number*/value, /*Object?*/options){
+dojo.currency.format = function(/*Number*/value, /*dojo.number.__FormatOptions?*/options){
 // summary:
-//              Format a Number as a String, using locale-specific settings
+//              Format a Number as a currency, using locale-specific settings
 //
 // description:
-//              Create a string from a Number using a known localized pattern.
-//              Formatting patterns appropriate to the locale are chosen from the CLDR http://unicode.org/cldr
-//              as well as the appropriate symbols and delimiters.  See http://www.unicode.org/reports/tr35/#Number_Elements
+//              Create a string from a Number using a known, localized pattern.
+//              [Formatting patterns](http://www.unicode.org/reports/tr35/#Number_Elements) appropriate to the locale are chosen from the [CLDR](http://unicode.org/cldr)
+//              as well as the appropriate symbols and delimiters.
 //
 // value:
 //              the number to be formatted.
-//
-// options: object {currency: String, pattern: String?, places: Number?, round: Number?, symbol: String?, locale: String?}
-//              currency- the ISO4217 currency code, a three letter sequence like "USD"
-//                      See http://en.wikipedia.org/wiki/ISO_4217
-//              symbol- override currency symbol. Normally, will be looked up in table of supported currencies, and ISO currency code will
-//                      be used if not found.  See dojo.i18n.cldr.nls->currency.js
-//              pattern- override formatting pattern with this string (see dojo.number.applyPattern)
-//              places- fixed number of decimal places to show.  Default is defined by the currency.
-//          round- 5 rounds to nearest .5; 0 rounds to nearest whole (default). -1 means don't round.
-//              locale- override the locale used to determine formatting rules
 
         return dojo.number.format(value, dojo.currency._mixInDefaults(options));
 }
 
-dojo.currency.regexp = function(/*Object?*/options){
+dojo.currency.regexp = function(/*dojo.number.__RegexpOptions?*/options){
 //
 // summary:
-//              Builds the regular needed to parse a number
+//              Builds the regular needed to parse a currency value
 //
 // description:
@@ -78 +68 @@
 }
 
-dojo.currency.parse = function(/*String*/expression, /*Object?*/options){
-//
-// summary:
-//              Convert a properly formatted string to a primitive Number,
-//              using locale-specific settings.
-//
-// description:
-//              Create a Number from a string using a known localized pattern.
-//              Formatting patterns are chosen appropriate to the locale.
-//              Formatting patterns are implemented using the syntax described at *URL*
-//
-// expression: A string representation of a Number
-//
-// options: object {pattern: string, locale: string, strict: boolean}
-//              currency- the ISO4217 currency code, a three letter sequence like "USD"
-//                      See http://en.wikipedia.org/wiki/ISO_4217
-//              symbol- override currency symbol. Normally, will be looked up in table of supported currencies, and ISO currency code will
-//                      be used if not found.  See dojo.i18n.cldr.nls->currency.js
-//              pattern- override pattern with this string
-//              locale- override the locale used to determine formatting rules
-//              strict- strict parsing, false by default
-//              places- number of decimal places to accept.  Default is defined by currency.
-//              fractional- where places are implied by pattern or explicit 'places' parameter, whether to include the fractional portion.
-//                      By default for currencies, it the fractional portion is optional.
+/*=====
+dojo.declare("dojo.currency.__ParseOptions", [dojo.number.__ParseOptions], {
+        //      type: String?
+        //              currency, set by default.
+        //      symbol: String?
+        //              override currency symbol. Normally, will be looked up in table of supported currencies,
+        //              and ISO currency code will be used if not found.  See dojo.i18n.cldr.nls->currency.js
+        //      places: Number?
+        //              number of decimal places to accept.  Default is defined by currency.
+        //      fractional: Boolean?|Array?
+        //              where places are implied by pattern or explicit 'places' parameter, whether to include the fractional portion.
+        //              By default for currencies, it the fractional portion is optional.
+
+        this.type = type;
+});
+=====*/
+
+dojo.currency.parse = function(/*String*/expression, /*dojo.currency.__ParseOptions?*/options){
+        //
+        // summary:
+        //              Convert a properly formatted currency string to a primitive Number,
+        //              using locale-specific settings.
+        //
+        // description:
+        //              Create a Number from a string using a known, localized pattern.
+        //              [Formatting patterns](http://www.unicode.org/reports/tr35/#Number_Format_Patterns) are chosen appropriate to the locale.
+        //
+        // expression: A string representation of a Number
+
         return dojo.number.parse(expression, dojo.currency._mixInDefaults(options));
 }

dojo/trunk/number.js

@@ -14 +14 @@
 dojo.number.__FormatOptions = function(){
         //      pattern: String?
-        //              override formatting pattern with this string (see
-        //              dojo.number._applyPattern)
+        //              override [formatting pattern](http://www.unicode.org/reports/tr35/#Number_Format_Patterns)
+        //              with this string
         //      type: String?
         //              choose a format type based on the locale from the following:
@@ -26 +26 @@
         //              means don't round.
         //      currency: String?
-        //              iso4217 currency code
+        //              an [ISO4217](http://en.wikipedia.org/wiki/ISO_4217) currency code, a three letter sequence like "USD"
         //      symbol: String?
         //              localized currency symbol