svn commit: r500980 - /incubator/adffaces/trunk/trinidad/src/site/xdoc/devguide/clientValidation.xml

[ma...@apache.org]

Author: matzew
Date: Mon Jan 29 01:20:06 2007
New Revision: 500980

URL: http://svn.apache.org/viewvc?view=rev&rev=500980
Log:
changed client side converter/validator docu, based on latest checkins to Trinidad

Modified:
    incubator/adffaces/trunk/trinidad/src/site/xdoc/devguide/clientValidation.xml

Modified: incubator/adffaces/trunk/trinidad/src/site/xdoc/devguide/clientValidation.xml
URL: http://svn.apache.org/viewvc/incubator/adffaces/trunk/trinidad/src/site/xdoc/devguide/clientValidation.xml?view=diff&rev=500980&r1=500979&r2=500980
==============================================================================
--- incubator/adffaces/trunk/trinidad/src/site/xdoc/devguide/clientValidation.xml (original)
+++ incubator/adffaces/trunk/trinidad/src/site/xdoc/devguide/clientValidation.xml Mon Jan 29 01:20:06 2007
@@ -47,6 +47,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){}
 
@@ -56,6 +59,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){}
 
@@ -307,12 +313,13 @@
 
 /**
  * Perform the correctness checks implemented by this Validator. 
- * If any violations are found, a ValidatorException will be thrown 
- * containing the FacesMessage describing the failure. 
+ * If any violations are found, a TrValidatorException will be thrown 
+ * containing the TrFacesMessage describing the failure. 
  * @param value value to be validated 
  * @param label label to identify the editableValueHolder to the user
+ * @param converter converter to format error string properly
  */
-TrValidator.prototype.validate = function(value, label){}
+TrValidator.prototype.validate = function(value, label, converter){}
       </source>
       
       The validator can throw javascript TrValidatorException objects: