View Javadoc
1   /**
2    * This file Copyright (c) 2013-2016 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.module.groovy.field.factory;
35  
36  import info.magnolia.i18nsystem.SimpleTranslator;
37  import info.magnolia.module.groovy.field.ConsoleOutputField;
38  import info.magnolia.module.groovy.field.definition.ConsoleOutputFieldDefinition;
39  import info.magnolia.objectfactory.Components;
40  import info.magnolia.ui.form.field.definition.FieldDefinition;
41  import info.magnolia.ui.form.field.factory.AbstractFieldFactory;
42  import info.magnolia.ui.framework.message.MessagesManager;
43  
44  import javax.inject.Inject;
45  
46  import com.vaadin.data.Item;
47  import com.vaadin.ui.Field;
48  
49  /**
50   * Creates and initializes a {@link ConsoleOutputField} field based on a field definition.
51   * 
52   * @param <D> definition type
53   */
54  public class ConsoleOutputFieldFactory<D extends FieldDefinition> extends AbstractFieldFactory<ConsoleOutputFieldDefinition, String> {
55  
56      private ConsoleOutputField outputField;
57      private Item relatedFieldItem;
58      private SimpleTranslator simpleTranslator;
59      private MessagesManager messagesManager;
60  
61      @Inject
62      public ConsoleOutputFieldFactory(ConsoleOutputFieldDefinition definition, Item relatedFieldItem, SimpleTranslator simpleTranslator, MessagesManager messagesManager) {
63          super(definition, relatedFieldItem);
64          this.relatedFieldItem = relatedFieldItem;
65          this.simpleTranslator = simpleTranslator;
66          this.messagesManager = messagesManager;
67      }
68  
69      /**
70       * @deprecated since 2.4.6, please use {@link #ConsoleOutputFieldFactory(ConsoleOutputFieldDefinition, Item, SimpleTranslator, MessagesManager)}.
71       */
72      @Deprecated
73      public ConsoleOutputFieldFactory(ConsoleOutputFieldDefinition definition, Item relatedFieldItem, SimpleTranslator simpleTranslator) {
74          this(definition, relatedFieldItem, simpleTranslator, Components.getComponent(MessagesManager.class));
75      }
76  
77      @Override
78      protected Field<String> createFieldComponent() {
79          outputField = new ConsoleOutputField(relatedFieldItem, simpleTranslator, messagesManager);
80          return outputField;
81      }
82  
83  }