Repository: wicket Updated Branches: refs/heads/master 43f9f7497 -> 4e7f30f9c
WICKET-6367 nearly all suggested changes have been applied Project: http://git-wip-us.apache.org/repos/asf/wicket/repo Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/4e7f30f9 Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/4e7f30f9 Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/4e7f30f9 Branch: refs/heads/master Commit: 4e7f30f9c9067477468d44120df68828c4a91d7f Parents: 43f9f74 Author: Andrea Del Bene <[email protected]> Authored: Fri May 12 12:14:51 2017 +0200 Committer: Andrea Del Bene <[email protected]> Committed: Fri May 12 12:14:51 2017 +0200 ---------------------------------------------------------------------- .../src/main/asciidoc/bestpractices/bestpractices_16.adoc | 2 +- wicket-user-guide/src/main/asciidoc/internals/pagestoring.adoc | 2 +- wicket-user-guide/src/main/asciidoc/maven/maven_1.adoc | 6 +++--- wicket-user-guide/src/main/asciidoc/maven/maven_2.adoc | 6 +++--- .../src/main/asciidoc/monitoring/monitoring_4.adoc | 4 ++-- wicket-user-guide/src/main/asciidoc/redirects.adoc | 2 +- .../main/asciidoc/requestProcessing/requestProcessing_3.adoc | 2 ++ wicket-user-guide/src/main/asciidoc/testing/testing_2.adoc | 3 +-- 8 files changed, 14 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/wicket/blob/4e7f30f9/wicket-user-guide/src/main/asciidoc/bestpractices/bestpractices_16.adoc ---------------------------------------------------------------------- diff --git a/wicket-user-guide/src/main/asciidoc/bestpractices/bestpractices_16.adoc b/wicket-user-guide/src/main/asciidoc/bestpractices/bestpractices_16.adoc index 9aa39f2..e15ba17 100644 --- a/wicket-user-guide/src/main/asciidoc/bestpractices/bestpractices_16.adoc +++ b/wicket-user-guide/src/main/asciidoc/bestpractices/bestpractices_16.adoc @@ -1,7 +1,7 @@ -It is a widespread opinion that Wicket has a bad documentation. This argument is just partly correct. There are a lot of code samples and snippets which can be used as code templates. Furthermore, there is a big community that answers complex questions very quickly. In Wicket it is very hard to document everything, because nearly everything is extensible and replaceable. If a component is not completely suitable, you will extend or replace it. Working with Wicket means permanently navigating through code. For example, just consider validators. How can I find all navigators that exist? Open the interface _IValidator_ (Eclipse: Ctrl + Shift + T) and then open the type hierachy (Crtl + T). Now we can see all the validators existing in Wicket and our project. +It is a widespread opinion that Wicket has a bad documentation. This argument is just partly correct. There are a lot of code samples and snippets which can be used as code templates. Furthermore, there is a big community that answers complex questions very quickly. In Wicket it is very hard to document everything, because nearly everything is extensible and replaceable. If a component is not completely suitable, you will extend or replace it. Working with Wicket means permanently navigating through code. For example, just consider validators. How can I find all validators that exist? Open the interface _IValidator_ (Eclipse: Ctrl + Shift + T) and then open the type hierachy (Crtl + T). Now we can see all the validators existing in Wicket and our project. image::../img/validator-type-hierachy.png[] http://git-wip-us.apache.org/repos/asf/wicket/blob/4e7f30f9/wicket-user-guide/src/main/asciidoc/internals/pagestoring.adoc ---------------------------------------------------------------------- diff --git a/wicket-user-guide/src/main/asciidoc/internals/pagestoring.adoc b/wicket-user-guide/src/main/asciidoc/internals/pagestoring.adoc index 52af511..273a874 100644 --- a/wicket-user-guide/src/main/asciidoc/internals/pagestoring.adoc +++ b/wicket-user-guide/src/main/asciidoc/internals/pagestoring.adoc @@ -43,7 +43,7 @@ This folder contains a sub-folder for each active http session. This session fol === AsynchronousDataStore By default Wicket wraps _DiskDataStore_ with _org.apache.wicket.pageStore.AsynchronousDataStore_. The role of _AsynchronousDataStore_ is to detach the http worker thread from waiting for the write of the page bytes to the disk. -To disable it use: _org.apache.wicket.settings.StoreSettings.setAsynchronous(false)_. AsynchronousDataStore can delay the storage of pages' bytes for at most _org.apache.wicket.settings.StoreSettings.setAsynchronousQueueCapacity(int)_ pages. If this capacity is exceeded then the page's bytes are written synchronously to the backing _IDataStore_. +To disable it use: _org.apache.wicket.settings.StoreSettings.setAsynchronous(false)_. AsynchronousDataStore can delay the storage of page's bytes for at most _org.apache.wicket.settings.StoreSettings.setAsynchronousQueueCapacity(int)_ pages. If this capacity is exceeded then the page's bytes are written synchronously to the backing _IDataStore_. === DebugDiskDataStore http://git-wip-us.apache.org/repos/asf/wicket/blob/4e7f30f9/wicket-user-guide/src/main/asciidoc/maven/maven_1.adoc ---------------------------------------------------------------------- diff --git a/wicket-user-guide/src/main/asciidoc/maven/maven_1.adoc b/wicket-user-guide/src/main/asciidoc/maven/maven_1.adoc index 0342163..5aa4cf1 100644 --- a/wicket-user-guide/src/main/asciidoc/maven/maven_1.adoc +++ b/wicket-user-guide/src/main/asciidoc/maven/maven_1.adoc @@ -15,7 +15,7 @@ As pointed out in the note in <<helloWorld.adoc#_configuration_of_wicket_applica As we can read Wicket itself discourages us from using DEVELOPMENT mode into production environment. The running mode of our application can be configured in four different ways. The first one is adding a filter parameter inside deployment descriptor web.xml: -[source,html] +[source,xml] ---- <filter> <filter-name>wicket.MyApp</filter-name> @@ -31,7 +31,7 @@ As we can read Wicket itself discourages us from using DEVELOPMENT mode into pro </filter> ---- -The additional parameter is written in bold. The same parameter can be also expressed as context parameter: +The additional parameter is named _configuration_. The same parameter can be also expressed as context parameter: [source,html] ---- @@ -41,7 +41,7 @@ The additional parameter is written in bold. The same parameter can be also expr </context-param> ---- -The third way to set the running mode is using system property wicket.configuration. This parameter can be specified in the command line that starts up the server: +The third way to set the running mode is using system property _wicket.configuration_. This parameter can be specified in the command line that starts up the server: [source,java] ---- http://git-wip-us.apache.org/repos/asf/wicket/blob/4e7f30f9/wicket-user-guide/src/main/asciidoc/maven/maven_2.adoc ---------------------------------------------------------------------- diff --git a/wicket-user-guide/src/main/asciidoc/maven/maven_2.adoc b/wicket-user-guide/src/main/asciidoc/maven/maven_2.adoc index 39774a4..c09f6e8 100644 --- a/wicket-user-guide/src/main/asciidoc/maven/maven_2.adoc +++ b/wicket-user-guide/src/main/asciidoc/maven/maven_2.adoc @@ -77,7 +77,7 @@ If we need to use more Wicket modules or additional libraries, we can add the ap === Importing a Maven project into our IDE -Maven projects can be easily imported into the most popular Java IDEs. However, the procedure needed to do this differs from IDE to IDE. In this paragraph we can find the instructions to import Maven projects into three of the most popular IDEs among Java developers : NetBeans, JetBrains IDEA and Eclipse. +Maven projects can be easily imported into the most popular Java IDEs. However, the procedure needed to do this differs from IDE to IDE. In this paragraph we can find the instructions to import Maven projects into three of the most popular IDEs among Java developers: NetBeans, JetBrains IDEA and Eclipse. *NetBeans* Starting from version 6.7, NetBeans includes Maven support, hence we can start it and directly open the folder containing our project: @@ -105,7 +105,7 @@ Once we have created the classpath variable we can go to âFile/Import.../Exist image::../img/eclipse-maven-import.png[] -Once the project has been imported into Eclipse, we are free to use our favourite plug-ins to run it or debug it (like for example [run-jetty-run] http://code.google.com/p/run-jetty-run/ ). +Once the project has been imported into Eclipse, we are free to use our favourite plug-ins to run it or debug it (like for example https://github.com/xzer/run-jetty-run/[run-jetty-run]). NOTE: Please note the option âCopy projects into workspaceâ in the previous illustration. If we select it, the original project generated with Maven won't be affected by the changes made inside Eclipse because we will work on a copy of it under the current workspace. @@ -123,6 +123,6 @@ You can find a nice introduction guide to this plugin at http://netbeans.org/k For JetBrain IDEA we can use WicketForge plugin, hosted at Google Code http://code.google.com/p/wicketforge/[http://code.google.com/p/wicketforge/] . The plugin is released under ASF 2.0 license. *Eclipse* -With Eclipse we can install one of the plugins that supports Wicket. As of the writing of this document, the most popular is probably Qwickie, available in the Eclipse Marketplace and hosted on Google Code at http://code.google.com/p/qwickie/[http://code.google.com/p/qwickie/] . +With Eclipse we can install one of the plugins that supports Wicket. As of the writing of this document, the most popular is probably Qwickie, available in the Eclipse Marketplace and hosted on Google Code at https://github.com/count-negative/qwickie/[https://github.com/count-negative/qwickie/]. QWickie is released under ASF 2.0 license. http://git-wip-us.apache.org/repos/asf/wicket/blob/4e7f30f9/wicket-user-guide/src/main/asciidoc/monitoring/monitoring_4.adoc ---------------------------------------------------------------------- diff --git a/wicket-user-guide/src/main/asciidoc/monitoring/monitoring_4.adoc b/wicket-user-guide/src/main/asciidoc/monitoring/monitoring_4.adoc index 60c57e5..2c412f0 100644 --- a/wicket-user-guide/src/main/asciidoc/monitoring/monitoring_4.adoc +++ b/wicket-user-guide/src/main/asciidoc/monitoring/monitoring_4.adoc @@ -1,7 +1,7 @@ There are only a two steps required to write own measurements for life data statistics in Wicket: -(1) Write a class which is named very close to what it measures. This class should extends WicketMetrics and should annotated with _Aspect_ and provide one method with a join point scanning for the target signature. +(1) Write a class which is named very close to what it measures. This class should extends WicketMetrics and should annotated with _@Aspect_ and provide one method with a join point scanning for the target signature. [source,java] ---- @Aspect @@ -14,7 +14,7 @@ There are only a two steps required to write own measurements for life data stat } } ---- -* To measure time you need _Around_ because measureTime of WicketMetrics requires the joinPoint - the class name is appended with a slash at the end +* To measure time you need _@Around_ because measureTime of WicketMetrics requires the joinPoint - the class name is appended with a slash at the end * To only mark that a method is called you can use mark of WicketMetrics and apply null as a second parameter - if you apply a join point to mark the class name is appended with a slash at the end http://git-wip-us.apache.org/repos/asf/wicket/blob/4e7f30f9/wicket-user-guide/src/main/asciidoc/redirects.adoc ---------------------------------------------------------------------- diff --git a/wicket-user-guide/src/main/asciidoc/redirects.adoc b/wicket-user-guide/src/main/asciidoc/redirects.adoc index 4691234..975afb3 100644 --- a/wicket-user-guide/src/main/asciidoc/redirects.adoc +++ b/wicket-user-guide/src/main/asciidoc/redirects.adoc @@ -1,7 +1,7 @@ Quite a few teams have already got stuck into the following problem when working with wicket forms in a clustered environment while having 2 (or more) tomcat server with enabled session replication running. -In case of invalid data being submitted with a form instance for example, it seemed like according error messages wouldnât be presented when the same form page gets displayed again. Sometimes! And sometimes they would! One of those nightmares of rather deterministic programmerâs life. This so called Lost In Redirection problem, even if it looks like a wicket bug at first, is rather a result of a default setting in wicket regarding the processing of form submissions in general. In order to prevent another wide known problem of double form submissions, Wicket uses a so called REDIRECT_TO_BUFFER strategy for dealing with rendering a page after web formâs processing (_see RequestCycleSettings1.RenderStrategy). +In case of invalid data being submitted with a form instance for example, it seemed like according error messages wouldnât be presented when the same form page gets displayed again. Sometimes! And sometimes they would! One of those nightmares of rather deterministic programmerâs life. This so called Lost In Redirection problem, even if it looks like a wicket bug at first, is rather a result of a default setting in wicket regarding the processing of form submissions in general. In order to prevent another wide known problem of double form submissions, Wicket uses a so called REDIRECT_TO_BUFFER strategy for dealing with rendering a page after web formâs processing (see _RequestCycleSettings.RenderStrategy_). What does the default RenderStrategy actually do? http://git-wip-us.apache.org/repos/asf/wicket/blob/4e7f30f9/wicket-user-guide/src/main/asciidoc/requestProcessing/requestProcessing_3.adoc ---------------------------------------------------------------------- diff --git a/wicket-user-guide/src/main/asciidoc/requestProcessing/requestProcessing_3.adoc b/wicket-user-guide/src/main/asciidoc/requestProcessing/requestProcessing_3.adoc index 1868ee7..73c0102 100644 --- a/wicket-user-guide/src/main/asciidoc/requestProcessing/requestProcessing_3.adoc +++ b/wicket-user-guide/src/main/asciidoc/requestProcessing/requestProcessing_3.adoc @@ -57,6 +57,7 @@ public final void setResponsePage(final Page page) { === RequestCycle's hook methods and listeners The RequestCycle comes with some hook methods which can be overridden to perform custom actions when request handling reaches a specific stage. These methods are: + * *onBeginRequest():* called when the RequestCycle is about to start handling the request. * *onEndRequest():* called when the RequestCycle has finished to handle the request * *onDetach():* called after the request handling has completed and the RequestCycle is about to be detached from its thread. The default implementation of this method invokes detach() on the current session (the Session class will be shortly discussed in paragraph 9.4). @@ -64,6 +65,7 @@ The RequestCycle comes with some hook methods which can be overridden to perform Methods onBeforeRequest and onEndRequest can be used if we need to execute custom actions before and after business code is executed, such as opening a Hibernate/JPA session and closing it when code has terminated. A more flexible way to interact with the request processing is to use the listener interface _org.apache.wicket.request.cycle.IRequestCycleListener_. In addition to the three methods already seen for RequestCycle, this interface offers further hooks into request processing: + * *onBeginRequest(RequestCycle cycle):* (see the description above) * *onEndRequest(RequestCycle cycle):* (see the description above) * *onDetach(RequestCycle cycle):* (see the description above) http://git-wip-us.apache.org/repos/asf/wicket/blob/4e7f30f9/wicket-user-guide/src/main/asciidoc/testing/testing_2.adoc ---------------------------------------------------------------------- diff --git a/wicket-user-guide/src/main/asciidoc/testing/testing_2.adoc b/wicket-user-guide/src/main/asciidoc/testing/testing_2.adoc index a29e94a..e771715 100644 --- a/wicket-user-guide/src/main/asciidoc/testing/testing_2.adoc +++ b/wicket-user-guide/src/main/asciidoc/testing/testing_2.adoc @@ -37,8 +37,7 @@ The purpose of a HTML form is to collect user input. _FormTester_ comes with the * *setValue(String checkboxId, boolean value)*: sets the value of a given _CheckBox_ component. * *setFile(String formComponentId, File file, String contentType)*: sets a _File_ object on a _FileUploadField_ component. * *select(String formComponentId, int index)*: selects an option among a list of possible options owned by a component. It supports components that are subclasses of _AbstractChoice_ along with _RadioGroup_ and _CheckGroup_. -* *selectMultiple(String formComponentId, int <<_>> - indexes)*: selects all the options corresponding to the given array of indexes. It can be used with multiple-choice components like _CheckGroup_ or _ListMultipleChoice_. +* *selectMultiple(String formComponentId, int[] indexes)*: selects all the options corresponding to the given array of indexes. It can be used with multiple-choice components like _CheckGroup_ or _ListMultipleChoice_. _setValue_ is used inside method _insertUsernamePassword_ to set the username and password fields of the form used in project _StatelessLoginForm_:
