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.definition.ConfiguredFormDefinition;
37 import info.magnolia.ui.form.definition.ConfiguredTabDefinition;
38 import info.magnolia.ui.form.definition.TabDefinition;
39
40 /**
41 * FormBuilder that builds form containing tabs and actions.
42 * Returns a {@link info.magnolia.ui.form.definition.FormDefinition}.
43 */
44 public class FormBuilder {
45
46 private final ConfiguredFormDefinition definition;
47
48 public FormBuilder() {
49 definition = new ConfiguredFormDefinition();
50 }
51
52 public FormBuilder(ConfiguredFormDefinition definition) {
53 this.definition = definition;
54 }
55
56 public ConfiguredFormDefinition definition() {
57 return definition;
58 }
59
60 public FormBuilder label(String label) {
61 definition().setLabel(label);
62 return this;
63 }
64
65 public FormBuilder i18nBasename(String i18nBasename) {
66 definition().setI18nBasename(i18nBasename);
67 return this;
68 }
69
70 public FormBuilder description(String description) {
71 definition().setDescription(description);
72 return this;
73 }
74
75 public FormBuilder tabs(TabBuilder... builders) {
76 for (TabBuilder builder : builders) {
77 definition().addTab(builder.definition());
78 }
79 return this;
80 }
81
82 public TabBuilder tab(String name) {
83 for (TabDefinition tab : definition().getTabs()) {
84 if (tab.getName().equals(name)) {
85 return new TabBuilder((ConfiguredTabDefinition) tab);
86 }
87 }
88
89 TabBuilder tabBuilder = new TabBuilder(name);
90 definition.addTab(tabBuilder.definition());
91 return tabBuilder;
92 }
93 }