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.definition.TextFieldDefinition;
40 import info.magnolia.ui.vaadin.extension.MaxLengthIndicator;
41
42 import javax.inject.Inject;
43
44 import com.vaadin.v7.data.Item;
45 import com.vaadin.v7.ui.AbstractTextField;
46 import com.vaadin.v7.ui.Field;
47 import com.vaadin.v7.ui.TextArea;
48 import com.vaadin.v7.ui.TextField;
49
50 /**
51 * Creates and initializes an edit field based on a field definition.
52 */
53 public class TextFieldFactory extends AbstractFieldFactory<TextFieldDefinition, String> {
54
55 private AbstractTextField field;
56
57 @Inject
58 public TextFieldFactory(TextFieldDefinition definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18nAuthoringSupport) {
59 super(definition, relatedFieldItem, uiContext, i18nAuthoringSupport);
60 }
61
62 /**
63 * @deprecated since 5.4.7 - use {@link #TextFieldFactory(TextFieldDefinition, Item, UiContext, I18NAuthoringSupport)} instead.
64 */
65 @Deprecated
66 public TextFieldFactory(TextFieldDefinition definition, Item relatedFieldItem) {
67 this(definition, relatedFieldItem, null, Components.getComponent(I18NAuthoringSupport.class));
68 }
69
70 @Override
71 protected Field<String> createFieldComponent() {
72 // Create a TextArea if the rows > 1
73 if (definition.getRows() > 1) {
74 TextArea textArea = new TextArea();
75 textArea.setRows(definition.getRows());
76 field = textArea;
77 } else {
78 field = new TextField();
79 }
80 field.setNullRepresentation("");
81 field.setNullSettingAllowed(true);
82 if (definition.getMaxLength() != -1) {
83 field.setMaxLength(definition.getMaxLength());
84 MaxLengthIndicator.extend(field);
85 }
86
87 String placeholder = definition.getPlaceholder();
88 if (placeholder != null && !isMessageKey(placeholder)) {
89 field.setInputPrompt(placeholder);
90 }
91
92 return field;
93 }
94 }