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.repository.RepositoryConstants;
37  import info.magnolia.ui.form.field.converter.BaseIdentifierToPathConverter;
38  
39  /**
40   * Config object creating builders for form fields.
41   */
42  public class FieldConfig {
43  
44      public DateFieldBuilder date(String name) {
45          return new DateFieldBuilder(name);
46      }
47  
48      public BasicUploadFieldBuilder basicUpload(String name) {
49          return new BasicUploadFieldBuilder(name).binaryNodeName(name);
50      }
51  
52      public TextFieldBuilder text(String name) {
53          return new TextFieldBuilder(name);
54      }
55  
56      public LinkFieldBuilder link(String name) {
57          return new LinkFieldBuilder(name);
58      }
59  
60      public LinkFieldBuilder pageLink(String name) {
61          return new LinkFieldBuilder(name).appName("pages").targetWorkspace(RepositoryConstants.WEBSITE).identifierToPathConverter(new BaseIdentifierToPathConverter());
62      }
63  
64      public SelectFieldBuilder select(String name) {
65          return new SelectFieldBuilder(name);
66      }
67  
68      public HiddenFieldBuilder hidden(String name) {
69          return new HiddenFieldBuilder(name);
70      }
71  
72      public CheckboxFieldBuilder checkbox(String name) {
73          return new CheckboxFieldBuilder(name);
74      }
75  
76      public OptionGroupFieldBuilder optionGroup(String name) {
77          return new OptionGroupFieldBuilder(name);
78      }
79  
80      public PasswordFieldBuilder password(String name) {
81          return new PasswordFieldBuilder(name);
82      }
83  
84      public StaticFieldBuilder staticField(String name) {
85          return new StaticFieldBuilder(name);
86      }
87  
88      public RichTextFieldBuilder richText(String name) {
89          return new RichTextFieldBuilder(name);
90      }
91  
92      public TwinColSelectFieldBuilder twinColSelect(String name) {
93          return new TwinColSelectFieldBuilder(name);
94      }
95  
96      public MultiValueFieldBuilder multi(String name) {
97          return new MultiValueFieldBuilder(name);
98      }
99  
100     public CodeFieldBuilder code(String name) {
101         return new CodeFieldBuilder(name);
102     }
103 
104     /**
105      * @deprecated Since 5.4, use {@link #code(String)} instead.
106      */
107     @Deprecated
108     public BasicTextCodeFieldBuilder basicTextCode(String name) {
109         return new BasicTextCodeFieldBuilder(name);
110     }
111 
112     public SwitchableFieldBuilder switchable(String name) {
113         return new SwitchableFieldBuilder(name);
114     }
115 }