improved javadoc for #setRecreateChoices()

Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/fee1ff66
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/fee1ff66
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/fee1ff66

Branch: refs/heads/lambdas
Commit: fee1ff669b3cd2516737944c911fe241757b2601
Parents: 62415d6
Author: Sven Meier <[email protected]>
Authored: Thu Nov 19 13:57:26 2015 +0100
Committer: Sven Meier <[email protected]>
Committed: Thu Nov 19 13:57:36 2015 +0100

----------------------------------------------------------------------
 .../extensions/markup/html/form/select/SelectOptions.java   | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/wicket/blob/fee1ff66/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/form/select/SelectOptions.java
----------------------------------------------------------------------
diff --git 
a/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/form/select/SelectOptions.java
 
b/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/form/select/SelectOptions.java
index 12cfed3..e0d338e 100644
--- 
a/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/form/select/SelectOptions.java
+++ 
b/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/form/select/SelectOptions.java
@@ -79,11 +79,12 @@ public class SelectOptions<T> extends RepeatingView
        }
 
        /**
-        * Controls whether {@link SelectOption}s are recreated on every request
+        * Controls whether {@link SelectOption}s are recreated on each render.
         * <p>
-        * Note: When refreshing on each render, {@link #newOption(String, 
IModel)} should return
-        * {@link SelectOption}s with stable values, otherwise the current 
selection will be lost on
-        * form errors.
+        * Note: When recreating on each render, {@link #newOption(String, 
IModel)} should return
+        * {@link SelectOption}s with stable values, i.e. {@link 
SelectOption#getValue()} should
+        * return a value based on its model object instead of the default auto 
index.
+        * Otherwise the current selection will be lost on form errors.
         * 
         * @param refresh
         * @return this for chaining

Reply via email to