added timer for all mainwindow examples; make refresh period configurable (#3)

Author: mariodavid

README.md

@@ -129,4 +129,12 @@ One of these two classes can be used as the mainwinow through the following defi
 
 You can also extend this screens, so that you can add your own (screen-) logic to the mainwindow.
 
- 
+##### unread messages counter in predefined main windows screens
+
+In order to display the messages that are marked as unread, the main windows will be refreshed in a particular interval.
+The logic is the same as the Count script which is available within the [Application Folders](https://doc.cuba-platform.com/manual-6.8/application_folder.html)
+feature of CUBA itself. 
+
+Therefore the refresh period can be adjusted by the existing application property:
+[cuba.web.appFoldersRefreshPeriodSec](https://doc.cuba-platform.com/manual-6.8/app_properties_reference.html#cuba.web.appFoldersRefreshPeriodSec)
+in the `web-app.properties` file.

modules/web/src/de/diedavids/cuba/userinbox/web-app.properties

@@ -45,3 +45,5 @@ cuba.availableLocales = English|en
 cuba.localeSelectVisible = false
 cuba.restApiUrl = http://localhost:8080/user-inbox-portal/api
 cuba.webAppUrl = http://localhost:8080/user-inbox
+
+cuba.web.appFoldersRefreshPeriodSec = 5

modules/web/src/de/diedavids/cuba/userinbox/web-screens.xml

@@ -4,13 +4,15 @@
 
 
     <!--
+
     <screen id="mainWindow"
             template="de/diedavids/cuba/userinbox/web/screens/mainwindow-with-messages.xml"/>
 
-    -->
+
     <screen id="mainWindow"
             template="de/diedavids/cuba/userinbox/web/screens/side-mainwindow-with-messages.xml"/>
 
+    -->
     <screen id="user-inbox"
             template="de/diedavids/cuba/userinbox/web/message/user-inbox.xml"/>
     <screen id="send-message"

modules/web/src/de/diedavids/cuba/userinbox/web/screens/AppMainWindowWithMessages.java

@@ -1,13 +1,65 @@
 package de.diedavids.cuba.userinbox.web.screens;
 
 import com.haulmont.cuba.gui.WindowManager;
+import com.haulmont.cuba.gui.components.Action;
+import com.haulmont.cuba.gui.components.Timer;
+import com.haulmont.cuba.web.WebConfig;
 import com.haulmont.cuba.web.app.mainwindow.AppMainWindow;
+import de.diedavids.cuba.userinbox.service.MessageService;
+
+import javax.inject.Inject;
+import java.util.Map;
 
 public class AppMainWindowWithMessages extends AppMainWindow {
 
 
+    @Inject
+    private Action openMessagesAction;
+
+    @Inject
+    private MessageService messageService;
+
+    @Inject
+    private Timer updateCountersTimer;
+
+    @Inject
+    private WebConfig webConfig;
+
     public void openMessages() {
         openWindow("user-inbox", WindowManager.OpenType.DIALOG);
     }
 
+    @Override
+    public void init(Map<String, Object> params) {
+        initUpdateCounterTimerDelay();
+    }
+
+    private void initUpdateCounterTimerDelay() {
+        int period = webConfig.getAppFoldersRefreshPeriodSec() * 1000;
+        updateCountersTimer.setDelay(period);
+    }
+
+    @Override
+    public void ready() {
+        updateMessageCounter();
+    }
+
+    public void updateCounters(Timer source) {
+        updateMessageCounter();
+    }
+
+    private void updateMessageCounter() {
+        int messageCounter = getMessageCounter();
+        String messageCounterCaption = "";
+
+        if (messageCounter > 0) {
+            messageCounterCaption = "(" + messageCounter + ")";
+        }
+
+        openMessagesAction.setCaption(messageCounterCaption);
+    }
+
+    private int getMessageCounter() {
+        return messageService.countUnreadMessagesForCurrentUser();
+    }
 }

modules/web/src/de/diedavids/cuba/userinbox/web/screens/SideMainwindowWithMessages.java

@@ -6,6 +6,7 @@
 import com.haulmont.cuba.gui.components.Timer;
 import com.haulmont.cuba.gui.components.mainwindow.FtsField;
 import com.haulmont.cuba.gui.components.mainwindow.SideMenu;
+import com.haulmont.cuba.web.WebConfig;
 import de.diedavids.cuba.userinbox.service.MessageService;
 
 import javax.inject.Inject;
@@ -25,6 +26,13 @@ public class SideMainwindowWithMessages extends AbstractMainWindow {
     @Inject
     private MessageService messageService;
 
+
+    @Inject
+    private Timer updateCountersTimer;
+
+    @Inject
+    private WebConfig webConfig;
+
     @Override
     public void init(Map<String, Object> params) {
         super.init(params);
@@ -35,12 +43,22 @@ public void init(Map<String, Object> params) {
         initLogoImage(logoImage);
         initFtsField(ftsField);
 
+        initUpdateCounterTimerDelay();
         initMessagesMenuItem();
 
         sideMenu.setSelectOnClick(true);
 
+
+
     }
 
+
+    private void initUpdateCounterTimerDelay() {
+        int period = webConfig.getAppFoldersRefreshPeriodSec() * 1000;
+        updateCountersTimer.setDelay(period);
+    }
+
+
     private void initMessagesMenuItem() {
         SideMenu.MenuItem messagesMenuItem = sideMenu.createMenuItem("messages");
         messagesMenuItem.setCaption(messages.getMessage(this.getClass(), "messages"));

modules/web/src/de/diedavids/cuba/userinbox/web/screens/mainwindow-with-messages.xml

@@ -4,17 +4,20 @@
         extends="/com/haulmont/cuba/web/app/mainwindow/mainwindow.xml"
         messagesPack="de.diedavids.cuba.userinbox.web.screens"
         xmlns:ext="http://schemas.haulmont.com/cuba/window-ext.xsd">
-    <dialogMode height="600"
-                width="800"/>
+    <timers>
+        <timer id="updateCountersTimer" delay="3000" autostart="true" repeating="true" onTimer="updateCounters"/>
+    </timers>
     <actions>
-        <action id="openMessagesAction" invoke="openMessages"/>
+        <action id="openMessagesAction"
+                invoke="openMessages"
+                icon="font-icon:ENVELOPE_O"
+        />
     </actions>
     <layout>
         <hbox id="titleBar">
             <button id="messagesBtn"
                     ext:index="2"
-                    action="openMessagesAction"
-                    icon="font-icon:ENVELOPE_O"/>
+                    action="openMessagesAction"/>
         </hbox>
     </layout>
 </window>

modules/web/src/de/diedavids/cuba/userinbox/web/screens/side-mainwindow-with-messages.xml

@@ -5,7 +5,7 @@
         messagesPack="de.diedavids.cuba.userinbox.web.screens"
         xmlns:main="http://schemas.haulmont.com/cuba/mainwindow.xsd">
     <timers>
-        <timer delay="3000" autostart="true" repeating="true" onTimer="updateCounters"/>
+        <timer id="updateCountersTimer" delay="3000"  autostart="true" repeating="true" onTimer="updateCounters"/>
     </timers>
     <layout expand="horizontalWrap">
         <hbox id="horizontalWrap"