1 /**
2 * This file Copyright (c) 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;
35
36 import info.magnolia.ui.dialog.DialogComponent;
37 import info.magnolia.ui.dialog.EditorActionLayout;
38
39 import java.util.ArrayList;
40 import java.util.List;
41
42 import com.vaadin.ui.Component;
43 import com.vaadin.ui.UI;
44 import com.vaadin.ui.Window;
45
46 /**
47 * Builder for Magnolia 6.0+ dialogs, based on the {@link AlertBuilder}.
48 *
49 * {@code withActions(List<Component> actions)} is to provide actions
50 * shown to the right of the form.
51 *
52 * {@code withSecondaryActions(List<Component> actions)} provides actions shown
53 * to the left of the dialog's footer but is optional.
54 *
55 * Here is an usage example:
56 * <pre>
57 * DialogBuilder.dialog()
58 * .withTitle("Edit object")
59 * .withContent(view)
60 * .withActions(new Button("Commit"))
61 * .buildAndOpen();
62 * </pre>
63 *
64 */
65 public class DialogBuilder {
66
67 private String title;
68 private Component content;
69 private List<Component> actions = new ArrayList<>();
70 private boolean modal = true;
71 private Component footer;
72
73 public static DialogBuilder dialog() {
74 return new DialogBuilder();
75 }
76
77 public DialogBuilder withTitle(String title) {
78 this.title = title;
79 return this;
80 }
81
82 public DialogBuilder withContent(Component content) {
83 this.content = content;
84 return this;
85 }
86
87 public DialogBuilder withActions(List<Component> actions) {
88 this.actions.addAll(actions);
89 return this;
90 }
91
92 public DialogBuilder modal() {
93 this.modal = true;
94 return this;
95 }
96
97 public DialogBuilder light() {
98 this.modal = false;
99 return this;
100 }
101
102 public DialogBuilder withFooter(Component footer) {
103 this.footer = footer;
104 return this;
105 }
106
107 public DialogComponent build() {
108 return new DialogComponent(this.content, getFooter());
109 }
110
111 private Component getFooter() {
112 if (this.footer == null) {
113 final EditorActionLayout editorActionLayout = new EditorActionLayout();
114 this.actions.forEach(editorActionLayout::addPrimaryAction);
115 this.footer = editorActionLayout;
116 }
117 return this.footer;
118 }
119
120 public Window buildAndOpen() {
121 Window window = new Window();
122 window.setCaption(this.title);
123 window.setContent(this.build());
124 window.center();
125 window.setModal(this.modal);
126 UI.getCurrent().addWindow(window);
127 return window;
128 }
129 }