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.ui.mediaeditor.action;
35  
36  import info.magnolia.event.EventBus;
37  import info.magnolia.ui.api.action.ActionExecutionException;
38  import info.magnolia.ui.api.view.View;
39  import info.magnolia.ui.dialog.actionarea.renderer.ActionRenderer;
40  import info.magnolia.ui.dialog.actionarea.renderer.DefaultEditorActionRenderer;
41  import info.magnolia.ui.mediaeditor.MediaEditorEventBus;
42  import info.magnolia.ui.mediaeditor.MediaEditorView;
43  import info.magnolia.ui.mediaeditor.data.EditHistoryTrackingProperty;
44  import info.magnolia.ui.mediaeditor.field.MediaField;
45  import info.magnolia.ui.mediaeditor.provider.MediaEditorActionDefinition;
46  
47  import java.util.Iterator;
48  import java.util.List;
49  
50  import javax.inject.Named;
51  
52  import org.slf4j.Logger;
53  import org.slf4j.LoggerFactory;
54  
55  import com.vaadin.ui.Component;
56  
57  /**
58   * Updates media editor UI in order to perform certain modification
59   * on the media data.
60   */
61  public abstract class MediaEditorUIAction extends MediaEditorAction {
62      private static final Logger log = LoggerFactory.getLogger(MediaEditorUIAction.class);
63  
64      protected MediaEditorView view;
65  
66      public MediaEditorUIAction(MediaEditorActionDefinition definition, MediaEditorView view, EditHistoryTrackingProperty dataSource, @Named(MediaEditorEventBus.NAME) EventBus eventBus) {
67          super(definition, dataSource, eventBus);
68          this.view = view;
69      }
70  
71      @Override
72      public void execute() throws ActionExecutionException {
73          MediaField newMediaField = createMediaField();
74          if (newMediaField != null) {
75              view.clearActions();
76              view.setMediaContent(newMediaField);
77              view.setToolbar(getStatusControls());
78  
79              List<ActionContext> actionContexts = getActionContextList();
80              Iterator<ActionContext> it = actionContexts.iterator();
81              boolean defaultIsSet = false;
82              while (it.hasNext()) {
83                  ActionContext action = it.next();
84                  ActionRenderer actionRenderer = new DefaultEditorActionRenderer();
85                  View actionView = actionRenderer.start(action.getDefinition(), action.getListener());
86                  view.getDialog().getActionAreaView().addPrimaryAction(actionView, action.getDefinition().getName());
87                  if (!defaultIsSet) {
88                      actionView.asVaadinComponent().addStyleName("default commit");
89                      defaultIsSet = true;
90                  }
91              }
92              newMediaField.setPropertyDataSource(dataSource);
93          } else {
94              log.warn("Provider did not provide any content UI ");
95          }
96  
97      }
98  
99      protected abstract List<ActionContext> getActionContextList();
100 
101     protected abstract Component getStatusControls();
102 
103     protected abstract MediaField createMediaField();
104 
105 
106 }