View Javadoc
1   /**
2    * This file Copyright (c) 2010-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.ui.vaadin.gwt.client.actionbar.widget;
35  
36  import info.magnolia.ui.vaadin.gwt.client.actionbar.shared.ActionbarItem;
37  import info.magnolia.ui.vaadin.gwt.client.actionbar.shared.ActionbarSection;
38  
39  import java.util.Collection;
40  import java.util.Map;
41  
42  import com.google.gwt.user.client.ui.HasWidgets;
43  import com.google.gwt.user.client.ui.IsWidget;
44  
45  /**
46   * View interface of client-side action bar.
47   */
48  public interface ActionbarWidgetView extends HasWidgets, IsWidget {
49  
50      /**
51       * Gets the section widgets inside this action bar view.
52       *
53       * @return the sections
54       */
55      Map<String, ActionbarSectionWidget> getSections();
56  
57      /**
58       * Sets the presenter.
59       *
60       * @param presenter the new presenter
61       */
62      void setPresenter(Presenter presenter);
63  
64      void setSections(Collection<ActionbarSection> sections);
65  
66      void setVisibleSections(Collection<ActionbarSection> visibleSections);
67  
68      void setDisabledActions(Collection<ActionbarItem> enabledActions);
69  
70      void setSectionPreview(String sectionName, String previewUrl);
71  
72      /**
73       * Update the classes on the actions so that they are positioned correctly.
74       * Necessary to handle when sections are dynamically changed like in the page editor.
75       */
76      void refreshActionsPositionsTablet();
77  
78      boolean isOpen();
79  
80      void setOpen(boolean isOpen);
81  
82      void updateLayout();
83  
84      /**
85       * Presenter for the Actionbar view.
86       */
87      interface Presenter {
88  
89          void triggerAction(String actionToken);
90  
91          void forceLayout();
92  
93          void setOpened(boolean opened);
94  
95          boolean isDeviceTablet();
96  
97          String getIconResourceURL(String actionName);
98      }
99  }