View Javadoc
1   /**
2    * This file Copyright (c) 2014-2017 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.ui.admincentral.shellapp.pulse.item.list;
35  
36  import info.magnolia.ui.admincentral.shellapp.pulse.item.detail.PulseItemCategory;
37  import info.magnolia.ui.admincentral.shellapp.pulse.item.list.footer.PulseListFooterView;
38  import info.magnolia.ui.api.view.View;
39  
40  import java.util.List;
41  import java.util.Set;
42  
43  import com.vaadin.data.Container;
44  
45  /**
46   * A generic pulse item view. An item can be e.g. an error message, a workflow task etc.
47   */
48  public interface PulseListView extends View {
49  
50      void setDataSource(Container dataSource);
51  
52      void setListener(Listener listener);
53  
54      /**
55       * @deprecated since 5.5.
56       */
57      @Deprecated
58      void refresh();
59  
60      void updateCategoryBadgeCount(PulseItemCategory type, int count);
61  
62      void setTabActive(PulseItemCategory category);
63  
64      void setFooter(PulseListFooterView footer);
65  
66      List<Object> getSelectedItemIds();
67  
68      /**
69       * Listener interface to call back to {@link PulseListPresenter}.
70       */
71      interface Listener {
72  
73          void filterByItemCategory(PulseItemCategory category);
74  
75          void onItemClicked(String itemId);
76  
77          void onSelectionChanged(Set<Object> itemIds);
78  
79          void setGrouping(boolean checked);
80  
81          /**
82           * @deprecated since 5.5 Bulk actions on footer now configurable. So, this function moved to {@link info.magnolia.ui.admincentral.shellapp.pulse.message.action.DeleteMessagesAction}.
83           */
84          @Deprecated
85          void deleteItems(Set<String> itemsIds);
86  
87          long getTotalEntriesAmount();
88  
89          void onItemSetChanged(long totalEntriesAmount);
90      }
91  
92  }