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.actions;
35  
36  import info.magnolia.config.registry.Registry;
37  import info.magnolia.context.Context;
38  import info.magnolia.ui.api.action.AbstractAction;
39  import info.magnolia.ui.api.action.ActionExecutionException;
40  import info.magnolia.ui.contentapp.browser.context.ValueContext;
41  import info.magnolia.ui.dialog.DialogDefinition;
42  import info.magnolia.ui.dialog.DialogDefinitionRegistry;
43  import info.magnolia.ui.dialog.DialogHelper;
44  import info.magnolia.ui.dialog.FormDialogDefinition;
45  import info.magnolia.ui.field.EditorPropertyDefinition;
46  import info.magnolia.ui.form.LocaleContext;
47  import info.magnolia.ui.framework.UiFrameworkView;
48  import info.magnolia.ui.framework.databinding.view.EditorView;
49  
50  import java.util.stream.Collectors;
51  
52  import javax.inject.Inject;
53  
54  /**
55   * Opens a dialog.
56   */
57  public class OpenDialogAction<T> extends AbstractAction<OpenDialogActionDefinition> {
58  
59      private final UiFrameworkView parentView;
60      private final DialogDefinitionRegistry dialogDefinitionRegistry;
61      private final ValueContext<T> valueContext;
62      private final LocaleContext localeContext;
63      private final Context mgnlContext;
64  
65      @Inject
66      public OpenDialogAction(OpenDialogActionDefinition definition,
67                              ValueContext<T> valueContext,
68                              LocaleContext localeContext,
69                              UiFrameworkView parentView,
70                              DialogDefinitionRegistry dialogDefinitionRegistry,
71                              Context mgnlContext) {
72          super(definition);
73          this.valueContext = valueContext;
74          this.localeContext = localeContext;
75          this.parentView = parentView;
76          this.dialogDefinitionRegistry = dialogDefinitionRegistry;
77          this.mgnlContext = mgnlContext;
78      }
79  
80      @Override
81      public void execute() throws ActionExecutionException {
82          try {
83              DialogDefinition dialogDefinition = dialogDefinitionRegistry.getProvider(getDefinition().getDialogId()).get();
84              if (dialogDefinition instanceof FormDialogDefinition) {
85                  FormDialogDefinition<T> formDialogDefinition = (FormDialogDefinition) dialogDefinition;
86                  EditorView<T> form = parentView.create(formDialogDefinition.getForm());
87                  valueContext.getSingle().ifPresent(form::populate);
88  
89                  new DialogHelper()
90                          .withActions(formDialogDefinition.getActions())
91                          .withLayoutDefinition(formDialogDefinition.getFooterLayout())
92                          .withContent(form)
93                          .withCaption(dialogDefinition.getLabel())
94                          .withItems(valueContext.get().collect(Collectors.toList()))
95                          .withLocaleContext(formDialogDefinition.getForm().getProperties().stream()
96                                  .filter(EditorPropertyDefinition::isI18n)
97                                  .findFirst()
98                                  .map(any -> localeContext)
99                                  .orElse(null)
100                         )
101                         .withUserLanguage(mgnlContext::getLocale)
102                         .buildAndOpen();
103 
104             } else {
105                 throw new ActionExecutionException(String.format("Expected instance of %s but got %s", FormDialogDefinition.class, dialogDefinition));
106             }
107         } catch (Registry.InvalidDefinitionException | Registry.NoSuchDefinitionException e) {
108             throw new ActionExecutionException(e);
109         }
110     }
111 }