View Javadoc
1   /**
2    * This file Copyright (c) 2019 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;
35  
36  import static java.util.stream.Collectors.toMap;
37  
38  import info.magnolia.objectfactory.ComponentProvider;
39  import info.magnolia.ui.availability.AvailabilityChecker;
40  import info.magnolia.ui.ValueContext;
41  import info.magnolia.ui.dialog.layout.DefaultEditorActionLayoutDefinition;
42  import info.magnolia.ui.framework.layout.LayoutDefinition;
43  
44  import java.util.ArrayList;
45  import java.util.Arrays;
46  import java.util.Collection;
47  import java.util.HashMap;
48  import java.util.List;
49  import java.util.Map;
50  
51  import javax.inject.Inject;
52  
53  import com.vaadin.ui.Component;
54  
55  /**
56   * Simple assembly utility class which populates the controls and actions for
57   * action areas of dialogs and editor sub-apps.
58   */
59  public class EditorActionBar<T> {
60  
61      private Map<String, Component> labeledControls = new HashMap<>();
62      private List<ActionExecution<T>> actionDefinitions = new ArrayList<>();
63      private LayoutDefinition<?> layoutDefinition = new DefaultEditorActionLayoutDefinition();
64  
65      private final ComponentProvider componentProvider;
66      private final ValueContext<T> valueContext;
67      private final AvailabilityChecker<T> availabilityChecker;
68  
69      @Inject
70      public EditorActionBar(ComponentProvider componentProvider, ValueContext<T> valueContext, AvailabilityChecker<T> availabilityChecker) {
71          this.componentProvider = componentProvider;
72          this.valueContext = valueContext;
73          this.availabilityChecker = availabilityChecker;
74      }
75  
76      public EditorActionBar<T> withLayoutDefinition(LayoutDefinition<?> layoutDefinition) {
77          this.layoutDefinition = layoutDefinition;
78          return this;
79      }
80  
81      public EditorActionBar<T> withActions(Collection<ActionExecution<T>> definitions) {
82          actionDefinitions.addAll(definitions);
83          return this;
84      }
85  
86      public EditorActionBar<T> withActions(ActionExecution... definitions) {
87          return withActions(Arrays.asList(definitions));
88      }
89  
90      public EditorActionBar<T> withLabeledControl(String label, Component control) {
91          this.labeledControls.put(label, control);
92          return this;
93      }
94  
95      public Component layout() {
96          Map<String, Component> allActionControls = actionDefinitions.stream()
97                  .collect(toMap(execution -> execution.getDefinition().getName(),
98                          execution ->
99                                  componentProvider.newInstance(ActionButton.class, execution, valueContext, availabilityChecker)));
100         allActionControls.putAll(labeledControls);
101 
102         //noinspection unchecked
103         return componentProvider.newInstance(layoutDefinition.getImplementationClass()).createLayout(layoutDefinition, allActionControls);
104     }
105 
106 }