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.ui.dialog.actionarea.view;
35  
36  import info.magnolia.ui.api.view.View;
37  
38  import java.util.HashMap;
39  import java.util.Map;
40  
41  import com.vaadin.ui.AbstractOrderedLayout;
42  import com.vaadin.ui.Component;
43  import com.vaadin.ui.ComponentContainer;
44  
45  /**
46   * Abstract base implementation of {@link EditorActionAreaView}. Was extracted in order
47   * to simplify the implementation fork between Mgnl 5 and 6.
48   */
49  public abstract class AbstractActionAreaViewImpl implements EditorActionAreaView {
50  
51      private AbstractOrderedLayout layout;
52      private Map<String, View> actionNameToView = new HashMap<>();
53  
54      public AbstractActionAreaViewImpl() {
55          this.layout = createRootLayout();
56          layout.addStyleName("footer");
57          layout.setWidthUndefined();
58      }
59  
60      @Override
61      public ComponentContainer asVaadinComponent() {
62          return layout;
63      }
64  
65      @Override
66      public void addPrimaryAction(View actionView, String actionName) {
67          actionNameToView.put(actionName, actionView);
68          insertPrimaryAction(actionView.asVaadinComponent(), layout);
69      }
70  
71      @Override
72      public void addSecondaryAction(View actionView, String actionName) {
73          actionNameToView.put(actionName, actionView);
74          insertSecondaryAction(actionView.asVaadinComponent(), layout);
75      }
76  
77      @Override
78      public void removeAllActions() {
79          actionNameToView.clear();
80          layout.removeAllComponents();
81      }
82  
83      @Override
84      public void setToolbarComponent(Component toolbar) {
85          toolbar.addStyleName("tool-control");
86          layout.addComponent(toolbar, 0);
87      }
88  
89      @Override
90      public View getViewForAction(String actionName) {
91          return actionNameToView.get(actionName);
92      }
93  
94      protected abstract AbstractOrderedLayout createRootLayout();
95  
96      protected abstract void insertPrimaryAction(Component actionControl, AbstractOrderedLayout layout);
97  
98      protected abstract void insertSecondaryAction(Component actionControl, AbstractOrderedLayout layout);
99  }