View Javadoc
1   /**
2    * This file Copyright (c) 2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.admincentral.badge;
35  
36  import info.magnolia.context.Context;
37  import info.magnolia.event.EventBus;
38  import info.magnolia.i18nsystem.SimpleTranslator;
39  import info.magnolia.ui.api.event.AdmincentralEventBus;
40  import info.magnolia.ui.api.location.DefaultLocation;
41  import info.magnolia.ui.api.location.Location;
42  import info.magnolia.ui.api.location.LocationController;
43  import info.magnolia.ui.api.message.Message;
44  import info.magnolia.ui.api.shell.CloseAppEvent;
45  import info.magnolia.ui.framework.message.MessagesManager;
46  
47  import java.util.Optional;
48  
49  import javax.inject.Inject;
50  import javax.inject.Named;
51  
52  /**
53   * Notification badge implementation.
54   */
55  public class NotificationBadge extends AbstractBadge implements MessagesManager.MessageListener {
56  
57      private final MessagesManager messagesManager;
58      private final EventBus eventBus;
59  
60      @Inject
61      NotificationBadge(LocationController controller, Context context, SimpleTranslator i18n, MessagesManager messagesManager,
62                        @Named(AdmincentralEventBus.NAME) EventBus eventBus) {
63          super(controller, context, i18n);
64          this.messagesManager = messagesManager;
65          this.messagesManager.registerMessagesListener(getUserName(), this);
66          this.eventBus = eventBus;
67  
68          update();
69      }
70  
71      @Deprecated
72      NotificationBadge(LocationController controller, Context context, SimpleTranslator i18n, MessagesManager messagesManager) {
73          this(controller, context, i18n, messagesManager, null);
74      }
75  
76      @Override
77      Status getStatus() {
78          // the number of new, unread notifications
79          int count = messagesManager.getNumberOfUnclearedMessagesForUser(getUserName());
80          String description = getI18n().translate("badge.notification.description", count);
81          return new Status(count > 0, count, description);
82      }
83  
84      @Override
85      public void messageSent(Message message) {
86          update();
87      }
88  
89      @Override
90      public void messageCleared(Message message) {
91          update();
92      }
93  
94      @Override
95      public void messageRemoved(String id) {
96          update();
97      }
98  
99      @Override
100     public String getCaption() {
101         return getI18n().translate("notifications.app.caption");
102     }
103 
104     @Override
105     Location getLocation() {
106         return new DefaultLocation("app", "notifications");
107     }
108 
109     @Override
110     public void detach() {
111         messagesManager.unregisterMessagesListener(getUserName(), this);
112         super.detach();
113     }
114 
115     @Override
116     protected void onBadgeDeselected() {
117         Optional.ofNullable(eventBus).ifPresent(eb -> eventBus.fireEvent(new CloseAppEvent()));
118     }
119 }