View Javadoc
1   /**
2    * This file Copyright (c) 2015 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.dam.external.app.field.factory;
35  
36  import info.magnolia.dam.api.ItemKey;
37  import info.magnolia.dam.external.app.field.AssetLinkField;
38  import info.magnolia.objectfactory.ComponentProvider;
39  import info.magnolia.ui.api.app.AppController;
40  import info.magnolia.ui.api.app.ChooseDialogCallback;
41  import info.magnolia.ui.api.context.UiContext;
42  import info.magnolia.ui.form.field.definition.LinkFieldDefinition;
43  import info.magnolia.ui.form.field.factory.AbstractFieldFactory;
44  
45  import javax.inject.Inject;
46  
47  import org.apache.commons.lang3.StringUtils;
48  import org.slf4j.Logger;
49  import org.slf4j.LoggerFactory;
50  
51  import com.vaadin.data.Item;
52  import com.vaadin.ui.Button;
53  import com.vaadin.ui.Field;
54  
55  /**
56   * {@link AssetLinkField} factory.
57   *
58   * @param <D> definition.
59   */
60  public class AssetLinkFieldFactory<D extends LinkFieldDefinition> extends AbstractFieldFactory<D, String> {
61  
62      private static final Logger log = LoggerFactory.getLogger(AssetLinkFieldFactory.class);
63  
64      private final AppController appController;
65      private final UiContext uiContext;
66      private ComponentProvider componentProvider;
67  
68      private AssetLinkField linkField;
69  
70      @Inject
71      public AssetLinkFieldFactory(D definition, Item relatedFieldItem, AppController appController, UiContext uiContext, ComponentProvider componentProvider) {
72          super(definition, relatedFieldItem);
73          this.appController = appController;
74          this.uiContext = uiContext;
75          this.componentProvider = componentProvider;
76      }
77  
78      @Override
79      public void setComponentProvider(ComponentProvider componentProvider) {
80          super.setComponentProvider(componentProvider);
81          this.componentProvider = componentProvider;
82      }
83  
84      @Override
85      protected Field<String> createFieldComponent() {
86          linkField = new AssetLinkField(definition, componentProvider);
87          // Set Caption
88          linkField.setButtonCaptionNew(getMessage(definition.getButtonSelectNewLabel()));
89          linkField.setButtonCaptionOther(getMessage(definition.getButtonSelectOtherLabel()));
90          // Add a callback listener on the select button
91          linkField.getSelectButton().addClickListener(createButtonClickListener());
92          return linkField;
93      }
94  
95      /**
96       * Create the Button click Listener. On click: Create a Dialog and
97       * Initialize callback handling.
98       */
99      private Button.ClickListener createButtonClickListener() {
100         return new Button.ClickListener() {
101             @Override
102             public void buttonClick(Button.ClickEvent event) {
103                 ChooseDialogCallback callback = createChooseDialogCallback();
104                 String value = linkField.getTextField().getValue();
105                 if (StringUtils.isNotBlank(definition.getTargetTreeRootPath())) {
106                     appController.openChooseDialog(definition.getAppName(), uiContext, definition.getTargetTreeRootPath(), value, callback);
107                 } else {
108                     appController.openChooseDialog(definition.getAppName(), uiContext, value, callback);
109                 }
110             }
111         };
112     }
113 
114     protected ChooseDialogCallback createChooseDialogCallback() {
115         return new ChooseDialogCallback() {
116 
117             @Override
118             public void onItemChosen(String actionName, final Object chosenValue) {
119                 if (chosenValue instanceof ItemKey) {
120                     ItemKey key = (ItemKey) chosenValue;
121                     String compoundId = key.asString();
122                     linkField.setValue(compoundId);
123                 }
124             }
125 
126             @Override
127             public void onCancel() {
128             }
129         };
130     }
131 }