automatic read flag once the message was shown in editor (#1) (#2)

Author: mariodavid

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

@@ -2,15 +2,15 @@
 <screen-config xmlns="http://schemas.haulmont.com/cuba/screens.xsd">
     <include file="de/diedavids/cuba/userinbox/screens.xml"/>
 
-    <!--
 
+    <!--
     <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/message/MessageEdit.groovy

@@ -1,7 +1,20 @@
 package de.diedavids.cuba.userinbox.web.message
 
 import com.haulmont.cuba.gui.components.AbstractEditor
+import com.haulmont.cuba.gui.data.Datasource
 import de.diedavids.cuba.userinbox.entity.Message
 
+import javax.inject.Inject
+
 class MessageEdit extends AbstractEditor<Message> {
+
+
+    @Inject
+    Datasource<Message> messageDs
+
+    @Override
+    protected void postInit() {
+        item.read = true
+        messageDs.commit()
+    }
 }

modules/web/src/de/diedavids/cuba/userinbox/web/message/ToggleReadActionListener.groovy

@@ -0,0 +1,36 @@
+package de.diedavids.cuba.userinbox.web.message
+
+import com.haulmont.cuba.core.global.Messages
+import com.haulmont.cuba.gui.components.Action
+import com.haulmont.cuba.gui.data.Datasource
+import de.diedavids.cuba.userinbox.entity.Message
+
+
+class ToggleReadActionListener implements Datasource.ItemChangeListener<Message> {
+
+    Action toggleReadAction
+    Messages messages
+
+
+    @Override
+    void itemChanged(Datasource.ItemChangeEvent<Message> e) {
+        if (e.item) {
+            updateToggleReadAction(e.item)
+        }
+    }
+
+    private updateToggleReadAction(Message message) {
+        if(message.read) {
+            toggleReadAction.caption = formatMessage('markAsUnread')
+            toggleReadAction.icon = 'font-icon:SQUARE_O'
+        }
+        else {
+            toggleReadAction.caption = formatMessage('markAsRead')
+            toggleReadAction.icon = 'font-icon:CHECK_SQUARE_O'
+        }
+    }
+
+    private String formatMessage(String messageKey) {
+        messages.formatMessage(getClass(), messageKey)
+    }
+}

modules/web/src/de/diedavids/cuba/userinbox/web/message/UserInbox.groovy

@@ -6,6 +6,7 @@ import com.haulmont.cuba.core.global.LoadContext
 import com.haulmont.cuba.core.global.Metadata
 import com.haulmont.cuba.gui.WindowManager
 import com.haulmont.cuba.gui.components.AbstractLookup
+import com.haulmont.cuba.gui.components.Action
 import com.haulmont.cuba.gui.components.Frame
 import com.haulmont.cuba.gui.components.Table
 import com.haulmont.cuba.gui.components.actions.CreateAction
@@ -25,6 +26,9 @@ class UserInbox extends AbstractLookup {
     @Named('messagesTable.edit')
     EditAction editAction
 
+    @Named('messagesTable.toggleRead')
+    Action toggleReadAction
+
     @Inject
     Table<Message> messagesTable
 
@@ -48,9 +52,14 @@ class UserInbox extends AbstractLookup {
                 showMessageSendNotification()
             }
         }
-    }
 
 
+        messagesDs.addItemChangeListener(new ToggleReadActionListener(
+                messages: messages,
+                toggleReadAction: toggleReadAction
+        ))
+    }
+
     private showMessageSendNotification() {
         showNotification(messages.formatMessage(getClass(), 'messageSend'), Frame.NotificationType.TRAY)
     }
@@ -68,7 +77,7 @@ class UserInbox extends AbstractLookup {
         LoadContext loadContext = LoadContext.create(entityClass)
                 .setId(getRecordId(item))
 
-         dataManager.load(loadContext)
+        dataManager.load(loadContext)
     }
 
     protected UUID getRecordId(Message item) {
@@ -78,4 +87,14 @@ class UserInbox extends AbstractLookup {
     protected Class getClassFromMessageRecord(Message item) {
         metadata.getClass(item.entityReferenceClass)?.javaClass
     }
+
+    void toggleRead() {
+
+
+        def message = messagesTable.singleSelected
+        message.read = !message.read
+
+        messagesDs.commit()
+
+    }
 }

modules/web/src/de/diedavids/cuba/userinbox/web/message/messages.properties

@@ -3,3 +3,5 @@ newMessage= Send Message
 editorCaption = Message Details
 
 messageSend = Message successful send
+markAsRead=Mark as read
+markAsUnread=Mark as unread

modules/web/src/de/diedavids/cuba/userinbox/web/message/user-inbox.xml

@@ -31,6 +31,12 @@
                         caption="msg://newMessage"/>
                 <action id="edit" caption="mainMsg://actions.View" icon="font-icon:SEARCH"/>
                 <action id="remove"/>
+                <action id="toggleRead"
+                        invoke="toggleRead"
+                        caption="msg://markAsRead"
+                        icon="font-icon:CHECK_SQUARE_O"
+                        trackSelection="true"
+                />
             </actions>
             <columns>
                 <column id="sender"/>
@@ -49,6 +55,8 @@
                         action="messagesTable.edit"/>
                 <button id="removeBtn"
                         action="messagesTable.remove"/>
+                <button id="toggleReadBtn"
+                        action="messagesTable.toggleRead"/>
             </buttonsPanel>
         </groupTable>
     </layout>