View Javadoc
1   /**
2    * This file Copyright (c) 2012-2015 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.detail;
35  
36  import info.magnolia.event.EventBus;
37  import info.magnolia.i18nsystem.I18nizer;
38  import info.magnolia.i18nsystem.SimpleTranslator;
39  import info.magnolia.objectfactory.ComponentProvider;
40  import info.magnolia.ui.api.action.ActionDefinition;
41  import info.magnolia.ui.api.action.ActionExecutionException;
42  import info.magnolia.ui.api.action.ActionExecutor;
43  import info.magnolia.ui.api.app.SubAppContext;
44  import info.magnolia.ui.api.availability.AvailabilityChecker;
45  import info.magnolia.ui.api.event.AdmincentralEventBus;
46  import info.magnolia.ui.api.event.ContentChangedEvent;
47  import info.magnolia.ui.api.message.Message;
48  import info.magnolia.ui.api.message.MessageType;
49  import info.magnolia.ui.contentapp.DefinitionCloner;
50  import info.magnolia.ui.contentapp.definition.EditorDefinition;
51  import info.magnolia.ui.dialog.DialogView;
52  import info.magnolia.ui.dialog.actionarea.ActionListener;
53  import info.magnolia.ui.dialog.actionarea.EditorActionAreaPresenter;
54  import info.magnolia.ui.dialog.actionarea.definition.FormActionItemDefinition;
55  import info.magnolia.ui.dialog.actionarea.view.EditorActionAreaView;
56  import info.magnolia.ui.dialog.formdialog.FormBuilder;
57  import info.magnolia.ui.dialog.formdialog.FormView;
58  import info.magnolia.ui.form.EditorCallback;
59  import info.magnolia.ui.form.EditorValidator;
60  import info.magnolia.ui.form.FormPresenter;
61  import info.magnolia.ui.form.definition.FormDefinition;
62  import info.magnolia.ui.form.definition.TabDefinition;
63  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
64  import info.magnolia.ui.form.field.definition.FieldDefinition;
65  import info.magnolia.ui.framework.app.SubAppActionExecutor;
66  import info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector;
67  
68  import java.util.Arrays;
69  import java.util.HashMap;
70  import java.util.LinkedList;
71  import java.util.List;
72  import java.util.Map;
73  
74  import javax.inject.Inject;
75  import javax.inject.Named;
76  
77  import org.slf4j.Logger;
78  import org.slf4j.LoggerFactory;
79  
80  import com.vaadin.data.Item;
81  import com.vaadin.event.ShortcutListener;
82  import com.vaadin.ui.Button;
83  
84  /**
85   * Presenter for the item displayed in the {@link info.magnolia.ui.contentapp.detail.DetailEditorPresenter}. Takes care
86   * of building and switching between the right {@link DetailView.ViewType}.
87   */
88  public class DetailPresenter implements EditorCallback, EditorValidator, ActionListener {
89  
90      private static final Logger log = LoggerFactory.getLogger(DetailPresenter.class);
91  
92      private final SubAppContext subAppContext;
93  
94      private final EventBus eventBus;
95  
96      private final DetailView view;
97  
98      private final ComponentProvider componentProvider;
99  
100     private final ActionExecutor executor;
101 
102     private final I18nizer i18nizer;
103 
104     private final SimpleTranslator i18n;
105 
106     private final AvailabilityChecker checker;
107 
108     private final ContentConnector contentConnector;
109 
110     private FormPresenter formPresenter;
111 
112     private final DefinitionCloner cloner;
113 
114     private EditorDefinition editorDefinition;
115 
116     private Item item;
117 
118     private Object itemId;
119 
120     private DialogView dialogView;
121 
122     private DetailView.ViewType viewType;
123 
124     /**
125      * @deprecated since 5.4.2 - use {@link #DetailPresenter(SubAppContext, EventBus, DetailView, ComponentProvider, SubAppActionExecutor, I18nizer, SimpleTranslator, AvailabilityChecker, ContentConnector, FormPresenter)} instead.
126      */
127     @Deprecated
128     public DetailPresenter(SubAppContext subAppContext, final @Named(AdmincentralEventBus.NAME) EventBus eventBus, DetailView view,
129                            FormBuilder formBuilder, ComponentProvider componentProvider, SubAppActionExecutor executor, I18nizer i18nizer, SimpleTranslator i18n, AvailabilityChecker checker, ContentConnector contentConnector) {
130         this(subAppContext, eventBus, view, componentProvider, executor, i18nizer, i18n, checker, contentConnector, componentProvider.getComponent(FormPresenter.class));
131     }
132 
133     @Inject
134     public DetailPresenter(SubAppContext subAppContext, final @Named(AdmincentralEventBus.NAME) EventBus eventBus, DetailView view,
135             ComponentProvider componentProvider, SubAppActionExecutor executor, I18nizer i18nizer, SimpleTranslator i18n, AvailabilityChecker checker, ContentConnector contentConnector, FormPresenter formPresenter) {
136         this.subAppContext = subAppContext;
137         this.eventBus = eventBus;
138         this.view = view;
139         this.componentProvider = componentProvider;
140         this.executor = executor;
141         this.i18nizer = i18nizer;
142         this.i18n = i18n;
143         this.checker = checker;
144         this.contentConnector = contentConnector;
145         this.formPresenter = formPresenter;
146         this.cloner = new DefinitionCloner();
147     }
148 
149     public DetailView start(EditorDefinition editorDefinition, DetailView.ViewType viewType, Object itemId) {
150         this.editorDefinition = editorDefinition;
151         this.viewType = viewType;
152         this.item = contentConnector.getItem(itemId);
153         this.itemId = itemId;
154 
155         initDetailView();
156         return view;
157     }
158 
159     protected void initDetailView() {
160         final FormView formView = componentProvider.getComponent(FormView.class);
161 
162         this.dialogView = formView;
163         view.setItemView(dialogView.asVaadinComponent(), viewType);
164         initActions();
165 
166         buildFormView(formView);
167     }
168 
169     protected void buildFormView(FormView formView) {
170         FormDefinition formDefinition;
171 
172         switch (viewType) {
173         case VIEW:
174             formDefinition = cloneFormDefinitionReadOnly(editorDefinition.getForm());
175             break;
176         case EDIT:
177         default:
178             formDefinition = editorDefinition.getForm();
179             break;
180         }
181 
182         formPresenter.presentView(formView, formDefinition, item, null);
183     }
184 
185     private void initActions() {
186         EditorActionAreaPresenter editorActionAreaPresenter = componentProvider.newInstance(editorDefinition.getActionArea().getPresenterClass());
187         EditorActionAreaView editorActionAreaView = editorActionAreaPresenter.start(filterSubAppActions(), editorDefinition.getActionArea(), this, subAppContext);
188         dialogView.setActionAreaView(editorActionAreaView);
189     }
190 
191     private Iterable<ActionDefinition> filterSubAppActions() {
192         Map<String, ActionDefinition> subAppActions = subAppContext.getSubAppDescriptor().getActions();
193         List<ActionDefinition> filteredActions = new LinkedList<ActionDefinition>();
194         List<FormActionItemDefinition> editorActions = editorDefinition.getActions();
195         if (editorActions != null && !editorActions.isEmpty()) {
196             for (FormActionItemDefinition editorAction : editorActions) {
197                 ActionDefinition def = subAppActions.get(editorAction.getName());
198                 if (def == null) {
199                     log.warn("DetailPresenter expected an action named {}, but no such action is currently configured in the subapp.", editorAction.getName());
200                     continue;
201                 }
202                 if (checker.isAvailable(def.getAvailability(), Arrays.asList(itemId))) {
203                     filteredActions.add(def);
204                 }
205             }
206         } else {
207             log.warn("DetailPresenter currently has no action configured.");
208         }
209         return filteredActions;
210     }
211 
212     /**
213      * Return clone of a form definition with all fields definitions set to read only.
214      *
215      * @see ConfiguredFieldDefinition#setReadOnly(boolean)
216      */
217     private FormDefinition cloneFormDefinitionReadOnly(FormDefinition formDefinition) {
218         FormDefinition formDefinitionClone = cloner.deepClone(formDefinition);
219 
220         for (TabDefinition tab : formDefinitionClone.getTabs()) {
221             for (FieldDefinition field : tab.getFields()) {
222                 ((ConfiguredFieldDefinition) field).setReadOnly(true);
223             }
224         }
225 
226         return formDefinitionClone;
227     }
228 
229     @Override
230     public void onCancel() {
231         // initDetailView(ItemView.ViewType.VIEW);
232         subAppContext.close();
233     }
234 
235     @Override
236     public void onSuccess(String actionName) {
237         eventBus.fireEvent(new ContentChangedEvent(itemId));
238         // initDetailView(ItemView.ViewType.VIEW);
239         subAppContext.close();
240     }
241 
242     @Override
243     public void showValidation(boolean visible) {
244         if (dialogView instanceof FormView) {
245             ((FormView) dialogView).showValidation(visible);
246         }
247     }
248 
249     @Override
250     public boolean isValid() {
251         return formPresenter.isValid();
252     }
253 
254     @Override
255     public void onActionFired(String actionName, Object... actionContextParams) {
256         Object[] providedParameters = new Object[] { this, item };
257         Object[] combinedParameters = new Object[providedParameters.length + actionContextParams.length];
258         System.arraycopy(providedParameters, 0, combinedParameters, 0, providedParameters.length);
259         System.arraycopy(actionContextParams, 0, combinedParameters, providedParameters.length, actionContextParams.length);
260         try {
261             executor.execute(actionName, combinedParameters);
262         } catch (ActionExecutionException e) {
263             log.error("An error occurred while executing an action.", e);
264             Message error = new Message(MessageType.ERROR, i18n.translate("ui-contentapp.error.action.execution"), e.getMessage());
265             subAppContext.getAppContext().sendLocalMessage(error);
266         }
267     }
268 
269     private EditorDefinition getEditorDefinition() {
270         return ((DetailSubAppDescriptor)subAppContext.getSubAppDescriptor()).getEditor();
271     }
272 
273     public Item getItem() {
274         return item;
275     }
276 
277     /**
278      * Add a shortcut key for the button for a specific action.
279      */
280     public void addClickShortcut(String actionName, int KeyCode){
281         Button button = (Button)(dialogView.getActionAreaView().getViewForAction(actionName).asVaadinComponent());
282         button.setClickShortcut(KeyCode);
283     }
284 
285     /**
286      * Add a shortcut key for a specific action.
287      */
288     public void addShortcut(final String actionName, final int keyCode, final int... modifiers) {
289         dialogView.addShortcut(new ShortcutListener(actionName, keyCode, modifiers) {
290             @Override
291             public void handleAction(Object sender, Object target) {
292                 onActionFired(actionName, new HashMap<String, Object>());
293             }
294         });
295     }
296 
297     public void addShortcut(ShortcutListener shortcut) {
298         dialogView.addShortcut(shortcut);
299     }
300 
301 }