From d45b801ed26bd8b50966a0668378c2889c90da97 Mon Sep 17 00:00:00 2001
From: Oscar Gonzalez Fernandez <ogfernandez@gmail.com>
Date: Thu, 10 Apr 2014 01:13:35 +0200
Subject: [PATCH] Fix issue with messages for users

The MessagesForUser component is used for showing information and
error messages to the users. It's designed to disappear once the user
does some action and a minimum of time has passed.

This is done listening to the events being produced in the page. In
previous versions of ZK this was enough to identify user activity, but
in the version currently used, 5.0.11, events not related to user
activity are generated. This causes the messages to disappear without
user action.

With this fix, only when the user clicks on something, or changes the
value of some input the shown message is cleared.
---
 .../libreplan/web/common/MessagesForUser.java | 32 ++++++++++++++-----
 1 file changed, 24 insertions(+), 8 deletions(-)

diff --git a/libreplan-webapp/src/main/java/org/libreplan/web/common/MessagesForUser.java b/libreplan-webapp/src/main/java/org/libreplan/web/common/MessagesForUser.java
index 07e5bf978..1d62686c0 100644
--- a/libreplan-webapp/src/main/java/org/libreplan/web/common/MessagesForUser.java
+++ b/libreplan-webapp/src/main/java/org/libreplan/web/common/MessagesForUser.java
@@ -35,9 +35,13 @@ import org.apache.commons.logging.LogFactory;
 import org.hibernate.validator.InvalidValue;
 import org.libreplan.business.common.exceptions.ValidationException;
 import org.zkoss.zk.ui.Component;
+import org.zkoss.zk.ui.event.CheckEvent;
 import org.zkoss.zk.ui.event.Event;
 import org.zkoss.zk.ui.event.EventListener;
 import org.zkoss.zk.ui.event.Events;
+import org.zkoss.zk.ui.event.InputEvent;
+import org.zkoss.zk.ui.event.MouseEvent;
+import org.zkoss.zk.ui.event.SelectEvent;
 import org.zkoss.zk.ui.util.EventInterceptor;
 import org.zkoss.zk.ui.util.GenericForwardComposer;
 import org.zkoss.zul.Div;
@@ -45,7 +49,12 @@ import org.zkoss.zul.Image;
 import org.zkoss.zul.Label;
 
 /**
- * It shows messages to the user. <br />
+ * <p>
+ * It shows messages from the application to the user with different
+ * {@link Level levels} of severity. Once the user does some action in the page,
+ * like clicking a button or changing some input the messages automatically
+ * disappear.
+ *
  * @author Óscar González Fernández <ogonzalez@igalia.com>
  */
 public class MessagesForUser extends GenericForwardComposer implements
@@ -78,25 +87,32 @@ public class MessagesForUser extends GenericForwardComposer implements
         @Override
         public Event beforeProcessEvent(Event event) {
             MessagesForUser messagesForUser = messagesForUserRef.get();
-            if (messagesForUser == null) {
+
+            if (messagesForUser == null
+                    || messagesForUser.pendingToDetach.isEmpty()
+                    || !eventIndicatesUserActivity(event)) {
                 return event;
             }
 
-            if (event.getName().equals(DETACH_EVENT_NAME)
-                    || messagesForUser.pendingToDetach.isEmpty()) {
-                return event;
-            }
             long currentTime = System.currentTimeMillis();
             ComponentHolderTimestamped currrent = null;
             while ((currrent = messagesForUser.pendingToDetach.peek()) != null
-                    && currrent
-                            .minimumVisualizationTimeSurpased(currentTime)) {
+                    && currrent.minimumVisualizationTimeSurpased(currentTime)) {
                 currrent.component.detach();
                 messagesForUser.pendingToDetach.poll();
             }
             return event;
         }
 
+        private boolean eventIndicatesUserActivity(Event event) {
+            if (event instanceof MouseEvent) {
+                MouseEvent e = (MouseEvent) event;
+                return e.getName().equals("onClick");
+            }
+            return event instanceof InputEvent || event instanceof CheckEvent
+                    || event instanceof SelectEvent;
+        }
+
         @Override
         public Event beforeSendEvent(Event event) {
             return event;