svn commit: r500979 - in /incubator/adffaces/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs: CoreFormat.js Locale.js

[matzew]

Author: matzew
Date: Mon Jan 29 01:18:26 2007
New Revision: 500979

URL: http://svn.apache.org/viewvc?view=rev&rev=500979
Log:
JSDoc added for TrConverter "interface" and TrNumberConverter clazz

Modified:
    
incubator/adffaces/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/CoreFormat.js
    
incubator/adffaces/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/Locale.js

Modified: 
incubator/adffaces/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/CoreFormat.js
URL: 
http://svn.apache.org/viewvc/incubator/adffaces/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/CoreFormat.js?view=diff&rev=500979&r1=500978&r2=500979
==============================================================================
--- 
incubator/adffaces/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/CoreFormat.js
 (original)
+++ 
incubator/adffaces/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/CoreFormat.js
 Mon Jan 29 01:18:26 2007
@@ -31,6 +31,10 @@
 
 TrNumberConverter.prototype = new TrConverter();
 
+/**
+ * Checks if this converter can convert the value, which
+ * is only true, if no pattern is set and the type is a number
+ */
 TrNumberConverter.prototype._isConvertible = function()
 {
        if(this._pattern == null && this._type=="number")
@@ -66,6 +70,9 @@
   }
 }
 
+/**
+ * Returns the number value as string or undefined (see also _isConvertible).
+ */
 TrNumberConverter.prototype.getAsString = function(
   number,
   label
@@ -81,6 +88,9 @@
   }
 }
 
+/**
+ * Returns the number value for the submitted string or undefined (see also 
_isConvertible).
+ */
 TrNumberConverter.prototype.getAsObject = function(
   numberString,
   label

Modified: 
incubator/adffaces/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/Locale.js
URL: 
http://svn.apache.org/viewvc/incubator/adffaces/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/Locale.js?view=diff&rev=500979&r1=500978&r2=500979
==============================================================================
--- 
incubator/adffaces/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/Locale.js
 (original)
+++ 
incubator/adffaces/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/Locale.js
 Mon Jan 29 01:18:26 2007
@@ -608,6 +608,9 @@
  *
  * @param value Model object value to be converted 
  * @param label label to identify the editableValueHolder to the user 
+ * 
+ * @return the value as a string or undefined in case of no converter 
mechanism is
+ * available (see TrNumberConverter).
  */
 TrConverter.prototype.getAsString = function(value, label){}
 
@@ -617,6 +620,9 @@
  *
  * @param value String value to be converted 
  * @param label label to identify the editableValueHolder to the user 
+ * 
+ * @return the converted value or undefined in case of no converter mechanism 
is
+ * available (see TrNumberConverter).
  */
 TrConverter.prototype.getAsObject = function(value, label){}