View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.pages.app.action;
35  
36  import info.magnolia.event.EventBus;
37  import info.magnolia.ui.api.action.AbstractAction;
38  import info.magnolia.ui.api.action.ActionExecutionException;
39  import info.magnolia.ui.api.app.SubAppContext;
40  import info.magnolia.ui.api.app.SubAppEventBus;
41  import info.magnolia.ui.api.event.ContentChangedEvent;
42  import info.magnolia.ui.dialog.formdialog.FormDialogPresenter;
43  import info.magnolia.ui.dialog.formdialog.FormDialogPresenterFactory;
44  import info.magnolia.ui.form.EditorCallback;
45  import info.magnolia.ui.vaadin.gwt.client.shared.AbstractElement;
46  import info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter;
47  
48  import javax.inject.Inject;
49  import javax.inject.Named;
50  
51  import org.slf4j.Logger;
52  import org.slf4j.LoggerFactory;
53  
54  /**
55   * Opens a dialog for editing a {@link AbstractElement}. Reads the dialog-name from {@link AbstractElement#getDialog()}
56   * which is extracted from the 'cms-comment' on client-side.
57   */
58  public class EditElementAction extends AbstractAction<EditElementActionDefinition> {
59  
60      private static final Logger log = LoggerFactory.getLogger(EditElementAction.class);
61  
62      private final FormDialogPresenterFactory dialogPresenterFactory;
63      private final JcrItemAdapter item;
64      private final AbstractElement element;
65      private final SubAppContext subAppContext;
66      private final EventBus eventBus;
67  
68      @Inject
69      public EditElementAction(final JcrItemAdapter item, final EditElementActionDefinition definition, final AbstractElement element,
70                               final SubAppContext subAppContext, final @Named(SubAppEventBus.NAME) EventBus eventBus,
71                               final FormDialogPresenterFactory dialogPresenterFactory) {
72          super(definition);
73          this.item = item;
74          this.element = element;
75          this.subAppContext = subAppContext;
76          this.eventBus = eventBus;
77          this.dialogPresenterFactory = dialogPresenterFactory;
78      }
79  
80      @Override
81      public void execute() throws ActionExecutionException {
82          final String dialogId = element.getDialog();
83          final FormDialogPresenter formDialogPresenter = dialogPresenterFactory.createFormDialogPresenter(dialogId);
84          formDialogPresenter.start(item, dialogId, subAppContext, new EditElementCallback(formDialogPresenter, item, eventBus));
85      }
86  
87      protected JcrItemAdapter getItem() {
88          return item;
89      }
90  
91      protected AbstractElement getElement() {
92          return element;
93      }
94  
95      protected SubAppContext getSubAppContext() {
96          return subAppContext;
97      }
98  
99      protected EventBus getEventBus() {
100         return eventBus;
101     }
102 
103     /**
104      * {@link info.magnolia.ui.form.EditorCallback} for {@link info.magnolia.pages.app.action.EditElementAction} which sends {@link info.magnolia.ui.api.event.ContentChangedEvent} on both save and cancel actions.
105      */
106     public static class EditElementCallback implements EditorCallback {
107 
108         private final FormDialogPresenter formDialogPresenter;
109         private final EventBus eventBus;
110         private final JcrItemAdapter item;
111 
112         @Inject
113         public EditElementCallback(FormDialogPresenter formDialogPresenter, JcrItemAdapter item, EventBus eventBus) {
114             this.formDialogPresenter = formDialogPresenter;
115             this.item = item;
116             this.eventBus = eventBus;
117         }
118 
119         @Override
120         public void onSuccess(String actionName) {
121             eventBus.fireEvent(new ContentChangedEvent(item.getItemId()));
122             formDialogPresenter.closeDialog();
123         }
124 
125         @Override
126         public void onCancel() {
127             formDialogPresenter.closeDialog();
128         }
129     }
130 }