{"id":764,"date":"2013-06-20T23:27:57","date_gmt":"2013-06-20T21:27:57","guid":{"rendered":"http:\/\/hasselba.ch\/blog\/?p=764"},"modified":"2013-06-20T23:27:57","modified_gmt":"2013-06-20T21:27:57","slug":"xpages-create-your-own-required-validators","status":"publish","type":"post","link":"https:\/\/hasselba.ch\/blog\/?p=764","title":{"rendered":"XPages: Create your own Required Validators"},"content":{"rendered":"

If you try to implement your own JSF Validator (by implementing javax.faces.validator.Validator<\/em><\/a>), you will notice that you are unable to check for an empty value. The reason for this is rather simple: The method validate()<\/em> is only called, if there is something to do. If the value is empty, there is nothing to do, that’s why nothing happens.<\/p>\n

But wait! What about the available required validator for XPages?<\/p>\n

<xp:inputText id=\"inputText1\">\r\n   <xp:this.validators>\r\n\u00a0\u00a0    <xp:validateRequired><\/xp:validateRequired>\r\n\u00a0\u00a0 <\/xp:this.validators>\r\n<\/xp:inputText><\/code><\/pre>\n
And yes, this is a validator, but the IBM implemented a workaround for their UIComponents: If the UIComponents required<\/em> property is set to true<\/em>, the UIComponent knows that she needs to be filled in. Or a validator has to be attached to the UIComponent which implements the com.ibm.xsp.validator.FacesRequiredValidator<\/em> interface.<\/p>\n
Here is an example:<\/p>\n
package ch.hasselba.xpages.core;\r\n\r\nimport javax.faces.component.UIComponent;\r\nimport javax.faces.context.FacesContext;\r\nimport javax.faces.validator.ValidatorException;\r\nimport com.ibm.xsp.validator.FacesRequiredValidator;\r\n\r\npublic class RequiredValidator implements FacesRequiredValidator {\r\n\r\n\u00a0\u00a0 \u00a0public String getRequiredMessage() {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0return \"Error! Required field is empty!\";\r\n\u00a0\u00a0 \u00a0}\r\n\r\n\u00a0\u00a0 \u00a0public void validate(FacesContext facesContext, UIComponent uiComponent,\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0Object obj) throws ValidatorException {\r\n\r\n\u00a0\u00a0 \u00a0}\r\n\r\n}<\/code><\/pre>\n
When processing the UIComponent data, the attached validators are checked if they are an instance of FacesRequiredValidator<\/em>, and this is the reason why you cannot attach this validator to a component in the DDE directly: Because if you define the validator in the faces-config.xml<\/em> and add it to the UIComponent with the validator id…<\/p>\n
<xp:inputText id=\"inputText1\">\r\n   <xp:this.validators>\r\n\u00a0\u00a0    <xp:validator validatorId=\"myValidator\" \/>\r\n   <\/xp:this.validators>\r\n<\/xp:inputText><\/code><\/pre>\n
… the XPages engine attaches a validator which is not implementing the FacesRequiredValidator<\/em> interface. Instead, an instance of com.ibm.xsp.validator.ValidatorImpl <\/em>is attached.<\/p>\n
You have to do this by your own, for example in the beforeRenderResponse<\/em> event:<\/p>\n
\r\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<xp:view xmlns:xp=\"http:\/\/www.ibm.com\/xsp\/core\">\r\n\r\n   <xp:this.beforeRenderResponse>\r\n      <![CDATA[#{javascript:getComponent('inputText1').addValidator(\r\n         new ch.hasselba.xpages.core.RequiredValidator()\r\n      );}]]>\r\n   <\/xp:this.beforeRenderResponse>\r\n\r\n   <xp:button\r\n      value=\"Label\"\r\n      id=\"button1\">\r\n      <xp:eventHandler event=\"onclick\" submit=\"true\"\r\n         refreshMode=\"complete\" immediate=\"false\" save=\"true\" \/>\r\n   <\/xp:button>\r\n\r\n   <xp:br \/>\r\n\r\n   <xp:messages id=\"messages1\"><\/xp:messages>\r\n\r\n   <xp:br \/>\r\n\r\n   <xp:inputText id=\"inputText1\" \/>\r\n\r\n<\/xp:view>\r\n<\/code><\/pre>\n
[This example is just for a demonstration. It contains a bug, the validator will attached over and over again, so you have to check if the validator is already attached or not]<\/em><\/p>\n
If you now open the XPage, your validator will work as expected:<\/p>\n
\"\"<\/p>\n
 <\/p>\n","protected":false},"excerpt":{"rendered":"
If you try to implement your own JSF Validator (by implementing javax.faces.validator.Validator), you will notice that you are unable to check for an empty value. The reason for this is rather simple: The method validate() is only called, if there … Weiterlesen →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[89,26,76,74],"tags":[47,14,7,31,86,5,3],"class_list":["post-764","post","type-post","status-publish","format-standard","hentry","category-java","category-jsf","category-ssjs","category-xpages","tag-9-0","tag-designer","tag-domino","tag-java","tag-jsf","tag-ssjs","tag-xpages"],"_links":{"self":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/764","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=764"}],"version-history":[{"count":13,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/764\/revisions"}],"predecessor-version":[{"id":1240,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/764\/revisions\/1240"}],"wp:attachment":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=764"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=764"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=764"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}