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 info.magnolia.ui.api.action.ActionDefinition;
37  import info.magnolia.ui.availability.AvailabilityChecker;
38  import info.magnolia.ui.ValueContext;
39  
40  import java.util.ArrayList;
41  import java.util.Optional;
42  
43  import javax.inject.Inject;
44  
45  import com.vaadin.ui.Button;
46  
47  /**
48   * Button control typically found in the action area
49   * of dialogs and editor views. Tracks the value currently
50   * set in {@link ValueContext value context} and updates own
51   * availability accordingly.
52   *
53   * Executes a pre-configured action upon click.
54   */
55  public class ActionButton<T> extends Button {
56  
57      @Inject
58      public ActionButton(AvailabilityChecker<T> availabilityChecker,
59                          ValueContext<T> valueContext,
60                          ActionExecution<T> execution) {
61          ActionDefinition actionDefinition = execution.getDefinition();
62          addClickListener(e -> execution.execute());
63  
64          valueContext.observe(items ->
65                  setEnabled(availabilityChecker.isAvailable(actionDefinition.getAvailability(), new ArrayList<>(items))));
66  
67          setCaption(Optional.ofNullable(actionDefinition.getLabel()).orElse(actionDefinition.getName()));
68          addStyleNames(actionDefinition.getName());
69      }
70  }