Author: chatellier Date: 2011-02-07 23:04:35 +0000 (Mon, 07 Feb 2011) New Revision: 698 Log: Add doc about controls Modified: trunk/src/site/rst/user/controls.rst Modified: trunk/src/site/rst/user/controls.rst =================================================================== --- trunk/src/site/rst/user/controls.rst 2011-02-07 22:44:15 UTC (rev 697) +++ trunk/src/site/rst/user/controls.rst 2011-02-07 23:04:35 UTC (rev 698) @@ -22,8 +22,72 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - -Validation -========== +Contrôles +========= -Source : http://struts.apache.org/2.x/docs/validation.html +Coser dispose d'un interface permettant de personnaliser les contrôles. +Cependant, leurs personnalisation est très technique et est réservé aux +utilisateurs expérimentée. + +Cette interface est composé d'un arbre avec la liste des 4 fichiers (captures, +tailles, traits, strates) et pour chacun d'eux, les niveaux des erreurs +detectable. + +A chaque niveau, un fichier XML décrivant les controles peut être associés +pour les décrires. + +Documentation +------------- + +Les fichiers XML sont basé sur une syntaxe utilisé par le framework Java XWork. + +La documentation de cette syntaxe peut être trouvé à cette adresse : +http://struts.apache.org/2.x/docs/validation.html + + +Champs +------ + +Pour chaque fichier, les champs sont accessible par leur nom anglais +(``survey``, ``stratum``...) dans leur type relatif (par exemple, ``number`` +est un double java). + +Pour chaque champs, il y a également un autre champs correspondant à sa +donnée sous forme de chaine de caracteres. Par exemple, le champs ``survey`` est +également accessible via le nom ``surveyAsString``. +Le champs ``number`` (de type double) est egalement accessible sous le nom +``numberAsString` (de type chaine). + +Exemple +------- + +Exemple du fichier de validation strate (niveau erreur) :: + + <validators> + <field name="survey"> + <field-validator type="requiredstring"> + <param name="trim">true</param> + <message>Missing survey name</message> + </field-validator> + </field> + <field name="stratum"> + <field-validator type="requiredstring"> + <param name="trim">true</param> + <message>Missing stratum name</message> + </field-validator> + </field> + <field name="surfaceAsString"> + <field-validator type="checkDouble"> + <param name="notAvailable">NA</param> + <message>surface attribute is not a valid double</message> + </field-validator> + </field> + </validators> + + +Dans cet exemple: + + * le champs ``survey`` est obligatoire (requiredstring) + * le champs ``surfaceAsString`` doit être un réel valide (la valeur NA étant + autorisée)