View Javadoc
1   /**
2    * This file Copyright (c) 2016-2017 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.i18nsystem.SimpleTranslator;
38  import info.magnolia.objectfactory.Components;
39  import info.magnolia.pages.app.editor.ComponentContentClipboard;
40  import info.magnolia.ui.api.action.ActionExecutionException;
41  import info.magnolia.ui.api.app.SubAppEventBus;
42  import info.magnolia.ui.api.context.UiContext;
43  import info.magnolia.ui.api.event.ContentChangedEvent;
44  import info.magnolia.ui.contentapp.browser.action.PasteContentAction;
45  import info.magnolia.ui.framework.ContentClipboard;
46  import info.magnolia.ui.framework.ContentClipboardException;
47  import info.magnolia.ui.vaadin.gwt.client.shared.AbstractElement;
48  import info.magnolia.ui.vaadin.gwt.client.shared.AreaElement;
49  import info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter;
50  import info.magnolia.ui.vaadin.overlay.MessageStyleTypeEnum;
51  
52  import java.util.List;
53  
54  import javax.inject.Inject;
55  import javax.inject.Named;
56  import javax.jcr.RepositoryException;
57  
58  /**
59   * Pastes one or more referenced components available in the clipboard to a user selected target area.
60   */
61  public class PasteComponentAction extends PasteContentAction {
62  
63      @Inject
64      public PasteComponentAction(PasteComponentActionDefinition definition, JcrItemAdapter destination,
65                                  @Named(SubAppEventBus.NAME) EventBus eventBus, UiContext uiContext, ComponentContentClipboard componentContentClipboard, SimpleTranslator i18n) {
66          super(definition, destination, componentContentClipboard, uiContext, eventBus, i18n);
67      }
68  
69      /**
70       * @deprecated since 5.5.1. Use {@link #PasteComponentAction(PasteComponentActionDefinition, JcrItemAdapter, EventBus, UiContext, ComponentContentClipboard, SimpleTranslator)} instead.
71       */
72      public PasteComponentAction(PasteComponentActionDefinition definition, JcrItemAdapter destination,
73                                  @Named(SubAppEventBus.NAME) EventBus eventBus, UiContext uiContext, ContentClipboard contentClipboard, SimpleTranslator i18n) {
74          this(definition, destination, eventBus, uiContext, Components.getComponent(ComponentContentClipboard.class), i18n);
75      }
76  
77      @Override
78      public void execute() throws ActionExecutionException {
79          try {
80              List<AbstractElement> pastedItems = getContentClipboard().paste(new AreaElement(getDestination().getWorkspace(), getDestination().getJcrItem().getPath(), null, null));
81  
82              getUiContext().openNotification(MessageStyleTypeEnum.INFO, true, getI18n().translate("actions.pasteComponent.success", pastedItems.size()));
83              getEventBus().fireEvent(new ContentChangedEvent(getDestination().getItemId()));
84          } catch (RepositoryException | ContentClipboardException e) {
85              throw new ActionExecutionException(getI18n().translate("actions.pasteComponent.failure"));
86          }
87      }
88  }