You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by sk...@apache.org on 2007/11/05 10:58:09 UTC
svn commit: r591940 - in
/myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui:
IgnoreProperty.java Max.java Min.java NotNull.java Range.java
Author: skitching
Date: Mon Nov 5 01:58:08 2007
New Revision: 591940
URL: http://svn.apache.org/viewvc?rev=591940&view=rev
Log:
Add documentation.
Modified:
myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/IgnoreProperty.java
myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Max.java
myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Min.java
myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/NotNull.java
myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Range.java
Modified: myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/IgnoreProperty.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/IgnoreProperty.java?rev=591940&r1=591939&r2=591940&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/IgnoreProperty.java (original)
+++ myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/IgnoreProperty.java Mon Nov 5 01:58:08 2007
@@ -24,7 +24,11 @@
import java.lang.annotation.Target;
/**
- * Ignore (skip) this property so it will not appear on any gui
+ * Ignore (skip) this property so it will not be displayed by the DynaForm
+ * (ie no input or output JSF components will be created to represent it).
+ * <p>
+ * This is particularly useful for annotating things like surrogate-key and
+ * version fields (which are not useful for users).
*/
@Target(value = {ElementType.METHOD, ElementType.FIELD})
@Retention(value = RetentionPolicy.RUNTIME)
Modified: myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Max.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Max.java?rev=591940&r1=591939&r2=591940&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Max.java (original)
+++ myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Max.java Mon Nov 5 01:58:08 2007
@@ -24,7 +24,9 @@
import java.lang.annotation.Target;
/**
- * set the maximum allowed value
+ * Set the maximum allowed value for a numeric input field.
+ * <p>
+ * See also annotation class Range.
*/
@Target(value = {ElementType.METHOD, ElementType.FIELD})
@Retention(value = RetentionPolicy.RUNTIME)
Modified: myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Min.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Min.java?rev=591940&r1=591939&r2=591940&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Min.java (original)
+++ myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Min.java Mon Nov 5 01:58:08 2007
@@ -24,7 +24,9 @@
import java.lang.annotation.Target;
/**
- * set the minimum allowed value
+ * Set the minimum allowed value for a numeric input field.
+ * <p>
+ * See also annotation class Range.
*/
@Target(value = {ElementType.METHOD, ElementType.FIELD})
@Retention(value = RetentionPolicy.RUNTIME)
Modified: myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/NotNull.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/NotNull.java?rev=591940&r1=591939&r2=591940&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/NotNull.java (original)
+++ myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/NotNull.java Mon Nov 5 01:58:08 2007
@@ -24,7 +24,7 @@
import java.lang.annotation.Target;
/**
- * required field
+ * Require the user to enter a value for this input field.
*/
@Target(value = {ElementType.METHOD, ElementType.FIELD})
@Retention(value = RetentionPolicy.RUNTIME)
Modified: myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Range.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Range.java?rev=591940&r1=591939&r2=591940&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Range.java (original)
+++ myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/annot/ui/Range.java Mon Nov 5 01:58:08 2007
@@ -24,7 +24,9 @@
import java.lang.annotation.Target;
/**
- * set the minimum and maximum allowed value
+ * Set the minimum and maximum allowed values for an input field.
+ * <p>
+ * This is an alternative to using separate Min and Max annotations.
*/
@Target(value = {ElementType.METHOD, ElementType.FIELD})
@Retention(value = RetentionPolicy.RUNTIME)