View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.config;
35  
36  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
37  import info.magnolia.ui.form.field.transformer.Transformer;
38  import info.magnolia.ui.form.validator.definition.ConfiguredFieldValidatorDefinition;
39  
40  /**
41   * Abstract base class for builder that create dialog field definitions.
42   */
43  public abstract class AbstractFieldBuilder {
44  
45      public abstract ConfiguredFieldDefinition definition();
46  
47      public AbstractFieldBuilder label(String label) {
48          definition().setLabel(label);
49          return this;
50      }
51  
52      public AbstractFieldBuilder i18nBasename(String i18nBasename) {
53          definition().setI18nBasename(i18nBasename);
54          return this;
55      }
56  
57      public AbstractFieldBuilder i18n(boolean i18n) {
58          definition().setI18n(i18n);
59          return this;
60      }
61  
62      public AbstractFieldBuilder i18n() {
63          definition().setI18n(true);
64          return this;
65      }
66  
67      public AbstractFieldBuilder description(String description) {
68          definition().setDescription(description);
69          return this;
70      }
71  
72      public AbstractFieldBuilder type(String type) {
73          definition().setType(type);
74          return this;
75      }
76  
77      public AbstractFieldBuilder required(boolean required) {
78          definition().setRequired(required);
79          return this;
80      }
81  
82      public AbstractFieldBuilder required() {
83          definition().setRequired(true);
84          return this;
85      }
86  
87      public AbstractFieldBuilder requiredErrorMessage(String requiredErrorMessage) {
88          definition().setRequiredErrorMessage(requiredErrorMessage);
89          return this;
90      }
91  
92      public AbstractFieldBuilder readOnly(boolean readOnly) {
93          definition().setReadOnly(readOnly);
94          return this;
95      }
96  
97      public AbstractFieldBuilder readOnly() {
98          definition().setReadOnly(true);
99          return this;
100     }
101 
102     public AbstractFieldBuilder defaultValue(String defaultValue) {
103         definition().setDefaultValue(defaultValue);
104         return this;
105     }
106 
107     public AbstractFieldBuilder styleName(String styleName) {
108         definition().setStyleName(styleName);
109         return this;
110     }
111 
112     public AbstractFieldBuilder validator(ConfiguredFieldValidatorDefinition validatorDefinition) {
113         definition().addValidator(validatorDefinition);
114         return this;
115     }
116 
117     public AbstractFieldBuilder validator(GenericValidatorBuilder validatorBuilder) {
118         definition().addValidator(validatorBuilder.definition());
119         return this;
120     }
121 
122     public AbstractFieldBuilder transformerClass(Class<? extends Transformer<?>> transformerClass) {
123         definition().setTransformerClass(transformerClass);
124         return this;
125     }
126 }