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 info.magnolia.ui.contentapp.action.CommitActionDefinition.COMMIT_ACTION_NAME;
37
38 import info.magnolia.ui.api.action.ActionDefinition;
39 import info.magnolia.ui.availability.AvailabilityChecker;
40 import info.magnolia.ui.ValueContext;
41 import info.magnolia.ui.contentapp.action.CommitActionDefinition;
42
43 import java.util.ArrayList;
44 import java.util.Optional;
45
46 import javax.inject.Inject;
47
48 import com.vaadin.ui.Button;
49
50 /**
51 * Button control typically found in the action area
52 * of dialogs and editor views. Tracks the value currently
53 * set in {@link ValueContext value context} and updates own
54 * availability accordingly.
55 *
56 * Executes a pre-configured action upon click.
57 */
58 public class ActionButton<T> extends Button {
59
60 @Inject
61 public ActionButton(AvailabilityChecker<T> availabilityChecker,
62 ValueContext<T> valueContext,
63 ActionExecution<T> execution) {
64 ActionDefinition actionDefinition = execution.getDefinition();
65 addClickListener(e -> execution.execute());
66
67 valueContext.observe(items ->
68 setEnabled(availabilityChecker.isAvailable(actionDefinition.getAvailability(), new ArrayList<>(items))));
69
70 setCaption(Optional.ofNullable(actionDefinition.getLabel()).orElse(actionDefinition.getName()));
71 addStyleNames(actionDefinition.getName());
72 addStylingToConfirmationButton(actionDefinition);
73 }
74
75 /**
76 * TODO MGNLUI-5925
77 * One button in dialog is usually the confirming one. At the time of writing, in dialogs, it’s the rightmost green
78 * button Code-wise it's always a CommitActionDefinition, but child classes can name the action differently than
79 * "commit".
80 * In these cases we need to add the "commit" style that is used to distinguish the main confirmation button
81 * visually.
82 * @param actionDefinition for the action triggered by the button.
83 */
84 private void addStylingToConfirmationButton(ActionDefinition actionDefinition) {
85 if (actionDefinition instanceof CommitActionDefinition) {
86 addStyleNames("primary-button");
87 }
88 }
89 }