1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34 package info.magnolia.ui.contentapp.detail;
35
36 import info.magnolia.config.MutableWrapper;
37 import info.magnolia.event.EventBus;
38 import info.magnolia.i18nsystem.I18nizer;
39 import info.magnolia.i18nsystem.SimpleTranslator;
40 import info.magnolia.objectfactory.ComponentProvider;
41 import info.magnolia.ui.api.action.ActionDefinition;
42 import info.magnolia.ui.api.action.ActionExecutionException;
43 import info.magnolia.ui.api.action.ActionExecutor;
44 import info.magnolia.ui.api.app.SubAppContext;
45 import info.magnolia.ui.api.availability.AvailabilityChecker;
46 import info.magnolia.ui.api.event.AdmincentralEventBus;
47 import info.magnolia.ui.api.event.ContentChangedEvent;
48 import info.magnolia.ui.api.message.Message;
49 import info.magnolia.ui.api.message.MessageType;
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.FieldDefinition;
64 import info.magnolia.ui.form.field.definition.FieldDefinitionMutator;
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.event.ShortcutListener;
81 import com.vaadin.ui.Button;
82 import com.vaadin.v7.data.Item;
83
84
85
86
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 EditorDefinition editorDefinition;
113
114 private Item item;
115
116 private Object itemId;
117
118 private DialogView dialogView;
119
120 private DetailView.ViewType viewType;
121
122
123
124
125 @Deprecated
126 public DetailPresenter(SubAppContext subAppContext, final @Named(AdmincentralEventBus.NAME) EventBus eventBus, DetailView view,
127 FormBuilder formBuilder, ComponentProvider componentProvider, SubAppActionExecutor executor, I18nizer i18nizer, SimpleTranslator i18n, AvailabilityChecker checker, ContentConnector contentConnector) {
128 this(subAppContext, eventBus, view, componentProvider, executor, i18nizer, i18n, checker, contentConnector, componentProvider.getComponent(FormPresenter.class));
129 }
130
131 @Inject
132 public DetailPresenter(SubAppContext subAppContext, final @Named(AdmincentralEventBus.NAME) EventBus eventBus, DetailView view,
133 ComponentProvider componentProvider, SubAppActionExecutor executor, I18nizer i18nizer, SimpleTranslator i18n, AvailabilityChecker checker, ContentConnector contentConnector, FormPresenter formPresenter) {
134 this.subAppContext = subAppContext;
135 this.eventBus = eventBus;
136 this.view = view;
137 this.componentProvider = componentProvider;
138 this.executor = executor;
139 this.i18nizer = i18nizer;
140 this.i18n = i18n;
141 this.checker = checker;
142 this.contentConnector = contentConnector;
143 this.formPresenter = formPresenter;
144 }
145
146 public DetailView start(EditorDefinition editorDefinition, DetailView.ViewType viewType, Object itemId) {
147 this.editorDefinition = editorDefinition;
148 this.viewType = viewType;
149 this.item = contentConnector.getItem(itemId);
150 this.itemId = itemId;
151
152 initDetailView();
153 return view;
154 }
155
156 protected void initDetailView() {
157 final FormView formView = componentProvider.getComponent(FormView.class);
158
159 this.dialogView = formView;
160 initActions();
161
162 buildFormView(formView);
163 view.setItemView(formView, viewType);
164 }
165
166 protected void buildFormView(FormView formView) {
167 FormDefinition formDefinition;
168
169 switch (viewType) {
170 case VIEW:
171 formDefinition = cloneFormDefinitionReadOnly(editorDefinition.getForm());
172 break;
173 case EDIT:
174 default:
175 formDefinition = editorDefinition.getForm();
176 break;
177 }
178
179 formPresenter.presentView(formView, formDefinition, item, null);
180 }
181
182 private void initActions() {
183 EditorActionAreaPresenter editorActionAreaPresenter = componentProvider.newInstance(editorDefinition.getActionArea().getPresenterClass());
184 EditorActionAreaView editorActionAreaView = editorActionAreaPresenter.start(filterSubAppActions(), editorDefinition.getActionArea(), this, subAppContext);
185 dialogView.setActionAreaView(editorActionAreaView);
186 }
187
188 private Iterable<ActionDefinition> filterSubAppActions() {
189 Map<String, ActionDefinition> subAppActions = subAppContext.getSubAppDescriptor().getActions();
190 List<ActionDefinition> filteredActions = new LinkedList<ActionDefinition>();
191 List<FormActionItemDefinition> editorActions = editorDefinition.getActions();
192 if (editorActions != null && !editorActions.isEmpty()) {
193 for (FormActionItemDefinition editorAction : editorActions) {
194 ActionDefinition def = subAppActions.get(editorAction.getName());
195 if (def == null) {
196 log.warn("DetailPresenter expected an action named {}, but no such action is currently configured in the subapp.", editorAction.getName());
197 continue;
198 }
199 if (checker.isAvailable(def.getAvailability(), Arrays.asList(itemId))) {
200 filteredActions.add(def);
201 }
202 }
203 } else {
204 log.warn("DetailPresenter currently has no action configured.");
205 }
206 return filteredActions;
207 }
208
209
210
211
212
213
214 private FormDefinition cloneFormDefinitionReadOnly(FormDefinition formDefinition) {
215 final FormDefinition formDefinitionClone = MutableWrapper.wrap(formDefinition);
216
217 for (TabDefinition tab : formDefinitionClone.getTabs()) {
218 for (FieldDefinition field : tab.getFields()) {
219 FieldDefinitionMutator.accessMutable(field).setReadOnly(true);
220 }
221 }
222
223 return formDefinitionClone;
224 }
225
226 @Override
227 public void onCancel() {
228
229 subAppContext.close();
230 }
231
232 @Override
233 public void onSuccess(String actionName) {
234 eventBus.fireEvent(new ContentChangedEvent(contentConnector.getItemId(item)));
235
236 subAppContext.close();
237 }
238
239 @Override
240 public void showValidation(boolean visible) {
241 if (dialogView instanceof FormView) {
242 ((FormView) dialogView).showValidation(visible);
243 }
244 }
245
246 @Override
247 public boolean isValid() {
248 return formPresenter.isValid();
249 }
250
251 @Override
252 public void onActionFired(String actionName, Object... actionContextParams) {
253 Object[] providedParameters = new Object[] { this, item };
254 Object[] combinedParameters = new Object[providedParameters.length + actionContextParams.length];
255 System.arraycopy(providedParameters, 0, combinedParameters, 0, providedParameters.length);
256 System.arraycopy(actionContextParams, 0, combinedParameters, providedParameters.length, actionContextParams.length);
257 try {
258 executor.execute(actionName, combinedParameters);
259 } catch (ActionExecutionException e) {
260 log.error("An error occurred while executing an action.", e);
261 Message error = new Message(MessageType.ERROR, i18n.translate("ui-contentapp.error.action.execution"), e.getMessage());
262 subAppContext.getAppContext().sendLocalMessage(error);
263 }
264 }
265
266 private EditorDefinition getEditorDefinition() {
267 return ((DetailSubAppDescriptor)subAppContext.getSubAppDescriptor()).getEditor();
268 }
269
270 public Item getItem() {
271 return item;
272 }
273
274
275
276
277 public void addClickShortcut(String actionName, int KeyCode){
278 Button button = (Button)(dialogView.getActionAreaView().getViewForAction(actionName).asVaadinComponent());
279 button.setClickShortcut(KeyCode);
280 }
281
282
283
284
285 public void addShortcut(final String actionName, final int keyCode, final int... modifiers) {
286 dialogView.addShortcut(new ShortcutListener(actionName, keyCode, modifiers) {
287 @Override
288 public void handleAction(Object sender, Object target) {
289 onActionFired(actionName, new HashMap<String, Object>());
290 }
291 });
292 }
293
294 public void addShortcut(ShortcutListener shortcut) {
295 dialogView.addShortcut(shortcut);
296 }
297
298 }