For example the following behavior prepends a red asterisk to the tag of a form component if this one is required:
public class RedAsteriskBehavior extends Behavior { @Override
public void beforeRender(Component component) {
Response response = component.getResponse();
- StringBuffer asterisktHtml = new StringBuffer(200); if(componet instanceof FormComponent
+ StringBuffer asterisktHtml = new StringBuffer(200); if(component instanceof FormComponent
&& ((FormComponent)component).isRequired()){
asteriskHtml.append(" <b style="color:red;font-size:medium">*</b>");
}
@@ -374,7 +374,7 @@
Index: guide/ajax.html
===================================================================
--- guide/ajax.html (revision 1675105)
+++ guide/ajax.html (working copy)
@@ -151,7 +151,7 @@
18 Working with AJAX - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -205,7 +205,7 @@
label.setDefaultModelObject(
"Another value 4 label.");
target.add(label);
}
-};
Components can be refreshed via Ajax only if they have rendered a markup id for their related tag. As a consequence, we must remember to set a valid id value on every component we want to add to AjaxRequestTarget. This can be done using one of the two methods seen in paragraph 4.3:final Label label = new Label("labelComponent", "Initial value.");
+};AjaxRequestTarget. This can be done using one of the two methods seen in paragraph 6.3:final Label label = new Label("labelComponent", "Initial value.");
//autogenerate a markup id
label.setOutputMarkupId(true);
add(label);
@@ -227,8 +227,9 @@
+
18.2 Build-in AJAX components
-Wicket distribution comes with a number of built-in AJAX components ready to be used. Some of them are the ajaxified version of common components like links and buttons, while others are AJAX-specific components.AJAX components are not different from any other component seen so far and they don't require any additional configuration to be used. As we will shortly see, switching from a classic link or button to the ajaxified version is just a matter of appending “Ajax” to the component class name.This paragraph provides an overview of what we can find in Wicket to start writing AJAX-enhanced web applications.Links and buttons
In the previous paragraph we have already introduced component AjaxLink. Wicket provides also the ajaxified versions of submitting components SubmitLink and Button which are simply called AjaxSubmitLink and AjaxButton. These components come with a version of methods onSubmit, onError and onAfterSubmit that takes in input also an instance of AjaxRequestTarget.Both components are in package org.apache.wicket.ajax.markup.html.form.Fallback components
Building an entire site using AJAX can be risky as some clients may not support this technology. In order to provide an usable version of our site also to these clients, we can use components AjaxFallbackLink and AjaxFallbackButton which are able to automatically degrade to a standard link or to a standard button if client doesn't support AJAX.AJAX Checkbox
Class org.apache.wicket.ajax.markup.html.form.AjaxCheckBox is a checkbox component that updates its model via AJAX when user changes its value. Its AJAX callback method is onUpdate(AjaxRequestTarget target). The component extends standard checkbox component CheckBox adding an AjaxFormComponentUpdatingBehavior to itself (we will see this behavior later in paragraph 16.3.3).AJAX editable labels
An editable label is a special label that can be edited by the user when she/he clicks on it. Wicket ships three different implementations for this component (all inside package org.apache.wicket.extensions.ajax.markup.html):
+Wicket distribution comes with a number of built-in AJAX components ready to be used. Some of them are the ajaxified version of common components like links and buttons, while others are AJAX-specific components.AJAX components are not different from any other component seen so far and they don't require any additional configuration to be used. As we will shortly see, switching from a classic link or button to the ajaxified version is just a matter of prepending “Ajax” to the component class name.This paragraph provides an overview of what we can find in Wicket to start writing AJAX-enhanced web applications.Links and buttons
In the previous paragraph we have already introduced component AjaxLink. Wicket provides also the ajaxified versions of submitting components SubmitLink and Button which are simply called AjaxSubmitLink and AjaxButton. These components come with a version of methods onSubmit, onError and onAfterSubmit that takes in input also an instance of AjaxRequestTarget.Both components are in package org.apache.wicket.ajax.markup.html.form.Fallback components
Building an entire site using AJAX can be risky as some clients may not support this technology. In order to provide an usable version of our site also to these clients, we can use components AjaxFallbackLink and AjaxFallbackButton which are able to automatically degrade to a standard link or to a standard button if client doesn't support AJAX.AJAX Checkbox
Class org.apache.wicket.ajax.markup.html.form.AjaxCheckBox is a checkbox component that updates its model via AJAX when user changes its value. Its AJAX callback method is onUpdate(AjaxRequestTarget target). The component extends standard checkbox component CheckBox adding an AjaxFormComponentUpdatingBehavior to itself (we will see this behavior later in paragraph 18.3.3).AJAX editable labels
An editable label is a special label that can be edited by the user when she/he clicks on it. Wicket ships three different implementations for this component (all inside package org.apache.wicket.extensions.ajax.markup.html):
The callback function takes in input the following parameters: attrs, jqXHR, textStatus, jqEvent and errorThrown. The first three parameters are the same seen before with
IAjaxCallListener while jqEvent is an event internally fired by Wicket. The last parameter errorThrown indicates if an error has occurred during the AJAX call.
To see a basic example of use of a global AJAX call listener, let's go back to our custom datepicker created in
chapter 16. When we built it we didn't think about a possible use of the component with AJAX. When a complex component like our datepicker is refreshed via AJAX, the following two side effects can occur:
- After been refreshed, the component loses every JavaScript handler set on it. This is not a problem for our datepicker as it sets a new JQuery datepicker every time is rendered (inside method renderHead).
- The markup previously created with JavaScript is not removed. For our datepicker this means that the icon used to open the calendar won't be removed while a new one will be added each time the component is refreshed.
@@ -590,7 +591,7 @@
Index: guide/bestpractices.html
===================================================================
--- guide/bestpractices.html (revision 1675105)
+++ guide/bestpractices.html (working copy)
@@ -151,7 +151,7 @@
24 Wicket Best Practices - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -532,7 +532,7 @@
Index: guide/componentLifecycle.html
===================================================================
--- guide/componentLifecycle.html (revision 1675105)
+++ guide/componentLifecycle.html (working copy)
@@ -151,7 +151,7 @@
7 Components lifecycle - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -305,7 +305,7 @@
Index: guide/contributing.html
===================================================================
--- guide/contributing.html (revision 1675105)
+++ guide/contributing.html (working copy)
@@ -149,7 +149,7 @@
29 Contributing to this guide (Appendix) - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -171,7 +171,7 @@
- To preview your changes you should have Grails installed.
Note: Download version
2.2.4. Newer versions are not supported at the moment.
+
Note: Download version
2.2.4. Newer versions are not supported at the moment. Grails 2.2.4 does
not work with Java 8. Use Java 7 instead.
- Install it by following these instructions
@@ -185,6 +185,7 @@
and attach it to a ticket in Apache Wicket's JIRAThank you!
+
@@ -209,7 +210,7 @@
Index: guide/forms2.html
===================================================================
--- guide/forms2.html (revision 1675105)
+++ guide/forms2.html (working copy)
@@ -151,7 +151,7 @@
12 Wicket forms in detail - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -207,11 +207,12 @@
-In the previous chapter we have only scratched the surface of Wicket forms. The Form component was not only designed to collect user input but also to extend the semantic of the classic HTML forms with new features.
One of such features is the ability to work with nested forms (they will be discussed in paragraph 10.5).
In this chapter we will continue to explore Wicket forms learning how to master them and how to build effective and user-proof forms for our web applications.
+In the previous chapter we have only scratched the surface of Wicket forms. The Form component was not only designed to collect user input but also to extend the semantic of the classic HTML forms with new features.
One of such features is the ability to work with nested forms (they will be discussed in
paragraph 12.6).
In this chapter we will continue to explore Wicket forms learning how to master them and how to build effective and user-proof forms for our web applications.
+
-
In paragraph 9.3 we have seen a very basic usage of the Form component and we didn't pay much attention to what happens behind the scenes of form submission. In Wicket when we submit a form we trigger the following steps on server side:
+
In
paragraph 11.3 we have seen a very basic usage of the Form component and we didn't pay much attention to what happens behind the scenes of form submission. In Wicket when we submit a form we trigger the following steps on server side:
- Form validation: user input is checked to see if it satisfies the validation rules set on the form. If validation fails, step number 2 is skipped and the form should display a feedback message to explain to user what went wrong. During this step input values (which are simple strings sent with a web request) are converted into Java objects. In the next paragraphs we will explore the infrastructures provided by Wicket for the three sub-tasks involved with form validation, which are: conversion of user input into objects, validation of user input, and visualization of feedback messages.
- Updating of models: if validation succeeds, the form updates the model of its children components with the converted values obtained in the previous step.
@@ -218,15 +219,16 @@
- Invoking callback methods onSubmit() or onError(): if we didn't have any validation error, method onSubmit() is called, otherwise onError() will be called. The default implementation of both these methods is left empty and we can override them to perform custom actions.
Please note that the model of form components is updated only if no validation error occurred (i.e. step two is performed only if validation succeeds).
-
Without going into too much detail, we can say that the first two steps of form processing correspond to the invocation of one or more Form's internal methods (which are declared protected and final). Some examples of these methods are validate(), which is invoked during validation step, and updateFormComponentModels(), which is used at the step that updates the form field models.
The whole form processing is started invoking public method process(IFormSubmitter) (Later in paragraph 10.4 we will introduce interface IFormSubmitter).
+
Without going into too much detail, we can say that the first two steps of form processing correspond to the invocation of one or more Form's internal methods (which are declared protected and final). Some examples of these methods are validate(), which is invoked during validation step, and updateFormComponentModels(), which is used at the step that updates the form field models.
The whole form processing is started invoking public method process(IFormSubmitter) (Later in
paragraph 12.5 we will introduce interface IFormSubmitter).
+
-
A basic example of a validation rule is to make a field required. In paragraph 9.3.2 we have already seen how this can be done calling setRequired(true) on a field. However, to set a validation rule on a FormComponent we must add the corresponding validator to it.
A validator is an implementation of the
org.apache.wicket.validation.IValidator interface and the
FormComponent has a version of method add which takes as input a reference of this interface.
For example if we want to use a text field to insert an email address, we could use the built-in validator EmailAddressValidator to ensure that the inserted input will respect the email format
local-part@domain :
TextField email = new TextField("email");
-email.add(EmailAddressValidator.getInstance());Wicket comes with a set of built-in validators that should suit most of our needs. We will see them in paragraph 10.2.3.
Feedback messages and localization
Wicket generates a feedback message for each field that doesn't satisfy one of its validation rules. For example the message generated when a required field is left empty is the following
Field '<label>' is required.<label> is the value of the label model set on a FormComponent with method setLabel(IModel <String> model). If such model is not provided, component id will be used as the default value.
The entire infrastructure of feedback messages is built on top of the Java internationalization (I18N) support and it uses
resource bundles to store messages.
-The topics of internationalization will be covered in chapter 12. For now we will give just few notions needed to understand the examples from this chapter.
-
By default resource bundles are stored into properties files but we can easily configure other sources as described later in paragraph 12.4.5.
Default feedback messages (like the one above for required fields) are stored in the file Application. properties placed inside Wicket the org.apache.wicket package. Opening this file we can find the key and the localized value of the message:
Required=Field '${label}' is required.We can note the key (Required in our case) and the label parameter written in the
expression language (${label}). Scrolling down this file we can also find the message used by the Email AddressValidator:
EmailAddressValidator=The value of '${label}' is not a valid email address.By default FormComponent provides 3 parameters for feedback message: input (the value that failed validation), label and name (this later is the id of the component).
-Remember that component model is updated with the user input only if validation succeeds! As a consequence, we can't retrieve the wrong value inserted for a field from its model. Instead, we should use getValue() method of FormComponent class. (This method will be introduced in the example used in paragraph 10.2.5)
+A basic example of a validation rule is to make a field required. In paragraph 11.3 we have already seen how this can be done calling setRequired(true) on a field. However, to set a validation rule on a FormComponent we must add the corresponding validator to it.A validator is an implementation of the org.apache.wicket.validation.IValidator interface and the FormComponent has a version of method add which takes as input a reference of this interface.For example if we want to use a text field to insert an email address, we could use the built-in validator EmailAddressValidator to ensure that the inserted input will respect the email format local-part@domain :TextField email = new TextField("email");
+email.add(EmailAddressValidator.getInstance());Feedback messages and localization
Wicket generates a feedback message for each field that doesn't satisfy one of its validation rules. For example the message generated when a required field is left empty is the followingField '<label>' is required.<label> is the value of the label model set on a FormComponent with method setLabel(IModel <String> model). If such model is not provided, component id will be used as the default value.The entire infrastructure of feedback messages is built on top of the Java internationalization (I18N) support and it uses resource bundles to store messages.
+The topics of internationalization will be covered in chapter 14. For now we will give just few notions needed to understand the examples from this chapter.
+
By default resource bundles are stored into properties files but we can easily configure other sources as described later in paragraph 14.2.Default feedback messages (like the one above for required fields) are stored in the file Application. properties placed inside Wicket the org.apache.wicket package. Opening this file we can find the key and the localized value of the message:Required=Field '${label}' is required.We can note the key (Required in our case) and the label parameter written in the expression language (${label}). Scrolling down this file we can also find the message used by the Email AddressValidator:EmailAddressValidator=The value of '${label}' is not a valid email address.By default FormComponent provides 3 parameters for feedback message: input (the value that failed validation), label and name (this later is the id of the component).
+Remember that component model is updated with the user input only if validation succeeds! As a consequence, we can't retrieve the wrong value inserted for a field from its model. Instead, we should use getValue() method of FormComponent class. (This method will be introduced in the example used later in this chapter)
Displaying feedback messages and filtering them
To display feedback messages we must use component org.apache.wicket.markup.html.panel.FeedbackPanel. This component automatically reads all the feedback messages generated during form validation and displays them with an unordered list:<ul class="feedbackPanel">
<li class="feedbackPanelERROR">
<span class="feedbackPanelERROR">Field 'Username' is required.</span>
@@ -235,7 +237,7 @@
- ComponentFeedbackMessageFilter: shows only messages coming from a specific component.
- ContainerFeedbackMessageFilter: shows only messages coming from a specific container or from any of its children components.
-- ErrorLevelFeedbackMessageFilter: shows only messages with a level of severity equals or greater than a given lower bound. Class FeedbackMessage defines a set of static constants to express different levels of severity: DEBUG, ERROR, WARNING, INFO, SUCCESS, etc.... Levels of severity for feedback messages are discussed in paragraph 10.2.6.
+- ErrorLevelFeedbackMessageFilter: shows only messages with a level of severity equals or greater than a given lower bound. Class FeedbackMessage defines a set of static constants to express different levels of severity: DEBUG, ERROR, WARNING, INFO, SUCCESS, etc.... Levels of severity for feedback messages are discussed later in this chapter.
These filters are intended to be used when there are more than one feedback panel (or more than one form) in the same page. We can pass a filter to a feedback panel via its constructor or using the setFilter method. Custom filters can be created implementing the IFeedbackMessageFilter interface. An example of custom filter is illustrated later in this paragraph.
Built-in validators
Wicket already provides a number of built-in validators ready to be used. The following table is a short reference where validators are listed along with a brief description of what they do. The default feedback message used by each of them is reported as well:
EmailAddressValidator
Checks if input respects the format local-part@domain.
Message:The value of '${label}' is not a valid email address.UrlValidator
Checks if input is a valid URL. We can specify in the constructor which protocols are allowed (http://, https://, and ftp://).
Message:The value of '${label}' is not a valid URL.DateValidator
Validator class that can be extended or used as a factory class to get date validators to check if a date is bigger than a lower bound (method minimum(Date min)), smaller than a upper bound (method maximum(Date max)) or inside a range (method range(Date min, Date max)).
Messages:The value of '${label}' is less than the minimum of ${minimum}.The value of '${label}' is larger than the maximum of ${maximum}.The value of '${label}' is not between ${minimum} and ${maximum}.RangeValidator
Validator class that can be extended or used as a factory class to get validators to check if a value is bigger than a given lower bound (method minimum(T min)), smaller than a upper bound (method maximum(T max)) or inside a range (method range(T min,T max)).
The type of the value is a generic subtype of java.lang.Comparable and must implement Serializable interface.
Messages:The value of '${label}' must be at least ${minimum}.The value of '${label}' must be at most ${maximum}.The value of '${label}' must be between ${minimum} and ${maximum}.StringValidator
Validator class that can be extended or used as a factory class to get validators to check if the length of a string value is bigger then a given lower bound (method minimumLength (int min)), smaller then a given upper bound (method maximumLength (int max)) or within a given range (method lengthBetween(int min, int max)).
To accept only string values consisting of exactly n characters, we must use method exactLength(int length).
Messages:The value of '${label}' is shorter than the minimum of ${minimum} characters.The value of '${label}' is longer than the maximum of ${maximum} characters.The value of '${label}' is not between ${minimum} and ${maximum} characters long.The value of '${label}' is not exactly ${exact} characters long.CreditCardValidator
Checks if input is a valid credit card number. This validator supports some of the most popular credit cards (like “American Express", "MasterCard", “Visa” or “Diners Club”).
Message:The credit card number is invalid.EqualPasswordInputValidator
This validator checks if two password fields have the same value.
Message:${label0} and ${label1} must be equal.Overriding standard feedback messages with custom bundles
If we don't like the default validation feedback messages, we can override them providing custom properties files. In these files we can write our custom messages using the same keys of the messages we want to override. For example if we wanted to override the default message for invalid email addresses, our properties file would contain a line like this:
EmailAddressValidator=Man, your email address is not good!As we will see in the next chapter, Wicket searches for custom properties files in various positions inside the application's class path, but for now we will consider just the properties file placed next to our application class. The name of this file must be equal to the name of our application class:
The example project OverrideMailMessage overrides email validator's message with a new one which also reports the value that failed validation:
EmailAddressValidator=The value '${input}' inserted for field '${label}' is not a valid email address.
Creating custom validators
If our web application requires a complex validation logic and built-in validators are not enough, we can implement our own custom validators. For example (project UsernameCustomValidator) suppose we are working on the registration page of our site where users can create their profile choosing their username. Our registration form should validate the new username checking if it was already chosen by another user. In a situation like this we may need to implement a custom validator that queries a specific data source to check if a username is already in use.
For the sake of simplicity, the validator of our example will check the given username against a fixed list of three existing usernames.
A custom validator must simply implement interface IValidator:
public class UsernameValidator implements IValidator<String> {
List<String> existingUsernames = Arrays.asList("bigJack", "anonymous", "mrSmith"); public void validate(IValidatable<String> validatable) {
String chosenUserName = validatable.getValue(); if(existingUsernames.contains(chosenUserName)){
@@ -325,7 +327,7 @@
public String convertToString(Pattern value, Locale locale) {
return value.toString();
}
-}Methods declared by interface IConverter take as input a Locale parameter in order to deal with locale-sensitive data and conversions. We will learn more about locales and internationalization in chapter 12.
Once we have implemented our custom converter, we must override method newConverterLocator() inside our application class and tell it to add our new converter to the default set:
Methods declared by interface IConverter take as input a Locale parameter in order to deal with locale-sensitive data and conversions. We will learn more about locales and internationalization in
paragraph 14.
Once we have implemented our custom converter, we must override method newConverterLocator() inside our application class and tell it to add our new converter to the default set:
@Override
protected IConverterLocator newConverterLocator() {
ConverterLocator defaultLocator = new ConverterLocator(); defaultLocator.set(Pattern.class, new RegExpPatternConverter()); return defaultLocator;
}Finally, in the home page of the project we build the form which displays (with a flash message) the tokens obtained splitting the string with the given pattern:
public class HomePage extends WebPage {
@@ -352,6 +354,7 @@
+
Standard JSR 303 defines a set of annotations and APIs to validate our domain objects at field-level. Wicket has introduced an experimental support for this standard since version 6.4.0 and with version 6.14.0 it has became an official Wicket model (named wicket-bean-validation).
In this paragraph we will see the basic steps needed to use JSR 303 validation in our Wicket application. Code snippets are from example project JSR303validation.In the example application we have a form to insert the data for a new Person bean and its relative Address. The code for class Person is the followingpublic class Person implements Serializable{ @NotNull
@@ -489,7 +492,7 @@
-In chapter 3.2.2 we have seen how to use class Panel to create custom components with their own markup and with an arbitrary number of children components.While it's perfectly legal to use Panel also to group form components, the resulting component won't be itself a form component and it won't participate in the form's submission workflow.This could be a strong limitation if the custom component needs to coordinate its children during sub-tasks like input conversion or model updating. That's why in Wicket we have the org.apache.wicket.markup.html.form.FormComponentPanel component which combines the features of a Panel (it has its own markup file) and a FormComponent (it is a subclass of FormComponent).A typical scenario in which we may need to implement a custom FormComponentPanel is when our web application and its users work with different units of measurement for the same data.To illustrate this possible scenario, let's consider a form where a user can insert a temperature that will be recorded after being converted to Kelvin degrees (see the example project CustomForm ComponentPanel).The Kelvin scale is wildly adopted among the scientific community and it is one of the seven base units of the International System of Units , so it makes perfect sense to store temperatures expressed with this unit of measurement.However, in our everyday life we still use other temperature scales like Celsius or Fahrenheit, so it would be nice to have a component which internally works with Kelvin degrees and automatically applies conversion between Kelvin temperature scale and the one adopted by the user.In order to implement such a component, we can make a subclass of FormComponentPanel and leverage the convertInput and onBeforeRender methods: in the implementation of the convertInput method we will convert input value to Kelvin degrees while in the implementation of onBeforeRender method we will take care of converting the Kelvin value to the temperature scale adopted by the user.Our custom component will contain two children components: a text field to let user insert and edit a temperature value and a label to display the letter corresponding to user's temperature scale (F for Fahrenheit and C for Celsius). The resulting markup file is the following:<html>
+In chapter 5.2.2 we have seen how to use class Panel to create custom components with their own markup and with an arbitrary number of children components.While it's perfectly legal to use Panel also to group form components, the resulting component won't be itself a form component and it won't participate in the form's submission workflow.This could be a strong limitation if the custom component needs to coordinate its children during sub-tasks like input conversion or model updating. That's why in Wicket we have the org.apache.wicket.markup.html.form.FormComponentPanel component which combines the features of a Panel (it has its own markup file) and a FormComponent (it is a subclass of FormComponent).A typical scenario in which we may need to implement a custom FormComponentPanel is when our web application and its users work with different units of measurement for the same data.To illustrate this possible scenario, let's consider a form where a user can insert a temperature that will be recorded after being converted to Kelvin degrees (see the example project CustomForm ComponentPanel).The Kelvin scale is wildly adopted among the scientific community and it is one of the seven base units of the International System of Units , so it makes perfect sense to store temperatures expressed with this unit of measurement.However, in our everyday life we still use other temperature scales like Celsius or Fahrenheit, so it would be nice to have a component which internally works with Kelvin degrees and automatically applies conversion between Kelvin temperature scale and the one adopted by the user.In order to implement such a component, we can make a subclass of FormComponentPanel and leverage the convertInput and onBeforeRender methods: in the implementation of the convertInput method we will convert input value to Kelvin degrees while in the implementation of onBeforeRender method we will take care of converting the Kelvin value to the temperature scale adopted by the user.Our custom component will contain two children components: a text field to let user insert and edit a temperature value and a label to display the letter corresponding to user's temperature scale (F for Fahrenheit and C for Celsius). The resulting markup file is the following:<html>
<head>
</head>
<body>
@@ -516,7 +519,7 @@
add(userDegree=new TextField<Double>("registeredTemperature", new
Model<Double>()));
userDegree.setType(Double.class);
- }// continued example
@Override
protected void convertInput() {
Double userDegreeVal = userDegree.getConvertedInput();
@@ -541,8 +544,9 @@
}<html>
+In chapter 8 we have seen how Wicket pages can be divided into two categories: stateful and stateless. Pages that are stateless don't need to be stored in the user session and they should be used when we don't need to save any user data in the user session (for example in the public area of a site).Besides saving resources on server-side, stateless pages can be adopted to improve user experience and to avoid security weaknesses. A typical situation where a stateless page can bring these benefits is when we have to implement a login page.For this kind of page we might encounter two potential problems if we chose to use a stateful page. The first problem occurs when the user tries to login without a valid session assigned to him. This could happen if the user leaves the login page opened for a period of time bigger than the session's timeout and then he decides to log in. Under these conditions the user will be redirected to a 'Page expired' error page, which is not exactly a nice thing for user experience.The second problem occurs when a malicious user or a web crawler program attempts to login into our web application, generating a huge number of page versions and consequently increasing the size of the user session.To avoid these kinds of problems we should build a stateless login page which does not depend on a user session. Wicket provides a special version of the Form component called StatelessForm which is stateless by default (i.e its method getStatelessHint() returns true), hence it's an ideal solution when we want to build a stateless page with a form. A possible implementation of our login form is the following (example project StatelessLoginForm):HTML:<html>
<head>
<meta charset="utf-8" />
</head>
@@ -586,8 +590,9 @@
}
A check box can be used as single component to set a boolean property. For this purpose Wicket provides the org.apache.wicket.markup.html.form.CheckBox component which must be attached to <input type="checkbox".../> tag. In the next example (project SingleCheckBox) we will consider a form similar to the one used in paragraph 9.5 to edit a Person object, but with an additional checkbox to let the user decide if she wants to subscribe to our mailing list or not. The form uses the following bean as backing object:public class RegistrationInfo implements Serializable { private String name;
+In this paragraph we will see which components can be used to handle HTML radio buttons and checkboxes. Both these input elements are usually grouped together to display a list of possible choices:A check box can be used as single component to set a boolean property. For this purpose Wicket provides the org.apache.wicket.markup.html.form.CheckBox component which must be attached to <input type="checkbox".../> tag. In the next example (project SingleCheckBox) we will consider a form similar to the one used in paragraph 11.5 to edit a Person object, but with an additional checkbox to let the user decide if she wants to subscribe to our mailing list or not. The form uses the following bean as backing object:public class RegistrationInfo implements Serializable { private String name;
private String surname;
private String address;
private String email;
@@ -638,7 +643,7 @@
<input type="checkbox"/>It will be replaced by the actual checkboxes…
</div>List<String> fruits = Arrays.asList("apple", "strawberry", "watermelon");
form.add(new CheckBoxMultipleChoice("checkGroup", new ListModel<String>(new
- ArrayList<String>()), fruits));
This component can be attached to a <div> tag or to a <span> tag. No specific content is required for this tag as it will be populated with the actual checkboxes. Since this component allows multiple selection, its model object is a list. In the example above we have used model class org.apache.wicket.model.util.ListModel which is specifically designed to wrap a List object.By default CheckBoxMultipleChoice inserts a <br/> tag as suffix after each option. We can configure both the suffix and the prefix used by the component with the setPrefix and setSuffix methods.When our options are more complex objects than simple strings, we can render them using an IChoiceRender, as we did for DropDownChoice in paragraph 9.4:HTML:<div wicket:id="checkGroup">
+ ArrayList<String>()), fruits));
org.apache.wicket.model.util.ListModel which is specifically designed to wrap a List object.By default CheckBoxMultipleChoice inserts a <br/> tag as suffix after each option. We can configure both the suffix and the prefix used by the component with the setPrefix and setSuffix methods.When our options are more complex objects than simple strings, we can render them using an IChoiceRender, as we did for DropDownChoice in paragraph 11.5:HTML:<div wicket:id="checkGroup">
<input type="checkbox"/>It will be replaced by actual checkboxes…
</div>
Person john = new Person("John", "Smith");
Person bob = new Person("Bob", "Smith");
@@ -656,6 +661,7 @@
form.add(new RadioChoice("radioGroup", Model.of(""), fruits));
Just like CheckBoxMultipleChoice, this component provides the setPrefix and setSuffix methods to configure the prefix and suffix for our options and it supports IChoiceRender as well. In addition, RadioChoice provides the wantOnSelectionChangedNotifications() method to notify the web server when the selected option changes (this is the same method seen for DropDownChoice in paragraph 9.4).
+
Checkboxes work well when we have a small amount of options to display, but they quickly become chaotic as the number of options increases. To overcome this limit we can use the <select> tag switching it to multiple-choice mode with attribute multiple="multiple":
Now the user can select multiple options by holding down Ctrl key (or Command key for Mac) and selecting them.To work with multiple choice list Wicket provides the org.apache.wicket.markup.html.form.ListMultipleChoice component:HTML:<select wicket:id="fruits">
<option>choice 1</option>
@@ -731,7 +737,7 @@
Index: guide/grails-app/conf/Config.groovy
===================================================================
--- guide/grails-app/conf/Config.groovy (revision 1675105)
+++ guide/grails-app/conf/Config.groovy (working copy)
@@ -94,7 +94,7 @@
grails.doc.title = "Apache Wicket User Guide"
grails.doc.subtitle = "Free Online Guide for Apache Wicket framework"
-grails.doc.authors = "Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko"
+grails.doc.authors = "Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde"
grails.doc.images = new File("src/docs/img")
grails.doc.css = new File("src/docs/css")
grails.doc.logo = """
"""
Index: guide/helloWorld.html
===================================================================
--- guide/helloWorld.html (revision 1675105)
+++ guide/helloWorld.html (working copy)
@@ -151,7 +151,7 @@
4 Wicket says “Hello world!” - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -328,7 +328,7 @@
Index: guide/howToSource.html
===================================================================
--- guide/howToSource.html (revision 1675105)
+++ guide/howToSource.html (working copy)
@@ -151,7 +151,7 @@
2 How to use the example code - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/i18n.html
===================================================================
--- guide/i18n.html (revision 1675105)
+++ guide/i18n.html (working copy)
@@ -151,7 +151,7 @@
14 Internationalization with Wicket - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -186,11 +186,12 @@
14 Internationalization with Wicket
-In chapter 10 we have seen how the topic of localization is involved in the generation of feedback messages and we had a first contact with resource bundles. In this chapter we will continue to explore the localization support provided by Wicket and we will learn how to build pages and components ready to be localized in different languages.
+In
chapter 12.2 we have seen how the topic of localization is involved in the generation of feedback messages and we had a first contact with resource bundles. In this chapter we will continue to explore the localization support provided by Wicket and we will learn how to build pages and components ready to be localized in different languages.
+
14.1 Localization
-
As we have seen in chapter 10, the infrastructure of feedback messages is built on top of Java internationalization (i18n) support, so it should not be surprising that the same infrastructure is used also for localization purpose. However, while so far we have used only the <ApplicationClassName>.properties file to store our custom messages, in this chapter we will see that also pages, components, validators and even Java packages can have their own resource bundles. This allows us to split bundles into multiple files keeping them close to where they are used. But before diving into the details of internationalization with Wicket, it's worthwhile to quickly review how i18n works under Java, see what classes are involved and how they are integrated into Wicket.
+As we have seen in paragraph 12.2, the infrastructure of feedback messages is built on top of Java internationalization (i18n) support, so it should not be surprising that the same infrastructure is used also for localization purpose. However, while so far we have used only the <ApplicationClassName>.properties file to store our custom messages, in this chapter we will see that also pages, components, validators and even Java packages can have their own resource bundles. This allows us to split bundles into multiple files keeping them close to where they are used. But before diving into the details of internationalization with Wicket, it's worthwhile to quickly review how i18n works under Java, see what classes are involved and how they are integrated into Wicket.
Providing a full description of Java support for i18n is clearly out of the scope of this document. If you need more informations about this topic you can find them in the JavaDocs and in the official i18n tutorial .
Class Locale and ResourceBundle
Class java.util.Locale represents a specific country or language of the world and is used in Java to retrieve other locale-dependent informations like numeric and date formats, the currency in use in a country and so on. Such kind of informations are accessed through special entities called resource bundles which are implemented by class java.util.ResourceBundle. Every resource bundle is identified by a full name which is built using four parameters: a base name (which is required), a language code, a country code and a variant (which are all optional). These three optional parameters are provided by an instance of Locale with its three corresponding getter methods: getLanguage(), getCountry() and getVariant(). Parameter language code is a lowercase ISO 639 2-letter code (like zh for Chinese, de for German and so on) while country code is an uppercase ISO 3166 2-letter code (like CN for China, DE for Germany and so on). The final full name will have the following structure (NOTE: tokens inside squared brackets are optional):<base name>[ <language code>[ <COUNTRY_CODE>[_<variant code>]]]
ResourceBundle is an abstract factory class, hence it exposes a number of factory methods named getBundle to load a concrete bundle. Without going into too much details we can say that a bundle corresponds to a file in the classpath. To find a file for a given bundle, getBundle needs first to generate an ordered list of candidate bundle names. These names are the set of all possible full names for a given bundle. For example if we have org.foo.MyBundle as base name and the current locale is the one seen before for Mandarin Chinese, the candidate names will be:
@@ -199,9 +200,10 @@
- org.foo.MyBundle_zh_CH
- org.foo.MyBundle_zh
- org.foo.MyBundle
-The list of these candidate names is generated starting from the most specific one and subtracting an optional parameter at each step. The last name of the list corresponds to the default resource bundle which is the most general name and is equal to the base name. Once that getBundle has generated the list of candidate names, it will iterate over them to find the first one for which is possible to load a class or a properties file. The class must be a subclass of ResourceBundle having as class name the full name used in the current iteration. If such a class is not found, getBundle will try to locate a properties file having a file name equals to the current full name (Java will automatically append extension .properties to the full name). For example given the resource bundle of the previous example, Java will search first for class org.foo.MyBundle_zh_CH_cmn and then for file MyBundle_zh_CH_cmn.properties inside package org.foo. If no file is found for any of the candidate names, a MissingResourceException will be thrown. Bundles contains local-dependent string resources identified by a key that is unique in the given bundle. So once we have obtained a valid bundle we can access these objects with method getString (String key).As we have seen before working with feedback messages, in Wicket most of the times we will work with properties files rather than with bundle classes. In chapter 10 we used a properties file having as base name the class name of the application class and without any information about the locale. This file is the default resource bundle for a Wicket application. In paragraph 12.4 we will explore the algorithm used in Wicket to locate the available bundles for a given component. Once we have learnt how to leverage this algorithm, we will be able to split our bundles into more files organized in a logical hierarchy.
+The list of these candidate names is generated starting from the most specific one and subtracting an optional parameter at each step. The last name of the list corresponds to the default resource bundle which is the most general name and is equal to the base name. Once that getBundle has generated the list of candidate names, it will iterate over them to find the first one for which is possible to load a class or a properties file. The class must be a subclass of ResourceBundle having as class name the full name used in the current iteration. If such a class is not found, getBundle will try to locate a properties file having a file name equals to the current full name (Java will automatically append extension .properties to the full name). For example given the resource bundle of the previous example, Java will search first for class org.foo.MyBundle_zh_CH_cmn and then for file MyBundle_zh_CH_cmn.properties inside package org.foo. If no file is found for any of the candidate names, a MissingResourceException will be thrown. Bundles contains local-dependent string resources identified by a key that is unique in the given bundle. So once we have obtained a valid bundle we can access these objects with method getString (String key).As we have seen before working with feedback messages, in Wicket most of the times we will work with properties files rather than with bundle classes. In paragraph 12.2 we used a properties file having as base name the class name of the application class and without any information about the locale. This file is the default resource bundle for a Wicket application. In paragraph 14.3 we will explore the algorithm used in Wicket to locate the available bundles for a given component. Once we have learnt how to leverage this algorithm, we will be able to split our bundles into more files organized in a logical hierarchy.
+
14.2 Localization in Wicket
A component can get the current locale in use calling its method getLocale(). By default this method will be recursively called on component's parent containers until one of them returns a valid locale. If no one of them returns a locale, this method will get the one associated with the current user session. This locale is automatically generated by Wicket in accordance with the language settings of the browser.Developers can change the locale of the current session with Session's method setLocale (Locale locale):Session.get().setLocale(locale)
Style and variation parameters for bundles
In addition to locale's informations, Wicket supports two further parameters to identify a resource bundle: style and variation. Parameter style is a string value and is defined at session-level. To set/get the style for the current session we can use the corresponding setter and getter of class Session:Session.get().setStyle("myStyle");
Session.get().getStyle();<base name>[ style][ <language code>[ <COUNTRY_CODE>[ <variant code>]]]
<base name>[ variation][_style][ <language code>[ <COUNTRY_CODE>[ <variant code>]]]
To use XML bundles in Wicket we don't need to put in place any additional configuration. The only rule we have to respect with these files is to use properties.xml as extension while their base name follows the same rules seen so far for bundle names.
Reading bundles from code
Class Component makes reading bundles very easy with method getString(String key). This method searches for a resource with the given key looking into the resource bundles visited by the lookup algorithm illustrated in paragraph 12.4. For example if we have a greeting message with key greetingMessage in our application's resource bundle, we can read it from our component code with this instruction:
getString("greetingMessage");Localization of bundles in Wicket
In chapter 10 we have used as resource bundle the properties file placed next to our application class. This file is the default resource bundle for the entire application and it is used by the lookup algorithm if it doesn't find any better match for a given component and locale. If we want to provide localized versions of this file we must simply follow the rules of Java i18n and put our translated resources into another properties file with a name corresponding to the desired locale. For example project LocalizedGreetings comes with the default application's properties file ( WicketApplication.properties) containing a greeting message:
greetingMessage=Welcome to the site!
Along with this file we can also find a bundle for German (WicketApplication_de.properties) and another one in XML format for simplified Chinese (WicketApplication_zh.properties.xml). The example project consists of a single page (HomePage.java) displaying the greeting message. The current locale can be changed with a drop-down list and the possible options are English (the default one), German and simplified Chinese:
The label displaying the greeting message has a custom read-only model which returns the message with method getString. The initialization code for this label is this:
AbstractReadOnlyModel<String> model = new AbstractReadOnlyModel<String>() {
+</properties>To use XML bundles in Wicket we don't need to put in place any additional configuration. The only rule we have to respect with these files is to use properties.xml as extension while their base name follows the same rules seen so far for bundle names.
Reading bundles from code
Class Component makes reading bundles very easy with method getString(String key). This method searches for a resource with the given key looking into the resource bundles visited by the lookup algorithm illustrated in
paragraph 14.3. For example if we have a greeting message with key greetingMessage in our application's resource bundle, we can read it from our component code with this instruction:
getString("greetingMessage");Localization of bundles in Wicket
In
paragraph 12.2 we have used as resource bundle the properties file placed next to our application class. This file is the default resource bundle for the entire application and it is used by the lookup algorithm if it doesn't find any better match for a given component and locale. If we want to provide localized versions of this file we must simply follow the rules of Java i18n and put our translated resources into another properties file with a name corresponding to the desired locale. For example project LocalizedGreetings comes with the default application's properties file ( WicketApplication.properties) containing a greeting message:
greetingMessage=Welcome to the site!
Along with this file we can also find a bundle for German (WicketApplication_de.properties) and another one in XML format for simplified Chinese (WicketApplication_zh.properties.xml). The example project consists of a single page (HomePage.java) displaying the greeting message. The current locale can be changed with a drop-down list and the possible options are English (the default one), German and simplified Chinese:
The label displaying the greeting message has a custom read-only model which returns the message with method getString. The initialization code for this label is this:
AbstractReadOnlyModel<String> model = new AbstractReadOnlyModel<String>() {
@Override
public String getObject() {
return getString("greetingMessage");
}
-};add(new Label("greetingMessage", model));Class
org.apache.wicket.model.AbstractReadOnlyModel is a convenience class for implementing read-only models. In this project we have implemented a custom read-only model for illustrative purposes only because Wicket already provides built-in models for the same task. We will see them in paragraph 12.6.
The rest of the code of the home page builds the stateless form and the drop-down menu used to change the locale.
List<Locale> locales = Arrays.asList(Locale.ENGLISH, Locale.CHINESE, Locale.GERMAN);
+};add(new Label("greetingMessage", model));Class
org.apache.wicket.model.AbstractReadOnlyModel is a convenience class for implementing read-only models. In this project we have implemented a custom read-only model for illustrative purposes only because Wicket already provides built-in models for the same task. We will see them in paragraph
paragraph 14.5.
The rest of the code of the home page builds the stateless form and the drop-down menu used to change the locale.
List<Locale> locales = Arrays.asList(Locale.ENGLISH, Locale.CHINESE, Locale.GERMAN);
final DropDownChoice<Locale> changeLocale =
new DropDownChoice<Locale>("changeLocale", new Model<Locale>(), locales);StatelessForm form = new StatelessForm("form"){
@Override
@@ -239,13 +241,13 @@
form.add(new Label("anotherLabel",new ResourceModel("labelValue")));
add(form);Page bundle:
labelValue=Default value
anotherLabel.labelValue=Value for anotherLabel
-form.anotherLabel.labelValue=Value for anotherLabel inside form
With the code and the bundle above, the label inside the form will display the value 'Value for anotherLabel inside form'.
Package bundles
If no one of the previous steps can find a resource for the given key, the algorithm will look for package bundles. These bundles have
wicket-package as base name and they can be placed in one of the package of our application:
Packages are traversed starting from the one containing the component requesting for a resource and going up to the root package.
Bundles for feedback messages
The algorithm described so far applies to feedback messages as well. In case of validation errors, the component that has caused the error will be considered as the component which the string resource is relative to. Furthermore, just like application class and components, validators can have their own bundles placed next to their class and having as base name their class name. This allows us to distribute validators along with the messages they use to report errors:
Validator's resource bundles have the lowest priority in the lookup algorithm. They can be overwritten by resource bundles of components, packages and application class.
Extending the default lookup algorithm
Wicket implements the default lookup algorithm using the strategy pattern1. The concrete strategies are abstracted with the interface
org.apache.wicket.resource.loader.IStringResourceLoader. By default Wicket uses the following implementations of
IStringResourceLoader (sorted by execution order):
+form.anotherLabel.labelValue=Value
for anotherLabel inside form
With the code and the bundle above, the label inside the form will display the value 'Value for anotherLabel inside form'.
Package bundles
If no one of the previous steps can find a resource for the given key, the algorithm will look for package bundles. These bundles have
wicket-package as base name and they can be placed in one of the package of our application:
Packages are traversed starting from the one containing the component requesting for a resource and going up to the root package.
Bundles for feedback messages
The algorithm described so far applies to feedback messages as well. In case of validation errors, the component that has caused the error will be considered as the component which the string resource is relative to. Furthermore, just like application class and components, validators can have their own bundles placed next to their class and having as base name their class name. This allows us to distribute validators along with the messages they use to report errors:
Validator's resource bundles have the lowest priority in the lookup algorithm. They can be overwritten by resource bundles of components, packages and application class.
Extending the default lookup algorithm
Wicket implements the default lookup algorithm using the strategy pattern. The concrete strategies are abstracted with the interface
org.apache.wicket.resource.loader.IStringResourceLoader. By default Wicket uses the following implementations of
IStringResourceLoader (sorted by execution order):
- ComponentStringResourceLoader: implements most of the default algorithm. It searches for a given resource across bundles from the container hierarchy, from class hierarchy and from the given component.
- PackageStringResourceLoader: searches into package bundles.
- ClassStringResourceLoader: searches into bundles of a given class. By default the target class is the application class.
- ValidatorStringResourceLoader: searches for resources into validator's bundles. A list of validators is provided by the form component that failed validation.
-- InitializerStringResourceLoader: this resource allows internationalization to interact with the initialization mechanism of the framework that will be illustrated in paragraph 15.4.
+- InitializerStringResourceLoader: this resource allows internationalization to interact with the initialization mechanism of the framework that will be illustrated in paragraph 17.3.
Developer can customize lookup algorithm removing default resource loaders or adding custom implementations to the list of the resource loaders in use. This task can be accomplished using method getStringResourceLoaders of setting interface
org.apache.wicket.settings.IResourceSettings:
@Override
public void init()
{
@@ -278,8 +280,8 @@
green=Green
red=Red
blue=Blue
-yellow=YellowGerman bundle:
selectColor.null=Wahlen sie eine farbe
-green=Grun
+yellow=Yellow
German bundle:
selectColor.null=Wählen Sie eine Farbe
+green=Grün
red=Rot
blue=Blau
yellow=Gelb
Italian bundle:
selectColor.null=Scegli un colore
@@ -286,11 +288,12 @@
green=Verde
red=Rosso
blue=Blu
-yellow=Giallo
Along with the localized versions of colors names, in the bundles above we can also find a custom value for the placeholder text (“Chose one ”) used for null value. The resource key for this resource is 'null' or '<component id>.null' if we want to make it component-specific.
+yellow=Giallo
Along with the localized versions of colors names, in the bundles above we can also find a custom value for the placeholder text (“Select a color ”) used for null value. The resource key for this resource is 'null' or '<component id>.null' if we want to make it component-specific.
+
14.5 Internationalization and Models
-Internationalization is another good chance to taste the power of models. Wicket provides two built-in models to better integrate our components with string resources: they are ResourceModel and StringResourceModel.ResourceModel
Model org.apache.wicket.model.ResourceModel acts just like the read-only model we have implemented in paragraph 12.3.4. It simply retrieves a string resource corresponding to a given key://build a ResourceModel for key 'greetingMessage'
+Internationalization is another good chance to taste the power of models. Wicket provides two built-in models to better integrate our components with string resources: they are ResourceModel and StringResourceModel.ResourceModel
Model org.apache.wicket.model.ResourceModel acts just like the read-only model we have implemented in paragraph 14.3. It simply retrieves a string resource corresponding to a given key://build a ResourceModel for key 'greetingMessage'
new ResourceModel("greetingMessage");//build a ResourceModel with a default value
new ResourceModel("notExistingResource", "Resource not found.");StringResourceModel
Model org.apache.wicket.model.StringResourceModel allows to work with complex and dynamic string resources containing parameters and property expressions. The basic constructor of this model takes in input a resource key and another model. This further model can be used by both the key and the related resource to specify dynamic values with property expressions. For example let's say that we are working on an e-commerce site which has a page where users can see an overview of their orders. To handle the state of user's orders we will use the following bean and enum (the code is from project StringResourceModelExample):Bean:public class Order implements Serializable { private Date orderDate;
private ORDER_STATUS status; public Order(Date orderDate, ORDER_STATUS status) {
@@ -313,6 +316,7 @@
StringResourceModel srm = new StringResourceModel("orderStatus.delay", null, propertyModel, 3);orderStatus.delay=Your order submitted on ${0} has been delayed by {1} days.new StringResourceModel("myKey", myComponent, myModel, param1, param2, param3,...);14.6 Summary
Internationalization is a mandatory step if we want to take our applications (and our business!) abroad. Choosing the right strategy to manage our localized resources is fundamental to avoid to make a mess of them. In this chapter we have explored the built-in support for localization provided by Wicket, and we have learnt which solutions it offers to manage resource bundles. In the final part of the chapter we have seen how to localize the options displayed by a component (such as DropDownChoice or RadioChoice) and we also introduced two new models specifically designed to localize our components without introducing in their code any detail about internationalization.
@@ -344,7 +348,7 @@
Index: guide/index.html
===================================================================
--- guide/index.html (revision 1675105)
+++ guide/index.html (working copy)
@@ -111,7 +111,7 @@
Apache Wicket User Guide - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -525,7 +525,7 @@
Index: guide/internals.html
===================================================================
--- guide/internals.html (revision 1675105)
+++ guide/internals.html (working copy)
@@ -151,7 +151,7 @@
25 Wicket Internals - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -186,7 +186,8 @@
data :
byte[]
}
i.e. this is the serialized page instance (data) plus additional information needed to be able to easily find it later (sessionId, pageId).When a SerializedPage has to be stored DefaultPageStore stores it in a application scoped cache ({sessionId, pageId} -> SerializedPage) and additionally gives it to the underlying IDataStore#storeData(sessionId, pageId, data). The application scoped cache is used as second level cache. Getting a page from it is slower than the http session based cache in PageStoreManager because the page has to be deserialized, but is faster than the underlying IDataStore which stores the page bytes in some persistent store.The size of the application scoped cache is configurable via org.apache.wicket.settings.IStoreSettings.setInmemoryCacheSize(int).IDataStore
org.apache.wicket.pageStore.IDataStore is used to persist Wicket pages (as bytes) to a persistent store like e.g. files or databases. The default implementation is org.apache.wicket.pageStore.DiskDataStore which as its name says stores the pages in files. The location of the folder where the files are stored is configurable via org.apache.wicket.settings.IStoreSettings.setFileStoreFolder(File), by default the web container's work folder is used (ServletContext attribute 'javax.servlet.context.tempdir'). In this folder a sub-folder is created named 'applicationName-filestore'.
This folder contains a sub-folder for each active http session. This session folder contains a single file named 'data' which contains the bytes for the pages. The size of this 'data' file is configurable via org.apache.wicket.settings.IStoreSettings.setMaxSizePerSession(Bytes). When this size is exceeded the newly stored files overwrite the oldest ones.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.IStoreSettings.setAsynchronous(false). AsynchronousDataStore can delay the storage of pages' bytes for at most org.apache.wicket.settings.IStoreSettings.setAsynchronousQueueCapacity(int) pages. If this capacity is exceeded then the page's bytes are written synchronously to the backing IDataStore.DebugDiskDataStore
Wicket provides an extension of DiskDataStore that can be used to browse the content of the 'data' files created by DiskDataStore. This debug enabled DiskDataStore is automatically setup when wicket-devutils.jar is in the classpath.
+To disable it use: org.apache.wicket.settings.IStoreSettings.setAsynchronous(false). AsynchronousDataStore can delay the storage of pages' bytes for at most org.apache.wicket.settings.IStoreSettings.setAsynchronousQueueCapacity(int) pages. If this capacity is exceeded then the page's bytes are written synchronously to the backing IDataStore.DebugDiskDataStore
Wicket provides an extension of DiskDataStore that can be used to browse the content of the 'data' files created by DiskDataStore. This extension can be found in wicket-devutils.jar and needs to be enabled in the init-method of your application via
+DebugDiskDataStore.register(this);
HttpSessionDataStore
In some environments like Google AppEngine it is not allowed to write to the file system and thus DiskDataStore cannot be used. In this case org.apache.wicket.pageStore.memory.HttpSessionDataStore can be used as replacement. This implementation of IDataStore is not persistent and puts all the data in the http session.
Wicket comes with 2 default eviction strategies to keep the size of the http session reasonable:
@@ -202,9 +203,12 @@
return new HttpSessionDataStore(pageManagerContext, new PageNumberEvictionStrategy(20));
}
}
-}
DebugBar
Further insights which can be valueable during debugging can be retrieved using the org.apache.wicket.devutils.debugbar.DebugBar from wicket-devutils.jar. It's a panel which you simply add:Java:
+add(new DebugBar("debug"));<span wicket:id="debug"/>
1 Introduction - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -190,7 +190,7 @@
Index: guide/jee.html
===================================================================
--- guide/jee.html (revision 1675105)
+++ guide/jee.html (working copy)
@@ -151,7 +151,7 @@
19 Integration with enterprise containers - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -231,10 +231,12 @@
19.3 JSR-330 annotations
Spring (and Guice) users can use standard
JSR-330 annotations to wire their dependencies. This will make their code more interoperable with other containers that support this standard:
//inject a bean specifying its name with JSR-330 annotations
- Inject Named("anotherName")
+ @Inject
+ @Named("anotherName")
private EnterpriseMessage enterpriseMessage;
+
19.4 Summary
In this chapter we have seen how to integrate Wicket applications with Spring and with an EJB container. Module wicket-examples contains also an example of integration with Guice (see application class
org.apache.wicket.examples.guice.GuiceApplication).
@@ -266,7 +268,7 @@
Index: guide/jsintegration.html
===================================================================
--- guide/jsintegration.html (revision 1675105)
+++ guide/jsintegration.html (working copy)
@@ -151,7 +151,7 @@
16 An example of integration with JavaScript - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -227,7 +227,7 @@
}
@Override
public <Date> IConverter<Date> getConverter(
Class<Date> type) {
return (IConverter<Date>) dateConverter;
-}
The first thing to do inside onInitialize is to ensure that our component will have a markup id for its related text field. This is done invoking setOutputMarkupId(true).
Next, JQueryDateField tries to retrieve the date format and the ISO language code that must be used as initialization parameters. This is done using class
ResourceModel which searches for a given resource in the available bundles. If no value is found for date format or for ISO language code, default values will be used ('mm/dd/yy' and 'en-GB').
To generate the relative URL for calendar icon, we load it as package resource reference and then we use
Component's method urlFor to get the URL value (we have seen this method in paragraph 7.3.2).
The last configuration instruction executed inside onInitialize is the instantiation of the custom converter used by our component. This converter is an instance of the built-in class
org.apache.wicket.datetime.PatternDateConvert and must use the previously retrieved date format to perform conversion operations. Now to tell our component to use this converter we must return it overriding
FormComponent's method
getConverter.
Header contributor code
The rest of the code of our custom component is inside method
renderHeader, which is responsible for adding to page header the bundled JQuery library, the three files from JQuery UI distribution, the custom file JQDatePicker.js and the invocation of function
initJQDatepicker:
The first thing to do inside onInitialize is to ensure that our component will have a markup id for its related text field. This is done invoking setOutputMarkupId(true).
Next, JQueryDateField tries to retrieve the date format and the ISO language code that must be used as initialization parameters. This is done using class
ResourceModel which searches for a given resource in the available bundles. If no value is found for date format or for ISO language code, default values will be used ('mm/dd/yy' and 'en-GB').
To generate the relative URL for calendar icon, we load it as package resource reference and then we use
Component's method urlFor to get the URL value (we have seen this method in
paragraph 9.3.2).
The last configuration instruction executed inside onInitialize is the instantiation of the custom converter used by our component. This converter is an instance of the built-in class
org.apache.wicket.datetime.PatternDateConvert and must use the previously retrieved date format to perform conversion operations. Now to tell our component to use this converter we must return it overriding
FormComponent's method
getConverter.
Header contributor code
The rest of the code of our custom component is inside method
renderHeader, which is responsible for adding to page header the bundled JQuery library, the three files from JQuery UI distribution, the custom file JQDatePicker.js and the invocation of function
initJQDatepicker:
@Override
public void renderHead(IHeaderResponse response) {
super.renderHead(response); //if component is disabled we don't have to load the JQueryUI datepicker
if(!isEnabledInHierarchy())
@@ -253,10 +253,11 @@
}If component is disabled the calendar icon must be hidden and no datepicker must be displayed. That's why
renderHeader is skipped if component is not enabled.
To get a reference to the bundled JQuery library we used the JavaScript setting interface
IJavaScriptLibrarySettings and its method
getJQueryReference.
In the last part of
renderHeader we build the string to invoke function
initJQDatepicker using the values obtained inside onInitialize. Unfortunately the date format used by JQuery UI is different from the one adopted in Java so we have to convert it before building the JavaScript code. This init script is rendered into header section using a
OnLoadHeaderItem to ensure that it will be executed after all the other scripts have been loaded.
If we add more than one instance of our custom component to a single page, static resources are rendered to the header section just once. Wicket automatically checks if a static resource is already referenced by a page and if so, it will not render it again.This does not apply to the init script which is dynamically generated and is rendered for every instance of the component.
-Our datepicker is not ready yet to be used with AJAX. In chapter 16 we will see how to modify it to make it AJAX-compatible.
+Our datepicker is not ready yet to be used with AJAX. In chapter 18 we will see how to modify it to make it AJAX-compatible.
+
16.3 Summary
In this brief chapter we have seen how custom components can be integrated with
DHTML technologies. To do so we have used most of what we have learnt in this guide. Now we are able to build complex components with a rich user experience. However this is not enough yet to develop
Web 2.0 applications. We still have to cover a fundamental technology like AJAX and some other Wicket-related topics that will help us building our application in more modular and efficient way.
@@ -287,7 +288,7 @@
Index: guide/keepControl.html
===================================================================
--- guide/keepControl.html (revision 1675105)
+++ guide/keepControl.html (working copy)
@@ -151,7 +151,7 @@
6 Keeping control over HTML - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -398,7 +398,7 @@
Index: guide/layout.html
===================================================================
--- guide/layout.html (revision 1675105)
+++ guide/layout.html (working copy)
@@ -151,7 +151,7 @@
5 Wicket as page layout manager - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -414,7 +414,7 @@
Index: guide/maven.html
===================================================================
--- guide/maven.html (revision 1675105)
+++ guide/maven.html (working copy)
@@ -151,7 +151,7 @@
26 Working with Maven (Appendix) - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -179,12 +179,12 @@
26.1 Switching Wicket to DEPLOYMENT mode
-
As pointed out in the note at page 9, Wicket can be started in two modes, DEVELOPMENT and DEPLOYMENT. When we are in DEVELOPMENT mode Wicket warns us at application startup with the following message:
********************************************************************
+As pointed out in the note in paragraph 4.2, Wicket can be started in two modes, DEVELOPMENT and DEPLOYMENT. When we are in DEVELOPMENT mode Wicket warns us at application startup with the following message:********************************************************************
*** WARNING: Wicket is running in DEVELOPMENT mode. ***
*** ^^^^^^^^^^^ ***
*** Do NOT deploy to your live server(s) without changing this. ***
*** See Application#getConfigurationType() for more information. ***
-********************************************************************
<filter>
+********************************************************************
<filter>
<filter-name>wicket.MyApp</filter-name>
<filter-class>org.apache.wicket.protocol.http.WicketFilter</filter-class>
<init-param>
@@ -198,15 +198,16 @@
</filter>
<context-param>
<param-name>configuration</param-name>
<param-value>deployment</param-value>
-</context-param>java -Dwicket.configuration=deployment ...
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:
java -Dwicket.configuration=deployment ...
The last option is to set it in your Java code (e.g. in the init-method of your WebApplication):
setConfigurationType(RuntimeConfigurationType.DEPLOYMENT);
Remember that system properties overwrite other settings, so they are ideal to ensure that on production machine the running mode will be always set to DEPLOYMENT.
+
26.2 Creating a Wicket project from scratch and importing it into our favourite IDE
In order to follow the instructions of this paragraph you must have Maven installed on your system. The installation of Maven is out of the scope of this guide but you can easily find an extensive documentation about it on Internet.
Another requirement is a good Internet connection (a flat ADSL is enough) because Maven needs to connect to its central repository to download the required dependencies.
-
From Maven to our IDE
Wicket project and its dependencies are managed using Maven1. This tool is very useful also when we want to create a new project based on Wicket from scratch. With a couple of shell commands we can generate a new project properly configured and ready to be imported into our favourite IDE.
+
From Maven to our IDE
Wicket project and its dependencies are managed using Maven. This tool is very useful also when we want to create a new project based on Wicket from scratch. With a couple of shell commands we can generate a new project properly configured and ready to be imported into our favourite IDE.
The main step to create such a project is to run the command which generates project's structure and its artifacts. If we are not familiar with Maven or we simply don't want to type this command by hand, we can use the utility form on Wicket site at
http://wicket.apache.org/start/quickstart.html :
Here we have to specify the root package of our project (GroupId), the project name (ArtifactId) and which version of Wicket we want to use (Version).
Once we have run the resulting command in the OS shell, we will have a new folder with the same name of the project (i.e the ArtifactId). Inside this folder we can find a file called pom.xml. This is the main file used by Maven to manage our project. For example, using “org.wicketTutorial” as GroupId and “MyProject” as ArtifactId, we would obtain the following artifacts:
.MyProject
| pom.xml
@@ -261,7 +262,7 @@
If we modify the pom.xml file (for example adding further dependencies) we must regenerate project's artifacts and refresh the project (F5 key) to reflect changes into Eclipse.
Speeding up development with plugins.
Now that we have our project loaded into our IDE we could start coding our components directly by hand. However it would be a shame to not leverage the free and good Wicket plugins available for our IDE. The following is a brief overview of the most widely used plugins for each of the three main IDEs considered so far.NetBeans
-NetBeans offers Wicket support thought 'NetBeans Plugin for Wicket' hosted at http://java.net/projects/nbwicketsupport/ . This plugin is released under CDDL-1.0 license.
+NetBeans offers Wicket support through 'NetBeans Plugin for Wicket' hosted at http://plugins.netbeans.org/plugin/3586/wicket-1-4-support . This plugin is released under CDDL-1.0 license.
You can find a nice introduction guide to this plugin at http://netbeans.org/kb/docs/web/quickstart-webapps-wicket.html .Intellj IDEA
For JetBrain IDEA we can use WicketForge plugin, hosted at Google Code 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/ .
@@ -268,6 +269,7 @@
QWickie is released under ASF 2.0 license.
+
@@ -294,7 +296,7 @@
Index: guide/modelsforms.html
===================================================================
--- guide/modelsforms.html (revision 1675105)
+++ guide/modelsforms.html (working copy)
@@ -151,7 +151,7 @@
11 Wicket models and forms - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -213,10 +213,11 @@
return new Date().toString();
}
};
add(
new Label(
"timeStamp", timeStampModel));
Even if sometimes writing a custom model could be a good choice to solve a specific problem, Wicket already provides a set of IModel implementations which should fit most of our needs. In the next paragraph we will see a couple of models that allow us to easily integrate JavaBeans with our web applications and in particular with our forms.
-By default class Component escapes HTML sensitive characters (like '<', '>' or '&') from the textual representation of its model object. The term 'escape' means that these characters will be replaced with their corresponding HTML entity (for example '<' becomes '< '). This is done for security reasons as a malicious user could attempt to inject markup or JavaScript into our pages. If we want to display the raw content stored inside a model, we can tell the Component class not to escape characters by calling the setEscapeModelStrings(false) method.
+By default the class Component escapes HTML sensitive characters (like '<', '>' or '&') from the textual representation of its model object. The term 'escape' means that these characters will be replaced with their corresponding HTML entity (for example '<' becomes '< '). This is done for security reasons as a malicious user could attempt to inject markup or JavaScript into our pages. If we want to display the raw content stored inside a model, we can tell the Component class not to escape characters by calling the setEscapeModelStrings(false) method.
+
One of the main goals of Wicket is to use JavaBeans and POJO as data model, overcoming the impedance mismatch between web technologies and OO paradigm. In order to make this task as easy as possible, Wicket offers two special model classes: org.apache.wicket.model.PropertyModel and org.apache.wicket.model.CompoundPropertyModel. We will see how to use them in the next two examples, using the following JavaBean as the data object:public class Person implements Serializable { private String name;
private String surname;
@@ -502,7 +503,7 @@
Index: guide/nativewebsockets.html
===================================================================
--- guide/nativewebsockets.html (revision 1675105)
+++ guide/nativewebsockets.html (working copy)
@@ -151,7 +151,7 @@
20 Native WebSockets - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -333,7 +333,7 @@
Index: guide/pages/advanced_1.html
===================================================================
--- guide/pages/advanced_1.html (revision 1675105)
+++ guide/pages/advanced_1.html (working copy)
@@ -151,7 +151,7 @@
17.1 Enriching components with behaviors - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -180,7 +180,7 @@
For example the following behavior prepends a red asterisk to the tag of a form component if this one is required:
public class RedAsteriskBehavior extends Behavior { @Override
public void beforeRender(Component component) {
Response response = component.getResponse();
- StringBuffer asterisktHtml = new StringBuffer(200); if(componet instanceof FormComponent
+ StringBuffer asterisktHtml = new StringBuffer(200); if(component instanceof FormComponent
&& ((FormComponent)component).isRequired()){
asteriskHtml.append(" <b style="color:red;font-size:medium">*</b>");
}
@@ -216,7 +216,7 @@
Index: guide/pages/advanced_2.html
===================================================================
--- guide/pages/advanced_2.html (revision 1675105)
+++ guide/pages/advanced_2.html (working copy)
@@ -151,7 +151,7 @@
17.2 Generating callback URLs with IRequestListener - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -262,7 +262,7 @@
Index: guide/pages/advanced_3.html
===================================================================
--- guide/pages/advanced_3.html (revision 1675105)
+++ guide/pages/advanced_3.html (working copy)
@@ -151,7 +151,7 @@
17.3 Initializers - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -203,7 +203,7 @@
Index: guide/pages/advanced_4.html
===================================================================
--- guide/pages/advanced_4.html (revision 1675105)
+++ guide/pages/advanced_4.html (working copy)
@@ -151,7 +151,7 @@
17.4 Using JMX with Wicket - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/advanced_5.html
===================================================================
--- guide/pages/advanced_5.html (revision 1675105)
+++ guide/pages/advanced_5.html (working copy)
@@ -151,7 +151,7 @@
17.5 Generating HTML markup from code - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -221,7 +221,7 @@
Index: guide/pages/advanced_6.html
===================================================================
--- guide/pages/advanced_6.html (revision 1675105)
+++ guide/pages/advanced_6.html (working copy)
@@ -151,7 +151,7 @@
17.6 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/ajax_1.html
===================================================================
--- guide/pages/ajax_1.html (revision 1675105)
+++ guide/pages/ajax_1.html (working copy)
@@ -151,7 +151,7 @@
18.1 How to use AJAX components and behaviors - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -175,7 +175,7 @@
label.setDefaultModelObject(
"Another value 4 label.");
target.add(label);
}
-};
Components can be refreshed via Ajax only if they have rendered a markup id for their related tag. As a consequence, we must remember to set a valid id value on every component we want to add to
AjaxRequestTarget. This can be done using one of the two methods seen in paragraph 4.3:
final Label label = new Label("labelComponent", "Initial value.");
+};Components can be refreshed via Ajax only if they have rendered a markup id for their related tag. As a consequence, we must remember to set a valid id value on every component we want to add to
AjaxRequestTarget. This can be done using one of the two methods seen in
paragraph 6.3:
final Label label = new Label("labelComponent", "Initial value.");
//autogenerate a markup id
label.setOutputMarkupId(true);
add(label);
@@ -197,6 +197,7 @@
+
@@ -223,7 +224,7 @@
Index: guide/pages/ajax_2.html
===================================================================
--- guide/pages/ajax_2.html (revision 1675105)
+++ guide/pages/ajax_2.html (working copy)
@@ -151,7 +151,7 @@
18.2 Build-in AJAX components - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
18.2 Build-in AJAX components
-
Wicket distribution comes with a number of built-in AJAX components ready to be used. Some of them are the ajaxified version of common components like links and buttons, while others are AJAX-specific components.
AJAX components are not different from any other component seen so far and they don't require any additional configuration to be used. As we will shortly see, switching from a classic link or button to the ajaxified version is just a matter of appending “Ajax” to the component class name.
This paragraph provides an overview of what we can find in Wicket to start writing AJAX-enhanced web applications.
Links and buttons
In the previous paragraph we have already introduced component AjaxLink. Wicket provides also the ajaxified versions of submitting components SubmitLink and Button which are simply called AjaxSubmitLink and AjaxButton. These components come with a version of methods onSubmit, onError and onAfterSubmit that takes in input also an instance of
AjaxRequestTarget.
Both components are in package
org.apache.wicket.ajax.markup.html.form.
Fallback components
Building an entire site using AJAX can be risky as some clients may not support this technology. In order to provide an usable version of our site also to these clients, we can use components
AjaxFallbackLink and
AjaxFallbackButton which are able to automatically degrade to a standard link or to a standard button if client doesn't support AJAX.
AJAX Checkbox
Class
org.apache.wicket.ajax.markup.html.form.AjaxCheckBox is a checkbox component that updates its model via AJAX when user changes its value. Its AJAX callback method is
onUpdate(AjaxRequestTarget target). The component extends standard checkbox component
CheckBox adding an
AjaxFormComponentUpdatingBehavior to itself (we will see this behavior later in paragraph 16.3.3).
AJAX editable labels
An editable label is a special label that can be edited by the user when she/he clicks on it. Wicket ships three different implementations for this component (all inside package
org.apache.wicket.extensions.ajax.markup.html):
+
Wicket distribution comes with a number of built-in AJAX components ready to be used. Some of them are the ajaxified version of common components like links and buttons, while others are AJAX-specific components.
AJAX components are not different from any other component seen so far and they don't require any additional configuration to be used. As we will shortly see, switching from a classic link or button to the ajaxified version is just a matter of prepending “Ajax” to the component class name.
This paragraph provides an overview of what we can find in Wicket to start writing AJAX-enhanced web applications.
Links and buttons
In the previous paragraph we have already introduced component AjaxLink. Wicket provides also the ajaxified versions of submitting components SubmitLink and Button which are simply called AjaxSubmitLink and AjaxButton. These components come with a version of methods onSubmit, onError and onAfterSubmit that takes in input also an instance of
AjaxRequestTarget.
Both components are in package
org.apache.wicket.ajax.markup.html.form.
Fallback components
Building an entire site using AJAX can be risky as some clients may not support this technology. In order to provide an usable version of our site also to these clients, we can use components
AjaxFallbackLink and
AjaxFallbackButton which are able to automatically degrade to a standard link or to a standard button if client doesn't support AJAX.
AJAX Checkbox
Class
org.apache.wicket.ajax.markup.html.form.AjaxCheckBox is a checkbox component that updates its model via AJAX when user changes its value. Its AJAX callback method is
onUpdate(AjaxRequestTarget target). The component extends standard checkbox component
CheckBox adding an
AjaxFormComponentUpdatingBehavior to itself (we will see this behavior later in
paragraph 18.3.3).
AJAX editable labels
An editable label is a special label that can be edited by the user when she/he clicks on it. Wicket ships three different implementations for this component (all inside package
org.apache.wicket.extensions.ajax.markup.html):
- AjaxEditableLabel: it's a basic version of editable label. User can edit the content of the label with a text field. This is also the base class for the other two editable labels.
- AjaxEditableMultiLineLabel: this label supports multi-line values and uses a text area as editor component.
@@ -334,7 +334,7 @@
Index: guide/pages/ajax_3.html
===================================================================
--- guide/pages/ajax_3.html (revision 1675105)
+++ guide/pages/ajax_3.html (working copy)
@@ -151,7 +151,7 @@
18.3 Built-in AJAX behaviors - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -245,7 +245,7 @@
Index: guide/pages/ajax_4.html
===================================================================
--- guide/pages/ajax_4.html (revision 1675105)
+++ guide/pages/ajax_4.html (working copy)
@@ -151,7 +151,7 @@
18.4 Using an activity indicator - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -206,7 +206,7 @@
Index: guide/pages/ajax_5.html
===================================================================
--- guide/pages/ajax_5.html (revision 1675105)
+++ guide/pages/ajax_5.html (working copy)
@@ -151,7 +151,7 @@
18.5 AJAX request attributes and call listeners - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -164,7 +164,7 @@
18.5 AJAX request attributes and call listeners
Starting from version 6.0 Wicket has introduced two entities which allow us to control how an AJAX request is generated on client side and to specify the custom JavaScript code we want to execute during request handling. These entities are class
AjaxRequestAttributes and interface
IAjaxCallListener, both placed in package
org.apache.wicket.ajax.attributes.
AjaxRequestAttributes exposes the attributes used to generate the JavaScript call invoked on client side to start an AJAX request. Each attribute will be passed as a
JSON parameter to the JavaScript function
Wicket.Ajax.ajax which is responsible for sending the concrete AJAX request. Every JSON parameter is identified by a short name. Here is a partial list of the available parameters:
| Short name | Description | Default value |
|---|
| u | The callback URL used to serve the AJAX request that will be sent. | |
| c | The id of the component that wants to start the AJAX call. | |
| e | A list of event (click, change, etc...) that can trigger the AJAX call. | domready |
| m | The request method that must be used (GET or POST). | GET |
| f | The id of the form that must be submitted with the AJAX call. | |
| mp | If the AJAX call involves the submission of a form, this flag indicates whether the data must be encoded using the encoding mode “multipart/form-data”. | false |
| sc | The input name of the submitting component of the form | |
| async | A boolean parameter that indicates if the AJAX call is asynchronous (true) or not. | true |
| wr | Specifies the type of data returned by the AJAX call (XML, HTML, JSON, etc...). | XML |
| bh, pre, bsh, ah, sh, fh, coh | This is a list of the listeners that are executed on client side (they are JavaScript scripts) during the lifecycle of an AJAX request. Each short name is the abbreviation of one of the methods defined in the interface IAjaxCallListener (see below). | An empty list |
-A full list of the available request parameters as well as more details on the related JavaScript code can be found at https://cwiki.apache.org/confluence/ display/WICKET/Wicket+Ajax display/WICKET/Wicket+Ajax .
+A full list of the available request parameters as well as more details on the related JavaScript code can be found at https://cwiki.apache.org/confluence/display/WICKET/Wicket+Ajax .
Parameters 'u' (callback URL) and 'c' (the id of the component) are generated by the AJAX behavior that will serve the AJAX call and they are not accessible through
AjaxRequestAttributes.
Here is the final AJAX function generate for the behavior used in example project
AjaxEventBehavior Example:
Wicket.Ajax.ajax({"u":"./?0-1.IBehaviorListener.0-clickCounterLabel", "e":"click",
"c":"clickCounterLabel1"});Even if most of the times we will let Wicket generate request attributes for us, both AJAX components and behaviors give us the chance to modify them overriding their method
updateAjaxAttributes (AjaxRequestAttributes attributes).
One of the attribute we may need to modify is the list of
IAjaxCallListeners returned by method
getAjaxCallListeners().
IAjaxCallListener defines a set of methods which return the JavaScript code (as a
CharSequence) that must be executed on client side when the AJAX request handling reaches a given stage:
@@ -215,7 +215,7 @@
Index: guide/pages/ajax_6.html
===================================================================
--- guide/pages/ajax_6.html (revision 1675105)
+++ guide/pages/ajax_6.html (working copy)
@@ -151,7 +151,7 @@
18.6 Creating custom AJAX call listener - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -232,7 +232,7 @@
- '/ajax/call/complete': called when the AJAX call has completed.
- '/dom/node/removing': called when a component is about to be removed via AJAX. This happens when component markup is updated via AJAX (i.e. the component itself or one of its containers has been added to
AjaxRequestTarget)
- '/dom/node/added': called when a component has been added via AJAX. Just like '/dom/node/removing', this event is triggered when a component is added to
AjaxRequestTarget.
-
The callback function takes in input the following parameters: attrs, jqXHR, textStatus, jqEvent and errorThrown. The first three parameters are the same seen before with
IAjaxCallListener while jqEvent is an event internally fired by Wicket. The last parameter errorThrown indicates if an error has occurred during the AJAX call.
To see a basic example of use of a global AJAX call listener, let's go back to our custom datepicker created in chapter 14. When we built it we didn't think about a possible use of the component with AJAX. When a complex component like our datepicker is refreshed via AJAX, the following two side effects can occur:
+
The callback function takes in input the following parameters: attrs, jqXHR, textStatus, jqEvent and errorThrown. The first three parameters are the same seen before with
IAjaxCallListener while jqEvent is an event internally fired by Wicket. The last parameter errorThrown indicates if an error has occurred during the AJAX call.
To see a basic example of use of a global AJAX call listener, let's go back to our custom datepicker created in
chapter 16. When we built it we didn't think about a possible use of the component with AJAX. When a complex component like our datepicker is refreshed via AJAX, the following two side effects can occur:
- After been refreshed, the component loses every JavaScript handler set on it. This is not a problem for our datepicker as it sets a new JQuery datepicker every time is rendered (inside method renderHead).
- The markup previously created with JavaScript is not removed. For our datepicker this means that the icon used to open the calendar won't be removed while a new one will be added each time the component is refreshed.
@@ -272,7 +272,7 @@
Index: guide/pages/ajax_7.html
===================================================================
--- guide/pages/ajax_7.html (revision 1675105)
+++ guide/pages/ajax_7.html (working copy)
@@ -151,7 +151,7 @@
18.7 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/bestpractices_1.html
===================================================================
--- guide/pages/bestpractices_1.html (revision 1675105)
+++ guide/pages/bestpractices_1.html (working copy)
@@ -151,7 +151,7 @@
24.1 Encapsulate components correctly - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -264,7 +264,7 @@
Index: guide/pages/bestpractices_10.html
===================================================================
--- guide/pages/bestpractices_10.html (revision 1675105)
+++ guide/pages/bestpractices_10.html (working copy)
@@ -151,7 +151,7 @@
24.10 Do not pass components to constructors - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -231,7 +231,7 @@
Index: guide/pages/bestpractices_11.html
===================================================================
--- guide/pages/bestpractices_11.html (revision 1675105)
+++ guide/pages/bestpractices_11.html (working copy)
@@ -151,7 +151,7 @@
24.11 Use the Wicket session only for global data - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -203,7 +203,7 @@
Index: guide/pages/bestpractices_12.html
===================================================================
--- guide/pages/bestpractices_12.html (revision 1675105)
+++ guide/pages/bestpractices_12.html (working copy)
@@ -151,7 +151,7 @@
24.12 Do not use factories for components - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -232,7 +232,7 @@
Index: guide/pages/bestpractices_13.html
===================================================================
--- guide/pages/bestpractices_13.html (revision 1675105)
+++ guide/pages/bestpractices_13.html (working copy)
@@ -151,7 +151,7 @@
24.13 Every page and component must be tested - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/bestpractices_14.html
===================================================================
--- guide/pages/bestpractices_14.html (revision 1675105)
+++ guide/pages/bestpractices_14.html (working copy)
@@ -151,7 +151,7 @@
24.14 Avoid interactions with other servlet filters - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/bestpractices_15.html
===================================================================
--- guide/pages/bestpractices_15.html (revision 1675105)
+++ guide/pages/bestpractices_15.html (working copy)
@@ -151,7 +151,7 @@
24.15 Cut small classes and methods - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -207,7 +207,7 @@
Index: guide/pages/bestpractices_16.html
===================================================================
--- guide/pages/bestpractices_16.html (revision 1675105)
+++ guide/pages/bestpractices_16.html (working copy)
@@ -151,7 +151,7 @@
24.16 The argument "Bad documentation" - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/bestpractices_17.html
===================================================================
--- guide/pages/bestpractices_17.html (revision 1675105)
+++ guide/pages/bestpractices_17.html (working copy)
@@ -151,7 +151,7 @@
24.17 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/bestpractices_2.html
===================================================================
--- guide/pages/bestpractices_2.html (revision 1675105)
+++ guide/pages/bestpractices_2.html (working copy)
@@ -151,7 +151,7 @@
24.2 Put models and page data in fields - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/bestpractices_3.html
===================================================================
--- guide/pages/bestpractices_3.html (revision 1675105)
+++ guide/pages/bestpractices_3.html (working copy)
@@ -151,7 +151,7 @@
24.3 Correct naming for Wicket IDs - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/bestpractices_4.html
===================================================================
--- guide/pages/bestpractices_4.html (revision 1675105)
+++ guide/pages/bestpractices_4.html (working copy)
@@ -151,7 +151,7 @@
24.4 Avoid changes at the component tree - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -198,7 +198,7 @@
Index: guide/pages/bestpractices_5.html
===================================================================
--- guide/pages/bestpractices_5.html (revision 1675105)
+++ guide/pages/bestpractices_5.html (working copy)
@@ -151,7 +151,7 @@
24.5 Implement visibilities of components correctly - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -208,7 +208,7 @@
Index: guide/pages/bestpractices_6.html
===================================================================
--- guide/pages/bestpractices_6.html (revision 1675105)
+++ guide/pages/bestpractices_6.html (working copy)
@@ -151,7 +151,7 @@
24.6 Always use models - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -197,7 +197,7 @@
Index: guide/pages/bestpractices_7.html
===================================================================
--- guide/pages/bestpractices_7.html (revision 1675105)
+++ guide/pages/bestpractices_7.html (working copy)
@@ -151,7 +151,7 @@
24.7 Do not unwrap models within the constructor hierarchy - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -198,7 +198,7 @@
Index: guide/pages/bestpractices_8.html
===================================================================
--- guide/pages/bestpractices_8.html (revision 1675105)
+++ guide/pages/bestpractices_8.html (working copy)
@@ -151,7 +151,7 @@
24.8 Pass models extended components - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -197,7 +197,7 @@
Index: guide/pages/bestpractices_9.html
===================================================================
--- guide/pages/bestpractices_9.html (revision 1675105)
+++ guide/pages/bestpractices_9.html (working copy)
@@ -151,7 +151,7 @@
24.9 Validators must not change any data or models - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/componentLifecycle_1.html
===================================================================
--- guide/pages/componentLifecycle_1.html (revision 1675105)
+++ guide/pages/componentLifecycle_1.html (working copy)
@@ -151,7 +151,7 @@
7.1 Lifecycle stages of a component - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -200,7 +200,7 @@
Index: guide/pages/componentLifecycle_2.html
===================================================================
--- guide/pages/componentLifecycle_2.html (revision 1675105)
+++ guide/pages/componentLifecycle_2.html (working copy)
@@ -151,7 +151,7 @@
7.2 Hook methods for component lifecycle - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/componentLifecycle_3.html
===================================================================
--- guide/pages/componentLifecycle_3.html (revision 1675105)
+++ guide/pages/componentLifecycle_3.html (working copy)
@@ -151,7 +151,7 @@
7.3 Initialization stage - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/componentLifecycle_4.html
===================================================================
--- guide/pages/componentLifecycle_4.html (revision 1675105)
+++ guide/pages/componentLifecycle_4.html (working copy)
@@ -151,7 +151,7 @@
7.4 Rendering stage - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -246,7 +246,7 @@
Index: guide/pages/componentLifecycle_5.html
===================================================================
--- guide/pages/componentLifecycle_5.html (revision 1675105)
+++ guide/pages/componentLifecycle_5.html (working copy)
@@ -151,7 +151,7 @@
7.5 Removing stage - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -194,7 +194,7 @@
Index: guide/pages/componentLifecycle_6.html
===================================================================
--- guide/pages/componentLifecycle_6.html (revision 1675105)
+++ guide/pages/componentLifecycle_6.html (working copy)
@@ -151,7 +151,7 @@
7.6 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/forms2_1.html
===================================================================
--- guide/pages/forms2_1.html (revision 1675105)
+++ guide/pages/forms2_1.html (working copy)
@@ -151,7 +151,7 @@
12.1 Default form processing - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
-
In paragraph 9.3 we have seen a very basic usage of the Form component and we didn't pay much attention to what happens behind the scenes of form submission. In Wicket when we submit a form we trigger the following steps on server side:
+
In
paragraph 11.3 we have seen a very basic usage of the Form component and we didn't pay much attention to what happens behind the scenes of form submission. In Wicket when we submit a form we trigger the following steps on server side:
- Form validation: user input is checked to see if it satisfies the validation rules set on the form. If validation fails, step number 2 is skipped and the form should display a feedback message to explain to user what went wrong. During this step input values (which are simple strings sent with a web request) are converted into Java objects. In the next paragraphs we will explore the infrastructures provided by Wicket for the three sub-tasks involved with form validation, which are: conversion of user input into objects, validation of user input, and visualization of feedback messages.
- Updating of models: if validation succeeds, the form updates the model of its children components with the converted values obtained in the previous step.
@@ -170,9 +170,10 @@
- Invoking callback methods onSubmit() or onError(): if we didn't have any validation error, method onSubmit() is called, otherwise onError() will be called. The default implementation of both these methods is left empty and we can override them to perform custom actions.
Please note that the model of form components is updated only if no validation error occurred (i.e. step two is performed only if validation succeeds).
-
Without going into too much detail, we can say that the first two steps of form processing correspond to the invocation of one or more Form's internal methods (which are declared protected and final). Some examples of these methods are validate(), which is invoked during validation step, and updateFormComponentModels(), which is used at the step that updates the form field models.
The whole form processing is started invoking public method process(IFormSubmitter) (Later in paragraph 10.4 we will introduce interface IFormSubmitter).
+
Without going into too much detail, we can say that the first two steps of form processing correspond to the invocation of one or more Form's internal methods (which are declared protected and final). Some examples of these methods are validate(), which is invoked during validation step, and updateFormComponentModels(), which is used at the step that updates the form field models.
The whole form processing is started invoking public method process(IFormSubmitter) (Later in
paragraph 12.5 we will introduce interface IFormSubmitter).
+
@@ -199,7 +200,7 @@
Index: guide/pages/forms2_10.html
===================================================================
--- guide/pages/forms2_10.html (revision 1675105)
+++ guide/pages/forms2_10.html (working copy)
@@ -151,7 +151,7 @@
12.10 Stateless form - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
-
In chapter 6 we have seen how Wicket pages can be divided into two categories: stateful and stateless. Pages that are stateless don't need to be stored in the user session and they should be used when we don't need to save any user data in the user session (for example in the public area of a site).
Besides saving resources on server-side, stateless pages can be adopted to improve user experience and to avoid security weaknesses. A typical situation where a stateless page can bring these benefits is when we have to implement a login page.
For this kind of page we might encounter two potential problems if we chose to use a stateful page. The first problem occurs when the user tries to login without a valid session assigned to him. This could happen if the user leaves the login page opened for a period of time bigger than the session's timeout and then he decides to log in. Under these conditions the user will be redirected to a 'Page expired' error page, which is not exactly a nice thing for user experience.
The second problem occurs when a malicious user or a web crawler program attempts to login into our web application, generating a huge number of page versions and consequently increasing the size of the user session.
To avoid these kinds of problems we should build a stateless login page which does not depend on a user session. Wicket provides a special version of the Form component called StatelessForm which is stateless by default (i.e its method getStatelessHint() returns true), hence it's an ideal solution when we want to build a stateless page with a form. A possible implementation of our login form is the following (example project StatelessLoginForm):
HTML:<html>
+In chapter 8 we have seen how Wicket pages can be divided into two categories: stateful and stateless. Pages that are stateless don't need to be stored in the user session and they should be used when we don't need to save any user data in the user session (for example in the public area of a site).Besides saving resources on server-side, stateless pages can be adopted to improve user experience and to avoid security weaknesses. A typical situation where a stateless page can bring these benefits is when we have to implement a login page.For this kind of page we might encounter two potential problems if we chose to use a stateful page. The first problem occurs when the user tries to login without a valid session assigned to him. This could happen if the user leaves the login page opened for a period of time bigger than the session's timeout and then he decides to log in. Under these conditions the user will be redirected to a 'Page expired' error page, which is not exactly a nice thing for user experience.The second problem occurs when a malicious user or a web crawler program attempts to login into our web application, generating a huge number of page versions and consequently increasing the size of the user session.To avoid these kinds of problems we should build a stateless login page which does not depend on a user session. Wicket provides a special version of the Form component called StatelessForm which is stateless by default (i.e its method getStatelessHint() returns true), hence it's an ideal solution when we want to build a stateless page with a form. A possible implementation of our login form is the following (example project StatelessLoginForm):HTML:<html>
<head>
<meta charset="utf-8" />
</head>
@@ -207,6 +207,7 @@
}
12.11 Working with radio buttons and checkboxes - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
-
In this paragraph we will see which components can be used to handle HTML radio buttons and checkboxes. Both these input elements are usually grouped together to display a list of possible choices:
A check box can be used as single component to set a boolean property. For this purpose Wicket provides the
org.apache.wicket.markup.html.form.CheckBox component which must be attached to <input type="checkbox".../> tag. In the next example (project SingleCheckBox) we will consider a form similar to the one used in paragraph 9.5 to edit a Person object, but with an additional checkbox to let the user decide if she wants to subscribe to our mailing list or not. The form uses the following bean as backing object:
public class RegistrationInfo implements Serializable { private String name;
+In this paragraph we will see which components can be used to handle HTML radio buttons and checkboxes. Both these input elements are usually grouped together to display a list of possible choices:A check box can be used as single component to set a boolean property. For this purpose Wicket provides the org.apache.wicket.markup.html.form.CheckBox component which must be attached to <input type="checkbox".../> tag. In the next example (project SingleCheckBox) we will consider a form similar to the one used in paragraph 11.5 to edit a Person object, but with an additional checkbox to let the user decide if she wants to subscribe to our mailing list or not. The form uses the following bean as backing object:public class RegistrationInfo implements Serializable { private String name;
private String surname;
private String address;
private String email;
@@ -214,7 +214,7 @@
<input type="checkbox"/>It will be replaced by the actual checkboxes…
</div>List<String> fruits = Arrays.asList("apple", "strawberry", "watermelon");
form.add(new CheckBoxMultipleChoice("checkGroup", new ListModel<String>(new
- ArrayList<String>()), fruits));org.apache.wicket.model.util.ListModel which is specifically designed to wrap a List object.By default CheckBoxMultipleChoice inserts a <br/> tag as suffix after each option. We can configure both the suffix and the prefix used by the component with the setPrefix and setSuffix methods.When our options are more complex objects than simple strings, we can render them using an IChoiceRender, as we did for DropDownChoice in paragraph 9.4:HTML:<div wicket:id="checkGroup">
+ ArrayList<String>()), fruits));
org.apache.wicket.model.util.ListModel which is specifically designed to wrap a List object.By default CheckBoxMultipleChoice inserts a <br/> tag as suffix after each option. We can configure both the suffix and the prefix used by the component with the setPrefix and setSuffix methods.When our options are more complex objects than simple strings, we can render them using an IChoiceRender, as we did for DropDownChoice in paragraph 11.5:HTML:<div wicket:id="checkGroup">
<input type="checkbox"/>It will be replaced by actual checkboxes…
</div>
Person john = new Person("John", "Smith");
Person bob = new Person("Bob", "Smith");
@@ -232,6 +232,7 @@
form.add(new RadioChoice("radioGroup", Model.of(""), fruits));
12.12 Selecting multiple values with ListMultipleChoices and Palette - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -231,7 +231,7 @@
Index: guide/pages/forms2_13.html
===================================================================
--- guide/pages/forms2_13.html (revision 1675105)
+++ guide/pages/forms2_13.html (working copy)
@@ -151,7 +151,7 @@
12.13 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -194,7 +194,7 @@
Index: guide/pages/forms2_2.html
===================================================================
--- guide/pages/forms2_2.html (revision 1675105)
+++ guide/pages/forms2_2.html (working copy)
@@ -151,7 +151,7 @@
12.2 Form validation and feedback messages - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,11 +163,11 @@
-
A basic example of a validation rule is to make a field required. In paragraph 9.3.2 we have already seen how this can be done calling setRequired(true) on a field. However, to set a validation rule on a FormComponent we must add the corresponding validator to it.
A validator is an implementation of the
org.apache.wicket.validation.IValidator interface and the
FormComponent has a version of method add which takes as input a reference of this interface.
For example if we want to use a text field to insert an email address, we could use the built-in validator EmailAddressValidator to ensure that the inserted input will respect the email format
local-part@domain :
TextField email = new TextField("email");
-email.add(EmailAddressValidator.getInstance());Wicket comes with a set of built-in validators that should suit most of our needs. We will see them in paragraph 10.2.3.
Feedback messages and localization
Wicket generates a feedback message for each field that doesn't satisfy one of its validation rules. For example the message generated when a required field is left empty is the following
Field '<label>' is required.<label> is the value of the label model set on a FormComponent with method setLabel(IModel <String> model). If such model is not provided, component id will be used as the default value.
The entire infrastructure of feedback messages is built on top of the Java internationalization (I18N) support and it uses
resource bundles to store messages.
-The topics of internationalization will be covered in chapter 12. For now we will give just few notions needed to understand the examples from this chapter.
-
By default resource bundles are stored into properties files but we can easily configure other sources as described later in paragraph 12.4.5.
Default feedback messages (like the one above for required fields) are stored in the file Application. properties placed inside Wicket the org.apache.wicket package. Opening this file we can find the key and the localized value of the message:
Required=Field '${label}' is required.We can note the key (Required in our case) and the label parameter written in the
expression language (${label}). Scrolling down this file we can also find the message used by the Email AddressValidator:
EmailAddressValidator=The value of '${label}' is not a valid email address.By default FormComponent provides 3 parameters for feedback message: input (the value that failed validation), label and name (this later is the id of the component).
-Remember that component model is updated with the user input only if validation succeeds! As a consequence, we can't retrieve the wrong value inserted for a field from its model. Instead, we should use getValue() method of FormComponent class. (This method will be introduced in the example used in paragraph 10.2.5)
+A basic example of a validation rule is to make a field required. In paragraph 11.3 we have already seen how this can be done calling setRequired(true) on a field. However, to set a validation rule on a FormComponent we must add the corresponding validator to it.A validator is an implementation of the org.apache.wicket.validation.IValidator interface and the FormComponent has a version of method add which takes as input a reference of this interface.For example if we want to use a text field to insert an email address, we could use the built-in validator EmailAddressValidator to ensure that the inserted input will respect the email format local-part@domain :TextField email = new TextField("email");
+email.add(EmailAddressValidator.getInstance());Feedback messages and localization
Wicket generates a feedback message for each field that doesn't satisfy one of its validation rules. For example the message generated when a required field is left empty is the followingField '<label>' is required.<label> is the value of the label model set on a FormComponent with method setLabel(IModel <String> model). If such model is not provided, component id will be used as the default value.The entire infrastructure of feedback messages is built on top of the Java internationalization (I18N) support and it uses resource bundles to store messages.
+The topics of internationalization will be covered in chapter 14. For now we will give just few notions needed to understand the examples from this chapter.
+
By default resource bundles are stored into properties files but we can easily configure other sources as described later in paragraph 14.2.Default feedback messages (like the one above for required fields) are stored in the file Application. properties placed inside Wicket the org.apache.wicket package. Opening this file we can find the key and the localized value of the message:Required=Field '${label}' is required.We can note the key (Required in our case) and the label parameter written in the expression language (${label}). Scrolling down this file we can also find the message used by the Email AddressValidator:EmailAddressValidator=The value of '${label}' is not a valid email address.By default FormComponent provides 3 parameters for feedback message: input (the value that failed validation), label and name (this later is the id of the component).
+Remember that component model is updated with the user input only if validation succeeds! As a consequence, we can't retrieve the wrong value inserted for a field from its model. Instead, we should use getValue() method of FormComponent class. (This method will be introduced in the example used later in this chapter)
Displaying feedback messages and filtering them
To display feedback messages we must use component org.apache.wicket.markup.html.panel.FeedbackPanel. This component automatically reads all the feedback messages generated during form validation and displays them with an unordered list:<ul class="feedbackPanel">
<li class="feedbackPanelERROR">
<span class="feedbackPanelERROR">Field 'Username' is required.</span>
@@ -176,7 +176,7 @@
- ComponentFeedbackMessageFilter: shows only messages coming from a specific component.
- ContainerFeedbackMessageFilter: shows only messages coming from a specific container or from any of its children components.
-- ErrorLevelFeedbackMessageFilter: shows only messages with a level of severity equals or greater than a given lower bound. Class FeedbackMessage defines a set of static constants to express different levels of severity: DEBUG, ERROR, WARNING, INFO, SUCCESS, etc.... Levels of severity for feedback messages are discussed in paragraph 10.2.6.
+- ErrorLevelFeedbackMessageFilter: shows only messages with a level of severity equals or greater than a given lower bound. Class FeedbackMessage defines a set of static constants to express different levels of severity: DEBUG, ERROR, WARNING, INFO, SUCCESS, etc.... Levels of severity for feedback messages are discussed later in this chapter.
These filters are intended to be used when there are more than one feedback panel (or more than one form) in the same page. We can pass a filter to a feedback panel via its constructor or using the setFilter method. Custom filters can be created implementing the IFeedbackMessageFilter interface. An example of custom filter is illustrated later in this paragraph.
Built-in validators
Wicket already provides a number of built-in validators ready to be used. The following table is a short reference where validators are listed along with a brief description of what they do. The default feedback message used by each of them is reported as well:
EmailAddressValidator
Checks if input respects the format local-part@domain.
Message:The value of '${label}' is not a valid email address.UrlValidator
Checks if input is a valid URL. We can specify in the constructor which protocols are allowed (http://, https://, and ftp://).
Message:The value of '${label}' is not a valid URL.DateValidator
Validator class that can be extended or used as a factory class to get date validators to check if a date is bigger than a lower bound (method minimum(Date min)), smaller than a upper bound (method maximum(Date max)) or inside a range (method range(Date min, Date max)).
Messages:The value of '${label}' is less than the minimum of ${minimum}.The value of '${label}' is larger than the maximum of ${maximum}.The value of '${label}' is not between ${minimum} and ${maximum}.RangeValidator
Validator class that can be extended or used as a factory class to get validators to check if a value is bigger than a given lower bound (method minimum(T min)), smaller than a upper bound (method maximum(T max)) or inside a range (method range(T min,T max)).
The type of the value is a generic subtype of java.lang.Comparable and must implement Serializable interface.
Messages:The value of '${label}' must be at least ${minimum}.The value of '${label}' must be at most ${maximum}.The value of '${label}' must be between ${minimum} and ${maximum}.StringValidator
Validator class that can be extended or used as a factory class to get validators to check if the length of a string value is bigger then a given lower bound (method minimumLength (int min)), smaller then a given upper bound (method maximumLength (int max)) or within a given range (method lengthBetween(int min, int max)).
To accept only string values consisting of exactly n characters, we must use method exactLength(int length).
Messages:The value of '${label}' is shorter than the minimum of ${minimum} characters.The value of '${label}' is longer than the maximum of ${maximum} characters.The value of '${label}' is not between ${minimum} and ${maximum} characters long.The value of '${label}' is not exactly ${exact} characters long.CreditCardValidator
Checks if input is a valid credit card number. This validator supports some of the most popular credit cards (like “American Express", "MasterCard", “Visa” or “Diners Club”).
Message:The credit card number is invalid.EqualPasswordInputValidator
This validator checks if two password fields have the same value.
Message:${label0} and ${label1} must be equal.Overriding standard feedback messages with custom bundles
If we don't like the default validation feedback messages, we can override them providing custom properties files. In these files we can write our custom messages using the same keys of the messages we want to override. For example if we wanted to override the default message for invalid email addresses, our properties file would contain a line like this:
EmailAddressValidator=Man, your email address is not good!As we will see in the next chapter, Wicket searches for custom properties files in various positions inside the application's class path, but for now we will consider just the properties file placed next to our application class. The name of this file must be equal to the name of our application class:
The example project OverrideMailMessage overrides email validator's message with a new one which also reports the value that failed validation:
EmailAddressValidator=The value '${input}' inserted for field '${label}' is not a valid email address.Creating custom validators
If our web application requires a complex validation logic and built-in validators are not enough, we can implement our own custom validators. For example (project UsernameCustomValidator) suppose we are working on the registration page of our site where users can create their profile choosing their username. Our registration form should validate the new username checking if it was already chosen by another user. In a situation like this we may need to implement a custom validator that queries a specific data source to check if a username is already in use.
For the sake of simplicity, the validator of our example will check the given username against a fixed list of three existing usernames.
A custom validator must simply implement interface IValidator:
public class UsernameValidator implements IValidator<String> {
List<String> existingUsernames = Arrays.asList("bigJack", "anonymous", "mrSmith"); public void validate(IValidatable<String> validatable) {
String chosenUserName = validatable.getValue(); if(existingUsernames.contains(chosenUserName)){
@@ -255,7 +255,7 @@
Index: guide/pages/forms2_3.html
===================================================================
--- guide/pages/forms2_3.html (revision 1675105)
+++ guide/pages/forms2_3.html (working copy)
@@ -151,7 +151,7 @@
12.3 Input value conversion - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -199,7 +199,7 @@
public String convertToString(Pattern value, Locale locale) {
return value.toString();
}
-}
Methods declared by interface IConverter take as input a Locale parameter in order to deal with locale-sensitive data and conversions. We will learn more about locales and internationalization in chapter 12.Once we have implemented our custom converter, we must override method newConverterLocator() inside our application class and tell it to add our new converter to the default set:Methods declared by interface IConverter take as input a Locale parameter in order to deal with locale-sensitive data and conversions. We will learn more about locales and internationalization in paragraph 14.Once we have implemented our custom converter, we must override method newConverterLocator() inside our application class and tell it to add our new converter to the default set:@Override
protected IConverterLocator newConverterLocator() {
ConverterLocator defaultLocator = new ConverterLocator(); defaultLocator.set(Pattern.class, new RegExpPatternConverter()); return defaultLocator;
}public class HomePage extends WebPage {
@@ -226,6 +226,7 @@
+
@@ -252,7 +253,7 @@
Index: guide/pages/forms2_4.html
===================================================================
--- guide/pages/forms2_4.html (revision 1675105)
+++ guide/pages/forms2_4.html (working copy)
@@ -151,7 +151,7 @@
12.4 Validation with JSR 303 - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -214,7 +214,7 @@
Index: guide/pages/forms2_5.html
===================================================================
--- guide/pages/forms2_5.html (revision 1675105)
+++ guide/pages/forms2_5.html (working copy)
@@ -151,7 +151,7 @@
12.5 Submit form with an IFormSubmittingComponent - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -239,7 +239,7 @@
Index: guide/pages/forms2_6.html
===================================================================
--- guide/pages/forms2_6.html (revision 1675105)
+++ guide/pages/forms2_6.html (working copy)
@@ -151,7 +151,7 @@
12.6 Nested forms - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -201,7 +201,7 @@
Index: guide/pages/forms2_7.html
===================================================================
--- guide/pages/forms2_7.html (revision 1675105)
+++ guide/pages/forms2_7.html (working copy)
@@ -151,7 +151,7 @@
12.7 Multi-line text input - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/forms2_8.html
===================================================================
--- guide/pages/forms2_8.html (revision 1675105)
+++ guide/pages/forms2_8.html (working copy)
@@ -151,7 +151,7 @@
12.8 File upload - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -230,7 +230,7 @@
Index: guide/pages/forms2_9.html
===================================================================
--- guide/pages/forms2_9.html (revision 1675105)
+++ guide/pages/forms2_9.html (working copy)
@@ -151,7 +151,7 @@
12.9 Creating complex form components with FormComponentPanel - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
-
In chapter 3.2.2 we have seen how to use class Panel to create custom components with their own markup and with an arbitrary number of children components.
While it's perfectly legal to use Panel also to group form components, the resulting component won't be itself a form component and it won't participate in the form's submission workflow.
This could be a strong limitation if the custom component needs to coordinate its children during sub-tasks like input conversion or model updating. That's why in Wicket we have the
org.apache.wicket.markup.html.form.FormComponentPanel component which combines the features of a Panel (it has its own markup file) and a FormComponent (it is a subclass of FormComponent).
A typical scenario in which we may need to implement a custom FormComponentPanel is when our web application and its users work with different units of measurement for the same data.
To illustrate this possible scenario, let's consider a form where a user can insert a temperature that will be recorded after being converted to Kelvin degrees (see the example project CustomForm ComponentPanel).
The Kelvin scale is wildly adopted among the scientific community and it is one of the seven base units of the
International System of Units , so it makes perfect sense to store temperatures expressed with this unit of measurement.
However, in our everyday life we still use other temperature scales like Celsius or Fahrenheit, so it would be nice to have a component which internally works with Kelvin degrees and automatically applies conversion between Kelvin temperature scale and the one adopted by the user.
In order to implement such a component, we can make a subclass of FormComponentPanel and leverage the convertInput and onBeforeRender methods: in the implementation of the convertInput method we will convert input value to Kelvin degrees while in the implementation of onBeforeRender method we will take care of converting the Kelvin value to the temperature scale adopted by the user.
Our custom component will contain two children components: a text field to let user insert and edit a temperature value and a label to display the letter corresponding to user's temperature scale (F for Fahrenheit and C for Celsius). The resulting markup file is the following:
<html>
+In chapter 5.2.2 we have seen how to use class Panel to create custom components with their own markup and with an arbitrary number of children components.While it's perfectly legal to use Panel also to group form components, the resulting component won't be itself a form component and it won't participate in the form's submission workflow.This could be a strong limitation if the custom component needs to coordinate its children during sub-tasks like input conversion or model updating. That's why in Wicket we have the org.apache.wicket.markup.html.form.FormComponentPanel component which combines the features of a Panel (it has its own markup file) and a FormComponent (it is a subclass of FormComponent).A typical scenario in which we may need to implement a custom FormComponentPanel is when our web application and its users work with different units of measurement for the same data.To illustrate this possible scenario, let's consider a form where a user can insert a temperature that will be recorded after being converted to Kelvin degrees (see the example project CustomForm ComponentPanel).The Kelvin scale is wildly adopted among the scientific community and it is one of the seven base units of the International System of Units , so it makes perfect sense to store temperatures expressed with this unit of measurement.However, in our everyday life we still use other temperature scales like Celsius or Fahrenheit, so it would be nice to have a component which internally works with Kelvin degrees and automatically applies conversion between Kelvin temperature scale and the one adopted by the user.In order to implement such a component, we can make a subclass of FormComponentPanel and leverage the convertInput and onBeforeRender methods: in the implementation of the convertInput method we will convert input value to Kelvin degrees while in the implementation of onBeforeRender method we will take care of converting the Kelvin value to the temperature scale adopted by the user.Our custom component will contain two children components: a text field to let user insert and edit a temperature value and a label to display the letter corresponding to user's temperature scale (F for Fahrenheit and C for Celsius). The resulting markup file is the following:<html>
<head>
</head>
<body>
@@ -190,7 +190,7 @@
add(userDegree=new TextField<Double>("registeredTemperature", new
Model<Double>()));
userDegree.setType(Double.class);
- }// continued example
@Override
protected void convertInput() {
Double userDegreeVal = userDegree.getConvertedInput();
@@ -215,6 +215,7 @@
}
4.1 Wicket distribution and modules - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/helloWorld_2.html
===================================================================
--- guide/pages/helloWorld_2.html (revision 1675105)
+++ guide/pages/helloWorld_2.html (working copy)
@@ -151,7 +151,7 @@
4.2 Configuration of Wicket applications - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -230,7 +230,7 @@
Index: guide/pages/helloWorld_3.html
===================================================================
--- guide/pages/helloWorld_3.html (revision 1675105)
+++ guide/pages/helloWorld_3.html (working copy)
@@ -151,7 +151,7 @@
4.3 The HomePage class - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -217,7 +217,7 @@
Index: guide/pages/helloWorld_4.html
===================================================================
--- guide/pages/helloWorld_4.html (revision 1675105)
+++ guide/pages/helloWorld_4.html (working copy)
@@ -151,7 +151,7 @@
4.4 Wicket Links - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -220,7 +220,7 @@
Index: guide/pages/helloWorld_5.html
===================================================================
--- guide/pages/helloWorld_5.html (revision 1675105)
+++ guide/pages/helloWorld_5.html (working copy)
@@ -151,7 +151,7 @@
4.5 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -194,7 +194,7 @@
Index: guide/pages/i18n_1.html
===================================================================
--- guide/pages/i18n_1.html (revision 1675105)
+++ guide/pages/i18n_1.html (working copy)
@@ -151,7 +151,7 @@
14.1 Localization - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
14.1 Localization
-
As we have seen in chapter 10, the infrastructure of feedback messages is built on top of Java internationalization (i18n) support, so it should not be surprising that the same infrastructure is used also for localization purpose. However, while so far we have used only the <ApplicationClassName>.properties file to store our custom messages, in this chapter we will see that also pages, components, validators and even Java packages can have their own resource bundles. This allows us to split bundles into multiple files keeping them close to where they are used. But before diving into the details of internationalization with Wicket, it's worthwhile to quickly review how i18n works under Java, see what classes are involved and how they are integrated into Wicket.
+As we have seen in paragraph 12.2, the infrastructure of feedback messages is built on top of Java internationalization (i18n) support, so it should not be surprising that the same infrastructure is used also for localization purpose. However, while so far we have used only the <ApplicationClassName>.properties file to store our custom messages, in this chapter we will see that also pages, components, validators and even Java packages can have their own resource bundles. This allows us to split bundles into multiple files keeping them close to where they are used. But before diving into the details of internationalization with Wicket, it's worthwhile to quickly review how i18n works under Java, see what classes are involved and how they are integrated into Wicket.
Providing a full description of Java support for i18n is clearly out of the scope of this document. If you need more informations about this topic you can find them in the JavaDocs and in the official i18n tutorial .
Class Locale and ResourceBundle
Class java.util.Locale represents a specific country or language of the world and is used in Java to retrieve other locale-dependent informations like numeric and date formats, the currency in use in a country and so on. Such kind of informations are accessed through special entities called resource bundles which are implemented by class java.util.ResourceBundle. Every resource bundle is identified by a full name which is built using four parameters: a base name (which is required), a language code, a country code and a variant (which are all optional). These three optional parameters are provided by an instance of Locale with its three corresponding getter methods: getLanguage(), getCountry() and getVariant(). Parameter language code is a lowercase ISO 639 2-letter code (like zh for Chinese, de for German and so on) while country code is an uppercase ISO 3166 2-letter code (like CN for China, DE for Germany and so on). The final full name will have the following structure (NOTE: tokens inside squared brackets are optional):<base name>[ <language code>[ <COUNTRY_CODE>[_<variant code>]]]
ResourceBundle is an abstract factory class, hence it exposes a number of factory methods named getBundle to load a concrete bundle. Without going into too much details we can say that a bundle corresponds to a file in the classpath. To find a file for a given bundle, getBundle needs first to generate an ordered list of candidate bundle names. These names are the set of all possible full names for a given bundle. For example if we have org.foo.MyBundle as base name and the current locale is the one seen before for Mandarin Chinese, the candidate names will be:
@@ -172,9 +172,10 @@
- org.foo.MyBundle_zh_CH
- org.foo.MyBundle_zh
- org.foo.MyBundle
-The list of these candidate names is generated starting from the most specific one and subtracting an optional parameter at each step. The last name of the list corresponds to the default resource bundle which is the most general name and is equal to the base name. Once that getBundle has generated the list of candidate names, it will iterate over them to find the first one for which is possible to load a class or a properties file. The class must be a subclass of ResourceBundle having as class name the full name used in the current iteration. If such a class is not found, getBundle will try to locate a properties file having a file name equals to the current full name (Java will automatically append extension .properties to the full name). For example given the resource bundle of the previous example, Java will search first for class org.foo.MyBundle_zh_CH_cmn and then for file MyBundle_zh_CH_cmn.properties inside package org.foo. If no file is found for any of the candidate names, a MissingResourceException will be thrown. Bundles contains local-dependent string resources identified by a key that is unique in the given bundle. So once we have obtained a valid bundle we can access these objects with method getString (String key).As we have seen before working with feedback messages, in Wicket most of the times we will work with properties files rather than with bundle classes. In chapter 10 we used a properties file having as base name the class name of the application class and without any information about the locale. This file is the default resource bundle for a Wicket application. In paragraph 12.4 we will explore the algorithm used in Wicket to locate the available bundles for a given component. Once we have learnt how to leverage this algorithm, we will be able to split our bundles into more files organized in a logical hierarchy.
+The list of these candidate names is generated starting from the most specific one and subtracting an optional parameter at each step. The last name of the list corresponds to the default resource bundle which is the most general name and is equal to the base name. Once that getBundle has generated the list of candidate names, it will iterate over them to find the first one for which is possible to load a class or a properties file. The class must be a subclass of ResourceBundle having as class name the full name used in the current iteration. If such a class is not found, getBundle will try to locate a properties file having a file name equals to the current full name (Java will automatically append extension .properties to the full name). For example given the resource bundle of the previous example, Java will search first for class org.foo.MyBundle_zh_CH_cmn and then for file MyBundle_zh_CH_cmn.properties inside package org.foo. If no file is found for any of the candidate names, a MissingResourceException will be thrown. Bundles contains local-dependent string resources identified by a key that is unique in the given bundle. So once we have obtained a valid bundle we can access these objects with method getString (String key).As we have seen before working with feedback messages, in Wicket most of the times we will work with properties files rather than with bundle classes. In paragraph 12.2 we used a properties file having as base name the class name of the application class and without any information about the locale. This file is the default resource bundle for a Wicket application. In paragraph 14.3 we will explore the algorithm used in Wicket to locate the available bundles for a given component. Once we have learnt how to leverage this algorithm, we will be able to split our bundles into more files organized in a logical hierarchy.
+
@@ -201,7 +202,7 @@
Index: guide/pages/i18n_2.html
===================================================================
--- guide/pages/i18n_2.html (revision 1675105)
+++ guide/pages/i18n_2.html (working copy)
@@ -151,7 +151,7 @@
14.2 Localization in Wicket - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -173,12 +173,12 @@
<!DOCTYPE properties SYSTEM
"http://www.oracle.com/webfolder/technetwork/jsc/dtd/properties.dtd">
<properties>
<entry key="greetingMessage">欢迎光临本网站！
</entry>
-
</properties> To use XML bundles in Wicket we don't need to put in place any additional configuration. The only rule we have to respect with these files is to use properties.xml as extension while their base name follows the same rules seen so far for bundle names.Reading bundles from code
Class Component makes reading bundles very easy with method getString(String key). This method searches for a resource with the given key looking into the resource bundles visited by the lookup algorithm illustrated in paragraph 12.4. For example if we have a greeting message with key greetingMessage in our application's resource bundle, we can read it from our component code with this instruction:getString("greetingMessage");Localization of bundles in Wicket
In chapter 10 we have used as resource bundle the properties file placed next to our application class. This file is the default resource bundle for the entire application and it is used by the lookup algorithm if it doesn't find any better match for a given component and locale. If we want to provide localized versions of this file we must simply follow the rules of Java i18n and put our translated resources into another properties file with a name corresponding to the desired locale. For example project LocalizedGreetings comes with the default application's properties file ( WicketApplication.properties) containing a greeting message:greetingMessage=Welcome to the site!
AbstractReadOnlyModel<String> model = new AbstractReadOnlyModel<String>() {
+</properties>Reading bundles from code
Class Component makes reading bundles very easy with method getString(String key). This method searches for a resource with the given key looking into the resource bundles visited by the lookup algorithm illustrated in paragraph 14.3. For example if we have a greeting message with key greetingMessage in our application's resource bundle, we can read it from our component code with this instruction:getString("greetingMessage");Localization of bundles in Wicket
In paragraph 12.2 we have used as resource bundle the properties file placed next to our application class. This file is the default resource bundle for the entire application and it is used by the lookup algorithm if it doesn't find any better match for a given component and locale. If we want to provide localized versions of this file we must simply follow the rules of Java i18n and put our translated resources into another properties file with a name corresponding to the desired locale. For example project LocalizedGreetings comes with the default application's properties file ( WicketApplication.properties) containing a greeting message:greetingMessage=Welcome to the site!
AbstractReadOnlyModel<String> model = new AbstractReadOnlyModel<String>() {
@Override
public String getObject() {
return getString("greetingMessage");
}
-};add(new Label("greetingMessage", model));org.apache.wicket.model.AbstractReadOnlyModel is a convenience class for implementing read-only models. In this project we have implemented a custom read-only model for illustrative purposes only because Wicket already provides built-in models for the same task. We will see them in paragraph 12.6.The rest of the code of the home page builds the stateless form and the drop-down menu used to change the locale.List<Locale> locales = Arrays.asList(Locale.ENGLISH, Locale.CHINESE, Locale.GERMAN);
+};add(new Label("greetingMessage", model));org.apache.wicket.model.AbstractReadOnlyModel is a convenience class for implementing read-only models. In this project we have implemented a custom read-only model for illustrative purposes only because Wicket already provides built-in models for the same task. We will see them in paragraph paragraph 14.5.The rest of the code of the home page builds the stateless form and the drop-down menu used to change the locale.List<Locale> locales = Arrays.asList(Locale.ENGLISH, Locale.CHINESE, Locale.GERMAN);
final DropDownChoice<Locale> changeLocale =
new DropDownChoice<Locale>("changeLocale", new Model<Locale>(), locales);StatelessForm form = new StatelessForm("form"){
@Override
@@ -218,7 +218,7 @@
Index: guide/pages/i18n_3.html
===================================================================
--- guide/pages/i18n_3.html (revision 1675105)
+++ guide/pages/i18n_3.html (working copy)
@@ -151,7 +151,7 @@
14.3 Bundles lookup algorithm - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -169,13 +169,13 @@
form.add(
new Label(
"anotherLabel",
new ResourceModel(
"labelValue")));
add(form);
Page bundle:labelValue=Default value
anotherLabel.labelValue=Value for anotherLabel
-form.anotherLabel.labelValue=Value for anotherLabel inside form
Package bundles
If no one of the previous steps can find a resource for the given key, the algorithm will look for package bundles. These bundles have wicket-package as base name and they can be placed in one of the package of our application:Packages are traversed starting from the one containing the component requesting for a resource and going up to the root package.Bundles for feedback messages
The algorithm described so far applies to feedback messages as well. In case of validation errors, the component that has caused the error will be considered as the component which the string resource is relative to. Furthermore, just like application class and components, validators can have their own bundles placed next to their class and having as base name their class name. This allows us to distribute validators along with the messages they use to report errors:Validator's resource bundles have the lowest priority in the lookup algorithm. They can be overwritten by resource bundles of components, packages and application class.Extending the default lookup algorithm
Wicket implements the default lookup algorithm using the strategy pattern1. The concrete strategies are abstracted with the interface org.apache.wicket.resource.loader.IStringResourceLoader. By default Wicket uses the following implementations of IStringResourceLoader (sorted by execution order):
+form.anotherLabel.labelValue=Value for anotherLabel inside formPackage bundles
If no one of the previous steps can find a resource for the given key, the algorithm will look for package bundles. These bundles have wicket-package as base name and they can be placed in one of the package of our application:Packages are traversed starting from the one containing the component requesting for a resource and going up to the root package.Bundles for feedback messages
The algorithm described so far applies to feedback messages as well. In case of validation errors, the component that has caused the error will be considered as the component which the string resource is relative to. Furthermore, just like application class and components, validators can have their own bundles placed next to their class and having as base name their class name. This allows us to distribute validators along with the messages they use to report errors:Validator's resource bundles have the lowest priority in the lookup algorithm. They can be overwritten by resource bundles of components, packages and application class.Extending the default lookup algorithm
Wicket implements the default lookup algorithm using the strategy pattern. The concrete strategies are abstracted with the interface org.apache.wicket.resource.loader.IStringResourceLoader. By default Wicket uses the following implementations of IStringResourceLoader (sorted by execution order):
- ComponentStringResourceLoader: implements most of the default algorithm. It searches for a given resource across bundles from the container hierarchy, from class hierarchy and from the given component.
- PackageStringResourceLoader: searches into package bundles.
- ClassStringResourceLoader: searches into bundles of a given class. By default the target class is the application class.
- ValidatorStringResourceLoader: searches for resources into validator's bundles. A list of validators is provided by the form component that failed validation.
-- InitializerStringResourceLoader: this resource allows internationalization to interact with the initialization mechanism of the framework that will be illustrated in paragraph 15.4.
+- InitializerStringResourceLoader: this resource allows internationalization to interact with the initialization mechanism of the framework that will be illustrated in paragraph 17.3.
Developer can customize lookup algorithm removing default resource loaders or adding custom implementations to the list of the resource loaders in use. This task can be accomplished using method getStringResourceLoaders of setting interface org.apache.wicket.settings.IResourceSettings:@Override
public void init()
{
@@ -213,7 +213,7 @@
Index: guide/pages/i18n_4.html
===================================================================
--- guide/pages/i18n_4.html (revision 1675105)
+++ guide/pages/i18n_4.html (working copy)
@@ -151,7 +151,7 @@
14.4 Localization of component's choices - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -183,8 +183,8 @@
green=Green
red=Red
blue=Blue
-yellow=Yellow
German bundle:selectColor.null=Wahlen sie eine farbe
-green=Grun
+yellow=Yellow
selectColor.null=Wählen Sie eine Farbe
+green=Grün
red=Rot
blue=Blau
yellow=Gelb
selectColor.null=Scegli un colore
@@ -191,9 +191,10 @@
green=Verde
red=Rosso
blue=Blu
-yellow=Giallo
14.5 Internationalization and Models - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
14.5 Internationalization and Models
-
Internationalization is another good chance to taste the power of models. Wicket provides two built-in models to better integrate our components with string resources: they are ResourceModel and StringResourceModel.
ResourceModel
Model
org.apache.wicket.model.ResourceModel acts just like the read-only model we have implemented in paragraph 12.3.4. It simply retrieves a string resource corresponding to a given key:
//build a ResourceModel for key 'greetingMessage'
+Internationalization is another good chance to taste the power of models. Wicket provides two built-in models to better integrate our components with string resources: they are ResourceModel and StringResourceModel.ResourceModel
Model org.apache.wicket.model.ResourceModel acts just like the read-only model we have implemented in paragraph 14.3. It simply retrieves a string resource corresponding to a given key://build a ResourceModel for key 'greetingMessage'
new ResourceModel("greetingMessage");//build a ResourceModel with a default value
new ResourceModel("notExistingResource", "Resource not found.");StringResourceModel
Model org.apache.wicket.model.StringResourceModel allows to work with complex and dynamic string resources containing parameters and property expressions. The basic constructor of this model takes in input a resource key and another model. This further model can be used by both the key and the related resource to specify dynamic values with property expressions. For example let's say that we are working on an e-commerce site which has a page where users can see an overview of their orders. To handle the state of user's orders we will use the following bean and enum (the code is from project StringResourceModelExample):Bean:public class Order implements Serializable { private Date orderDate;
private ORDER_STATUS status; public Order(Date orderDate, ORDER_STATUS status) {
@@ -186,6 +186,7 @@
StringResourceModel srm = new StringResourceModel("orderStatus.delay", null, propertyModel, 3);orderStatus.delay=Your order submitted on ${0} has been delayed by {1} days.new StringResourceModel("myKey", myComponent, myModel, param1, param2, param3,...);
14.6 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/jee_1.html
===================================================================
--- guide/pages/jee_1.html (revision 1675105)
+++ guide/pages/jee_1.html (working copy)
@@ -151,7 +151,7 @@
19.1 Integrating Wicket with EJB - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -208,7 +208,7 @@
Index: guide/pages/jee_2.html
===================================================================
--- guide/pages/jee_2.html (revision 1675105)
+++ guide/pages/jee_2.html (working copy)
@@ -151,7 +151,7 @@
19.2 Integrating Wicket with Spring - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -214,7 +214,7 @@
Index: guide/pages/jee_3.html
===================================================================
--- guide/pages/jee_3.html (revision 1675105)
+++ guide/pages/jee_3.html (working copy)
@@ -151,7 +151,7 @@
19.3 JSR-330 annotations - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -164,10 +164,12 @@
19.3 JSR-330 annotations
Spring (and Guice) users can use standard
JSR-330 annotations to wire their dependencies. This will make their code more interoperable with other containers that support this standard:
//inject a bean specifying its name with JSR-330 annotations
- Inject Named("anotherName")
+ @Inject
+ @Named("anotherName")
private EnterpriseMessage enterpriseMessage;
+
@@ -194,7 +196,7 @@
Index: guide/pages/jee_4.html
===================================================================
--- guide/pages/jee_4.html (revision 1675105)
+++ guide/pages/jee_4.html (working copy)
@@ -151,7 +151,7 @@
19.4 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/jsintegration_1.html
===================================================================
--- guide/pages/jsintegration_1.html (revision 1675105)
+++ guide/pages/jsintegration_1.html (working copy)
@@ -151,7 +151,7 @@
16.1 What we want to do... - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -199,7 +199,7 @@
Index: guide/pages/jsintegration_2.html
===================================================================
--- guide/pages/jsintegration_2.html (revision 1675105)
+++ guide/pages/jsintegration_2.html (working copy)
@@ -151,7 +151,7 @@
16.2 ...and how we will do it - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -198,7 +198,7 @@
}
@Override
public <Date> IConverter<Date> getConverter(
Class<Date> type) {
return (IConverter<Date>) dateConverter;
-}
The first thing to do inside onInitialize is to ensure that our component will have a markup id for its related text field. This is done invoking setOutputMarkupId(true).
Next, JQueryDateField tries to retrieve the date format and the ISO language code that must be used as initialization parameters. This is done using class
ResourceModel which searches for a given resource in the available bundles. If no value is found for date format or for ISO language code, default values will be used ('mm/dd/yy' and 'en-GB').
To generate the relative URL for calendar icon, we load it as package resource reference and then we use
Component's method urlFor to get the URL value (we have seen this method in paragraph 7.3.2).
The last configuration instruction executed inside onInitialize is the instantiation of the custom converter used by our component. This converter is an instance of the built-in class
org.apache.wicket.datetime.PatternDateConvert and must use the previously retrieved date format to perform conversion operations. Now to tell our component to use this converter we must return it overriding
FormComponent's method
getConverter.
Header contributor code
The rest of the code of our custom component is inside method
renderHeader, which is responsible for adding to page header the bundled JQuery library, the three files from JQuery UI distribution, the custom file JQDatePicker.js and the invocation of function
initJQDatepicker:
The first thing to do inside onInitialize is to ensure that our component will have a markup id for its related text field. This is done invoking setOutputMarkupId(true).
Next, JQueryDateField tries to retrieve the date format and the ISO language code that must be used as initialization parameters. This is done using class
ResourceModel which searches for a given resource in the available bundles. If no value is found for date format or for ISO language code, default values will be used ('mm/dd/yy' and 'en-GB').
To generate the relative URL for calendar icon, we load it as package resource reference and then we use
Component's method urlFor to get the URL value (we have seen this method in
paragraph 9.3.2).
The last configuration instruction executed inside onInitialize is the instantiation of the custom converter used by our component. This converter is an instance of the built-in class
org.apache.wicket.datetime.PatternDateConvert and must use the previously retrieved date format to perform conversion operations. Now to tell our component to use this converter we must return it overriding
FormComponent's method
getConverter.
Header contributor code
The rest of the code of our custom component is inside method
renderHeader, which is responsible for adding to page header the bundled JQuery library, the three files from JQuery UI distribution, the custom file JQDatePicker.js and the invocation of function
initJQDatepicker:
@Override
public void renderHead(IHeaderResponse response) {
super.renderHead(response); //if component is disabled we don't have to load the JQueryUI datepicker
if(!isEnabledInHierarchy())
@@ -224,10 +224,11 @@
}If component is disabled the calendar icon must be hidden and no datepicker must be displayed. That's why
renderHeader is skipped if component is not enabled.
To get a reference to the bundled JQuery library we used the JavaScript setting interface
IJavaScriptLibrarySettings and its method
getJQueryReference.
In the last part of
renderHeader we build the string to invoke function
initJQDatepicker using the values obtained inside onInitialize. Unfortunately the date format used by JQuery UI is different from the one adopted in Java so we have to convert it before building the JavaScript code. This init script is rendered into header section using a
OnLoadHeaderItem to ensure that it will be executed after all the other scripts have been loaded.
If we add more than one instance of our custom component to a single page, static resources are rendered to the header section just once. Wicket automatically checks if a static resource is already referenced by a page and if so, it will not render it again.This does not apply to the init script which is dynamically generated and is rendered for every instance of the component.
-Our datepicker is not ready yet to be used with AJAX. In chapter 16 we will see how to modify it to make it AJAX-compatible.
+Our datepicker is not ready yet to be used with AJAX. In chapter 18 we will see how to modify it to make it AJAX-compatible.
+
@@ -254,7 +255,7 @@
Index: guide/pages/jsintegration_3.html
===================================================================
--- guide/pages/jsintegration_3.html (revision 1675105)
+++ guide/pages/jsintegration_3.html (working copy)
@@ -151,7 +151,7 @@
16.3 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/keepControl_1.html
===================================================================
--- guide/pages/keepControl_1.html (revision 1675105)
+++ guide/pages/keepControl_1.html (working copy)
@@ -151,7 +151,7 @@
6.1 Hiding or disabling a component - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/keepControl_10.html
===================================================================
--- guide/pages/keepControl_10.html (revision 1675105)
+++ guide/pages/keepControl_10.html (working copy)
@@ -151,7 +151,7 @@
6.10 Surrounding existing markup with Border - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -229,7 +229,7 @@
Index: guide/pages/keepControl_11.html
===================================================================
--- guide/pages/keepControl_11.html (revision 1675105)
+++ guide/pages/keepControl_11.html (working copy)
@@ -151,7 +151,7 @@
6.11 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/keepControl_2.html
===================================================================
--- guide/pages/keepControl_2.html (revision 1675105)
+++ guide/pages/keepControl_2.html (working copy)
@@ -151,7 +151,7 @@
6.2 Modifing tag attributes - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -195,7 +195,7 @@
Index: guide/pages/keepControl_3.html
===================================================================
--- guide/pages/keepControl_3.html (revision 1675105)
+++ guide/pages/keepControl_3.html (working copy)
@@ -151,7 +151,7 @@
6.3 Generating tag attribute 'id' - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/keepControl_4.html
===================================================================
--- guide/pages/keepControl_4.html (revision 1675105)
+++ guide/pages/keepControl_4.html (working copy)
@@ -151,7 +151,7 @@
6.4 Creating in-line panels with WebMarkupContainer - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -199,7 +199,7 @@
Index: guide/pages/keepControl_5.html
===================================================================
--- guide/pages/keepControl_5.html (revision 1675105)
+++ guide/pages/keepControl_5.html (working copy)
@@ -151,7 +151,7 @@
6.5 Working with markup fragments - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -215,7 +215,7 @@
Index: guide/pages/keepControl_6.html
===================================================================
--- guide/pages/keepControl_6.html (revision 1675105)
+++ guide/pages/keepControl_6.html (working copy)
@@ -151,7 +151,7 @@
6.6 Adding header contents to the final page - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -212,7 +212,7 @@
Index: guide/pages/keepControl_7.html
===================================================================
--- guide/pages/keepControl_7.html (revision 1675105)
+++ guide/pages/keepControl_7.html (working copy)
@@ -151,7 +151,7 @@
6.7 Using stub markup in our pages/panels - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -199,7 +199,7 @@
Index: guide/pages/keepControl_8.html
===================================================================
--- guide/pages/keepControl_8.html (revision 1675105)
+++ guide/pages/keepControl_8.html (working copy)
@@ -151,7 +151,7 @@
6.8 How to render component body only - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -208,7 +208,7 @@
Index: guide/pages/keepControl_9.html
===================================================================
--- guide/pages/keepControl_9.html (revision 1675105)
+++ guide/pages/keepControl_9.html (working copy)
@@ -151,7 +151,7 @@
6.9 Hiding decorating elements with the wicket:enclosure tag - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -202,7 +202,7 @@
Index: guide/pages/layout_1.html
===================================================================
--- guide/pages/layout_1.html (revision 1675105)
+++ guide/pages/layout_1.html (working copy)
@@ -151,7 +151,7 @@
5.1 Header, footer, left menu, content, etc... - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -200,7 +200,7 @@
Index: guide/pages/layout_2.html
===================================================================
--- guide/pages/layout_2.html (revision 1675105)
+++ guide/pages/layout_2.html (working copy)
@@ -151,7 +151,7 @@
5.2 Here comes the inheritance! - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -218,7 +218,7 @@
Index: guide/pages/layout_3.html
===================================================================
--- guide/pages/layout_3.html (revision 1675105)
+++ guide/pages/layout_3.html (working copy)
@@ -151,7 +151,7 @@
5.3 Divide et impera! - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -277,7 +277,7 @@
Index: guide/pages/layout_4.html
===================================================================
--- guide/pages/layout_4.html (revision 1675105)
+++ guide/pages/layout_4.html (working copy)
@@ -151,7 +151,7 @@
5.4 Markup inheritance with the wicket:extend tag - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -253,7 +253,7 @@
Index: guide/pages/layout_5.html
===================================================================
--- guide/pages/layout_5.html (revision 1675105)
+++ guide/pages/layout_5.html (working copy)
@@ -151,7 +151,7 @@
5.5 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/maven_1.html
===================================================================
--- guide/pages/maven_1.html (revision 1675105)
+++ guide/pages/maven_1.html (working copy)
@@ -151,7 +151,7 @@
26.1 Switching Wicket to DEPLOYMENT mode - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,12 +163,12 @@
26.1 Switching Wicket to DEPLOYMENT mode
-
As pointed out in the note at page 9, Wicket can be started in two modes, DEVELOPMENT and DEPLOYMENT. When we are in DEVELOPMENT mode Wicket warns us at application startup with the following message:
********************************************************************
+As pointed out in the note in paragraph 4.2, Wicket can be started in two modes, DEVELOPMENT and DEPLOYMENT. When we are in DEVELOPMENT mode Wicket warns us at application startup with the following message:********************************************************************
*** WARNING: Wicket is running in DEVELOPMENT mode. ***
*** ^^^^^^^^^^^ ***
*** Do NOT deploy to your live server(s) without changing this. ***
*** See Application#getConfigurationType() for more information. ***
-********************************************************************
<filter>
+********************************************************************
<filter>
<filter-name>wicket.MyApp</filter-name>
<filter-class>org.apache.wicket.protocol.http.WicketFilter</filter-class>
<init-param>
@@ -182,9 +182,10 @@
</filter>
<context-param>
<param-name>configuration</param-name>
<param-value>deployment</param-value>
-</context-param>java -Dwicket.configuration=deployment ...
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:
java -Dwicket.configuration=deployment ...
The last option is to set it in your Java code (e.g. in the init-method of your WebApplication):
setConfigurationType(RuntimeConfigurationType.DEPLOYMENT);
Remember that system properties overwrite other settings, so they are ideal to ensure that on production machine the running mode will be always set to DEPLOYMENT.
+
@@ -211,7 +212,7 @@
Index: guide/pages/maven_2.html
===================================================================
--- guide/pages/maven_2.html (revision 1675105)
+++ guide/pages/maven_2.html (working copy)
@@ -151,7 +151,7 @@
26.2 Creating a Wicket project from scratch and importing it into our favourite IDE - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -167,7 +167,7 @@
In order to follow the instructions of this paragraph you must have Maven installed on your system. The installation of Maven is out of the scope of this guide but you can easily find an extensive documentation about it on Internet.
Another requirement is a good Internet connection (a flat ADSL is enough) because Maven needs to connect to its central repository to download the required dependencies.
-
From Maven to our IDE
Wicket project and its dependencies are managed using Maven1. This tool is very useful also when we want to create a new project based on Wicket from scratch. With a couple of shell commands we can generate a new project properly configured and ready to be imported into our favourite IDE.
+
From Maven to our IDE
Wicket project and its dependencies are managed using Maven. This tool is very useful also when we want to create a new project based on Wicket from scratch. With a couple of shell commands we can generate a new project properly configured and ready to be imported into our favourite IDE.
The main step to create such a project is to run the command which generates project's structure and its artifacts. If we are not familiar with Maven or we simply don't want to type this command by hand, we can use the utility form on Wicket site at
http://wicket.apache.org/start/quickstart.html :
Here we have to specify the root package of our project (GroupId), the project name (ArtifactId) and which version of Wicket we want to use (Version).
Once we have run the resulting command in the OS shell, we will have a new folder with the same name of the project (i.e the ArtifactId). Inside this folder we can find a file called pom.xml. This is the main file used by Maven to manage our project. For example, using “org.wicketTutorial” as GroupId and “MyProject” as ArtifactId, we would obtain the following artifacts:
.MyProject
| pom.xml
@@ -222,7 +222,7 @@
If we modify the pom.xml file (for example adding further dependencies) we must regenerate project's artifacts and refresh the project (F5 key) to reflect changes into Eclipse.
Speeding up development with plugins.
Now that we have our project loaded into our IDE we could start coding our components directly by hand. However it would be a shame to not leverage the free and good Wicket plugins available for our IDE. The following is a brief overview of the most widely used plugins for each of the three main IDEs considered so far.NetBeans
-NetBeans offers Wicket support thought 'NetBeans Plugin for Wicket' hosted at http://java.net/projects/nbwicketsupport/ . This plugin is released under CDDL-1.0 license.
+NetBeans offers Wicket support through 'NetBeans Plugin for Wicket' hosted at http://plugins.netbeans.org/plugin/3586/wicket-1-4-support . This plugin is released under CDDL-1.0 license.
You can find a nice introduction guide to this plugin at http://netbeans.org/kb/docs/web/quickstart-webapps-wicket.html .Intellj IDEA
For JetBrain IDEA we can use WicketForge plugin, hosted at Google Code 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/ .
@@ -229,6 +229,7 @@
QWickie is released under ASF 2.0 license.
+
@@ -255,7 +256,7 @@
Index: guide/pages/modelsforms_1.html
===================================================================
--- guide/pages/modelsforms_1.html (revision 1675105)
+++ guide/pages/modelsforms_1.html (working copy)
@@ -151,7 +151,7 @@
11.1 What is a model? - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -177,10 +177,11 @@
return new Date().toString();
}
};
add(
new Label(
"timeStamp", timeStampModel));
Even if sometimes writing a custom model could be a good choice to solve a specific problem, Wicket already provides a set of IModel implementations which should fit most of our needs. In the next paragraph we will see a couple of models that allow us to easily integrate JavaBeans with our web applications and in particular with our forms.
-By default class Component escapes HTML sensitive characters (like '<', '>' or '&') from the textual representation of its model object. The term 'escape' means that these characters will be replaced with their corresponding HTML entity (for example '<' becomes '< '). This is done for security reasons as a malicious user could attempt to inject markup or JavaScript into our pages. If we want to display the raw content stored inside a model, we can tell the Component class not to escape characters by calling the setEscapeModelStrings(false) method.
+By default the class Component escapes HTML sensitive characters (like '<', '>' or '&') from the textual representation of its model object. The term 'escape' means that these characters will be replaced with their corresponding HTML entity (for example '<' becomes '< '). This is done for security reasons as a malicious user could attempt to inject markup or JavaScript into our pages. If we want to display the raw content stored inside a model, we can tell the Component class not to escape characters by calling the setEscapeModelStrings(false) method.
+
@@ -207,7 +208,7 @@
Index: guide/pages/modelsforms_2.html
===================================================================
--- guide/pages/modelsforms_2.html (revision 1675105)
+++ guide/pages/modelsforms_2.html (working copy)
@@ -151,7 +151,7 @@
11.2 Models and JavaBeans - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -222,7 +222,7 @@
Index: guide/pages/modelsforms_3.html
===================================================================
--- guide/pages/modelsforms_3.html (revision 1675105)
+++ guide/pages/modelsforms_3.html (working copy)
@@ -151,7 +151,7 @@
11.3 Wicket forms - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -264,7 +264,7 @@
Index: guide/pages/modelsforms_4.html
===================================================================
--- guide/pages/modelsforms_4.html (revision 1675105)
+++ guide/pages/modelsforms_4.html (working copy)
@@ -151,7 +151,7 @@
11.4 Component DropDownChoice - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -208,7 +208,7 @@
Index: guide/pages/modelsforms_5.html
===================================================================
--- guide/pages/modelsforms_5.html (revision 1675105)
+++ guide/pages/modelsforms_5.html (working copy)
@@ -151,7 +151,7 @@
11.5 Model chaining - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -248,7 +248,7 @@
Index: guide/pages/modelsforms_6.html
===================================================================
--- guide/pages/modelsforms_6.html (revision 1675105)
+++ guide/pages/modelsforms_6.html (working copy)
@@ -151,7 +151,7 @@
11.6 Detachable models - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -220,7 +220,7 @@
Index: guide/pages/modelsforms_7.html
===================================================================
--- guide/pages/modelsforms_7.html (revision 1675105)
+++ guide/pages/modelsforms_7.html (working copy)
@@ -151,7 +151,7 @@
11.7 Using more than one model in a component - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -205,7 +205,7 @@
Index: guide/pages/modelsforms_8.html
===================================================================
--- guide/pages/modelsforms_8.html (revision 1675105)
+++ guide/pages/modelsforms_8.html (working copy)
@@ -151,7 +151,7 @@
11.8 Use models! - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -203,7 +203,7 @@
Index: guide/pages/modelsforms_9.html
===================================================================
--- guide/pages/modelsforms_9.html (revision 1675105)
+++ guide/pages/modelsforms_9.html (working copy)
@@ -151,7 +151,7 @@
11.9 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/nativewebsockets_1.html
===================================================================
--- guide/pages/nativewebsockets_1.html (revision 1675105)
+++ guide/pages/nativewebsockets_1.html (working copy)
@@ -151,7 +151,7 @@
20.1 How does it work ? - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -195,7 +195,7 @@
Index: guide/pages/nativewebsockets_2.html
===================================================================
--- guide/pages/nativewebsockets_2.html (revision 1675105)
+++ guide/pages/nativewebsockets_2.html (working copy)
@@ -151,7 +151,7 @@
20.2 How to use - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -262,7 +262,7 @@
Index: guide/pages/nativewebsockets_3.html
===================================================================
--- guide/pages/nativewebsockets_3.html (revision 1675105)
+++ guide/pages/nativewebsockets_3.html (working copy)
@@ -151,7 +151,7 @@
20.3 Client-side APIs - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -202,7 +202,7 @@
Index: guide/pages/nativewebsockets_4.html
===================================================================
--- guide/pages/nativewebsockets_4.html (revision 1675105)
+++ guide/pages/nativewebsockets_4.html (working copy)
@@ -151,7 +151,7 @@
20.4 Testing - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -194,7 +194,7 @@
Index: guide/pages/nativewebsockets_5.html
===================================================================
--- guide/pages/nativewebsockets_5.html (revision 1675105)
+++ guide/pages/nativewebsockets_5.html (working copy)
@@ -151,7 +151,7 @@
20.5 Differences with Wicket-Atmosphere module. - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/nativewebsockets_6.html
===================================================================
--- guide/pages/nativewebsockets_6.html (revision 1675105)
+++ guide/pages/nativewebsockets_6.html (working copy)
@@ -151,7 +151,7 @@
20.6 FAQ - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -194,7 +194,7 @@
Index: guide/pages/pagestoring.html
===================================================================
--- guide/pages/pagestoring.html (revision 1675105)
+++ guide/pages/pagestoring.html (working copy)
@@ -151,7 +151,7 @@
25.1 Page storing - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -174,7 +174,8 @@
data :
byte[]
}
i.e. this is the serialized page instance (data) plus additional information needed to be able to easily find it later (sessionId, pageId).
When a
SerializedPage has to be stored
DefaultPageStore stores it in a application scoped cache ({sessionId, pageId} -> SerializedPage) and additionally gives it to the underlying
IDataStore#storeData(sessionId, pageId, data). The application scoped cache is used as second level cache. Getting a page from it is slower than the http session based cache in
PageStoreManager because the page has to be deserialized, but is faster than the underlying
IDataStore which stores the page bytes in some persistent store.
The size of the application scoped cache is configurable via
org.apache.wicket.settings.IStoreSettings.setInmemoryCacheSize(int).
IDataStore
org.apache.wicket.pageStore.IDataStore is used to persist Wicket pages (as bytes) to a persistent store like e.g. files or databases. The default implementation is
org.apache.wicket.pageStore.DiskDataStore which as its name says stores the pages in files. The location of the folder where the files are stored is configurable via
org.apache.wicket.settings.IStoreSettings.setFileStoreFolder(File), by default the web container's work folder is used (ServletContext attribute 'javax.servlet.context.tempdir'). In this folder a sub-folder is created named
'applicationName-filestore'.
This folder contains a sub-folder for each active http session. This session folder contains a single file named 'data' which contains the bytes for the pages. The size of this 'data' file is configurable via
org.apache.wicket.settings.IStoreSettings.setMaxSizePerSession(Bytes). When this size is exceeded the newly stored files overwrite the oldest ones.
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.IStoreSettings.setAsynchronous(false). AsynchronousDataStore can delay the storage of pages' bytes for at most
org.apache.wicket.settings.IStoreSettings.setAsynchronousQueueCapacity(int) pages. If this capacity is exceeded then the page's bytes are written synchronously to the backing
IDataStore.
DebugDiskDataStore
Wicket provides an extension of
DiskDataStore that can be used to browse the content of the 'data' files created by
DiskDataStore. This debug enabled
DiskDataStore is automatically setup when wicket-devutils.jar is in the classpath.
+To disable it use:
org.apache.wicket.settings.IStoreSettings.setAsynchronous(false). AsynchronousDataStore can delay the storage of pages' bytes for at most
org.apache.wicket.settings.IStoreSettings.setAsynchronousQueueCapacity(int) pages. If this capacity is exceeded then the page's bytes are written synchronously to the backing
IDataStore.
DebugDiskDataStore
Wicket provides an extension of
DiskDataStore that can be used to browse the content of the 'data' files created by
DiskDataStore. This extension can be found in wicket-devutils.jar and needs to be enabled in the
init-method of your application via
+
DebugDiskDataStore.register(this);
The debug information can be seen at http://host:port/context/wicket/internal/debug/diskDataStore
HttpSessionDataStore
In some environments like Google AppEngine it is not allowed to write to the file system and thus
DiskDataStore cannot be used. In this case
org.apache.wicket.pageStore.memory.HttpSessionDataStore can be used as replacement. This implementation of
IDataStore is not persistent and puts all the data in the http session.
Wicket comes with 2 default eviction strategies to keep the size of the http session reasonable:
@@ -190,9 +191,12 @@
return new HttpSessionDataStore(pageManagerContext, new PageNumberEvictionStrategy(20));
}
}
-}
+}
DebugBar
Further insights which can be valueable during debugging can be retrieved using the
org.apache.wicket.devutils.debugbar.DebugBar from wicket-devutils.jar. It's a panel which you simply add:
Java:
+
add(new DebugBar("debug"));HTML:
+
<span wicket:id="debug"/>
+
@@ -219,7 +223,7 @@
Index: guide/pages/repeaters_1.html
===================================================================
--- guide/pages/repeaters_1.html (revision 1675105)
+++ guide/pages/repeaters_1.html (working copy)
@@ -151,7 +151,7 @@
13.1 The RepeatingView Component - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -204,7 +204,7 @@
Index: guide/pages/repeaters_2.html
===================================================================
--- guide/pages/repeaters_2.html (revision 1675105)
+++ guide/pages/repeaters_2.html (working copy)
@@ -151,7 +151,7 @@
13.2 The ListView Component - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -211,7 +211,7 @@
Index: guide/pages/repeaters_3.html
===================================================================
--- guide/pages/repeaters_3.html (revision 1675105)
+++ guide/pages/repeaters_3.html (working copy)
@@ -151,7 +151,7 @@
13.3 The RefreshingView Component - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -215,7 +215,7 @@
Index: guide/pages/repeaters_4.html
===================================================================
--- guide/pages/repeaters_4.html (revision 1675105)
+++ guide/pages/repeaters_4.html (working copy)
@@ -151,7 +151,7 @@
13.4 Pageable repeaters - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
13.4 Pageable repeaters
-
Wicket offers a number of components that should be used when we have to display a big number of items (for example the results of a select SQL query).
All these components implement interface
org.apache.wicket.markup.html.navigation.paging.IPageable and use interface
IDataProvider (placed in package
org.apache.wicket.markup.repeater.data) as data source. This interface is designed to support data paging. We will see an example of data paging later in paragraph 11.4.2.
The methods defined by IDataProvider are the following:
+
Wicket offers a number of components that should be used when we have to display a big number of items (for example the results of a select SQL query).
All these components implement interface
org.apache.wicket.markup.html.navigation.paging.IPageable and use interface
IDataProvider (placed in package
org.apache.wicket.markup.repeater.data) as data source. This interface is designed to support data paging. We will see an example of data paging later in
paragraph 13.4.2.
The methods defined by IDataProvider are the following:
- iterator(long first, long count): returns an iterator over a subset of the entire dataset. The subset starts from the item at position first and includes all the next count items (i.e. it's the closed interval first,first+count).
- size(): gets the size of the entire dataset.
@@ -246,7 +246,7 @@
Index: guide/pages/repeaters_5.html
===================================================================
--- guide/pages/repeaters_5.html (revision 1675105)
+++ guide/pages/repeaters_5.html (working copy)
@@ -151,7 +151,7 @@
13.5 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/requestProcessing_1.html
===================================================================
--- guide/pages/requestProcessing_1.html (revision 1675105)
+++ guide/pages/requestProcessing_1.html (working copy)
@@ -151,7 +151,7 @@
9.1 Class Application and request processing - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/requestProcessing_2.html
===================================================================
--- guide/pages/requestProcessing_2.html (revision 1675105)
+++ guide/pages/requestProcessing_2.html (working copy)
@@ -151,7 +151,7 @@
9.2 Request and Response classes - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/requestProcessing_3.html
===================================================================
--- guide/pages/requestProcessing_3.html (revision 1675105)
+++ guide/pages/requestProcessing_3.html (working copy)
@@ -151,7 +151,7 @@
9.3 The “director” of request processing - RequestCycle - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
9.3 The “director” of request processing - RequestCycle
-
Class
org.apache.wicket.request.cycle.RequestCycle is the entity in charge of serving a web request. Our application class creates a new
RequestCycle on every request with its method
createRequestCycle(request, response).
Method
createRequestCycle is declared as final, so we can't override it to return a custom subclass of
RequestCycle. Instead, we must build a request cycle provider implementing interface
org.apache.wicket.IRequestCycleProvider, and then we must tell our application class to use it via the
setRequestCycleProvider method.
The current running request cycle can be retrieved at any time by calling its static method
RequestCycle.get(). Strictly speaking this method returns the request cycle associated with the current (or local) thread, which is the thread that is serving the current request. A similar
get() method is also implemented in classes
org.apache.wicket.Application (as we have seen in paragraph 2.2.2) and
org.apache.wicket.Session in order to get the application and the session in use by the current thread.
+Class org.apache.wicket.request.cycle.RequestCycle is the entity in charge of serving a web request. Our application class creates a new RequestCycle on every request with its method createRequestCycle(request, response).Method createRequestCycle is declared as final, so we can't override it to return a custom subclass of RequestCycle. Instead, we must build a request cycle provider implementing interface org.apache.wicket.IRequestCycleProvider, and then we must tell our application class to use it via the setRequestCycleProvider method.The current running request cycle can be retrieved at any time by calling its static method RequestCycle.get(). Strictly speaking this method returns the request cycle associated with the current (or local) thread, which is the thread that is serving the current request. A similar get() method is also implemented in classes org.apache.wicket.Application (as we have seen in paragraph 4.2.2) and org.apache.wicket.Session in order to get the application and the session in use by the current thread.
The implementation of the get method takes advantage of the standard class java.lang.ThreadLocal. See its JavaDoc for an introduction to local-thread variables.
Class org.apache.wicket.Component provides the getRequestCycle() method which is a convenience method that internally invokes RequestCycle.get():public final RequestCycle getRequestCycle() {
return RequestCycle.get();
@@ -173,8 +173,8 @@
- a page class, via the
urlFor(Class<C> pageClass, PageParameters parameters) method
- an IRequestHandler via the
urlFor(IRequestHandler handler) method
-- a ResourceReference via the
urlFor(ResourceReference reference, PageParameters params) method (resource entities will be introduced in chapter 13).
-
The overloaded
urlFor method from above also has a corresponding version that returns an instance of
org.apache.wicket.request.Url instead of a
CharSequence. This version has the prefix 'map' in its name (i.e. it has
mapUrlFor as full name).
Method setResponsePage
The
RequestCycle class contains the implementation of the
setResponsePage method we use to redirect a user to a specific page (see paragraph 2.4). The namesake method of class
org.apache.wicket.Component is just a convenience method that internally invokes the actual implementation on current request cycle:
public final void setResponsePage(final Page page) {
+- a ResourceReference via the
urlFor(ResourceReference reference, PageParameters params) method (resource entities will be introduced in chapter 15).
+
The overloaded
urlFor method from above also has a corresponding version that returns an instance of
org.apache.wicket.request.Url instead of a
CharSequence. This version has the prefix 'map' in its name (i.e. it has
mapUrlFor as full name).
Method setResponsePage
The
RequestCycle class contains the implementation of the
setResponsePage method we use to redirect a user to a specific page (see
paragraph 4.4). The namesake method of class
org.apache.wicket.Component is just a convenience method that internally invokes the actual implementation on current request cycle:
public final void setResponsePage(final Page page) {
getRequestCycle().setResponsePage(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:
@@ -225,7 +225,7 @@
Index: guide/pages/requestProcessing_4.html
===================================================================
--- guide/pages/requestProcessing_4.html (revision 1675105)
+++ guide/pages/requestProcessing_4.html (working copy)
@@ -151,7 +151,7 @@
9.4 Session Class - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -172,7 +172,7 @@
- setAttribute(String name, Serializable value): creates an attribute identified by the given name. If the session already contains an attribute with the same name, the new value will replace the existing one. The value must be a serializable object.
- getAttribute(String name): returns the value of the attribute identified by the given name, or null if the name does not correspond to any attribute.
- removeAttribute(String name): removes the attribute identified by the given name.
-
By default class WebSession will use the underlying http session to store attributes. Wicket will automatically add a prefix to the name of the attributes. This prefix is returned by the WebApplication's method getSessionAttributePrefix().
Accessing to the HTTP session
If for any reason we need to directly access to the underlying HttpSession object, we can retrieve it from the current request with the following code:
HttpSession session = ((ServletWebRequest)RequestCycle.get()
+By default class WebSession will use the underlying HTTP session to store attributes. Wicket will automatically add a prefix to the name of the attributes. This prefix is returned by the WebApplication's method getSessionAttributePrefix().Accessing to the HTTP session
If for any reason we need to directly access to the underlying HttpSession object, we can retrieve it from the current request with the following code:HttpSession session = ((ServletWebRequest)RequestCycle.get()
.getRequest()).getContainerRequest().getSession();
Tomcat allows us to set the values that will be displayed in columns “Guessed locale” and “Guessed User name”. One possible way to do this is to use session attributes named “Locale” and “userName” but we can't create them via Wicket's Session class because they would not have exactly the name required by Tomcat. Instead, we must use the raw HttpSession and set our attributes on it:HttpSession session = ((ServletWebRequest)RequestCycle.get().
getRequest()).getContainerRequest().getSession();session.setAttribute("Locale", "ENGLISH");
session.setAttribute("userName", "Mr BadGuy");Temporary and permanent sessions
Wicket doesn't need to store data into user session as long as the user visits only stateless pages. Nonetheless, even under these conditions, a temporary session object is created to process each request but it is discarded at the end of the current request. To know if the current session is temporary, we can use the isTemporary() method:Session.get().isTemporary();
9.5 Exception handling - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -205,7 +205,7 @@
Index: guide/pages/requestProcessing_6.html
===================================================================
--- guide/pages/requestProcessing_6.html (revision 1675105)
+++ guide/pages/requestProcessing_6.html (working copy)
@@ -151,7 +151,7 @@
9.6 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,9 +163,10 @@
9.6 Summary
-
In this chapter we had a look at how Wicket internally handles a web request. Even if most of the time we won't need to customize this internal process, knowing how it works is essential to use the framework at 100%.
Entities like Application and Session will come in handy again when we will tackle the topic of security in chapter 20.
+
In this chapter we had a look at how Wicket internally handles a web request. Even if most of the time we won't need to customize this internal process, knowing how it works is essential to use the framework at 100%.
Entities like Application and Session will come in handy again when we will tackle the topic of security in
chapter 21.
+
@@ -192,7 +193,7 @@
Index: guide/pages/resources_1.html
===================================================================
--- guide/pages/resources_1.html (revision 1675105)
+++ guide/pages/resources_1.html (working copy)
@@ -151,7 +151,7 @@
15.1 Static vs dynamic resources - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,9 +163,10 @@
15.1 Static vs dynamic resources
-
In Wicket a resource is an entity that can interact with the current request and response and It must implement interface
org.apache.wicket.request.resource.IResource. This interface defines just method respond(IResource.Attributes attributes) where the nested class IResource. Attributes provides access to request, response and page parameters objects.
Resources can be static or dynamic. Static resources don't entail any computational effort to be generated and they generally correspond to a resource on the filesystem. On the contrary dynamic resources are generated on the fly when they are requested, following a specific logic coded inside them.
An example of dynamic resource is the built-in class CaptchaImageResource in package
org.apache.wicket.extensions.markup.html.captcha which generates a captcha image each time is rendered.
As we will see in paragraph 13.6, developers can build custom resources extending base class
org.apache.wicket.request.resource.AbstractResource.
+
In Wicket a resource is an entity that can interact with the current request and response and It must implement interface
org.apache.wicket.request.resource.IResource. This interface defines just method respond(IResource.Attributes attributes) where the nested class IResource. Attributes provides access to request, response and page parameters objects.
Resources can be static or dynamic. Static resources don't entail any computational effort to be generated and they generally correspond to a resource on the filesystem. On the contrary dynamic resources are generated on the fly when they are requested, following a specific logic coded inside them.
An example of dynamic resource is the built-in class CaptchaImageResource in package
org.apache.wicket.extensions.markup.html.captcha which generates a captcha image each time is rendered.
As we will see in
paragraph 15.10, developers can build custom resources extending base class
org.apache.wicket.request.resource.AbstractResource.
+
@@ -192,7 +193,7 @@
Index: guide/pages/resources_10.html
===================================================================
--- guide/pages/resources_10.html (revision 1675105)
+++ guide/pages/resources_10.html (working copy)
@@ -151,7 +151,7 @@
15.10 Custom resources - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
15.10 Custom resources
-
In Wicket the best way to add dynamic functionalities to our application (such as csv export, a pdf generated on the fly, etc...) is implementing a custom resource. In this paragraph as example of custom resource we will build a basic RSS feeds generator which can be used to publish feeds on our site (project CustomResourceMounting). Instead of generating a RSS feed by hand we will use Rome framework and its utility classes.
As hinted above in paragraph 13.1, class
AbstractResource can be used as base class to implement new resources. This class defines abstract method
newResourceResponse which is invoked when the resource is requested. The following is the code of our RSS feeds generator:
public class RSSProducerResource extends AbstractResource { @Override
+In Wicket the best way to add dynamic functionalities to our application (such as csv export, a pdf generated on the fly, etc...) is implementing a custom resource. In this paragraph as example of custom resource we will build a basic RSS feeds generator which can be used to publish feeds on our site (project CustomResourceMounting). Instead of generating a RSS feed by hand we will use Rome framework and its utility classes.As hinted above in paragraph 15.1, class AbstractResource can be used as base class to implement new resources. This class defines abstract method newResourceResponse which is invoked when the resource is requested. The following is the code of our RSS feeds generator:public class RSSProducerResource extends AbstractResource { @Override
protected ResourceResponse newResourceResponse(Attributes attributes) {
ResourceResponse resourceResponse = new ResourceResponse();
resourceResponse.setContentType("text/xml");
@@ -187,6 +187,7 @@
}newResourceResponse returns an instance of ResourceResponse representing the response generated by the custom resource. Since RSS feeds are based on XML, in the code above we have set the type of the response to text/xml and the text encoding to utf-8.To specify the content that will be returned by our resource we must also provide an implementation of inner class WriteCallback which is responsible for writing content data to response's output stream. In our project we used class SyndFeedOutput from Rome framework to write our feed to response. Method getFeed() is just an utility method that generates a sample RSS feed (which is an instance of interface com.sun.syndication.feed.synd.SyndFeed).Now that we have our custom resource in place, we can use it in the home page of the project. The easiest way to make a resource available to users is to expose it with link component ResourceLink:add(new ResourceLink("rssLink", new RSSProducerResource()));
15.11 Mounting resources - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
15.11 Mounting resources
-
Just like pages also resources can be mounted to a specific path. Class
WebApplication provides method
mountResource which is almost identical to
mountPage seen in paragraph 8.6.1:
@Override
+Just like pages also resources can be mounted to a specific path. Class WebApplication provides method mountResource which is almost identical to mountPage seen in paragraph 10.6.1:@Override
public void init() {
super.init();
//resource mounted to path /foo/bar
@@ -188,6 +188,7 @@
}
15.12 Shared resources - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -202,7 +202,7 @@
Index: guide/pages/resources_13.html
===================================================================
--- guide/pages/resources_13.html (revision 1675105)
+++ guide/pages/resources_13.html (working copy)
@@ -151,7 +151,7 @@
15.13 Customizing resource loading - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -206,7 +206,7 @@
Index: guide/pages/resources_14.html
===================================================================
--- guide/pages/resources_14.html (revision 1675105)
+++ guide/pages/resources_14.html (working copy)
@@ -151,7 +151,7 @@
15.14 CssHeaderItem and JavaScriptHeaderItem compression - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -233,7 +233,7 @@
Index: guide/pages/resources_15.html
===================================================================
--- guide/pages/resources_15.html (revision 1675105)
+++ guide/pages/resources_15.html (working copy)
@@ -151,7 +151,7 @@
15.15 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/resources_2.html
===================================================================
--- guide/pages/resources_2.html (revision 1675105)
+++ guide/pages/resources_2.html (working copy)
@@ -151,7 +151,7 @@
15.2 Resource references - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/resources_3.html
===================================================================
--- guide/pages/resources_3.html (revision 1675105)
+++ guide/pages/resources_3.html (working copy)
@@ -151,7 +151,7 @@
15.3 Package resources - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -178,7 +178,7 @@
new PackageResourceReference(getClass(),
"calendar.jpg");
add(
new Image(
"packageResPicture", resourceReference));
}
-}
Wicket will take care of generating a valid URL for file calendar.jpg. URLs for package resources have the following structure:
<path to application root>/wicket/resource/<fully qualified classname>/<resource file name>-<ver-<id>>(.file extension)In our example the URL for our picture file calendar.jpg is the following:
./wicket/resource/org.wicketTutorial.CustomPanel/calendar-ver-1297887542000.jpgThe first part of the URL is the relative path to the application root. In our example our page is already at the application's root so we have only a single-dotted segment. The next two segments, wicket and resource, are respectively the namespace and the identifier for resources seen in paragraph 8.6.4.
The fourth segment is the fully qualified name of the class used to locate the resource and it is the scope of the package resource. In the last segment of the URL we can find the name of the resource (the file name).
As you can see Wicket has automatically appended to the file name a version identifier (ver-1297887542000). When Wicket runs in DEVELOPMENT mode this identifier contains the timestamp in millisecond indicating the last time the resource file was modified. This can be useful when we are developing our application and resource files are frequently modified. Appending the timestamp to the original name we are sure that our browser will use always the last version of the file and not an old, out of date, cached version.
When instead Wicket is running in DEPLOYMENT mode, the version identifier will contain the MD5 digest of the file instead of the timestamp. The digest is computed only the first time the resource is requested. This perfectly makes sense as static resources don't change so often when our application runs into production environment and when this appends the application is redeployed.
+}
Wicket will take care of generating a valid URL for file calendar.jpg. URLs for package resources have the following structure:
<path to application root>/wicket/resource/<fully qualified classname>/<resource file name>-<ver-<id>>(.file extension)In our example the URL for our picture file calendar.jpg is the following:
./wicket/resource/org.wicketTutorial.CustomPanel/calendar-ver-1297887542000.jpgThe first part of the URL is the relative path to the application root. In our example our page is already at the application's root so we have only a single-dotted segment. The next two segments, wicket and resource, are respectively the namespace and the identifier for resources seen in
paragraph 10.6.4.
The fourth segment is the fully qualified name of the class used to locate the resource and it is the scope of the package resource. In the last segment of the URL we can find the name of the resource (the file name).
As you can see Wicket has automatically appended to the file name a version identifier (ver-1297887542000). When Wicket runs in DEVELOPMENT mode this identifier contains the timestamp in millisecond indicating the last time the resource file was modified. This can be useful when we are developing our application and resource files are frequently modified. Appending the timestamp to the original name we are sure that our browser will use always the last version of the file and not an old, out of date, cached version.
When instead Wicket is running in DEPLOYMENT mode, the version identifier will contain the MD5 digest of the file instead of the timestamp. The digest is computed only the first time the resource is requested. This perfectly makes sense as static resources don't change so often when our application runs into production environment and when this appends the application is redeployed.
Package resources can be localized following the same rules seen for resource bundles and markup files:
In the example illustrated in the picture above, if we try to retrieve package resource calendar.jpg when the current locale is set to French, the actual file returned will be calendar_fr.jpg.
Responsive images - multiple resource references use in one component
Since Wicket 7.0.0 the build-in component
org.apache.wicket.markup.html.image.Image allows you to add several ResourceReferences via varargs and to provide sizes for each image so that the browser is able to pick the best image source.
HTML:
…
@@ -214,7 +214,7 @@
...
…
Video video = new Video("video", new PackageResourceReference(getClass(),"video.mp4"));
-...Using package resources with tag <wicket:link>
In paragraph 8.3 we have used tag <wicket:link> to automatically create links to bookmarkable pages. The same technique can be used also for package resources in order to use them directly from markup file. Let's assume for example that we have a picture file called icon.png placed in the same package of the current page. Under these conditions we can display the picture file using the following markup fragment:
Using package resources with tag <wicket:link>
In
paragraph 10.3 we have used tag <wicket:link> to automatically create links to bookmarkable pages. The same technique can be used also for package resources in order to use them directly from markup file. Let's assume for example that we have a picture file called icon.png placed in the same package of the current page. Under these conditions we can display the picture file using the following markup fragment:
<wicket:link>
<img src="icon.png"/>
</wicket:link>In the example above Wicket will populate the attribute src with the URL corresponding to the package resource icon.png. <wicket:link> supports also tag <link> for CSS files and tag <script> for JavaScript files.
@@ -246,7 +246,7 @@
Index: guide/pages/resources_4.html
===================================================================
--- guide/pages/resources_4.html (revision 1675105)
+++ guide/pages/resources_4.html (working copy)
@@ -151,7 +151,7 @@
15.4 Adding resources to page header section - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
15.4 Adding resources to page header section
-
Wicket comes with interface
org.apache.wicket.markup.html.IHeaderContributor which allows components and behaviors (which will be introduced later in paragraph 15.1) to contribute to the header section of their page. The only method defined in this interface is
renderHead(IHeaderResponse response) where
IHeaderResponse is an interface which defines method
render(HeaderItem item) to write static resources or free-form text into the header section of the page.
Header entries are instances of abstract class
org.apache.wicket.markup.head.HeaderItem. Wicket provides a set of built-in implementations of this class suited for the most common types of resources. With the exception of
PriorityHeaderItem, every implementation of
HeaderItem is an abstract factory class:
+
Wicket comes with interface
org.apache.wicket.markup.html.IHeaderContributor which allows components and behaviors (which will be introduced later in
paragraph 17.1) to contribute to the header section of their page. The only method defined in this interface is
renderHead(IHeaderResponse response) where
IHeaderResponse is an interface which defines method
render(HeaderItem item) to write static resources or free-form text into the header section of the page.
Header entries are instances of abstract class
org.apache.wicket.markup.head.HeaderItem. Wicket provides a set of built-in implementations of this class suited for the most common types of resources. With the exception of
PriorityHeaderItem, every implementation of
HeaderItem is an abstract factory class:
- CssHeaderItem: represents a CSS resource. Factory methods provided by this class are
forReference which takes in input a resource reference, forUrl which creates an CSS item from a given URL and forCSS which takes in input an arbitrary CSS string and an optional id value to identify the resource.
- JavaScriptHeaderItem: represents a JavaScript resource. Just like
CssHeaderItem it provides factory methods forReference and forUrl along with method forScript which takes in input an arbitrary string representing the script and an optional id value to identify the resource. Method forReference also supports boolean parameter defer which renders the namesake attribute in the script tag (defer attribute indicates that our script must be execute only after the page has loaded).
@@ -210,7 +210,7 @@
Index: guide/pages/resources_5.html
===================================================================
--- guide/pages/resources_5.html (revision 1675105)
+++ guide/pages/resources_5.html (working copy)
@@ -151,7 +151,7 @@
15.5 Context-relative resources - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -197,7 +197,7 @@
Index: guide/pages/resources_6.html
===================================================================
--- guide/pages/resources_6.html (revision 1675105)
+++ guide/pages/resources_6.html (working copy)
@@ -151,7 +151,7 @@
15.6 Resource dependencies - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -200,7 +200,7 @@
Index: guide/pages/resources_7.html
===================================================================
--- guide/pages/resources_7.html (revision 1675105)
+++ guide/pages/resources_7.html (working copy)
@@ -151,7 +151,7 @@
15.7 Aggregate multiple resources with resource bundles - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -203,7 +203,7 @@
Index: guide/pages/resources_8.html
===================================================================
--- guide/pages/resources_8.html (revision 1675105)
+++ guide/pages/resources_8.html (working copy)
@@ -151,7 +151,7 @@
15.8 Put JavaScript inside page body - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -230,7 +230,7 @@
Index: guide/pages/resources_9.html
===================================================================
--- guide/pages/resources_9.html (revision 1675105)
+++ guide/pages/resources_9.html (working copy)
@@ -151,7 +151,7 @@
15.9 Header contributors positioning - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -197,7 +197,7 @@
Index: guide/pages/security_1.html
===================================================================
--- guide/pages/security_1.html (revision 1675105)
+++ guide/pages/security_1.html (working copy)
@@ -151,7 +151,7 @@
21.1 Authentication - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -268,7 +268,7 @@
Index: guide/pages/security_2.html
===================================================================
--- guide/pages/security_2.html (revision 1675105)
+++ guide/pages/security_2.html (working copy)
@@ -151,7 +151,7 @@
21.2 Authorizations - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -200,7 +200,7 @@
{
//Authentication code…
}
-};
By default
SimplePageAuthorizationStrategy checks for permissions only on pages. If we want to change this behavior and check also other kinds of components, we must override method
isActionAuthorized and implement our custom logic inside it.
Role-based strategies
At the end of paragraph 20.1 we have introduced AbstractAuthenticatedWebSession's method getRoles which is provided to support role-based authorization returning the set of roles granted to the current user.
In Wicket roles are simple strings like “BASIC_USER” or “ADMIN” (they don't need to be capitalized) and they are handled with class
org.apache.wicket.authroles.authorization.strategies.role.Roles. This class extends standard HashSet collection adding some functionalities to check whether the set contains one or more roles. Class
Roles already defines roles Roles.USER and Roles.ADMIN.
The session class in the following example returns a custom “SIGNED_IN” role for every authenticated user and it adds an Roles.ADMIN role if username is equal to superuser:
class BasicAuthenticationRolesSession extends AuthenticatedWebSession {
+};By default
SimplePageAuthorizationStrategy checks for permissions only on pages. If we want to change this behavior and check also other kinds of components, we must override method
isActionAuthorized and implement our custom logic inside it.
Role-based strategies
At the end of
paragraph 21.1 we have introduced AbstractAuthenticatedWebSession's method getRoles which is provided to support role-based authorization returning the set of roles granted to the current user.
In Wicket roles are simple strings like “BASIC_USER” or “ADMIN” (they don't need to be capitalized) and they are handled with class
org.apache.wicket.authroles.authorization.strategies.role.Roles. This class extends standard HashSet collection adding some functionalities to check whether the set contains one or more roles. Class
Roles already defines roles Roles.USER and Roles.ADMIN.
The session class in the following example returns a custom “SIGNED_IN” role for every authenticated user and it adds an Roles.ADMIN role if username is equal to superuser:
class BasicAuthenticationRolesSession extends AuthenticatedWebSession {
private String userName; public BasicAuthenticationRolesSession(Request request) {
super(request);
} @Override
@@ -214,7 +214,7 @@
resultRoles.add(Roles.ADMIN); return resultRoles;
}
}Roles can be adopted to apply security restrictions on our pages and components. This can be done using one of the two built-in authorization strategies that extend super class
AbstractRoleAuthorizationStrategyWicket:
MetaDataRoleAuthorizationStrategy and
AnnotationsRoleAuthorizationStrategyThe difference between these two strategies is that
MetaDataRoleAuthorizationStrategy handles role-based authorizations with Wicket metadata while
AnnotationsRoleAuthorizationStrategy uses Java annotations.
-Application class AuthenticatedWebApplication already sets MetaDataRoleAuthorizationStrategy and AnnotationsRoleAuthorizationStrategy as its own authorization strategies (it uses a compound strategy as we will see in paragraph 20.2).The code that we will see in the next examples is for illustrative purpose only. If our application class inherits from AuthenticatedWebApplication we won't need to configure anything to use these two strategies.
+Application class AuthenticatedWebApplication already sets MetaDataRoleAuthorizationStrategy and AnnotationsRoleAuthorizationStrategy as its own authorization strategies (it uses a compound strategy as we will see in paragraph 21.2).The code that we will see in the next examples is for illustrative purpose only. If our application class inherits from AuthenticatedWebApplication we won't need to configure anything to use these two strategies.
Using roles with metadata
Strategy
MetaDataRoleAuthorizationStrategy uses application and components metadata to implement role-based authorizations. The class defines a set of static methods authorize that can be used to specify which roles are allowed to instantiate a component and which roles can perform a given action on a component.
The following code snippet reports both application and session classes from project
MetaDataRolesStrategyExample and illustrates how to use
MetaDataRoleAuthorizationStrategy to allow access to a given page (AdminOnlyPage) only to ADMIN role:
Application class:public class WicketApplication extends AuthenticatedWebApplication{
@Override
public Class<? extends WebPage> getHomePage(){
@@ -255,7 +255,7 @@
public void init(){
getApplicationSettings().setAccessDeniedPage(
MyCustomAccessDeniedPage.class);
- }Just like custom “Page expired” page (see chapter 6.2.5), also custom “Access denied” page must be bookmarkable.
Using roles with annotations
Strategy
AnnotationsRoleAuthorizationStrategy relies on two built-in annotations to handle role-based authorizations. These annotations are
AuthorizeInstantiation and
AuthorizeAction. As their names suggest the first annotation specifies which roles are allowed to instantiate the annotated component while the second must be used to indicate which roles are allowed to perform a specific action on the annotated component.
In the following example we use annotations to make a page accessible only to signed-in users and to enable it only if user has the ADMIN role:
@AuthorizeInstantiation("SIGNED_IN")
+ }Just like custom “Page expired” page (see
chapter 8.2.5), also custom “Access denied” page must be bookmarkable.
Using roles with annotations
Strategy
AnnotationsRoleAuthorizationStrategy relies on two built-in annotations to handle role-based authorizations. These annotations are
AuthorizeInstantiation and
AuthorizeAction. As their names suggest the first annotation specifies which roles are allowed to instantiate the annotated component while the second must be used to indicate which roles are allowed to perform a specific action on the annotated component.
In the following example we use annotations to make a page accessible only to signed-in users and to enable it only if user has the ADMIN role:
@AuthorizeInstantiation("SIGNED_IN")
@AuthorizeAction(action = "ENABLE", roles = {"ADMIN"})
public class MyPage extends WebPage {
//Page class code…
@@ -303,7 +303,7 @@
Index: guide/pages/security_3.html
===================================================================
--- guide/pages/security_3.html (revision 1675105)
+++ guide/pages/security_3.html (working copy)
@@ -151,7 +151,7 @@
21.3 Using HTTPS protocol - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
21.3 Using HTTPS protocol
-
HTTPS is the standard technology adopted on Internet to create a secure communication channel between web applications and their users.
In Wicket we can easily protect our pages with HTTPS mounting a special request mapper called
HttpsMapper and using annotation RequireHttps with those pages we want to serve over this protocol. Both these two entities are in package
org.apache.wicket.protocol.https.
HttpsMapper wraps an existing mapper and redirects incoming requests to HTTPS if the related response must render a page containing annotation
RequireHttps. Most of the times the wrapped mapper will be the root one, just like we saw before for
CryptoMapper in paragraph 10.6.
Another parameter needed to build a
HttpsMapper is an instance of class
HttpsConfig. This class allows us to specify which ports must be used for HTTPS and HTTP. By default the port numbers used by these two protocols are respectively 443 and 80.
The following code is taken from project
HttpsProtocolExample and illustrates how to enable HTTPS in our applications:
//Application class code…
+HTTPS is the standard technology adopted on Internet to create a secure communication channel between web applications and their users.In Wicket we can easily protect our pages with HTTPS mounting a special request mapper called HttpsMapper and using annotation RequireHttps with those pages we want to serve over this protocol. Both these two entities are in package org.apache.wicket.protocol.https.HttpsMapper wraps an existing mapper and redirects incoming requests to HTTPS if the related response must render a page containing annotation RequireHttps. Most of the times the wrapped mapper will be the root one, just like we saw before for CryptoMapper in paragraph 10.6.Another parameter needed to build a HttpsMapper is an instance of class HttpsConfig. This class allows us to specify which ports must be used for HTTPS and HTTP. By default the port numbers used by these two protocols are respectively 443 and 80.The following code is taken from project HttpsProtocolExample and illustrates how to enable HTTPS in our applications://Application class code…
@Override
public void init(){
setRootRequestMapper(new HttpsMapper(getRootRequestMapper(),
@@ -216,7 +216,7 @@
Index: guide/pages/security_4.html
===================================================================
--- guide/pages/security_4.html (revision 1675105)
+++ guide/pages/security_4.html (working copy)
@@ -151,7 +151,7 @@
21.4 URLs encryption in detail - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -220,7 +220,7 @@
Index: guide/pages/security_5.html
===================================================================
--- guide/pages/security_5.html (revision 1675105)
+++ guide/pages/security_5.html (working copy)
@@ -151,7 +151,7 @@
21.5 Package Resource Guard - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -211,7 +211,7 @@
Index: guide/pages/security_6.html
===================================================================
--- guide/pages/security_6.html (revision 1675105)
+++ guide/pages/security_6.html (working copy)
@@ -151,7 +151,7 @@
21.6 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/testing_1.html
===================================================================
--- guide/pages/testing_1.html (revision 1675105)
+++ guide/pages/testing_1.html (working copy)
@@ -151,7 +151,7 @@
22.1 Utility class WicketTester - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -278,7 +278,7 @@
//…
//execute AJAX behavior, i.e. onUpdate will be invoked
tester.executeBehavior(ajaxBehavior));
-//...
Using a custom servlet context
In paragraph 13.9 we have seen how to configure our application to store resource files into a custom folder placed inside webapp root folder (see project
CustomFolder4MarkupExample).
In order to write testing code for applications that use this kind of customization, we must tell
WicketTester which folder to use as webapp root. This is necessary as under test environment we don't have any web server, hence it's impossible for
WicketTester to retrieve this parameter from servlet context.
Webapp root folder can be passed to
WicketTester's constructor as further parameter like we did in the test case of project
CustomFolder4MarkupExample:
public class TestHomePage{
+//...Using a custom servlet context
In
paragraph 15.13 we have seen how to configure our application to store resource files into a custom folder placed inside webapp root folder (see project
CustomFolder4MarkupExample).
In order to write testing code for applications that use this kind of customization, we must tell
WicketTester which folder to use as webapp root. This is necessary as under test environment we don't have any web server, hence it's impossible for
WicketTester to retrieve this parameter from servlet context.
Webapp root folder can be passed to
WicketTester's constructor as further parameter like we did in the test case of project
CustomFolder4MarkupExample:
public class TestHomePage{
private WicketTester tester; @Before
public void setUp(){
//build the path to webapp root folder
@@ -322,7 +322,7 @@
Index: guide/pages/testing_2.html
===================================================================
--- guide/pages/testing_2.html (revision 1675105)
+++ guide/pages/testing_2.html (working copy)
@@ -151,7 +151,7 @@
22.2 Testing Wicket forms - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -242,7 +242,7 @@
Index: guide/pages/testing_3.html
===================================================================
--- guide/pages/testing_3.html (revision 1675105)
+++ guide/pages/testing_3.html (working copy)
@@ -151,7 +151,7 @@
22.3 Testing markup with TagTester - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -217,7 +217,7 @@
Index: guide/pages/testing_4.html
===================================================================
--- guide/pages/testing_4.html (revision 1675105)
+++ guide/pages/testing_4.html (working copy)
@@ -151,7 +151,7 @@
22.4 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/testingspring_1.html
===================================================================
--- guide/pages/testingspring_1.html (revision 1675105)
+++ guide/pages/testingspring_1.html (working copy)
@@ -151,7 +151,7 @@
23.1 Configuration of the runtime environment - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -236,7 +236,7 @@
Index: guide/pages/testingspring_2.html
===================================================================
--- guide/pages/testingspring_2.html (revision 1675105)
+++ guide/pages/testingspring_2.html (working copy)
@@ -151,7 +151,7 @@
23.2 Configuration of the JUnit based integration test environment - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -253,7 +253,7 @@
Index: guide/pages/testingspring_3.html
===================================================================
--- guide/pages/testingspring_3.html (revision 1675105)
+++ guide/pages/testingspring_3.html (working copy)
@@ -151,7 +151,7 @@
23.3 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/urls_1.html
===================================================================
--- guide/pages/urls_1.html (revision 1675105)
+++ guide/pages/urls_1.html (working copy)
@@ -151,7 +151,7 @@
10.1 PageParameters - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -218,7 +218,7 @@
Index: guide/pages/urls_2.html
===================================================================
--- guide/pages/urls_2.html (revision 1675105)
+++ guide/pages/urls_2.html (working copy)
@@ -151,7 +151,7 @@
10.2 Bookmarkable links - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/urls_3.html
===================================================================
--- guide/pages/urls_3.html (revision 1675105)
+++ guide/pages/urls_3.html (working copy)
@@ -151,7 +151,7 @@
10.3 Automatically creating bookmarkable links with tag wicket:link - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -228,7 +228,7 @@
Index: guide/pages/urls_4.html
===================================================================
--- guide/pages/urls_4.html (revision 1675105)
+++ guide/pages/urls_4.html (working copy)
@@ -151,7 +151,7 @@
10.4 External links - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -199,7 +199,7 @@
Index: guide/pages/urls_5.html
===================================================================
--- guide/pages/urls_5.html (revision 1675105)
+++ guide/pages/urls_5.html (working copy)
@@ -151,7 +151,7 @@
10.5 Stateless links - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -204,7 +204,7 @@
Index: guide/pages/urls_6.html
===================================================================
--- guide/pages/urls_6.html (revision 1675105)
+++ guide/pages/urls_6.html (working copy)
@@ -151,7 +151,7 @@
10.6 Generating structured and clear URLs - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
10.6 Generating structured and clear URLs
-
Having structured URLs in our site is a basic requirement if we want to build an efficient SEO1 strategy, but it also contributes to improve user experience with more intuitive URLs. Wicket provides two different ways to control URL generation. The first (and simplest) is to “mount” one or more pages to an arbitrary path, while a more powerful technique is to use custom implementations of IMapperContext and IPageParametersEncoder interfaces. In the next paragraphs we will learn both of these two techniques.
Mounting a single page
With Wicket we can mount a page to a given path in much the same way as we map a servlet filer to a desired path inside file web.xml (see page 9). Using mountPage(String path, Class <T> pageClass) method of the WepApplication class we tell Wicket to respond with a new instance of pageClass whenever a user navigates to the given path. In the application class of the project MountedPagesExample we mount MountedPage to the "/pageMount" path:
@Override
+Having structured URLs in our site is a basic requirement if we want to build an efficient SEO strategy, but it also contributes to improve user experience with more intuitive URLs. Wicket provides two different ways to control URL generation. The first (and simplest) is to “mount” one or more pages to an arbitrary path, while a more powerful technique is to use custom implementations of IMapperContext and IPageParametersEncoder interfaces. In the next paragraphs we will learn both of these two techniques.Mounting a single page
With Wicket we can mount a page to a given path in much the same way as we map a servlet filter to a desired path inside file web.xml (see paragraph 4.2). Using mountPage(String path, Class <T> pageClass) method of the WepApplication class we tell Wicket to respond with a new instance of pageClass whenever a user navigates to the given path. In the application class of the project MountedPagesExample we mount MountedPage to the "/pageMount" path:@Override
public void init()
{
super.init();
@@ -172,14 +172,14 @@
}//it will return "/pageMount"
RequestCycle.get().urlFor(MountedPage.class);
org.apache.wicket.request.mapper.MountedMapper configured for the given path:public final <T extends Page> void mountPage(final String path,final Class<T> pageClass) {
mount(new MountedMapper(path, pageClass));
-}Using parameter placeholders with mounted pages
The path specified for mounted pages can contain dynamic segments which are populated with the values of the named parameters used to build the page. These segments are declared using special segments called parameter placeholders. Consider the path used in the following example:mountPage("/pageMount/${foo}/otherSegm", MountedPageWithPlaceholder.class);PageParameters pageParameters = new PageParameters();
+}
Using parameter placeholders with mounted pages
The path specified for mounted pages can contain dynamic segments which are populated with the values of the named parameters used to build the page. These segments are declared using special segments called parameter placeholders. Consider the path used in the following example:mountPage("/pageMount/${foo}/otherSegm", MountedPageWithPlaceholder.class);PageParameters pageParameters = new PageParameters();
pageParameters.add("foo", "foo");setResponsePage(MountedPageWithPlaceholder.class, pageParameters)<Application path>/pageMount/foo/otherSegm
mountPage("/pageMount/#{foo}/otherSegm", MountedPageOptionalPlaceholder.class);PageParameters pageParameters = new PageParameters();
setResponsePage(MountedPageWithPlaceholder.class, pageParameters);
<Application path>/pageMount/otherSegm
Mounting a package
In addition to mounting a single page, Wicket allows to mount all of the pages inside a package to a given path. Method mountPackage(String path, Class<T> pageClass) of class WepApplication will mount every page inside pageClass's package to the specified path.The resulting URL for package-mounted pages will have the following structure:<Application path>/mountedPath/<PageClassName>[optional query string]
mountPackage("/mountPackage", StatefulPackageMount.class);<Application path>/mountPackage/StatefulPackageMount?1
org.apache.wicket.request.mapper.PackageMapper to the given path.Providing custom mapper context to request mappers
Interface org.apache.wicket.request.mapper.IMapperContext is used by request mappers to create new page instances and to retrieve static URL segments used to build and parse page URLs. Here is the list of these segments:
- Namespace: it's the first URL segment of non-mounted pages. By default its value is wicket.
- Identifier for non-bookmarkable URLs: it's the segment that identifies non bookmarkable pages. By default its value is page.
-- Identifier for bookmarkable URLs: it's the segment that identifies bookmarkable pages. By default its value is bookmarkable (as we have seen before in paragraph 8.1.1).
-- Identifier for resources: it's the segment that identifies Wicket resources. Its default value is resources. The topic of resource management will be covered in chapter 13.
+- Identifier for bookmarkable URLs: it's the segment that identifies bookmarkable pages. By default its value is bookmarkable (as we have seen before in paragraph 10.1.1).
+- Identifier for resources: it's the segment that identifies Wicket resources. Its default value is resources. The topic of resource management will be covered in chapter 15.
IMapperContext provides a getter method for any segment listed above. By default Wicket uses class
org.apache.wicket.DefaultMapperContext as mapper context.
Project CustomMapperContext is an example of customization of mapper context where we use index as identifier for non-bookmarkable pages and staticURL as identifier for bookmarkable pages. In this project, instead of implementing our mapper context from scratch, we used DefaultMapperContext as base class overriding just the two methods we need to achieve the desired result (getBookmarkableIdentifier() and getPageIdentifier()). The final implementation is the following:
public class CustomMapperContext extends DefaultMapperContext{ @Override
public String getBookmarkableIdentifier() {
return "staticURL";
@@ -236,7 +236,7 @@
Index: guide/pages/urls_7.html
===================================================================
--- guide/pages/urls_7.html (revision 1675105)
+++ guide/pages/urls_7.html (working copy)
@@ -151,7 +151,7 @@
10.7 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -192,7 +192,7 @@
Index: guide/pages/versioningCaching_1.html
===================================================================
--- guide/pages/versioningCaching_1.html (revision 1675105)
+++ guide/pages/versioningCaching_1.html (working copy)
@@ -151,7 +151,7 @@
8.1 Stateful pages vs stateless - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -194,7 +194,7 @@
Index: guide/pages/versioningCaching_2.html
===================================================================
--- guide/pages/versioningCaching_2.html (revision 1675105)
+++ guide/pages/versioningCaching_2.html (working copy)
@@ -151,7 +151,7 @@
8.2 Stateful pages - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -180,10 +180,10 @@
});
}
}
Now if we run the new example (project LifeCycleStagesRevisited) and we click on the “Reload” button, a new page version is created and the page id is increased by one:
If we press the back button the page version previously rendered (and serialized) will be retrieved (i.e. deserialized) and it will be used again to respond to our request (and page id is decremented):
For more details about page storing you can take a look at paragraph "Page storing" from chapter "Wicket Internals". The content of this paragraph is from wiki page https://cwiki.apache.org/confluence/display/WICKET/Page+Storage.
-
As we have stated at the beginning of this chapter, page versions are stored using Java serialization, therefore every object referenced inside a page must be serializable. In paragraph 9.6 we will see how to overcome this limit and work with non-serializable objects in our components using detachable Wicket models.
Using a specific page version with PageReference
To retrieve a specific page version in our code we can use class
org.apache.wicket.PageReference by providing its constructor with the corresponding page id:
//load page version with page id = 3
+As we have stated at the beginning of this chapter, page versions are stored using Java serialization, therefore every object referenced inside a page must be serializable. In paragraph 11.6 we will see how to overcome this limit and work with non-serializable objects in our components using detachable Wicket models.Using a specific page version with PageReference
To retrieve a specific page version in our code we can use class org.apache.wicket.PageReference by providing its constructor with the corresponding page id://load page version with page id = 3
PageReference pageReference = new PageReference(3);
//load the related page instance
-Page page = pageReference.getPage();
Turning off page versioning
If for any reason we need to switch off versioning for a given page, we can call its method setVersioned(false).Pluggable serialization
Starting from version 1.5 it is possible to choose which implementation of Java serialization will be used by Wicket to store page versions. Wicket serializes pages using an implementation of interface org.apache.wicket.serialize.ISerializer. The default implementation is org.apache.wicket.serialize.java.JavaSerializer and it uses the standard Java serialization mechanism based on classes ObjectOutputStream and ObjectInputStream. However on Internet we can find other interesting serialization libraries like Kryo or Fast which perform faster then the standard implementation. The serializer in use can be customized with the setSerializer(ISerializer) method defined by setting interface org.apache.wicket.settings.IFrameworkSettings.We can access this interface inside the method init of the class Application using the getFrameworkSettings() method :@Override
+Page page = pageReference.getPage();
Turning off page versioning
If for any reason we need to switch off versioning for a given page, we can call its method setVersioned(false).Pluggable serialization
Starting from version 1.5 it is possible to choose which implementation of Java serialization will be used by Wicket to store page versions. Wicket serializes pages using an implementation of interface org.apache.wicket.serialize.ISerializer. The default implementation is org.apache.wicket.serialize.java.JavaSerializer and it uses the standard Java serialization mechanism based on classes ObjectOutputStream and ObjectInputStream. However on Internet we can find other interesting serialization libraries like Kryo or Fast which perform faster then the standard implementation. The serializer in use can be customized with the setSerializer(ISerializer) method defined by setting interface org.apache.wicket.settings.IFrameworkSettings.We can access this interface inside the method init of the class Application using the getFrameworkSettings() method :@Override
public void init()
{
super.init();
@@ -205,7 +205,7 @@
super.init();
getApplicationSettings().setPageExpiredErrorPage(
CustomExpiredErrorPage.class);
-}
The page class provided as custom error page must have a public constructor with no argument or a constructor that takes as input a single PageParameters argument (the page must be bookmarkable as described in
paragraph 10.1.1).
@@ -235,7 +235,7 @@
Index: guide/pages/versioningCaching_3.html
===================================================================
--- guide/pages/versioningCaching_3.html (revision 1675105)
+++ guide/pages/versioningCaching_3.html (working copy)
@@ -151,7 +151,7 @@
8.3 Stateless pages - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,9 +163,9 @@
8.3 Stateless pages
-
Wicket makes it very easy to build stateful pages, but sometimes we might want to use an “old school” stateless page that doesn't keep memory of its state in the user session. For example consider the public area of a site or a login page: in those cases a stateful page would be a waste of resources or even a security threat, as we will see in paragraph 10.9.
In Wicket a page can be stateless only if it satisfies the following requirements:
+
Wicket makes it very easy to build stateful pages, but sometimes we might want to use an “old school” stateless page that doesn't keep memory of its state in the user session. For example consider the public area of a site or a login page: in those cases a stateful page would be a waste of resources or even a security threat, as we will see in paragraph
paragraph 12.10.
In Wicket a page can be stateless only if it satisfies the following requirements:
-- it has been instantiated by Wicket (i.e. we don't create it with operator new) using a constructor with no argument or a constructor that takes as input a single PageParameters argument (class PageParameters will be covered in chapter 8).
+- it has been instantiated by Wicket (i.e. we don't create it with operator new) using a constructor with no argument or a constructor that takes as input a single PageParameters argument (class PageParameters will be covered in chapter 10.1).
- All its children components (and behaviors) are in turn stateless, which means that their method isStateless must return true.
The first requirement implies that, rather than creating a page by hand, we should rely on Wicket's capability of resolving page instances, like we do when we use method setResponsePage(Class page).
In order to comply with the second requirement it could be helpful to check if all children components of a page are stateless. To do this we can leverage method visitChildren and the visitor pattern to iterate over components and test if their method isStateless actually returns true:
@Override
protected void onInitialize() {
@@ -215,7 +215,7 @@
Index: guide/pages/versioningCaching_4.html
===================================================================
--- guide/pages/versioningCaching_4.html (revision 1675105)
+++ guide/pages/versioningCaching_4.html (working copy)
@@ -151,7 +151,7 @@
8.4 Summary - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,9 +163,10 @@
8.4 Summary
-
In this chapter we have seen how page instances are managed by Wicket. We have learnt that pages can be divided into two families: stateless and stateful pages. Knowing the difference between the two types of pages is important to build the right page for a given task.
However, to complete the discussion about stateless pages we still have to deal with two topics we have just outlined in this chapter: class PageParameters and bookmarkable pages. The first part of chapter 10 will cover these missing topics.
+
In this chapter we have seen how page instances are managed by Wicket. We have learnt that pages can be divided into two families: stateless and stateful pages. Knowing the difference between the two types of pages is important to build the right page for a given task.
However, to complete the discussion about stateless pages we still have to deal with two topics we have just outlined in this chapter: class PageParameters and bookmarkable pages. The first part of
chapter 10 will cover these missing topics.
+
@@ -192,7 +193,7 @@
Index: guide/pages/whyLearn_1.html
===================================================================
--- guide/pages/whyLearn_1.html (revision 1675105)
+++ guide/pages/whyLearn_1.html (working copy)
@@ -151,7 +151,7 @@
3.1 We all like spaghetti :-) ... - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -193,7 +193,7 @@
Index: guide/pages/whyLearn_2.html
===================================================================
--- guide/pages/whyLearn_2.html (revision 1675105)
+++ guide/pages/whyLearn_2.html (working copy)
@@ -151,7 +151,7 @@
3.2 Component oriented frameworks - an overview - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -199,7 +199,7 @@
Index: guide/pages/whyLearn_3.html
===================================================================
--- guide/pages/whyLearn_3.html (revision 1675105)
+++ guide/pages/whyLearn_3.html (working copy)
@@ -151,7 +151,7 @@
3.3 Benefits of component oriented frameworks for web development - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -198,7 +198,7 @@
Index: guide/pages/whyLearn_4.html
===================================================================
--- guide/pages/whyLearn_4.html (revision 1675105)
+++ guide/pages/whyLearn_4.html (working copy)
@@ -151,7 +151,7 @@
3.4 Wicket vs the other component oriented frameworks - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -199,7 +199,7 @@
Index: guide/pages/wicketstuff_1.html
===================================================================
--- guide/pages/wicketstuff_1.html (revision 1675105)
+++ guide/pages/wicketstuff_1.html (working copy)
@@ -151,7 +151,7 @@
27.1 What is project WicketStuff - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -197,7 +197,7 @@
Index: guide/pages/wicketstuff_2.html
===================================================================
--- guide/pages/wicketstuff_2.html (revision 1675105)
+++ guide/pages/wicketstuff_2.html (working copy)
@@ -151,7 +151,7 @@
27.2 Module tinymce - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -216,7 +216,7 @@
Index: guide/pages/wicketstuff_3.html
===================================================================
--- guide/pages/wicketstuff_3.html (revision 1675105)
+++ guide/pages/wicketstuff_3.html (working copy)
@@ -151,7 +151,7 @@
27.3 Module wicketstuff-gmap3 - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -207,7 +207,7 @@
Index: guide/pages/wicketstuff_4.html
===================================================================
--- guide/pages/wicketstuff_4.html (revision 1675105)
+++ guide/pages/wicketstuff_4.html (working copy)
@@ -151,7 +151,7 @@
27.4 Module wicketstuff-googlecharts - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -201,7 +201,7 @@
Index: guide/pages/wicketstuff_5.html
===================================================================
--- guide/pages/wicketstuff_5.html (revision 1675105)
+++ guide/pages/wicketstuff_5.html (working copy)
@@ -151,7 +151,7 @@
27.5 Module wicketstuff-inmethod-grid - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -163,7 +163,7 @@
27.5 Module wicketstuff-inmethod-grid
-
Module wicketstuff-inmethod-grid implements a sophisticated grid-component with class com. inmethod.grid.datagrid.DataGrid.
Just like pageable repeaters (seen in paragraph 11.4) DataGrid provides data pagination and uses interface IDataProvider as data source. In addition the component is completely ajaxified:
DataGrid supports also editable cells and row selection:
The following snippet illustrate how to use DataGrid and is taken from wiki page
https://github.com/wicketstuff/core/wiki/InMethodGrid :
HTML:…
+Module wicketstuff-inmethod-grid implements a sophisticated grid-component with class com. inmethod.grid.datagrid.DataGrid.Just like pageable repeaters (seen in paragraph 13.4) DataGrid provides data pagination and uses interface IDataProvider as data source. In addition the component is completely ajaxified:DataGrid supports also editable cells and row selection:The following snippet illustrate how to use DataGrid and is taken from wiki page https://github.com/wicketstuff/core/wiki/InMethodGrid :HTML:…
<div wicket:id="grid">Grid</div>
...
final List<Person> personList = //load a list of Persons
final ListDataProvider listDataProvider = new ListDataProvider(personList);
@@ -200,7 +200,7 @@
Index: guide/pages/wicketstuff_6.html
===================================================================
--- guide/pages/wicketstuff_6.html (revision 1675105)
+++ guide/pages/wicketstuff_6.html (working copy)
@@ -151,7 +151,7 @@
27.6 Module wicketstuff-rest-annotations - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -216,7 +216,7 @@
Index: guide/pages/wicketstuff_7.html
===================================================================
--- guide/pages/wicketstuff_7.html (revision 1675105)
+++ guide/pages/wicketstuff_7.html (working copy)
@@ -151,7 +151,7 @@
27.7 Module stateless - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -194,7 +194,7 @@
Index: guide/redirects.html
===================================================================
--- guide/redirects.html (revision 1675105)
+++ guide/redirects.html (working copy)
@@ -151,7 +151,7 @@
28 Lost In Redirection With Apache Wicket (Appendix) - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -227,7 +227,7 @@
Index: guide/repeaters.html
===================================================================
--- guide/repeaters.html (revision 1675105)
+++ guide/repeaters.html (working copy)
@@ -151,7 +151,7 @@
13 Displaying multiple items with repeaters - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -266,7 +266,7 @@
13.4 Pageable repeaters
-
Wicket offers a number of components that should be used when we have to display a big number of items (for example the results of a select SQL query).
All these components implement interface
org.apache.wicket.markup.html.navigation.paging.IPageable and use interface
IDataProvider (placed in package
org.apache.wicket.markup.repeater.data) as data source. This interface is designed to support data paging. We will see an example of data paging later in paragraph 11.4.2.
The methods defined by IDataProvider are the following:
+
Wicket offers a number of components that should be used when we have to display a big number of items (for example the results of a select SQL query).
All these components implement interface
org.apache.wicket.markup.html.navigation.paging.IPageable and use interface
IDataProvider (placed in package
org.apache.wicket.markup.repeater.data) as data source. This interface is designed to support data paging. We will see an example of data paging later in
paragraph 13.4.2.
The methods defined by IDataProvider are the following:
- iterator(long first, long count): returns an iterator over a subset of the entire dataset. The subset starts from the item at position first and includes all the next count items (i.e. it's the closed interval first,first+count).
- size(): gets the size of the entire dataset.
@@ -353,7 +353,7 @@
Index: guide/requestProcessing.html
===================================================================
--- guide/requestProcessing.html (revision 1675105)
+++ guide/requestProcessing.html (working copy)
@@ -151,7 +151,7 @@
9 Under the hood of the request processing - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -199,7 +199,7 @@
9.3 The “director” of request processing - RequestCycle
-
Class
org.apache.wicket.request.cycle.RequestCycle is the entity in charge of serving a web request. Our application class creates a new
RequestCycle on every request with its method
createRequestCycle(request, response).
Method
createRequestCycle is declared as final, so we can't override it to return a custom subclass of
RequestCycle. Instead, we must build a request cycle provider implementing interface
org.apache.wicket.IRequestCycleProvider, and then we must tell our application class to use it via the
setRequestCycleProvider method.
The current running request cycle can be retrieved at any time by calling its static method
RequestCycle.get(). Strictly speaking this method returns the request cycle associated with the current (or local) thread, which is the thread that is serving the current request. A similar
get() method is also implemented in classes
org.apache.wicket.Application (as we have seen in paragraph 2.2.2) and
org.apache.wicket.Session in order to get the application and the session in use by the current thread.
+Class org.apache.wicket.request.cycle.RequestCycle is the entity in charge of serving a web request. Our application class creates a new RequestCycle on every request with its method createRequestCycle(request, response).Method createRequestCycle is declared as final, so we can't override it to return a custom subclass of RequestCycle. Instead, we must build a request cycle provider implementing interface org.apache.wicket.IRequestCycleProvider, and then we must tell our application class to use it via the setRequestCycleProvider method.The current running request cycle can be retrieved at any time by calling its static method RequestCycle.get(). Strictly speaking this method returns the request cycle associated with the current (or local) thread, which is the thread that is serving the current request. A similar get() method is also implemented in classes org.apache.wicket.Application (as we have seen in paragraph 4.2.2) and org.apache.wicket.Session in order to get the application and the session in use by the current thread.
The implementation of the get method takes advantage of the standard class java.lang.ThreadLocal. See its JavaDoc for an introduction to local-thread variables.
Class org.apache.wicket.Component provides the getRequestCycle() method which is a convenience method that internally invokes RequestCycle.get():public final RequestCycle getRequestCycle() {
return RequestCycle.get();
@@ -209,8 +209,8 @@
- a page class, via the
urlFor(Class<C> pageClass, PageParameters parameters) method
- an IRequestHandler via the
urlFor(IRequestHandler handler) method
-- a ResourceReference via the
urlFor(ResourceReference reference, PageParameters params) method (resource entities will be introduced in chapter 13).
-
The overloaded
urlFor method from above also has a corresponding version that returns an instance of
org.apache.wicket.request.Url instead of a
CharSequence. This version has the prefix 'map' in its name (i.e. it has
mapUrlFor as full name).
Method setResponsePage
The
RequestCycle class contains the implementation of the
setResponsePage method we use to redirect a user to a specific page (see paragraph 2.4). The namesake method of class
org.apache.wicket.Component is just a convenience method that internally invokes the actual implementation on current request cycle:
public final void setResponsePage(final Page page) {
+- a ResourceReference via the
urlFor(ResourceReference reference, PageParameters params) method (resource entities will be introduced in chapter 15).
+
The overloaded
urlFor method from above also has a corresponding version that returns an instance of
org.apache.wicket.request.Url instead of a
CharSequence. This version has the prefix 'map' in its name (i.e. it has
mapUrlFor as full name).
Method setResponsePage
The
RequestCycle class contains the implementation of the
setResponsePage method we use to redirect a user to a specific page (see
paragraph 4.4). The namesake method of class
org.apache.wicket.Component is just a convenience method that internally invokes the actual implementation on current request cycle:
public final void setResponsePage(final Page page) {
getRequestCycle().setResponsePage(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:
@@ -245,7 +245,7 @@
- setAttribute(String name, Serializable value): creates an attribute identified by the given name. If the session already contains an attribute with the same name, the new value will replace the existing one. The value must be a serializable object.
- getAttribute(String name): returns the value of the attribute identified by the given name, or null if the name does not correspond to any attribute.
- removeAttribute(String name): removes the attribute identified by the given name.
-
By default class WebSession will use the underlying http session to store attributes. Wicket will automatically add a prefix to the name of the attributes. This prefix is returned by the WebApplication's method getSessionAttributePrefix().
Accessing to the HTTP session
If for any reason we need to directly access to the underlying HttpSession object, we can retrieve it from the current request with the following code:
HttpSession session = ((ServletWebRequest)RequestCycle.get()
+By default class WebSession will use the underlying HTTP session to store attributes. Wicket will automatically add a prefix to the name of the attributes. This prefix is returned by the WebApplication's method getSessionAttributePrefix().Accessing to the HTTP session
If for any reason we need to directly access to the underlying HttpSession object, we can retrieve it from the current request with the following code:HttpSession session = ((ServletWebRequest)RequestCycle.get()
.getRequest()).getContainerRequest().getSession();
HttpSession session = ((ServletWebRequest)RequestCycle.get().
getRequest()).getContainerRequest().getSession();session.setAttribute("Locale", "ENGLISH");
session.setAttribute("userName", "Mr BadGuy");Temporary and permanent sessions
Wicket doesn't need to store data into user session as long as the user visits only stateless pages. Nonetheless, even under these conditions, a temporary session object is created to process each request but it is discarded at the end of the current request. To know if the current session is temporary, we can use the isTemporary() method:Session.get().isTemporary();
9.6 Summary
-In this chapter we had a look at how Wicket internally handles a web request. Even if most of the time we won't need to customize this internal process, knowing how it works is essential to use the framework at 100%.Entities like Application and Session will come in handy again when we will tackle the topic of security in chapter 20.
+In this chapter we had a look at how Wicket internally handles a web request. Even if most of the time we won't need to customize this internal process, knowing how it works is essential to use the framework at 100%.Entities like Application and Session will come in handy again when we will tackle the topic of security in chapter 21.
+
@@ -332,7 +333,7 @@
Index: guide/resources.html
===================================================================
--- guide/resources.html (revision 1675105)
+++ guide/resources.html (working copy)
@@ -151,7 +151,7 @@
15 Resource management with Wicket - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -213,13 +213,15 @@
15 Resource management with Wicket
-One of the biggest challenge for a web framework is to offer an efficient and consistent mechanism to handle internal resources such as CSS/JavaScript files, picture files, pdf and so on. Resources can be static (like an icon used across the site) or dynamic (they can be generated on the fly) and they can be made available to users as a download or as a simple URL.
In paragraph 4.6 we have already seen how to add CSS and JavaScript contents to the header section of the page. In the first half of this chapter we will learn a more sophisticated technique that allows us to manage static resources directly from code and “pack” them with our custom components.
Then, in the second part of the chapter we will see how to implement custom resources to enrich our web application with more complex and dynamic functionalities.
+One of the biggest challenge for a web framework is to offer an efficient and consistent mechanism to handle internal resources such as CSS/JavaScript files, picture files, pdf and so on. Resources can be static (like an icon used across the site) or dynamic (they can be generated on the fly) and they can be made available to users as a download or as a simple URL.
In
paragraph 6.6 we have already seen how to add CSS and JavaScript contents to the header section of the page. In the first half of this chapter we will learn a more sophisticated technique that allows us to manage static resources directly from code and “pack” them with our custom components.
Then, in the second part of the chapter we will see how to implement custom resources to enrich our web application with more complex and dynamic functionalities.
+
15.1 Static vs dynamic resources
-
In Wicket a resource is an entity that can interact with the current request and response and It must implement interface
org.apache.wicket.request.resource.IResource. This interface defines just method respond(IResource.Attributes attributes) where the nested class IResource. Attributes provides access to request, response and page parameters objects.
Resources can be static or dynamic. Static resources don't entail any computational effort to be generated and they generally correspond to a resource on the filesystem. On the contrary dynamic resources are generated on the fly when they are requested, following a specific logic coded inside them.
An example of dynamic resource is the built-in class CaptchaImageResource in package
org.apache.wicket.extensions.markup.html.captcha which generates a captcha image each time is rendered.
As we will see in paragraph 13.6, developers can build custom resources extending base class
org.apache.wicket.request.resource.AbstractResource.
+
In Wicket a resource is an entity that can interact with the current request and response and It must implement interface
org.apache.wicket.request.resource.IResource. This interface defines just method respond(IResource.Attributes attributes) where the nested class IResource. Attributes provides access to request, response and page parameters objects.
Resources can be static or dynamic. Static resources don't entail any computational effort to be generated and they generally correspond to a resource on the filesystem. On the contrary dynamic resources are generated on the fly when they are requested, following a specific logic coded inside them.
An example of dynamic resource is the built-in class CaptchaImageResource in package
org.apache.wicket.extensions.markup.html.captcha which generates a captcha image each time is rendered.
As we will see in
paragraph 15.10, developers can build custom resources extending base class
org.apache.wicket.request.resource.AbstractResource.
+
15.2 Resource references
Most of the times in Wicket we won't directly instantiate a resource but rather we will use a reference to it. Resource references are represented by abstract class
org.apache.wicket.request.resource.ResourceReference which returns a concrete resource with factory method getResource(). In this way we can lazy-initialize resources loading them only the first time they are requested.
@@ -240,7 +242,7 @@
new PackageResourceReference(getClass(),
"calendar.jpg");
add(
new Image(
"packageResPicture", resourceReference));
}
-}
Wicket will take care of generating a valid URL for file calendar.jpg. URLs for package resources have the following structure:<path to application root>/wicket/resource/<fully qualified classname>/<resource file name>-<ver-<id>>(.file extension)In our example the URL for our picture file calendar.jpg is the following:./wicket/resource/org.wicketTutorial.CustomPanel/calendar-ver-1297887542000.jpgThe first part of the URL is the relative path to the application root. In our example our page is already at the application's root so we have only a single-dotted segment. The next two segments, wicket and resource, are respectively the namespace and the identifier for resources seen in paragraph 8.6.4.The fourth segment is the fully qualified name of the class used to locate the resource and it is the scope of the package resource. In the last segment of the URL we can find the name of the resource (the file name).As you can see Wicket has automatically appended to the file name a version identifier (ver-1297887542000). When Wicket runs in DEVELOPMENT mode this identifier contains the timestamp in millisecond indicating the last time the resource file was modified. This can be useful when we are developing our application and resource files are frequently modified. Appending the timestamp to the original name we are sure that our browser will use always the last version of the file and not an old, out of date, cached version.When instead Wicket is running in DEPLOYMENT mode, the version identifier will contain the MD5 digest of the file instead of the timestamp. The digest is computed only the first time the resource is requested. This perfectly makes sense as static resources don't change so often when our application runs into production environment and when this appends the application is redeployed.
+}
Wicket will take care of generating a valid URL for file calendar.jpg. URLs for package resources have the following structure:
<path to application root>/wicket/resource/<fully qualified classname>/<resource file name>-<ver-<id>>(.file extension)In our example the URL for our picture file calendar.jpg is the following:
./wicket/resource/org.wicketTutorial.CustomPanel/calendar-ver-1297887542000.jpgThe first part of the URL is the relative path to the application root. In our example our page is already at the application's root so we have only a single-dotted segment. The next two segments, wicket and resource, are respectively the namespace and the identifier for resources seen in
paragraph 10.6.4.
The fourth segment is the fully qualified name of the class used to locate the resource and it is the scope of the package resource. In the last segment of the URL we can find the name of the resource (the file name).
As you can see Wicket has automatically appended to the file name a version identifier (ver-1297887542000). When Wicket runs in DEVELOPMENT mode this identifier contains the timestamp in millisecond indicating the last time the resource file was modified. This can be useful when we are developing our application and resource files are frequently modified. Appending the timestamp to the original name we are sure that our browser will use always the last version of the file and not an old, out of date, cached version.
When instead Wicket is running in DEPLOYMENT mode, the version identifier will contain the MD5 digest of the file instead of the timestamp. The digest is computed only the first time the resource is requested. This perfectly makes sense as static resources don't change so often when our application runs into production environment and when this appends the application is redeployed.
Package resources can be localized following the same rules seen for resource bundles and markup files:In the example illustrated in the picture above, if we try to retrieve package resource calendar.jpg when the current locale is set to French, the actual file returned will be calendar_fr.jpg.
Responsive images - multiple resource references use in one component
Since Wicket 7.0.0 the build-in component
org.apache.wicket.markup.html.image.Image allows you to add several ResourceReferences via varargs and to provide sizes for each image so that the browser is able to pick the best image source.
HTML:
…
@@ -276,7 +278,7 @@
...
…
Video video = new Video("video", new PackageResourceReference(getClass(),"video.mp4"));
-...Using package resources with tag <wicket:link>
In paragraph 8.3 we have used tag <wicket:link> to automatically create links to bookmarkable pages. The same technique can be used also for package resources in order to use them directly from markup file. Let's assume for example that we have a picture file called icon.png placed in the same package of the current page. Under these conditions we can display the picture file using the following markup fragment:
Using package resources with tag <wicket:link>
In
paragraph 10.3 we have used tag <wicket:link> to automatically create links to bookmarkable pages. The same technique can be used also for package resources in order to use them directly from markup file. Let's assume for example that we have a picture file called icon.png placed in the same package of the current page. Under these conditions we can display the picture file using the following markup fragment:
<wicket:link>
<img src="icon.png"/>
</wicket:link>In the example above Wicket will populate the attribute src with the URL corresponding to the package resource icon.png. <wicket:link> supports also tag <link> for CSS files and tag <script> for JavaScript files.
@@ -283,7 +285,7 @@
15.4 Adding resources to page header section
-
Wicket comes with interface
org.apache.wicket.markup.html.IHeaderContributor which allows components and behaviors (which will be introduced later in paragraph 15.1) to contribute to the header section of their page. The only method defined in this interface is
renderHead(IHeaderResponse response) where
IHeaderResponse is an interface which defines method
render(HeaderItem item) to write static resources or free-form text into the header section of the page.
Header entries are instances of abstract class
org.apache.wicket.markup.head.HeaderItem. Wicket provides a set of built-in implementations of this class suited for the most common types of resources. With the exception of
PriorityHeaderItem, every implementation of
HeaderItem is an abstract factory class:
+
Wicket comes with interface
org.apache.wicket.markup.html.IHeaderContributor which allows components and behaviors (which will be introduced later in
paragraph 17.1) to contribute to the header section of their page. The only method defined in this interface is
renderHead(IHeaderResponse response) where
IHeaderResponse is an interface which defines method
render(HeaderItem item) to write static resources or free-form text into the header section of the page.
Header entries are instances of abstract class
org.apache.wicket.markup.head.HeaderItem. Wicket provides a set of built-in implementations of this class suited for the most common types of resources. With the exception of
PriorityHeaderItem, every implementation of
HeaderItem is an abstract factory class:
- CssHeaderItem: represents a CSS resource. Factory methods provided by this class are
forReference which takes in input a resource reference, forUrl which creates an CSS item from a given URL and forCSS which takes in input an arbitrary CSS string and an optional id value to identify the resource.
- JavaScriptHeaderItem: represents a JavaScript resource. Just like
CssHeaderItem it provides factory methods forReference and forUrl along with method forScript which takes in input an arbitrary string representing the script and an optional id value to identify the resource. Method forReference also supports boolean parameter defer which renders the namesake attribute in the script tag (defer attribute indicates that our script must be execute only after the page has loaded).
@@ -392,7 +394,7 @@
15.10 Custom resources
-In Wicket the best way to add dynamic functionalities to our application (such as csv export, a pdf generated on the fly, etc...) is implementing a custom resource. In this paragraph as example of custom resource we will build a basic RSS feeds generator which can be used to publish feeds on our site (project CustomResourceMounting). Instead of generating a RSS feed by hand we will use Rome framework and its utility classes.As hinted above in paragraph 13.1, class AbstractResource can be used as base class to implement new resources. This class defines abstract method newResourceResponse which is invoked when the resource is requested. The following is the code of our RSS feeds generator:public class RSSProducerResource extends AbstractResource { @Override
+In Wicket the best way to add dynamic functionalities to our application (such as csv export, a pdf generated on the fly, etc...) is implementing a custom resource. In this paragraph as example of custom resource we will build a basic RSS feeds generator which can be used to publish feeds on our site (project CustomResourceMounting). Instead of generating a RSS feed by hand we will use Rome framework and its utility classes.As hinted above in paragraph 15.1, class AbstractResource can be used as base class to implement new resources. This class defines abstract method newResourceResponse which is invoked when the resource is requested. The following is the code of our RSS feeds generator:public class RSSProducerResource extends AbstractResource { @Override
protected ResourceResponse newResourceResponse(Attributes attributes) {
ResourceResponse resourceResponse = new ResourceResponse();
resourceResponse.setContentType("text/xml");
@@ -416,8 +418,9 @@
}newResourceResponse returns an instance of ResourceResponse representing the response generated by the custom resource. Since RSS feeds are based on XML, in the code above we have set the type of the response to text/xml and the text encoding to utf-8.To specify the content that will be returned by our resource we must also provide an implementation of inner class WriteCallback which is responsible for writing content data to response's output stream. In our project we used class SyndFeedOutput from Rome framework to write our feed to response. Method getFeed() is just an utility method that generates a sample RSS feed (which is an instance of interface com.sun.syndication.feed.synd.SyndFeed).Now that we have our custom resource in place, we can use it in the home page of the project. The easiest way to make a resource available to users is to expose it with link component ResourceLink:add(new ResourceLink("rssLink", new RSSProducerResource()));15.11 Mounting resources
-Just like pages also resources can be mounted to a specific path. Class WebApplication provides method mountResource which is almost identical to mountPage seen in paragraph 8.6.1:@Override
+Just like pages also resources can be mounted to a specific path. Class WebApplication provides method mountResource which is almost identical to mountPage seen in paragraph 10.6.1:@Override
public void init() {
super.init();
//resource mounted to path /foo/bar
@@ -442,6 +445,7 @@
}15.12 Shared resources
Resources can be added to a global registry in order to share them at application-level. Shared resources are identified by an application-scoped key and they can be easily retrieved at a later time using reference class SharedResourceReference. The global registry can be accessed with Application's method getSharedResources. In the following excerpt of code (taken again from project CustomResourceMounting) we register an instance of our custom RSS feeds producer as application-shared resource://init application's method
@Override
@@ -549,7 +553,7 @@
Index: guide/security.html
===================================================================
--- guide/security.html (revision 1675105)
+++ guide/security.html (working copy)
@@ -151,7 +151,7 @@
21 Security with Wicket - Reference Documentation
-
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko
+
Authors: Andrea Del Bene, Martin Grigorov, Carsten Hufe, Christian Kroemer, Daniel Bartl, Paul Borș, Tobias Soloschenko, Joachim Rohde
Version: 6.x
@@ -307,7 +307,7 @@
{
//Authentication code…
}
-};
By default SimplePageAuthorizationStrategy checks for permissions only on pages. If we want to change this behavior and check also other kinds of components, we must override method isActionAuthorized and implement our custom logic inside it.Role-based strategies
At the end of paragraph 20.1 we have introduced AbstractAuthenticatedWebSession's method getRoles which is provided to support role-based authorization returning the set of roles granted to the current user.In Wicket roles are simple strings like “BASIC_USER” or “ADMIN” (they don't need to be capitalized) and they are handled with class org.apache.wicket.authroles.authorization.strategies.role.Roles. This class extends standard HashSet collection adding some functionalities to check whether the set contains one or more roles. Class Roles already defines roles Roles.USER and Roles.ADMIN.The session class in the following example returns a custom “SIGNED_IN” role for every authenticated user and it adds an Roles.ADMIN role if username is equal to superuser:class BasicAuthenticationRolesSession extends AuthenticatedWebSession {
+};SimplePageAuthorizationStrategy checks for permissions only on pages. If we want to change this behavior and check also other kinds of components, we must override method isActionAuthorized and implement our custom logic inside it.Role-based strategies
At the end of paragraph 21.1 we have introduced AbstractAuthenticatedWebSession's method getRoles which is provided to support role-based authorization returning the set of roles granted to the current user.In Wicket roles are simple strings like “BASIC_USER” or “ADMIN” (they don't need to be capitalized) and they are handled with class org.apache.wicket.authroles.authorization.strategies.role.Roles. This class extends standard HashSet collection adding some functionalities to check whether the set contains one or more roles. Class Roles already defines roles Roles.USER and Roles.ADMIN.The session class in the following example returns a custom “SIGNED_IN” role for every authenticated user and it adds an Roles.ADMIN role if username is equal to superuser:class BasicAuthenticationRolesSession extends AuthenticatedWebSession {
private String userName; public BasicAuthenticationRolesSession(Request request) {
super(request);
} @Override
@@ -321,7 +321,7 @@
resultRoles.add(Roles.ADMIN); return resultRoles;
}
}AbstractRoleAuthorizationStrategyWicket: MetaDataRoleAuthorizationStrategy and AnnotationsRoleAuthorizationStrategyThe difference between these two strategies is that MetaDataRoleAuthorizationStrategy handles role-based authorizations with Wicket metadata while AnnotationsRoleAuthorizationStrategy uses Java annotations.
-Application class AuthenticatedWebApplication already sets MetaDataRoleAuthorizationStrategy and AnnotationsRoleAuthorizationStrategy as its own authorization strategies (it uses a compound strategy as we will see in paragraph 20.2).The code that we will see in the next examples is for illustrative purpose only. If our application class inherits from AuthenticatedWebApplication we won't need to configure anything to use these two strategies.
+Application class AuthenticatedWebApplication already sets MetaDataRoleAuthorizationStrategy and AnnotationsRoleAuthorizationStrategy as its own authorization strategies (it uses a compound strategy as we will see in paragraph 21.2).The code that we will see in the next examples is for illustrative purpose only. If our application class inherits from AuthenticatedWebApplication we won't need to configure anything to use these two strategies.
Using roles with metadata
Strategy MetaDataRoleAuthorizationStrategy uses application and components metadata to implement role-based authorizations. The class defines a set of static methods authorize that can be used to specify which roles are allowed to instantiate a component and which roles can perform a given action on a component.The following code snippet reports both application and session classes from project MetaDataRolesStrategyExample and illustrates how to use MetaDataRoleAuthorizationStrategy to allow access to a given page (AdminOnlyPage) only to ADMIN role:Application class:public class WicketApplication extends AuthenticatedWebApplication{
@Override
public Class<? extends WebPage> getHomePage(){
@@ -362,7 +362,7 @@
public void init(){
getApplicationSettings().setAccessDeniedPage(
MyCustomAccessDeniedPage.class);
- }Using roles with annotations
Strategy AnnotationsRoleAuthorizationStrategy relies on two built-in annotations to handle role-based authorizations. These annotations are AuthorizeInstantiation and AuthorizeAction. As their names suggest the first annotation specifies which roles are allowed to instantiate the annotated component while the second must be used to indicate which roles are allowed to perform a specific action on the annotated component.In the following example we use annotations to make a page accessible only to signed-in users and to enable it only if user has the ADMIN role:@AuthorizeInstantiation("SIGNED_IN")
+ }Using roles with annotations
Strategy AnnotationsRoleAuthorizationStrategy relies on two built-in annotations to handle role-based authorizations. These annotations are AuthorizeInstantiation and AuthorizeAction. As their names suggest the first annotation specifies which roles are allowed to instantiate the annotated component while the second must be used to indicate which roles are allowed to perform a specific action on the annotated component.In the following example we use annotations to make a page accessible only to signed-in users and to enable it only if user has the ADMIN role:@AuthorizeInstantiation("SIGNED_IN")
@AuthorizeAction(action = "ENABLE", roles = {"ADMIN"})
public class MyPage extends WebPage {
//Page class code…
@@ -385,7 +385,7 @@
21.3 Using HTTPS protocol
-HTTPS is the standard technology adopted on Internet to create a secure communication channel between web applications and their users.In Wicket we can easily protect our pages with HTTPS mounting a special request mapper called HttpsMapper and using annotation RequireHttps with those pages we want to serve over this protocol. Both these two entities are in package org.apache.wicket.protocol.https.HttpsMapper wraps an existing mapper and redirects incoming requests to HTTPS if the related response must render a page containing annotation RequireHttps. Most of the times the wrapped mapper will be the root one, just like we saw before for CryptoMapper in paragraph 10.6.Another parameter needed to build a HttpsMapper is an instance of class HttpsConfig. This class allows us to specify which ports must be used for HTTPS and HTTP. By default the port numbers used by these two protocols are respectively 443 and 80.The following code is taken from project HttpsProtocolExample and illustrates how to enable HTTPS in our applications://Application class code…
+