Author: steveh Date: Tue Jan 18 14:53:29 2005 New Revision: 125557 URL: http://svn.apache.org/viewcvs?view=rev&rev=125557 Log: Adding doc on @Jpf.ValidateXXX annotations. Added: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_validation_annotations.xml (contents, props changed) Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml Url: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml?view=diff&rev=125557&p1=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml&r1=125556&p2=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml&r2=125557 ============================================================================== --- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml (original) +++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml Tue Jan 18 14:53:29 2005 @@ -25,7 +25,7 @@ <ul> <li><a href="pageflow_class_annotations.html">Controller Class Annotations</a></li> <li><a href="pageflow_method_annotations.html">Controller Method Annotations</a></li> - <li>Validation Annotations</li> + <li><a href="pageflow_validation_annotations.html">Validation Annotations</a></li> </ul> </section> Added: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_validation_annotations.xml Url: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_validation_annotations.xml?view=auto&rev=125557 ============================================================================== --- (empty file) +++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_validation_annotations.xml Tue Jan 18 14:53:29 2005 @@ -0,0 +1,2204 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd";> +<document> + <header> + <title>JPF Validation Annotations</title> + </header> + <body> + <section id="ValidatableBean"> + <title>Jpf.ValidatableBean</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidatableBean.html"> + Jpf.ValidatableBean</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidatableBean</code> annotation is an attribute of the @Jpf.Controller + annotation. It refers to a JavaBean class that is to be subject to validation. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>type</code> + </td> + <td> + <code>Class</code> + </td> + <td>Required. The type of the JavaBean decorated by this + annotation.</td> + </tr> + <tr> + <td> + <code>validatableProperties</code> + </td> + <td> + <a href="#ValidatableProperty"> + <code>@Jpf.ValidatableProperty[]</code> + </a> + </td> + <td>Required. Comma-separated list of @Jpf.ValidatableProperty + elements.</td> + </tr> + </table> + <p><strong>Example</strong></p> + <p> In this example, three bean properties are validated: three Strings representing the date, + a credit card, and an email address.</p> + <source>@Jpf.Controller( + validatableBeans={ + <strong>@Jpf.ValidatableBean</strong>( + type=Controller.MyForm.class, + validatableProperties={ + @Jpf.ValidatableProperty( + propertyName="date", + displayName="This field", + [EMAIL PROTECTED](), + [EMAIL PROTECTED](pattern="M-d-y") + ), + @Jpf.ValidatableProperty( + propertyName="creditCard", + displayName="This field", + [EMAIL PROTECTED](), + [EMAIL PROTECTED]() + ), + @Jpf.ValidatableProperty( + propertyName="email", + displayName="This field", + [EMAIL PROTECTED](), + [EMAIL PROTECTED]() + ) + } + ) + } +) +public class Controller extends PageFlowController +{ + ... + + public static class MyForm implements Serializable + { + private String _date; + + public String getDate() + { + return _date; + } + + public void setDate( String str ) + { + _date = str; + } + + private String _creditCard; + + public String getCreditCard() + { + return _creditCard; + } + + public void setCreditCard( String str ) + { + _creditCard = str; + } + + private String _email; + + public String getEmail() + { + return _email; + } + + public void setEmail( String str ) + { + _email = str; + } + } +}</source> + </section> + <section id="ValidatableProperty"> + <title>Jpf.ValidatableProperty</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidatableProperty.html"> + Jpf.ValidatableProperty</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidatableProperty</code> annotation is an attribute of the @Jpf.Controller or + @Jpf.Action annotations, or it can decorate a method in a form bean. It refers to a form field (or bean property) + that is to be subject to validation. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>displayName</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>displayNameKey</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>localeRules</code> + </td> + <td> + <a href="#ValidationLocaleRules"><code>@Jpf.ValidationLocaleRules[]</code></a> + </td> + <td>A comma-separated list of @Jpf.ValidationLocaleRules annotations.</td> + </tr> + <tr> + <td> + <code>propertyName</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>validateCreditCard</code> + </td> + <td> + <a href="#ValidateCreditCard"><code>@Jpf.ValidateCreditCard</code></a> + </td> + <td>A @Jpf.ValidateCreditCard annotation.</td> + </tr> + <tr> + <td> + <code>validateCustom</code> + </td> + <td> + <a href="#ValidateCustom"><code>@Jpf.ValidateCustom</code></a> + </td> + <td>A @Jpf.ValidateCustom annotation.</td> + </tr> + <tr> + <td> + <code>validateDate</code> + </td> + <td> + <a href="#ValidateDate"><code>@Jpf.ValidateDate</code></a> + </td> + <td>A @Jpf.ValidateDate annotation.</td> + </tr> + <tr> + <td> + <code>validateEmail</code> + </td> + <td> + <a href="#ValidateEmail"><code>@Jpf.ValidateEmail</code></a> + </td> + <td>A @Jpf.ValidateEmail annotation.</td> + </tr> + <tr> + <td> + <code>validateMask</code> + </td> + <td> + <a href="#ValidateMask"><code>@Jpf.ValidateMask</code></a> + </td> + <td>A @Jpf.ValidateMask annotation.</td> + </tr> + <tr> + <td> + <code>validateMaxLength</code> + </td> + <td> + <a href="#ValidateMaxLength"><code>@Jpf.ValidateMaxLength</code></a> + </td> + <td>A @Jpf.ValidateMaxLength annotation.</td> + </tr> + <tr> + <td> + <code>validateMinLength</code> + </td> + <td> + <a href="#ValidateMinLength"><code>@Jpf.ValidateMinLength</code></a> + </td> + <td>A @Jpf.ValidateMinLength annotation.</td> + </tr> + <tr> + <td> + <code>validateRange</code> + </td> + <td> + <a href="#ValidateRange"><code>@Jpf.ValidateRange</code></a> + </td> + <td>A @Jpf.ValidateRange annotation.</td> + </tr> + <tr> + <td> + <code>validateRequired</code> + </td> + <td> + <a href="#ValidateRequired"><code>@Jpf.ValidateRequired</code></a> + </td> + <td>A @Jpf.ValidateRequired annotation.</td> + </tr> + <tr> + <td> + <code>validateType</code> + </td> + <td> + <a href="#ValidateType"><code>@Jpf.ValidateType</code></a> + </td> + <td>A @Jpf.ValidateType annotation.</td> + </tr> + <tr> + <td> + <code>validateValidWhen</code> + </td> + <td> + <a href="#ValidateValidWhen"><code>@Jpf.ValidateValidWhen</code></a> + </td> + <td>A @Jpf.ValidateValidWhen annotation.</td> + </tr> + </table> + <p><strong>Example</strong></p> + <p> In this example, a date String is validated.</p> + <source>@Jpf.Controller( + validatableBeans={ + @Jpf.ValidatableBean( + type=Controller.MyForm.class, + validatableProperties={ + <strong>@Jpf.ValidatableProperty</strong>( + propertyName="date", + displayName="This field", + [EMAIL PROTECTED](), + [EMAIL PROTECTED](pattern="M-d-y") + ) + } + ) + } +) +public class Controller extends PageFlowController +{ + ... + + public static class MyForm implements Serializable + { + private String _date; + + public String getDate() + { + return _date; + } + } +}</source> + </section> + <section id="ValidateCreditCard"> + <title>Jpf.ValidateCreditCard</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateCreditCard.html"> + Jpf.ValidateCreditCard</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateCreditCard</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>arg0</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg0Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>enabled</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>message</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>messageKey</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>variables</code> + </td> + <td> + <a href="#ValidateCustomVariable"><code>@Jpf.ValidateCustomVariable[]</code></a> + </td> + <td>A comma-separated list of @Jpf.ValidateCustomVariable annotations.</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> public static class ValidatedForm implements Serializable + { + private String _creditCard; + + @Jpf.ValidatableProperty( + displayName="This field", + [EMAIL PROTECTED](), + validateCreditCard=<strong>@Jpf.ValidateCreditCard()</strong> + ) + public String getCreditCard() + { + return _creditCard; + } + + public void setCreditCard( String str ) + { + _creditCard = str; + } + } +</source> + </section> + <section id="ValidateCustom"> + <title>Jpf.ValidateCustom</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateCustom.html"> + Jpf.ValidateCustom</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateCustom</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>rule</code> + </td> + <td> + <code>String</code> + </td> + <td>Required. [todo]</td> + </tr> + <tr> + <td> + <code>arg0</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg0Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>enabled</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>message</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>messageKey</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>variables</code> + </td> + <td> + <a href="#ValidateCustomVariable"><code>@Jpf.ValidateCustomVariable[]</code></a> + </td> + <td>A comma-separated list of @Jpf.ValidateCustomVariable annotations.</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> + [todo] + </source> + </section> + <section id="ValidateCustomVariable"> + <title>Jpf.ValidateCustomVariable</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateCustomVariable.html"> + Jpf.ValidateCustomVariable</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateCustomVariable</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>name</code> + </td> + <td> + <code>String</code> + </td> + <td>Required. [todo]</td> + </tr> + <tr> + <td> + <code>value</code> + </td> + <td> + <code>String</code> + </td> + <td>Required. [todo]</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> + [todo] + </source> + </section> + + <section id="ValidateDate"> + <title>Jpf.ValidateDate</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateDate.html"> + Jpf.ValidateDate</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateDate</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>pattern</code> + </td> + <td> + <code>String</code> + </td> + <td>Required. [todo]</td> + </tr> + <tr> + <td> + <code>arg0</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg0Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>enabled</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>message</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>messageKey</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>strict</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> public static class ValidatedForm implements Serializable + { + private String _date; + + @Jpf.ValidatableProperty( + displayName="This field", + [EMAIL PROTECTED](), + validateDate=<strong>@Jpf.ValidateDate(pattern="M-d-y")</strong> + ) + public String getDate() + { + return _date; + } + + public void setDate( String str ) + { + _date = str; + } + }</source> + </section> + <section id="ValidateEmail"> + <title>Jpf.ValidateEmail</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateEmail.html"> + Jpf.ValidateEmail</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateEmail</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>arg0</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg0Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>enabled</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>message</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>messageKey</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> public static class ValidatedForm implements Serializable + { + private String _email; + + @Jpf.ValidatableProperty( + displayName="This field", + [EMAIL PROTECTED](), + validateEmail=<strong>@Jpf.ValidateEmail()</strong> + ) + public String getEmail() + { + return _email; + } + + public void setEmail( String str ) + { + _email = str; + } + } +</source> + </section> + <section id="ValidateMask"> + <title>Jpf.ValidateMask</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateMask.html"> + Jpf.ValidateMask</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateMask</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>regex</code> + </td> + <td> + <code>String</code> + </td> + <td>Required. [todo]</td> + </tr> + <tr> + <td> + <code>arg0</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg0Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>enabled</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>message</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>messageKey</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> public static class ValidatedForm implements Serializable + { + private String _mask; + + @Jpf.ValidatableProperty( + displayName="This field", + [EMAIL PROTECTED](), + [EMAIL PROTECTED](regex="a*b") + ) + public String getMask() + { + return _mask; + } + + public void setMask( String str ) + { + _mask = str; + } + }</source> + </section> + <section id="ValidateMaxLength"> + <title>Jpf.ValidateMaxLength</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateMaxLength.html"> + Jpf.ValidateMaxLength</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateMaxLength</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>chars</code> + </td> + <td> + <code>int</code> + </td> + <td>Required. [todo]</td> + </tr> + <tr> + <td> + <code>arg0</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg0Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>enabled</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>message</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>messageKey</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> public static class ValidatedForm implements Serializable + { + private String _maxLength; + + @Jpf.ValidatableProperty( + displayName="This field", + [EMAIL PROTECTED](), + [EMAIL PROTECTED](chars=2) + ) + public String getMaxLength() + { + return _maxLength; + } + + public void setMaxLength( String str ) + { + _maxLength = str; + } + }</source> + </section> + <section id="ValidateMinLength"> + <title>Jpf.ValidateMinLength</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateMinLength.html"> + Jpf.ValidateMinLength</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateMinLength</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>chars</code> + </td> + <td> + <code>int</code> + </td> + <td>Required. [todo]</td> + </tr> + <tr> + <td> + <code>arg0</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg0Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>enabled</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>message</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>messageKey</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> public static class ValidatedForm implements Serializable + { + private String _minLength; + + @Jpf.ValidatableProperty( + displayName="This field", + [EMAIL PROTECTED](), + [EMAIL PROTECTED](chars=2) + ) + public String getMinLength() + { + return _minLength; + } + + public void setMinLength( String str ) + { + _minLength = str; + } + }</source> + </section> + <section id="ValidateRange"> + <title>Jpf.ValidateRange</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateRange.html"> + Jpf.ValidateRange</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateRange</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>arg0</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg0Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>enabled</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>maxFloat</code> + </td> + <td> + double + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>maxInt</code> + </td> + <td> + int + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>message</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>messageKey</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>minFloat</code> + </td> + <td> + double + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>minInt</code> + </td> + <td> + int + </td> + <td>[todo]</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> public static class ValidatedForm implements Serializable + { + private String _range; + + @Jpf.ValidatableProperty( + displayName="This field", + [EMAIL PROTECTED](), + [EMAIL PROTECTED](minInt=1, maxInt=10) + ) + public String getRange() + { + return _range; + } + + public void setRange( String str ) + { + _range = str; + } + }</source> + </section> + <section id="ValidateRequired"> + <title>Jpf.ValidateRequired</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateRequired.html"> + Jpf.ValidateRequired</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateRequired</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>arg0</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg0Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>enabled</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>message</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>messageKey</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> public static class ValidatedForm implements Serializable + { + private String _range; + + @Jpf.ValidatableProperty( + displayName="This field", + [EMAIL PROTECTED](), + [EMAIL PROTECTED](minInt=1, maxInt=10) + ) + public String getRange() + { + return _range; + } + + public void setRange( String str ) + { + _range = str; + } + }</source> + </section> + <section id="ValidateType"> + <title>Jpf.ValidateType</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateType.html"> + Jpf.ValidateType</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateType</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>type</code> + </td> + <td> + <code>Class</code> + </td> + <td>Required. [todo]</td> + </tr> + <tr> + <td> + <code>arg0</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg0Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>enabled</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>message</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>messageKey</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> public static class ValidatedForm implements Serializable + { + private String _typeInt; + + @Jpf.ValidatableProperty( + displayName="This field", + [EMAIL PROTECTED](), + [EMAIL PROTECTED](type=int.class) + ) + public String getTypeInt() + { + return _typeInt; + } + + public void setTypeInt( String str ) + { + _typeInt = str; + } + }</source> + </section> + <section id="ValidateValidWhen"> + <title>Jpf.ValidateValidWhen</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidateValidWhen.html"> + Jpf.ValidateValidWhen</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidateValidWhen</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>condtion</code> + </td> + <td> + <code>String</code> + </td> + <td>Required. [todo]</td> + </tr> + <tr> + <td> + <code>arg0</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg0Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg1Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg2Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>arg3Key</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>enabled</code> + </td> + <td> + boolean + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>message</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>messageKey</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source> public static class ValidatedForm implements Serializable + { + private String _validWhenPageFlowProp; + + @Jpf.ValidatableProperty( + displayName="This field", + [EMAIL PROTECTED](), + [EMAIL PROTECTED](condition="${pageFlow.str==actionForm.validWhenPageFlowProp}", message="pageFlow.str must be the same as this") + ) + public String getValidWhenPageFlowProp() + { + return _validWhenPageFlowProp; + } + + public void setValidWhenPageFlowProp( String str ) + { + _validWhenPageFlowProp = str; + } + }</source> + </section> + <section id="ValidationLocaleRules"> + <title>Jpf.ValidationLocaleRules</title> + <p> + <strong>Javadoc: </strong> + <a class="fork" + href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.ValidationLocaleRules.html"> + Jpf.ValidationLocaleRules</a> + </p> + <p> + <strong>Description</strong> + </p> + <p> The <code>@Jpf.ValidationLocaleRules</code> annotation... [todo]. </p> + <p> + <strong>Attributes</strong> + </p> + <table> + <tr> + <th>Attribute</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td> + <code>applyToUnhandledLocales</code> + </td> + <td> + <code>boolean</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>country</code> + </td> + <td> + <code>String</code> + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>language</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + <tr> + <td> + <code>validateCreditCard</code> + </td> + <td> + <a href="#ValidateCreditCard"><code>@Jpf.ValidateCreditCard</code></a> + </td> + <td>A @Jpf.ValidateCreditCard annotation.</td> + </tr> + <tr> + <td> + <code>validateCustom</code> + </td> + <td> + <a href="#ValidateCustom"><code>@Jpf.ValidateCustom</code></a> + </td> + <td>A @Jpf.ValidateCustom annotation.</td> + </tr> + <tr> + <td> + <code>validateDate</code> + </td> + <td> + <a href="#ValidateDate"><code>@Jpf.ValidateDate</code></a> + </td> + <td>A @Jpf.ValidateDate annotation.</td> + </tr> + <tr> + <td> + <code>validateEmail</code> + </td> + <td> + <a href="#ValidateEmail"><code>@Jpf.ValidateEmail</code></a> + </td> + <td>A @Jpf.ValidateEmail annotation.</td> + </tr> + <tr> + <td> + <code>validateMask</code> + </td> + <td> + <a href="#ValidateMask"><code>@Jpf.ValidateMask</code></a> + </td> + <td>A @Jpf.ValidateMask annotation.</td> + </tr> + <tr> + <td> + <code>validateMaxLength</code> + </td> + <td> + <a href="#ValidateMaxLength"><code>@Jpf.ValidateMaxLength</code></a> + </td> + <td>A @Jpf.ValidateMaxLength annotation.</td> + </tr> + <tr> + <td> + <code>validateMinLength</code> + </td> + <td> + <a href="#ValidateMinLength"><code>@Jpf.ValidateMinLength</code></a> + </td> + <td>A @Jpf.ValidateMinLength annotation.</td> + </tr> + <tr> + <td> + <code>validateRange</code> + </td> + <td> + <a href="#ValidateRange"><code>@Jpf.ValidateRange</code></a> + </td> + <td>A @Jpf.ValidateRange annotation.</td> + </tr> + <tr> + <td> + <code>validateRequired</code> + </td> + <td> + <a href="#ValidateRequired"><code>@Jpf.ValidateRequired</code></a> + </td> + <td>A @Jpf.ValidateRequired annotation.</td> + </tr> + <tr> + <td> + <code>validateType</code> + </td> + <td> + <a href="#ValidateType"><code>@Jpf.ValidateType</code></a> + </td> + <td>A @Jpf.ValidateType annotation.</td> + </tr> + <tr> + <td> + <code>validateValidWhen</code> + </td> + <td> + <a href="#ValidateValidWhen"><code>@Jpf.ValidateValidWhen</code></a> + </td> + <td>A @Jpf.ValidateValidWhen annotation.</td> + </tr> + <tr> + <td> + <code>variant</code> + </td> + <td> + String + </td> + <td>[todo]</td> + </tr> + </table> + <p><strong>Example</strong></p> + <source>[todo]</source> + </section> + </body> + <footer> + <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br/> + © 2004, Apache Software Foundation + </legal> + </footer> +</document> \ No newline at end of file Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml Url: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml?view=diff&rev=125557&p1=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml&r1=125556&p2=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml&r2=125557 ============================================================================== --- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml (original) +++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml Tue Jan 18 14:53:29 2005 @@ -49,9 +49,13 @@ <control label="Controls Javadoc" href="apidocs/classref_controls/index.html"/> </controls> <netui label="Page Flows"> - <netui label="Page Flow Javadoc" href="apidocs/classref_pageflows/index.html"/> - <netui label="<netui> Tags" href="apidocs/taglib/index.html"/> - <netui label="Metadata Annotations" href="pageflow/jpf-annotations/pageflow_annotations.html"/> + <netui_api label="Page Flow Javadoc" href="apidocs/classref_pageflows/index.html"/> + <netui_taglib label="<netui> Tags" href="apidocs/taglib/index.html"/> + <netui_meta label="@Jpf Annotations"> + <netui_meta_class label="Class Annotations" href="pageflow/jpf-annotations/pageflow_class_annotations.html"/> + <netui_meta_method label="Method Annotations" href="pageflow/jpf-annotations/pageflow_method_annotations.html"/> + <netui_meta_validation label="Validation Annotations" href="pageflow/jpf-annotations/pageflow_validation_annotations.html"/> + </netui_meta> <netui label="netui-config.xml" href="pageflow/config/netui-config.html"/> </netui> <ws label="Web Services">
