View Javadoc
1   /**
2    * This file Copyright (c) 2016-2018 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.framework.tools;
35  
36  import info.magnolia.ui.api.action.ActionDefinition;
37  import info.magnolia.ui.api.action.ActionExecutionException;
38  import info.magnolia.ui.api.view.View;
39  import info.magnolia.ui.dialog.actionarea.ActionListener;
40  import info.magnolia.ui.dialog.formdialog.FormBuilder;
41  import info.magnolia.ui.form.EditorValidator;
42  import info.magnolia.ui.form.definition.FormDefinition;
43  import info.magnolia.ui.vaadin.form.Form;
44  import info.magnolia.ui.vaadin.form.FormViewReduced;
45  
46  import java.util.Map;
47  
48  import javax.inject.Inject;
49  
50  import org.slf4j.Logger;
51  import org.slf4j.LoggerFactory;
52  
53  import com.vaadin.v7.data.Item;
54  import com.vaadin.v7.data.util.PropertysetItem;
55  
56  /**
57   * A {@link FormToolPresenter} consumes a {@link FormToolDefinition} and presents a generic configured form
58   * in a {@link FormToolView}.
59   */
60  public class FormToolPresenter implements ToolPresenter<FormToolDefinition, FormToolView>, ActionListener, EditorValidator {
61  
62      private static final Logger log = LoggerFactory.getLogger(FormToolPresenter.class);
63  
64      private final FormToolView view;
65      private final FormBuilder formBuilder;
66      private final FormToolActionExecutor actionExecutor;
67      private Item item;
68      private FormViewReduced formView;
69  
70      @Inject
71      public FormToolPresenter(FormToolView view, FormBuilder formBuilder, FormToolActionExecutor actionExecutor) {
72          this.view = view;
73          this.formBuilder = formBuilder;
74          this.actionExecutor = actionExecutor;
75      }
76  
77      @Override
78      public FormToolView start(FormToolDefinition definition) {
79          item = getItem();
80  
81          formView = new Form();
82          FormDefinition form = definition.getForm();
83          if (form != null) {
84              formBuilder.buildReducedForm(form, formView, item, null);
85              view.setForm(formView);
86          } else {
87              view.asVaadinComponent().addStyleName("no-form");
88          }
89  
90          actionExecutor.setFormToolDefinition(definition);
91          buildActions(definition);
92  
93          return view;
94      }
95  
96      protected Item getItem() {
97          return new PropertysetItem();
98      }
99  
100     protected View getView() {
101         return view;
102     }
103 
104     protected void buildActions(FormToolDefinition definition) {
105         Map<String, ActionDefinition> actions = definition.getActions();
106         if (actions != null && !actions.isEmpty()) {
107             for (final ActionDefinition action : actions.values()) {
108                 view.addAction(action.getName(), action.getLabel(), this);
109             }
110         }
111     }
112 
113     @Override
114     public void onActionFired(String actionName, Object... actionContextParams) {
115         try {
116             actionExecutor.execute(actionName, view, this, item);
117         } catch (ActionExecutionException e) {
118             log.error("Cannot execute action " + actionName, e);
119         }
120     }
121 
122     @Override
123     public void showValidation(boolean visible) {
124         formView.showValidation(visible);
125     }
126 
127     @Override
128     public boolean isValid() {
129         return formView.isValid();
130     }
131 }