View Javadoc
1   /**
2    * This file Copyright (c) 2012-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.form.field.factory;
35  
36  import info.magnolia.objectfactory.Components;
37  import info.magnolia.ui.api.context.UiContext;
38  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
39  import info.magnolia.ui.form.field.StaticField;
40  import info.magnolia.ui.form.field.definition.StaticFieldDefinition;
41  
42  import javax.inject.Inject;
43  
44  import com.vaadin.v7.data.Item;
45  import com.vaadin.v7.data.Property;
46  import com.vaadin.v7.ui.Field;
47  
48  /**
49   * Creates and initializes an static field definition.
50   * 
51   * @param <D> type of definition
52   */
53  public class StaticFieldFactory<D extends StaticFieldDefinition> extends AbstractFieldFactory<D, Object> {
54  
55      @Inject
56      public StaticFieldFactory(D definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18nAuthoringSupport) {
57          super(definition, relatedFieldItem, uiContext, i18nAuthoringSupport);
58      }
59  
60      /**
61       * @deprecated since 5.4.7 - use {@link #StaticFieldFactory(StaticFieldDefinition, Item, UiContext, I18NAuthoringSupport)} instead.
62       */
63      @Deprecated
64      public StaticFieldFactory(D definition, Item relatedFieldItem) {
65          this(definition, relatedFieldItem, null, Components.getComponent(I18NAuthoringSupport.class));
66      }
67  
68      @Override
69      protected Field<Object> createFieldComponent() {
70          StaticField field = new StaticField(createFieldValue());
71          return field;
72      }
73  
74      /**
75       * Create the value displayed into the static field.
76       */
77      public String createFieldValue() {
78          return definition.getValue();
79      }
80  
81      /**
82       * Do not set datasource for a Static field.
83       */
84      @Override
85      public void setPropertyDataSourceAndDefaultValue(Property property) {
86          // do nothing specific
87      }
88  
89  }