Author: ehillenius
Date: Tue Jan 30 23:30:35 2007
New Revision: 501754
URL: http://svn.apache.org/viewvc?view=rev&rev=501754
Log:
javadoc improvement
Modified:
incubator/wicket/branches/wicket-1.x/wicket/src/main/java/wicket/settings/IRequestCycleSettings.java
Modified:
incubator/wicket/branches/wicket-1.x/wicket/src/main/java/wicket/settings/IRequestCycleSettings.java
URL:
http://svn.apache.org/viewvc/incubator/wicket/branches/wicket-1.x/wicket/src/main/java/wicket/settings/IRequestCycleSettings.java?view=diff&rev=501754&r1=501753&r2=501754
==============================================================================
---
incubator/wicket/branches/wicket-1.x/wicket/src/main/java/wicket/settings/IRequestCycleSettings.java
(original)
+++
incubator/wicket/branches/wicket-1.x/wicket/src/main/java/wicket/settings/IRequestCycleSettings.java
Tue Jan 30 23:30:35 2007
@@ -20,6 +20,7 @@
import wicket.IResponseFilter;
import wicket.RequestCycle;
+import wicket.Session;
import wicket.markup.html.pages.BrowserInfoPage;
import wicket.protocol.http.WebRequestCycle;
import wicket.settings.IExceptionSettings.UnexpectedExceptionDisplay;
@@ -231,6 +232,20 @@
* method is used by the default implementation of
* [EMAIL PROTECTED] WebRequestCycle#newClientInfo()}, so if that
method is overriden,
* there is no guarantee this method will be taken into account.
+ *
+ * <p>
+ * <strong>WARNING: </strong> though this facility should work
transparently
+ * in most cases, it is recommended that you trigger the roundtrip to
get
+ * the browser info somewhere where it hurts the least. The roundtrip
will
+ * be triggered the first time you call [EMAIL PROTECTED]
Session#getClientInfo()} for
+ * a session, and after the roundtrip a new request with the same info
(url,
+ * post parameters) is handled. So rather than calling this in the
middle of
+ * an implementation of a form submit method, which would result in the
code
+ * of that method before the call to [EMAIL PROTECTED]
Session#getClientInfo()} to be
+ * executed twice, you best call [EMAIL PROTECTED]
Session#getClientInfo()} e.g. in a
+ * page constructor or somewhere else where you didn't do a lot of
+ * processing first.
+ * </p>
*
* @param gatherExtendedBrowserInfo
* Whether to gather extensive client info
