View Javadoc
1   /**
2    * This file Copyright (c) 2011-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.field;
35  
36  import info.magnolia.event.EventBus;
37  import info.magnolia.objectfactory.Components;
38  import info.magnolia.ui.api.context.UiContext;
39  import info.magnolia.ui.api.event.AdmincentralEventBus;
40  import info.magnolia.ui.api.event.ChooseDialogEventBus;
41  import info.magnolia.ui.api.event.ContentChangedEvent;
42  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
43  import info.magnolia.ui.form.field.factory.AbstractFieldFactory;
44  import info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector;
45  import info.magnolia.ui.vaadin.integration.contentconnector.DefaultContentConnector;
46  import info.magnolia.ui.workbench.WorkbenchPresenter;
47  
48  import javax.inject.Inject;
49  import javax.inject.Named;
50  
51  import com.vaadin.v7.data.Item;
52  import com.vaadin.v7.ui.Field;
53  
54  /**
55   * Factory capable of producing {@link WorkbenchField}.
56   */
57  public class WorkbenchFieldFactory extends AbstractFieldFactory<WorkbenchFieldDefinition, Object> {
58  
59      private final WorkbenchFieldDefinition definition;
60  
61      private final WorkbenchPresenter workbenchPresenter;
62      private final ContentConnector contentConnector;
63  
64      private final EventBus chooseDialogEventBus;
65      private final EventBus admincentralEventBus;
66  
67      @Inject
68      public WorkbenchFieldFactory(
69              WorkbenchFieldDefinition definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18nAuthoringSupport,
70              WorkbenchPresenter workbenchPresenter,
71              ContentConnector contentConnector,
72              @Named(ChooseDialogEventBus.NAME) EventBus chooseDialogEventBus,
73              @Named(AdmincentralEventBus.NAME) EventBus admincentralEventBus) {
74  
75          super(definition, relatedFieldItem, uiContext, i18nAuthoringSupport);
76          this.definition = definition;
77          this.workbenchPresenter = workbenchPresenter;
78          this.contentConnector = contentConnector;
79          this.chooseDialogEventBus = chooseDialogEventBus;
80          this.admincentralEventBus = admincentralEventBus;
81      }
82  
83      /**
84       * @deprecated since 5.4.7 - use {@link #WorkbenchFieldFactory(WorkbenchFieldDefinition, Item, UiContext, I18NAuthoringSupport, WorkbenchPresenter, ContentConnector, EventBus, EventBus)} instead.
85       */
86      @Deprecated
87      public WorkbenchFieldFactory(WorkbenchFieldDefinition definition, Item relatedFieldItem, WorkbenchPresenter workbenchPresenter, ContentConnector contentConnector, @Named(ChooseDialogEventBus.NAME) EventBus chooseDialogEventBus, @Named(AdmincentralEventBus.NAME) EventBus admincentralEventBus) {
88          this(definition, relatedFieldItem, null, Components.getComponent(I18NAuthoringSupport.class), workbenchPresenter, contentConnector, chooseDialogEventBus, admincentralEventBus);
89      }
90  
91      /**
92       * @deprecated since 5.3.4 - use {@link #WorkbenchFieldFactory(WorkbenchFieldDefinition, Item, UiContext, I18NAuthoringSupport, WorkbenchPresenter, ContentConnector, EventBus, EventBus)} instead.
93       * Constructor should not be called explicitly, but rather use IoC anyway.
94       */
95      @Deprecated
96      public WorkbenchFieldFactory(WorkbenchFieldDefinition definition, Item relatedFieldItem, WorkbenchPresenter workbenchPresenter, @Named(ChooseDialogEventBus.NAME) EventBus eventBus) {
97          this(definition, relatedFieldItem, null, Components.getComponent(I18NAuthoringSupport.class), workbenchPresenter, new DefaultContentConnector(), eventBus, null);
98      }
99  
100     @Override
101     protected Field<Object> createFieldComponent() {
102         final WorkbenchField workbenchField = new WorkbenchField(definition.getWorkbench(), definition.getImageProvider(), workbenchPresenter, chooseDialogEventBus);
103 
104         // Workaround for choose-dialogs to listen to ContentChangeEvents
105         // Ideally this goes in ChooseDialogPresenter but it should be relocated to ui-contentapp first.
106         if (admincentralEventBus != null) {
107             admincentralEventBus.addHandler(ContentChangedEvent.class, new ContentChangedEvent.Handler() {
108 
109                 @Override
110                 public void onContentChanged(ContentChangedEvent event) {
111                     Object itemId = event.getItemId();
112                     if (contentConnector.canHandleItem(itemId)) {
113                         workbenchField.getPresenter().refresh();
114                         workbenchField.getPresenter().select(itemId);
115                     }
116                 }
117             });
118         }
119         return workbenchField;
120     }
121 }