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.cms.i18n.I18nContentSupport;
37 import info.magnolia.objectfactory.ComponentProvider;
38 import info.magnolia.ui.api.view.View;
39 import info.magnolia.ui.form.FormItem;
40 import info.magnolia.ui.form.field.definition.FieldDefinition;
41 import info.magnolia.ui.form.validator.registry.FieldValidatorFactoryFactory;
42
43 import com.vaadin.v7.ui.Field;
44
45 /**
46 * A FieldFactory is responsible for creating Vaadin {@link Field}s configured based on their
47 * associated FieldDefinition.
48 * <p>
49 * FieldFactory and {@link FieldDefinition} are linked together using {@link FieldFactoryFactory}.
50 * <p>
51 * Implementations of this interface will be instantiated with the
52 * <ul>
53 * <li>{@link info.magnolia.ui.form.field.definition.FieldDefinition} they should use for configuration
54 * <li>{@link com.vaadin.v7.data.Item} they will be operating on additional injected constructor arguments.
55 * </ul>
56 * <strong>FieldFactory are responsible to create/initialize Items that are by the Vaadin Field.</strong>
57 *
58 * @see FieldDefinition
59 * @see FieldFactoryFactory
60 */
61 public interface FieldFactory extends FormItem {
62
63 /**
64 * Creates and initializes a Vaadin {@link Field} component.
65 */
66 Field<?> createField();
67
68 View getView();
69
70 FieldDefinition getFieldDefinition();
71
72 void setFieldValidatorFactoryFactory(FieldValidatorFactoryFactory fieldValidatorFactoryFactory);
73
74 /**
75 * @deprecated This is deprecated since 5.3.4; {@link I18nContentSupport} was never used within any {@link FieldFactory}, rightfully so.
76 * If any, {@link info.magnolia.ui.api.i18n.I18NAuthoringSupport I18NAuthoringSupport} is the one that should be used.
77 */
78 @Deprecated
79 void setI18nContentSupport(I18nContentSupport i18nContentSupport);
80
81 void setComponentProvider(ComponentProvider componentProvider);
82 }