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.objectfactory.ComponentProvider;
38  import info.magnolia.ui.ValueContext;
39  import info.magnolia.ui.api.action.ActionExecutionException;
40  import info.magnolia.ui.availability.AvailabilityChecker;
41  import info.magnolia.ui.dialog.ActionButton;
42  import info.magnolia.ui.dialog.ActionExecution;
43  import info.magnolia.ui.mediaeditor.MediaEditorEventBus;
44  import info.magnolia.ui.mediaeditor.MediaEditorView;
45  import info.magnolia.ui.mediaeditor.data.MediaState;
46  import info.magnolia.ui.mediaeditor.field.MediaField;
47  import info.magnolia.ui.mediaeditor.provider.MediaEditorActionDefinition;
48  
49  import java.util.Iterator;
50  import java.util.List;
51  
52  import javax.inject.Named;
53  
54  import org.slf4j.Logger;
55  import org.slf4j.LoggerFactory;
56  
57  import com.vaadin.ui.Component;
58  
59  /**
60   * Updates media editor UI in order to perform certain modification
61   * on the media data.
62   */
63  public abstract class MediaEditorUIAction extends MediaEditorAction {
64      private static final Logger log = LoggerFactory.getLogger(MediaEditorUIAction.class);
65  
66      protected MediaEditorView view;
67  
68      public MediaEditorUIAction(MediaEditorActionDefinition definition,
69                                 MediaEditorView view,
70                                 ValueContext<MediaState> valueContext,
71                                 @Named(MediaEditorEventBus.NAME) EventBus eventBus) {
72          super(definition, valueContext, eventBus);
73          this.view = view;
74      }
75  
76      @Override
77      public void execute() throws ActionExecutionException {
78          MediaField newMediaField = createMediaField();
79          if (newMediaField != null) {
80              view.clearActions();
81              view.setMediaContent(newMediaField);
82              view.setToolbar(getStatusControls());
83  
84              List<ActionContext> actionContexts = getActionContextList();
85              Iterator<ActionContext> it = actionContexts.iterator();
86              boolean defaultIsSet = false;
87              while (it.hasNext()) {
88                  ActionContext action = it.next();
89                  ComponentProvider componentProvider = view.getComponentProvider();
90                  final ValueContext<Object> valueContext = view.bindContext(ValueContext.class);
91                  final ActionExecution<?> actionExecution = new ActionExecution<Object>(action.getDefinition(), componentProvider) {
92                      @Override
93                      public void execute() {
94                          action.getListener().onActionFired(getDefinition().getName());
95                      }
96                  };
97                  AvailabilityChecker<?> availabilityChecker = (anyDef, anyItems) -> true;
98                  ActionButton<?> actionButton = componentProvider.newInstance(ActionButton.class, valueContext, actionExecution, availabilityChecker);
99                  view.getEditorActionLayout().addPrimaryAction(actionButton);
100                 if (!defaultIsSet) {
101                     actionButton.addStyleNames("default commitState", "commit v-button-commit");
102                     defaultIsSet = true;
103                 }
104             }
105             newMediaField.setValue(valueContext.getSingleOrThrow().getState());
106         } else {
107             log.warn("Provider did not provide any content UI ");
108         }
109 
110     }
111 
112     protected abstract List<ActionContext> getActionContextList();
113 
114     protected abstract Component getStatusControls();
115 
116     protected abstract MediaField createMediaField();
117 
118 }