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.contentapp.action;
35  
36  import info.magnolia.ui.CloseHandler;
37  import info.magnolia.ui.ValueContext;
38  import info.magnolia.ui.api.action.ActionExecutionException;
39  import info.magnolia.ui.contentapp.Datasource;
40  import info.magnolia.ui.editor.EditorView;
41  import info.magnolia.ui.observation.DatasourceObservation;
42  
43  import java.util.Collection;
44  import java.util.List;
45  import java.util.stream.Collectors;
46  
47  import javax.inject.Inject;
48  
49  import com.vaadin.data.BinderValidationStatus;
50  import com.vaadin.data.BindingValidationStatus;
51  import com.vaadin.ui.Component;
52  
53  import lombok.AccessLevel;
54  import lombok.Getter;
55  
56  /**
57   * Save the form view present in the context.
58   */
59  @Getter(AccessLevel.PROTECTED)
60  public class CommitAction<T> extends CloseAction<CommitActionDefinition> {
61  
62      private final ValueContext<T> valueContext;
63      private final EditorView<T> form;
64      private final Datasource<T> datasource;
65      private final DatasourceObservation.Manual datasourceObservation;
66  
67      @Inject
68      public CommitAction(CommitActionDefinition definition, CloseHandler closeHandler, ValueContext<T> valueContext, EditorView<T> form, Datasource<T> datasource, DatasourceObservation.Manual datasourceObservation) {
69          super(definition, closeHandler);
70          this.valueContext = valueContext;
71          this.form = form;
72          this.datasource = datasource;
73          this.datasourceObservation = datasourceObservation;
74      }
75  
76      @Override
77      public void execute() throws ActionExecutionException {
78          List<BinderValidationStatus<?>> validationStatuses = form.validate();
79          boolean hasValidationErrors = validationStatuses.stream().anyMatch(BinderValidationStatus::hasErrors);
80  
81          // If there are any validation errors, focus on the first focusable parent and return
82          if (hasValidationErrors) {
83              // Flatten the list of FieldValidationErrors from both the form and the subforms
84              List<BindingValidationStatus<?>> bindingValidationStatuses = validationStatuses.stream()
85                      .map(BinderValidationStatus::getFieldValidationErrors)
86                      .flatMap(Collection::stream).collect(Collectors.toList());
87  
88              // Fetch all the form validation errors for the first locale
89              for (BindingValidationStatus<?> validationStatus : bindingValidationStatuses) {
90                  Component field = (Component) validationStatus.getField();
91                  Component parent = field.getParent();
92  
93                  while ((parent != null) && !(parent instanceof Component.Focusable)) {
94                      parent = parent.getParent();
95                  }
96  
97                  if (parent != null) {
98                      ((Component.Focusable) parent).focus();
99                      break;
100                 }
101             }
102             return;
103         }
104 
105         write();
106 
107         super.execute();
108     }
109 
110     protected void write() {
111         valueContext.getSingle().ifPresent(item -> {
112             form.write(item);
113             datasource.commit(item);
114             datasourceObservation.trigger();
115         });
116     }
117 
118 }