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.TextFieldDefinition;
37  import info.magnolia.ui.form.field.transformer.Transformer;
38  import info.magnolia.ui.form.validator.definition.ConfiguredFieldValidatorDefinition;
39  
40  /**
41   * Builder for building a text field definition.
42   */
43  public class TextFieldBuilder extends AbstractFieldBuilder {
44  
45      private final TextFieldDefinition definition = new TextFieldDefinition();
46  
47      public TextFieldBuilder(String name) {
48          this.definition().setName(name);
49      }
50  
51      @Override
52      public TextFieldDefinition definition() {
53          return definition;
54      }
55  
56      public TextFieldBuilder rows(int rows) {
57          definition().setRows(rows);
58          return this;
59      }
60  
61      public TextFieldBuilder maxLength(int maxLength) {
62          definition().setMaxLength(maxLength);
63          return this;
64      }
65  
66      // Overrides for methods in parent class changing return type to allow method chaining
67  
68      @Override
69      public TextFieldBuilder label(String label) {
70          return (TextFieldBuilder) super.label(label);
71      }
72  
73      @Override
74      public TextFieldBuilder i18nBasename(String i18nBasename) {
75          return (TextFieldBuilder) super.i18nBasename(i18nBasename);
76      }
77  
78      @Override
79      public TextFieldBuilder i18n(boolean i18n) {
80          return (TextFieldBuilder) super.i18n(i18n);
81      }
82  
83      @Override
84      public TextFieldBuilder i18n() {
85          return (TextFieldBuilder) super.i18n();
86      }
87  
88      @Override
89      public TextFieldBuilder description(String description) {
90          return (TextFieldBuilder) super.description(description);
91      }
92  
93      @Override
94      public TextFieldBuilder type(String type) {
95          return (TextFieldBuilder) super.type(type);
96      }
97  
98      @Override
99      public TextFieldBuilder required(boolean required) {
100         return (TextFieldBuilder) super.required(required);
101     }
102 
103     @Override
104     public TextFieldBuilder required() {
105         return (TextFieldBuilder) super.required();
106     }
107 
108     @Override
109     public TextFieldBuilder requiredErrorMessage(String requiredErrorMessage) {
110         return (TextFieldBuilder) super.requiredErrorMessage(requiredErrorMessage);
111     }
112 
113     @Override
114     public TextFieldBuilder readOnly(boolean readOnly) {
115         return (TextFieldBuilder) super.readOnly(readOnly);
116     }
117 
118     @Override
119     public TextFieldBuilder readOnly() {
120         return (TextFieldBuilder) super.readOnly();
121     }
122 
123     @Override
124     public TextFieldBuilder defaultValue(String defaultValue) {
125         return (TextFieldBuilder) super.defaultValue(defaultValue);
126     }
127 
128     @Override
129     public TextFieldBuilder styleName(String styleName) {
130         return (TextFieldBuilder) super.styleName(styleName);
131     }
132 
133     @Override
134     public TextFieldBuilder validator(ConfiguredFieldValidatorDefinition validatorDefinition) {
135         return (TextFieldBuilder) super.validator(validatorDefinition);
136     }
137 
138     @Override
139     public TextFieldBuilder validator(GenericValidatorBuilder validatorBuilder) {
140         return (TextFieldBuilder) super.validator(validatorBuilder);
141     }
142 
143     @Override
144     public TextFieldBuilder transformerClass(Class<? extends Transformer<?>> transformerClass) {
145         return (TextFieldBuilder) super.transformerClass(transformerClass);
146     }
147 }