View Javadoc

1   /**
2    * This file Copyright (c) 2012-2014 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.event.AdmincentralEventBus;
45  import info.magnolia.ui.api.event.ContentChangedEvent;
46  import info.magnolia.ui.api.message.Message;
47  import info.magnolia.ui.api.message.MessageType;
48  import info.magnolia.ui.contentapp.definition.EditorDefinition;
49  import info.magnolia.ui.dialog.DialogView;
50  import info.magnolia.ui.dialog.actionarea.ActionListener;
51  import info.magnolia.ui.dialog.actionarea.EditorActionAreaPresenter;
52  import info.magnolia.ui.dialog.actionarea.definition.FormActionItemDefinition;
53  import info.magnolia.ui.dialog.actionarea.view.EditorActionAreaView;
54  import info.magnolia.ui.dialog.formdialog.FormBuilder;
55  import info.magnolia.ui.dialog.formdialog.FormView;
56  import info.magnolia.ui.form.EditorCallback;
57  import info.magnolia.ui.form.EditorValidator;
58  import info.magnolia.ui.form.definition.FormDefinition;
59  import info.magnolia.ui.form.definition.TabDefinition;
60  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
61  import info.magnolia.ui.form.field.definition.FieldDefinition;
62  import info.magnolia.ui.framework.app.SubAppActionExecutor;
63  import info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter;
64  import info.magnolia.ui.vaadin.integration.jcr.JcrNodeAdapter;
65  
66  import java.util.HashMap;
67  import java.util.LinkedList;
68  import java.util.List;
69  import java.util.Map;
70  
71  import javax.inject.Inject;
72  import javax.inject.Named;
73  
74  import org.slf4j.Logger;
75  import org.slf4j.LoggerFactory;
76  
77  import com.rits.cloning.Cloner;
78  import com.vaadin.event.ShortcutListener;
79  import com.vaadin.ui.Button;
80  
81  /**
82   * Presenter for the item displayed in the {@link info.magnolia.ui.contentapp.detail.DetailEditorPresenter}. Takes care
83   * of building and switching between the right {@link DetailView.ViewType}.
84   */
85  public class DetailPresenter implements EditorCallback, EditorValidator, ActionListener {
86  
87      private Logger log = LoggerFactory.getLogger(getClass());
88  
89      private SubAppContext subAppContext;
90  
91      private final EventBus eventBus;
92  
93      private final DetailView view;
94  
95      private FormBuilder formBuilder;
96  
97      private ComponentProvider componentProvider;
98  
99      private ActionExecutor executor;
100 
101     private EditorDefinition editorDefinition;
102 
103     private JcrNodeAdapter item;
104 
105     private DialogView dialogView;
106 
107     private final I18nizer i18nizer;
108 
109     private final SimpleTranslator i18n;
110 
111     @Inject
112     public DetailPresenter(SubAppContext subAppContext, final @Named(AdmincentralEventBus.NAME) EventBus eventBus, DetailView view,
113             FormBuilder formBuilder, ComponentProvider componentProvider, SubAppActionExecutor executor, I18nizer i18nizer, SimpleTranslator i18n) {
114         this.subAppContext = subAppContext;
115         this.eventBus = eventBus;
116         this.view = view;
117         this.formBuilder = formBuilder;
118         this.componentProvider = componentProvider;
119         this.executor = executor;
120         this.i18nizer = i18nizer;
121         this.i18n = i18n;
122     }
123 
124     public DetailView start(EditorDefinition editorDefinition, final JcrNodeAdapter item, DetailView.ViewType viewType) {
125         this.editorDefinition = editorDefinition;
126         this.item = item;
127         setItemView(viewType);
128         return view;
129     }
130 
131     private void setItemView(DetailView.ViewType viewType) {
132         FormView formView = componentProvider.getComponent(FormView.class);
133         this.dialogView = formView;
134 
135         FormDefinition formDefinition;
136 
137         switch (viewType) {
138         case VIEW:
139             formDefinition = cloneFormDefinitionReadOnly(editorDefinition.getForm());
140             break;
141         case EDIT:
142         default:
143             formDefinition = editorDefinition.getForm();
144             break;
145         }
146 
147         initActions();
148         formBuilder.buildForm(formView, formDefinition, item, null);
149         view.setItemView(dialogView.asVaadinComponent(), viewType);
150     }
151 
152     private void initActions() {
153         EditorActionAreaPresenter editorActionAreaPresenter = componentProvider.newInstance(editorDefinition.getActionArea().getPresenterClass());
154         EditorActionAreaView editorActionAreaView = editorActionAreaPresenter.start(filterSubAppActions(), editorDefinition.getActionArea(), this, subAppContext);
155         dialogView.setActionAreaView(editorActionAreaView);
156     }
157 
158     private Iterable<ActionDefinition> filterSubAppActions() {
159         Map<String, ActionDefinition> subAppActions = subAppContext.getSubAppDescriptor().getActions();
160         List<ActionDefinition> filteredActions = new LinkedList<ActionDefinition>();
161         List<FormActionItemDefinition> editorActions = editorDefinition.getActions();
162         boolean isJcrItemAdapter = (item instanceof JcrItemAdapter);
163         for (FormActionItemDefinition editorAction : editorActions) {
164             ActionDefinition def = subAppActions.get(editorAction.getName());
165             if (def != null && (!isJcrItemAdapter || (isJcrItemAdapter && executor.isAvailable(editorAction.getName(), ((JcrItemAdapter) item).getJcrItem())))) {
166                 filteredActions.add(def);
167             } else {
168                 log.debug("Action is configured for an editor but not configured for sub-app: " + editorAction.getName());
169             }
170         }
171         return filteredActions;
172     }
173 
174     /**
175      * Return clone of a form definition with all fields definitions set to read only.
176      *
177      * @see ConfiguredFieldDefinition#setReadOnly(boolean)
178      */
179     private FormDefinition cloneFormDefinitionReadOnly(FormDefinition formDefinition) {
180         Cloner cloner = new Cloner();
181         FormDefinition formDefinitionClone = cloner.deepClone(formDefinition);
182 
183         for (TabDefinition tab : formDefinitionClone.getTabs()) {
184             for (FieldDefinition field : tab.getFields()) {
185                 ((ConfiguredFieldDefinition) field).setReadOnly(true);
186             }
187         }
188 
189         return formDefinitionClone;
190     }
191 
192     @Override
193     public void onCancel() {
194         // setItemView(ItemView.ViewType.VIEW);
195         subAppContext.close();
196     }
197 
198     @Override
199     public void onSuccess(String actionName) {
200         eventBus.fireEvent(new ContentChangedEvent(item.getWorkspace(), item.getItemId()));
201         // setItemView(ItemView.ViewType.VIEW);
202         subAppContext.close();
203     }
204 
205     @Override
206     public void showValidation(boolean visible) {
207         if (dialogView instanceof FormView) {
208             ((FormView) dialogView).showValidation(visible);
209         }
210     }
211 
212     @Override
213     public boolean isValid() {
214         return dialogView instanceof FormView ? ((FormView) dialogView).isValid() : true;
215     }
216 
217     @Override
218     public void onActionFired(String actionName, Object... actionContextParams) {
219         Object[] providedParameters = new Object[] { this, item };
220         Object[] combinedParameters = new Object[providedParameters.length + actionContextParams.length];
221         System.arraycopy(providedParameters, 0, combinedParameters, 0, providedParameters.length);
222         System.arraycopy(actionContextParams, 0, combinedParameters, providedParameters.length, actionContextParams.length);
223         try {
224             executor.execute(actionName, combinedParameters);
225         } catch (ActionExecutionException e) {
226             log.error("An error occurred while executing an action.", e);
227             Message error = new Message(MessageType.ERROR, i18n.translate("ui-contentapp.error.action.execution"), e.getMessage());
228             subAppContext.getAppContext().sendLocalMessage(error);
229         }
230     }
231 
232     /**
233      * Add a shortcut key for the button for a specific action.
234      */
235     public void addClickShortcut(String actionName, int KeyCode){
236         Button button = (Button)(dialogView.getActionAreaView().getViewForAction(actionName).asVaadinComponent());
237         button.setClickShortcut(KeyCode);
238     }
239 
240     /**
241      * Add a shortcut key for a specific action.
242      */
243     public void addShortcut(final String actionName, final int keyCode, final int... modifiers) {
244         dialogView.addShortcut(new ShortcutListener(actionName, keyCode, modifiers) {
245             @Override
246             public void handleAction(Object sender, Object target) {
247                 onActionFired(actionName, new HashMap<String, Object>());
248             }
249         });
250     }
251 
252     public void addShortcut(ShortcutListener shortcut) {
253         dialogView.addShortcut(shortcut);
254     }
255 
256 }