View Javadoc
1   /**
2    * This file Copyright (c) 2016-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.ui.contentapp.browser.action;
35  
36  import info.magnolia.event.EventBus;
37  import info.magnolia.i18nsystem.SimpleTranslator;
38  import info.magnolia.ui.api.action.AbstractAction;
39  import info.magnolia.ui.api.action.ActionExecutionException;
40  import info.magnolia.ui.api.context.UiContext;
41  import info.magnolia.ui.api.event.AdmincentralEventBus;
42  import info.magnolia.ui.api.event.ContentChangedEvent;
43  import info.magnolia.ui.framework.ContentClipboard;
44  import info.magnolia.ui.framework.ContentClipboardException;
45  import info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter;
46  import info.magnolia.ui.vaadin.integration.jcr.JcrItemId;
47  import info.magnolia.ui.vaadin.integration.jcr.JcrItemUtil;
48  import info.magnolia.ui.vaadin.overlay.MessageStyleTypeEnum;
49  
50  import java.util.ArrayList;
51  import java.util.List;
52  
53  import javax.inject.Inject;
54  import javax.inject.Named;
55  import javax.jcr.RepositoryException;
56  
57  /**
58   * Action for copying the reference(s) of single or multiple JCR items into the clipboard.
59   */
60  public class CopyContentAction extends AbstractAction<CopyContentActionDefinition> {
61  
62      private final ContentClipboard contentClipboard;
63      private final UiContext uiContext;
64      private final EventBus eventBus;
65      private final SimpleTranslator i18n;
66      private final List<JcrItemAdapter> source;
67  
68      @Inject
69      public CopyContentAction(CopyContentActionDefinition definition, List<JcrItemAdapter> source,
70                            ContentClipboard contentClipboard,
71                            UiContext uiContext,
72                             @Named(AdmincentralEventBus.NAME) EventBus eventBus,
73                            SimpleTranslator i18n) {
74          super(definition);
75          this.contentClipboard = contentClipboard;
76          this.i18n = i18n;
77          this.source = source;
78          this.eventBus = eventBus;
79          this.uiContext = uiContext;
80      }
81  
82      @Override
83      public void execute() throws ActionExecutionException {
84          try {
85              List<JcrItemId> copiedItemIds = new ArrayList<>();
86              for (JcrItemAdapter itemAdapter : source) {
87                  copiedItemIds.add(JcrItemUtil.getItemId(itemAdapter.getJcrItem()));
88              }
89              contentClipboard.copy(copiedItemIds);
90  
91              uiContext.openNotification(MessageStyleTypeEnum.INFO, true, getSuccessMessage());
92              // fire event to refresh the action bar
93              eventBus.fireEvent(new ContentChangedEvent(copiedItemIds));
94          } catch (RepositoryException | ContentClipboardException e) {
95              throw new ActionExecutionException(i18n.translate("ui-framework.actions.pasteItem.failure"));
96          }
97      }
98  
99      protected String getSuccessMessage() {
100         if (source.size() == 1) {
101             return i18n.translate("ui-framework.actions.copyItem.successOneItemCopied");
102         } else {
103             return i18n.translate("ui-framework.actions.copyItem.successManyItemsCopied", source.size());
104         }
105     }
106 
107     protected ContentClipboard getContentClipboard() {
108         return contentClipboard;
109     }
110 
111     protected UiContext getUiContext() {
112         return uiContext;
113     }
114 
115     protected EventBus getEventBus() {
116         return eventBus;
117     }
118 
119     protected SimpleTranslator getI18n() {
120         return i18n;
121     }
122 
123     protected List<JcrItemAdapter> getSource() {
124         return source;
125     }
126 
127 }