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