{"id":1368,"date":"2014-03-02T13:07:07","date_gmt":"2014-03-02T11:07:07","guid":{"rendered":"http:\/\/hasselba.ch\/blog\/?p=1368"},"modified":"2014-03-02T13:07:07","modified_gmt":"2014-03-02T11:07:07","slug":"xpages-events-actionlisteners-parameters","status":"publish","type":"post","link":"https:\/\/hasselba.ch\/blog\/?p=1368","title":{"rendered":"XPages: Events, ActionListeners & Parameters"},"content":{"rendered":"

To access the event parameters of an event within your actionListener<\/em>, you have to access the source object of your actionEvent<\/em> object:<\/p>\n

package ch.hasselba.xpages;\r\n\r\nimport java.util.List;\r\nimport javax.faces.event.AbortProcessingException;\r\nimport javax.faces.event.ActionEvent;\r\nimport com.ibm.xsp.complex.Parameter;\r\nimport com.ibm.xsp.component.xp.XspEventHandler;\r\n\r\npublic class MyActionListener implements javax.faces.event.ActionListener {\r\n\r\n\u00a0\u00a0 \u00a0public void processAction(ActionEvent event)\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0throws AbortProcessingException {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0XspEventHandler eventHandler = (XspEventHandler) event.getSource();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0List<Parameter> params = eventHandler.getParameters();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0for (Parameter p : params) {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0System.out.println(p.getName() + \" -> \" + p.getValue());\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0}\r\n\u00a0\u00a0 \u00a0}\r\n}<\/code><\/pre>\n
Here is an example XPage:<\/p>\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<xp:view xmlns:xp=\"http:\/\/www.ibm.com\/xsp\/core\">\r\n\r\n\u00a0\u00a0 \u00a0<xp:button\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0value=\"Label\"\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0id=\"buttonAction\">\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:eventHandler\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0event=\"onclick\"\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0submit=\"true\"\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0immediate=\"true\" refreshMode=\"norefresh\">\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:this.parameters>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:parameter\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0name=\"param\"\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0value=\"#{javascript:java.lang.System.currentTimeMillis()}\">\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<\/xp:parameter>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<\/xp:this.parameters>\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:this.actionListeners>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:actionListener type=\"ch.hasselba.xpages.MyActionListener\" \/>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<\/xp:this.actionListeners>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<\/xp:eventHandler>\r\n\r\n\u00a0\u00a0 \u00a0<\/xp:button>\r\n\r\n<\/xp:view><\/code><\/pre>\n
You can see the result on the console when the button is clicked:<\/p>\n
\"\"<\/p>\n
When doing the same for an action, you have to access the UIComponent<\/em> from the actionEvent<\/em>:<\/p>\n
package ch.hasselba.xpages;\r\nimport java.util.List;\r\nimport javax.faces.event.ActionEvent;\r\nimport com.ibm.xsp.complex.Parameter;\r\nimport com.ibm.xsp.component.xp.XspEventHandler;\r\n\r\npublic class MyActionListener {\r\npublic void execute(ActionEvent event) {\r\n        XspEventHandler eventHandler = (XspEventHandler) event.getComponent();\r\n        List<Parameter> params = eventHandler.getParameters();\r\n        for (Parameter p : params) {\r\n            System.out.println(p.getName() + \" -> \" + p.getValue());\r\n        }\r\n     }\r\n}<\/code><\/pre>\n
Here is an example XPage, the method execute<\/em><\/em> is contained by the managed bean myAction<\/em>:<\/p>\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<xp:view xmlns:xp=\"http:\/\/www.ibm.com\/xsp\/core\">\r\n\r\n\u00a0\u00a0 \u00a0<xp:button\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0value=\"Label\"\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0id=\"buttonAction\">\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:eventHandler\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0event=\"onclick\"\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0submit=\"true\"\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0immediate=\"true\"\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0refreshMode=\"complete\"\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0actionListener=\"#{myAction.execute}\">\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:this.parameters>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:parameter\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0name=\"param\"\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0value=\"#{javascript:java.lang.System.currentTimeMillis()}\">\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<\/xp:parameter>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<\/xp:this.parameters>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<\/xp:eventHandler>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0<\/xp:button>\r\n\u00a0\u00a0 \u00a0\r\n<\/xp:view><\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
To access the event parameters of an event within your actionListener, you have to access the source object of your actionEvent object: package ch.hasselba.xpages; import java.util.List; import javax.faces.event.AbortProcessingException; import javax.faces.event.ActionEvent; import com.ibm.xsp.complex.Parameter; import com.ibm.xsp.component.xp.XspEventHandler; public class MyActionListener implements javax.faces.event.ActionListener { … 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,74],"tags":[33,47,7,31,86,3],"class_list":["post-1368","post","type-post","status-publish","format-standard","hentry","category-java","category-jsf","category-xpages","tag-8-5-3","tag-9-0","tag-domino","tag-java","tag-jsf","tag-xpages"],"_links":{"self":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1368","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=1368"}],"version-history":[{"count":2,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1368\/revisions"}],"predecessor-version":[{"id":1370,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1368\/revisions\/1370"}],"wp:attachment":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1368"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1368"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1368"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}